{{project-name}}¶
AI Agent Instructions - Compact context with dynamic loading. Copy to project root as
AGENTS.mdand commit to version control.
Overview¶
{{One sentence describing what this project does}}
Stack¶
| Tech | Version |
|---|---|
| Language | {{e.g., TypeScript 5.3, Python 3.12, Go 1.22}} |
| Framework | {{e.g., Next.js 15, Django 5, Gin}} |
| {{other relevant tech}} | {{version}} |
Discovery -> Activation -> Execution¶
Use this flow for context loading:
- Discovery (always loaded)
- This file: stack, structure, boundaries, routing hints
- Activation (load only if task needs it)
- Domain docs in
@docs/— only the docs this project actually has - Execution (load before running commands)
- Command catalog (for example
@docs/scripts.md) if this project maintains one
Commands¶
- Package manager:
{{package-manager}}
{{package-manager}} install # Install dependencies
{{package-manager}} dev # Start dev server
{{package-manager}} test # Run tests
{{package-manager}} lint # Lint
{{package-manager}} build # Production build
- If this project maintains a detailed command catalog, reference it here (for example
@docs/scripts.md) - Do not invent commands not present in project config/docs
Task Mode Routing¶
| Task Mode | Load by Default | Command Docs |
|---|---|---|
| Research / Design / Plan | This file + relevant domain docs | Skip unless user asks |
| Implement / Fix | This file + relevant domain docs | Load command catalog before running commands (if it exists) |
| Verify / Release | This file + test/build docs | Load command catalog (if it exists) |
Structure¶
{{project-name}}/
├── {{source-dir}}/
│ ├── {{area-1}}/ # {{description}}
│ ├── {{area-2}}/ # {{description}}
│ ├── {{area-3}}/ # {{description}}
│ └── {{area-4}}/ # {{description}}
├── {{test-dir}}/ # Test files
├── docs/ # AI context docs
└── {{other-dir}}/ # {{description}}
Key Areas (for routing decisions):
| Area | Path | Contains |
|---|---|---|
| {{area-name}} | {{path}} |
{{what this area contains}} |
| {{area-name}} | {{path}} |
{{what this area contains}} |
| {{area-name}} | {{path}} |
{{what this area contains}} |
Context Loading¶
Load detailed docs based on your task:
| Task | Read First |
|---|---|
| {{task description}} | @docs/{{doc-name}}.md |
| {{task description}} | @docs/{{doc-name}}.md |
| Running commands / CI checks / release steps | @docs/scripts.md (if this doc exists) |
Boundaries¶
Always¶
- If command docs exist, use verified commands from those docs when executing tasks
- Follow existing patterns in codebase
- {{project-specific always-rule}}
Ask First¶
- Adding new dependencies
- {{project-specific ask-first rule, e.g., database schema changes}}
- Running destructive commands (reset/drop/force operations)
Never¶
- Commit
.envfiles or secrets - {{project-specific never-rule, e.g., modify generated directories}}
- Push directly to main branch