AGENTS.md Template

Use AGENTS.md for instructions a coding agent must apply whenever it works in a repository or subtree. Keep the root file short, exact, and current. Link detailed domain rules instead of loading every convention into every task.

# Project instructions

[One sentence describing what this repository builds.]

## Setup and commands
- Install: `[exact command]`
- Develop: `[exact command]`
- Test: `[exact command]`
- Lint or typecheck: `[exact command]`

## Local conventions
- [Only a convention that differs from normal ecosystem practice.]
- [Where generated files, schemas, or migrations come from.]

## Safety boundaries
- [Secret, production, migration, or destructive-action rule.]
- [Directory or generated artifact that must not be edited directly.]

## Verification
- [Minimum proof for an ordinary change.]
- [Stronger proof for high-risk work.]

## More specific guidance
- [Domain]: `[relative/path/to/GUIDE.md]`
- Nested `AGENTS.md` files apply to their subtrees.

Annotated example

# Project instructions

This repository builds a Node API and React web app.

## Setup and commands
- Install: `pnpm install`
- Test: `pnpm test`
- Typecheck: `pnpm typecheck`

## Safety boundaries
- Never place credentials in the repository.
- Do not edit files under `packages/api/generated/`; run `pnpm gen:api`.

## More specific guidance
- API changes: `docs/API.md`
- Web accessibility: `apps/web/AGENTS.md`

Every line changes agent behavior. Generic advice such as “write clean code” adds noise without telling the agent what is different here. The AGENTS.md project describes the file as a simple open format and requires no fixed headings. Scope and precedence depend on the consuming tool. Read How to write a good AGENTS.md for detailed guidance.

Review prompts

Does every command work from the directory where the file applies?
Are safety rules specific enough to prevent a real mistake?
Has detailed material been moved to a linked guide or nested file?
Can a new maintainer verify every claim against the repository?

Reviewed July 18, 2026. Written and maintained by the Plannotator documentation team.

Templates

Frameworks

Comparisons

Annotated example

Review prompts

​Annotated example

​Review prompts

Annotated example

Review prompts