agents-md

To create an AGENTS.md file for LLM agents, you need to document exact commands, project structure, tech stack, key patterns, testing, gotchas, and task-to-file mappings in a concise format under 100 lines at the repository root.

Documenting workflow conventions and gotchas in AGENTS.md requires including Quick Commands, Project Structure, Tech Stack, Key Patterns, Testing, and Gotchas sections, plus a mapping of tasks to files to improve automation reliability and knowledge transfer.

You can update an existing AGENTS.md file without losing custom workflow notes because the update process preserves user customizations while applying new task-to-file mappings, coding guidelines, and repository-specific guidance incrementally.

The best way to structure repository documentation for LLM agents is maintaining a compact, human-readable AGENTS.md reference at the repository root that captures exact commands, conventions, and task-to-file mappings.

AGENTS.md is designed for code repositories of any size but enforces a strict constraint of staying under 100 lines to ensure the repository-specific guidance, exact commands, and workflow notes remain a compact, human-readable reference.

You need to generate an AGENTS.md file when your team adds documentation for new workflows or patterns and requires explicit commands, task-to-file mappings, and conventions to guide LLM agents and reviewers in a repository.