List your AI tool on AI Orion for free. Submit a tool

AGENTS.md

A simple, open format for guiding coding agents, used by over 60k open-source projects.

Monthly visits
242K
Added
2026-07-28 17:16:59
AGENTS.md website

About AGENTS.md

AGENTS.md provides a dedicated, predictable place to provide context and instructions to help AI coding agents work on a project. It complements READMEs by containing the extra, sometimes detailed context coding agents need, such as build steps, tests, and conventions that might clutter a human-readable README. The format is designed to be adopted by teams building or using coding agents and to fit into existing documentation ecosystems.

AGENTS.md describes a lightweight, Markdown-based file used at the root of a repository to guide automated agents. It emphasizes separation from human-focused READMEs and aims to keep agent instructions concise, while allowing detailed guidance when necessary. The intent is to support a broad ecosystem of AI coding agents and tools by providing a clear, predictable file for agents to read.

AGENTS.md is a general, open format with compatibility across multiple agents and tools. It outlines how the file should be used to provide instruction, build steps, tests, and conventions so agents can operate on a project. The guidance includes practical tips for setup and collaboration with agents while remaining repository-focused.

AGENTS.md outlines how to add and organize agent-focused instructions within a repository and mentions nesting AGENTS.md files for subprojects. It also notes the format’s stewardship and alignment with open development efforts, aiming to benefit developers using various coding agents.

Key features

  • Dedicated, predictable place for agent context and instructions
  • Separates agent guidance from human-focused READMEs
  • Supports multiple agents and tools
  • Guides setup and project conventions
  • Works across monorepos with nested files

Pros and cons

Pros

Separates agent guidance from human README content
Widely used with many agents and tools

Reviews

Loading reviews…

Frequently asked questions

What is AGENTS.md?
AGENTS.md is a simple, open format for guiding coding agents, used by over 60k open-source projects. Think of AGENTS.md as a README for agents: a dedicated, predictable place to provide the context and instructions to help AI coding agents work on your project.
What should be included in AGENTS.md?
Add sections that help an agent work effectively with your project. Popular choices: Project overview, Build and test commands, Code style guidelines, Testing instructions, Security considerations.
How do I add AGENTS.md to a repo?
Create an AGENTS.md file at the root of the repository. Most coding agents can even scaffold one for you if you ask nicely.
Can AGENTS.md be nested for subprojects?
Large monorepo? Use nested AGENTS.md files for subprojects. Place another AGENTS.md inside each package. Agents automatically read the nearest file in the directory tree, so the closest one takes precedence and every subproject can ship tailored instructions.

Alternatives to AGENTS.md

More in AI Agent

Comparing tools