Skip to content
Get packs

AGENTS.md

A plain-text markdown file format that gives AI coding agents project instructions.

GitHub Download source
Stars
25.3k
Forks
1.9k
Licence
MIT
Language
TypeScript
Last update
2 months ago
Type
Other

What it is

AGENTS.md is an open, simple format for a file that sits in a code project and tells AI coding agents how to work on it. The README describes it as a README written for agents: a predictable place for context and instructions such as setup commands, test steps, and pull request conventions. The repository itself hosts the format's website and a sample file; the README shown does not describe a separate tool to install.

  • Write an AGENTS.md that lists the commands to install dependencies, run tests, and lint code
  • Document PR title conventions so agents follow them when preparing changes
  • Point agents to CI workflow locations and the right package in a monorepo

Great for

  • Maintainers of projects who use AI coding agents and want to give them consistent instructions
  • Teams with monorepos that need agents to find packages and run the right commands
  • Developers who want a shared, predictable location for agent guidance instead of repeating it in chats

Not ideal for

  • People looking for a runnable program: the README describes a format and a website, not an application
  • Projects that do not use AI coding agents, since the file has no effect without one
  • Anyone expecting enforcement: the README presents the file as guidance, not a guarantee of agent behavior
Step-by-step guide: how to use AGENTS.mdInstall, first run, examples, tips and FAQs

How to get it

  1. 1

    See the README

    Clone the repository

    git clone https://github.com/agentsmd/agents.md
  2. 2

    Run it

    • Read the sample AGENTS.md in the README to see the structure
    • Create an AGENTS.md file at the root of your project
    • Add sections for dev environment tips, testing instructions, and PR instructions
    • Check whether your coding agent reads AGENTS.md and adjust the content accordingly
  3. 3

    Get the most out of it

    • Keep commands exact and copy-pasteable, as the sample does with pnpm commands
    • Use the package-level guidance pattern shown in the sample for monorepos
    • Include a testing section that says which checks must pass before merging
    • Visit https://agents.md for the project's stated goals and examples

Downloads

Source code (.zip)main branch · straight from GitHubOfficial website & docsagents.md

Strengths

  • Simple, open format described in plain markdown
  • Sample file in the README shows concrete, practical content
  • Permissive MIT license

Trade-offs

  • The README is short and does not specify which agents read the file or how
  • No releases are listed, so the format's stability is unclear from this data
  • Benefit depends on each agent tool honoring the file, which the README does not document in detail

Stats synced from GitHub. The assessment above was drafted with AI from the project's README on 2026-10-29 and may miss recent changes — check the README before relying on a command. MIT licence: free to use, modify and distribute, including commercially, as long as you keep the copyright notice.