AGENTS.md

AGENTS.md

Also called: 智能体项目说明文件 · agents.md

A convention for a Markdown file at a repo's root that tells coding agents how to build, test, and follow the project's conventions. Introduced by OpenAI in 2025.

AGENTS.mdbuild / test cmdscode conventionsproject layout
Schematic (simplified)

Contents and purpose

It is like "a README for agents": typical entries are build/test/lint commands, directory layout, code-style conventions, pre-commit checks, and "don't touch these files." An agent reads it before editing code, so its changes fit the project's habits with fewer detours. A nested AGENTS.md in a subdirectory can override local rules.

Degree of standardisation

It is a lightweight convention, not a strict schema — plain Markdown with no mandatory fields. By 2026 it had been adopted by 60,000+ open-source projects and tools including Codex, Cursor, Devin, Gemini CLI, and Copilot, and moved to community governance under the Agentic AI Foundation alongside OpenAI joining it.

Common misconceptions

  • AGENTS.md has no mandatory format; tools parse it on a best-effort basis, not against a spec.
  • It is operating instructions for an agent, not a human-facing project description — different purposes.

Related terms

Sources

  1. AGENTS.md — agents.md
  2. OpenAI — OpenAI co-founds the Agentic AI Foundation (contributes AGENTS.md)

Compiled 2026-08-29 · This glossary is compiled from public papers, official specifications, and common industry definitions, and is updated as the field evolves. Corrections welcome.