Protocols & Standards

AGENTS.md

AGENTS.md is a plain-text file placed in a project's repository that gives AI coding agents project-specific instructions, like how to set up, build, test, and follow the project's conventions.

When a coding agent works on a repository, it often needs context a human contributor would normally get from a README, a CONTRIBUTING guide, or just tribal knowledge — how to install dependencies, which command runs the tests, what code style the project expects. AGENTS.md is a convention for putting that context in one predictable place so an agent can find it without being told each time.

It's a plain-text (usually Markdown) file read by multiple different coding agents, not a format tied to one vendor. A project maintainer writes it once, and any AGENTS.md-aware agent that works on the repo picks it up automatically, the same way many tools already look for a README.md by convention.

AGENTS.md is a convention, not an enforced standard — nothing requires a project to have one, and an agent that doesn't recognize the file just won't use it. Projects that do add one typically keep it focused: setup and run commands, testing instructions, and any code-style or workflow rules that matter for that specific codebase.

Example

# AGENTS.md

## Setup
Run `npm install` to install dependencies.

## Testing
Run `npm test` before committing. All tests must pass.

## Code style
Use 2-space indentation. Prefer named exports over default exports.

Common misconceptions

Often assumed: AGENTS.md is required for a coding agent to work on a repo.
Actually: It's optional — an agent without one just falls back to exploring the codebase and asking, or using whatever other docs exist; AGENTS.md just makes that step faster and more reliable.
Often assumed: AGENTS.md is specific to one vendor's coding agent.
Actually: It's meant to be read by multiple different coding agents as a shared, tool-agnostic convention, similar in spirit to how README.md is a convention many tools recognize.

FAQ

What goes in an AGENTS.md file?
Typically setup/install commands, how to run tests, and any project-specific coding conventions or workflow notes an agent should follow.
Do I need an AGENTS.md file?
No, it's optional — but if your coding agent keeps guessing wrong about how to build or test your project, adding one usually fixes that.
Is AGENTS.md the same as SKILL.md?
No — AGENTS.md gives project-specific instructions for a repository; SKILL.md packages a reusable capability with its own trigger conditions, independent of any one project.

Last checked: 2026-08-28

Related terms