How to write a useful AGENTS.md
A strong AGENTS.md is not a prompt dump. It is a compact operating contract for an agent working inside a real repository.
The best files are specific about purpose, hard constraints, verification commands, Git workflow, and where key parts of the codebase live. They avoid vague phrases and unnecessary prose.
Good AGENTS.md principles
- Say what the project does in one sentence.
- List the behaviors the agent must never introduce.
- Give exact install, lint, typecheck, test, and build commands when they exist.
- Explain where routes, logic, content, and shared UI should live.
- Keep the wording imperative and easy to scan.
The builder presets give you a strong default so you can edit the important details instead of starting from a blank page. If you want to inspect the generated examples first, go to the examples page.
Guide FAQ
What should an AGENTS.md file contain?
A strong AGENTS.md explains project purpose, hard constraints, setup and verification commands, code conventions, safety rules, Git workflow rules, and architecture notes.
Why use presets instead of a blank editor?
Presets reduce omissions. They seed realistic commands, forbidden actions, and stack-specific guidance so you are editing a strong draft instead of starting from zero.
Why does the lint panel warn about vague language?
Phrases like "do the right thing" do not constrain coding agents. Clear, imperative guidance is easier for agents to follow consistently.