Download
openai/agents.md is a repository whose primary file is AGENTS.md, a proposed open, lightweight convention (i.e. Markdown file) for guiding coding agents in software repositories. The idea is that AGENTS.md acts as a “README for agents”: a predictable, structured place where humans can put instructions, conventions, build/test commands, environment setup, and other guidance that generative agents (e.g. code-writing, code-assisting tools) should consult when operating in the repo. Instead of putting everything in README or doc files (which are more human-oriented and might mix high-level narrative), AGENTS.md is intended to surface agent-relevant details that help them “do the right thing” (tests, style, project structure, tooling).
Features
- Dedicated guidance file for agents (AGENTS.md) — a standardized place to put instructions that matter to AI coding agents
- Nested/subdirectory support with precedence — local AGENTS.md override or refine instructions for submodules
- Agent-focused content (build, tests, lint, environment, conventions) — things agents need to know to operate safely and correctly
- Flexible Markdown format (no rigid schema) — authors can structure with headings, lists, narrative as suits their project
- Predictability and minimal clutter — by separating agent instructions from README, projects keep human docs cleaner
- Adoption by tooling and agent ecosystems — agents, assistants, and code tools can scan for AGENTS.md automatically and use it as a context guide
Project Samples
