ai-agent-project-template
AGENTS.md1 starsChanged 39 days agoMITView on GitHub
Canonical instructions for all agents in this repo. Client adapters point here. Reserve most context for the actual project, not template instructions. All clients share memory-bank/handoff.md: update on pause/switch, read on resume. Routing: memory-bank/model-routing.md. Follow the startup path above. Read present stack manifests/configs (package.json, pyproject.toml, requirements.txt, go.mod, Cargo.toml, tsconfig.json, vite.config.*, next.config.*). - Do not read by default: README.md, docs/, workflows/, skills, references/, assets/, .mcp/, validator scripts. - Update only: memory-bank/startup.md, memory-bank/handoff.md, memory-bank/projectbrief.md, memory-bank/activeContext.md, memory-bank/progress.md, memory-bank/techContext.md. - Keep unknowns as TBD.…
- Reads credentials
- Deletes or force-pushes
- Commits and pushes
Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 31,843 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository48 other files it gives its agents.
- .codex/AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- .github/copilot-instructions.mdCopilot instructions
- .cursor/rules/agents.mdcCursor rule
- code-reviewerSkill
- debug-issueSkill
- delegation-coordinatorSkill
- docs-memory-maintainerSkill
- handoffSkill
- human-voice-draftingSkill
- implement-taskSkill
- karpathy-engineerSkill
- local-media-transcriptionSkill
- plan-taskSkill
- pre-edit-checkSkill
- project-plannerSkill
- project-upgraderSkill
- refactor-safelySkill
- self-evaluateSkill
- sharepoint-teams-video-transcript-downloaderSkill
- spec-driven-developmentSkill
- storm-researchSkill
- test-strategistSkill
- update-memory-bankSkill
- upgrade-projectSkill
- usage-pacingSkill
- code-reviewerSkill
- debug-issueSkill
- delegation-coordinatorSkill
- docs-memory-maintainerSkill
- handoffSkill
- human-voice-draftingSkill
- implement-taskSkill
- karpathy-engineerSkill
- local-media-transcriptionSkill
- plan-taskSkill
- pre-edit-checkSkill
- project-plannerSkill
- project-upgraderSkill
- refactor-safelySkill
- self-evaluateSkill
- sharepoint-teams-video-transcript-downloaderSkill
- spec-driven-developmentSkill
- storm-researchSkill
- test-strategistSkill
- update-memory-bankSkill
- upgrade-projectSkill
- usage-pacingSkill
The file
Show its rules and text
We split this AGENTS.md into the rules it gives an agent
21 rules. About 0 are common, 7 are distinctive, and 14 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈7
Distinctive · estimate
This author's own choices. Worth a look.
14
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 9
If resuming work or switching models, also read memory-bank/handoff.md.
- Very specific: line 10
Read memory-bank/00-index.md only to choose additional files.
- Very specific: line 17
All clients share memory-bank/handoff.md: update on pause/switch, read on resume.
- Very specific: line 23
Follow the startup path above.
- Very specific: line 24
Do not read by default: README.md, docs/, workflows/, skills, references/, assets/, .mcp/, validator scripts.
- Very specific: line 25
Update only: memory-bank/startup.md, memory-bank/handoff.md, memory-bank/projectbrief.md, memory-bank/activeContext.md, …
- Very specific: line 26
Keep unknowns as TBD. Do not run full-repo audits.
- Very specific: line 30
Use when the user asks for full template review, publishing readiness, architecture audit, or broad cleanup.
- Very specific: line 34
Start in FAST_INIT. Escalate only when required facts cannot be verified from allowed files, or the user explicitly asks.
- Distinctive: line 42
One project, one repository: Never share a repo between projects.
- Very specific: line 44
.gitignoreis not a security control: Verify with git status --ignored --short and git ls-files. - Very specific: line 54
Do not invent facts. If unknown, write TBD or ask.
- Distinctive: line 55
Write repository documentation and commit messages in English.
- Very specific: line 56
Do not expose or edit secrets, credentials, tokens, .env values, or production config unless explicitly requested.
- Distinctive: line 57
Ask before destructive commands, dependency installs, migrations, production-impacting actions, or broad refactors.
- Distinctive: line 58
Prefer small, reviewable changes that match existing style.
- Distinctive: line 59
Keep Memory Bank updates concise and operational.
- Distinctive: line 60
Do not re-read files already read in the current task unless they changed.
- Very specific: line 62
Proactive Tool Suggestion: If codebase is too large for standard file search, suggest Graphify (workflows/build-graph.md).
- Very specific: line 69
Verify each step, then commit locally: git commit -m "<type>(<scope>): <step>".
- Distinctive: line 71
Use ~5 / 15 / 30 calls as diagnostic checkpoints, not forced task termination.
≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
AGENTS.md — Canonical Agent Instructions
Canonical instructions for all agents in this repo. Client adapters point here.
Startup path — keep context small
- Read this file.
- Read
memory-bank/startup.md. - If resuming work or switching models, also read
memory-bank/handoff.md. - Read
memory-bank/00-index.mdonly to choose additional files. - Load source/docs/workflows/skills only when the task requires them.
Reserve most context for the actual project, not template instructions.
Cross-model continuity
All clients share memory-bank/handoff.md: update on pause/switch, read on resume. Routing: memory-bank/model-routing.md.
Initialization modes
FAST_INIT (default)
Follow the startup path above. Read present stack manifests/configs (package.json, pyproject.toml, requirements.txt, go.mod, Cargo.toml, tsconfig.json, vite.config.*, next.config.*).
- Do not read by default:
README.md,docs/,workflows/, skills,references/,assets/,.mcp/, validator scripts. - Update only:
memory-bank/startup.md,memory-bank/handoff.md,memory-bank/projectbrief.md,memory-bank/activeContext.md,memory-bank/progress.md,memory-bank/techContext.md. - Keep unknowns as
TBD. Do not run full-repo audits. Minimize turns and narration.
DEEP_AUDIT (explicit only)
Use when the user asks for full template review, publishing readiness, architecture audit, or broad cleanup. Read deeper docs/workflows/skills/scripts as needed; document findings; propose focused changes.
Escalation rule
Start in FAST_INIT. Escalate only when required facts cannot be verified from allowed files, or the user explicitly asks.
Core rules
Repository boundaries — read before any git command
- This project is local-only until human says otherwise in current conversation. Check
git remote -vbefore any git work. Iforiginpoints to the template repo, detach:python scripts/detach-remote.py. Local commits encouraged; transmission forbidden. - Never push, publish, or sync without explicit instruction. No
git push, remote branch, PR, issue, or tag push. Never rungit push --force --mirror. - One project, one repository. Never share a repo between projects. Humans create dedicated repos for hosting (Vercel, Cloudflare, Netlify).
- Confidential material never enters a repository that is or was public. Removing later does not work (commits retrievable, forks share objects).
.gitignoreis not a security control. Verify withgit status --ignored --shortandgit ls-files.
Media & Transcription (Local GPU-Only)
- Transcribe locally with Whisper
large-v3(32 layers), RTX A5000 first, viascripts/transcribe_local_large_v3.py. Never reduce model size. - Fallback:
cuda/float16->cuda/int8_float16-> CPU chunked. Media and transcripts never leave the workstation.
General
- Do not invent facts. If unknown, write
TBDor ask. - Write repository documentation and commit messages in English. Match the user's language in chat.
- Do not expose or edit secrets, credentials, tokens,
.envvalues, or production config unless explicitly requested. - Ask before destructive commands, dependency installs, migrations, production-impacting actions, or broad refactors.
- Prefer small, reviewable changes that match existing style.
- Keep Memory Bank updates concise and operational.
- Do not re-read files already read in the current task unless they changed.
- HARD RULE — anything the user sends under their own name must read as human-written. Apply
.agents/skills/human-voice-drafting/SKILL.md; repo files are exempt. - Proactive Tool Suggestion: If codebase is too large for standard file search, suggest Graphify (
workflows/build-graph.md). If frequent style corrections occur, suggest Calibration (workflows/calibrate.md).
Engineering and execution
- Define the observable success check first; state baseline and expected outcome. Use a short plan for routine work, phases for complex work. Detail:
docs/agent-loop.md. - Inspect the real flow, then reuse existing behavior, configuration or code before adding code. Keep validation, error handling, security and accessibility.
- Delegate ready, bounded tasks only: one worker by default, two open tasks unless explicitly planned otherwise. Review/blocked work counts as open. Accept results before releasing dependents; no recursive spawning. See
docs/subagent-contract.md. - Verify each step, then commit locally:
git commit -m "<type>(<scope>): <step>". Document completed work inactiveContext.mdandhandoff.md. - Batch independent reads/checks; keep dependent operations sequential. Escalate diagnostics only when evidence requires it.
- Use ~5 / 15 / 30 calls as diagnostic checkpoints, not forced task termination. Stop unproductive retries; continue authorized work while making measurable progress.
- Record consequential disproven hypotheses and evidence; classify failures before retrying (
docs/agent-loop.md). - Apply the cognitive harness proportionately; load
assets/LLM_PROJECT_HARNESS.mdonly for deeper guidance.
Optional usage pacing
If asked to maximize tokens/quota or pace agents, read docs/usage-pacing.md. Explain the concrete plan, resource use and stop conditions, then wait for separate human confirmation before activation. Default OFF on every client; never auto-resume after a handoff. Useful work and verified completion take priority over consuming quota.
More detail (lazy-load)
- Agent execution loop (budgets, errors, phase summary):
docs/agent-loop.md - Subagent delegation contract:
docs/subagent-contract.md - Prompts:
docs/prompts.md - Antigravity/Cline master setup:
docs/antigravity-master-prompt.md - Skills/plugins:
docs/agent-skill-ecosystem.md - Hooks & safety guards (Antigravity, Claude, Codex):
docs/hooks.md - Model/provider routing:
memory-bank/model-routing.md - Local cross-client mail assessment:
docs/local-agent-mail.md
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

