Build AGENTS.md
How to build AGENTS.md
Section titled “How to build AGENTS.md”Author the agent navigation + instructions entrypoint (Standard sec 3.10) and keep it in sync.
1. Create
Section titled “1. Create”Invoke askit-build-agents-md (create mode). It asks what the project is, its conventions, and its boundaries, then authors a tight AGENTS.md with the standard sections: what-this-is, current-state, conventions, build/test/lint, where-to-look.
2. Keep it brief and positive
Section titled “2. Keep it brief and positive”Verbose, generated-looking AGENTS.md files measurably reduce agent task success and raise cost, and long “do not X” lists backfire. Keep it essential-only and prefer positive, concrete instructions.
3. Sync the component section
Section titled “3. Sync the component section”node scripts/generators/sync-agents-md.mjsrenders the component list from library.json so it cannot drift. Regenerate it when components change instead of hand-editing.
This generator ships with the plugin, not with the npm package. The npm package carries the grading gate and STANDARD.md only. If you installed that way and want the component section kept current, ask your agent to run askit-build-agents-md in improve mode instead.
4. Validate
Section titled “4. Validate”node scripts/evaluate.mjs . --jsonAGENTS.md presence is checked by U2 (anatomy); the description and instruction-budget rules apply.