← Directory

AGENTS.md

Free
• Updated Jul 28, 2026, 09:11 PM

AGENTS.

Use Cases ▼
01

Define build and test commands for AI coding agents

02

Specify code style guidelines (e.g., linting rules) for generated code

03

Provide environment setup steps to ensure agent reproducibility

04

Share project conventions with multiple AI tools via a single file

05

Document directory structure and monorepo navigation for agents

06

Instruct agents on CI/CD pipeline integration and deployment steps

07

Enable agent-friendly contributor onboarding by including custom instructions

What Problem It Solves ▼

Coding agents often lack consistent, project-specific guidance, leading to incorrect or non-conforming code. AGENTS.md solves this by providing a standardized file that both open-source and closed-source projects can use to convey instructions to AI agents, ensuring they follow build steps, testing workflows, and style rules appropriately.

Key Features ▼
✓

Simple, open, and tool-agnostic format

✓

Widely adopted by over 60k open-source projects

✓

Compatible with many leading AI coding agents

✓

Complements README, reduces clutter

✓

Easy to adopt—just add a file

Overview

AGENTS.md is an open, simple format for providing project-specific instructions to AI coding agents. It serves as a dedicated, predictable place to define context such as build commands, testing procedures, code style conventions, and environment setup—complementing human-focused READMEs. The format is designed to be a single file placed in the project root, read by a wide range of AI coding tools and platforms.

Full Description ▼

The specification has been adopted by over 60,000 open-source projects on GitHub, demonstrating strong community endorsement. It works across numerous AI coding agents including VS Code, GitHub Copilot, Cursor, Devin, Aider, Windsurf, and many others, making it a de facto standard for agent instructions.

AGENTS.md is intentionally kept minimal and agent-focused, avoiding clutter that might overwhelm human contributors. By separating agent instructions from documentation for people, it enables maintainers to provide precise, actionable guidance to coding agents without compromising the readability of existing project documentation.

Pros & Cons

Pros

+

Simple, open, and tool-agnostic format

+

Widely adopted by over 60k open-source projects

+

Compatible with many leading AI coding agents

+

Complements README, reduces clutter

+

Easy to adopt—just add a file

Cons

−

No enforced validation or syntax checks

−

Limited to static instructions; cannot include dynamic logic

−

Relies on agent developers to support the standard

−

May require duplication if agents need different formats

−

Can become outdated without manual updates

Similar Tools

CLAUDE.md .cursorrules Copilot Instructions Aider conventions file .windsurfrules README.md

More in AI Agent