AGENTS.md: project operating instructions

PurposeCopy Anchor Link

AGENTS.md contains operating instructions for agents working in the repository: context, activities, conventions, documents to consult, commands and checks. It can be used in individual and team projects for design, development or other work within the project.

Its content depends on repository needs. This playbook’s focus on design concerns the topics documented here; it does not limit the activities agents can perform in applications.

What to includeCopy Anchor Link

1. Describe the project and where to find necessary context.
2. Specify instructions to consult according to the requested activity.
3. List conventions, commands and checks that actually apply.
4. Specify how to preserve concurrent work and manage changes.
5. Link reusable instruction sources, avoiding divergent copies.

Adapt the operating instructions template to the repository. For an individual assignment, also provide the goal, materials and expected outcome in the request to the agent.

Relationship to the playbookCopy Anchor Link

The playbook explains the design method and links tools and skills. AGENTS.md guides work execution in the project. If the project uses JADO, specify its repository location and link jado-run for design assignments: ask-jado clarifies missing decisions, and jado-flow coordinates the route and specialists. Instructions applicable to the session and user requests take precedence over the site’s descriptive content.