{
  "slug": "agents-md",
  "name": "AGENTS.md",
  "category": "Scaffolds / Recipes",
  "tagline": "A simple open format, basically a README for coding agents, that tells them how to work in your repo.",
  "kit_says": "This is a page written for me, not for you. Every repo should have one, and every listing here ends up as one.",
  "homepage": "https://agents.md/",
  "repo": "https://github.com/agentsmd/agents.md",
  "docs": "https://agents.md/",
  "license": "MIT",
  "platforms": [
    "macos-apple-silicon",
    "linux",
    "windows"
  ],
  "mac_studio_fit": "Primary",
  "what_it_is": "A convention: put an AGENTS.md file at the repo root with dev environment tips, test instructions and PR rules so coding agents behave predictably.",
  "gap_role": "Context engineering: clear instructions let smaller local models punch above their weight in a codebase.",
  "prerequisites": [
    "A git repository"
  ],
  "install": {
    "macos-apple-silicon": [
      {
        "run": "cat > AGENTS.md <<'EOF'\n# AGENTS.md\n\n## Dev environment tips\n- <how to install deps / run the app>\n\n## Testing instructions\n- <exact test command>\n\n## PR instructions\n- Always run lint and tests before committing.\nEOF",
        "note": "section headings follow the official example"
      }
    ]
  },
  "configure": [
    {
      "run": "# point your agent at the repo; agents that support AGENTS.md read it automatically"
    }
  ],
  "verify": [
    {
      "run": "test -f AGENTS.md && head -5 AGENTS.md",
      "expect": "file exists at the repo root"
    }
  ],
  "rollback": [
    {
      "run": "git rm AGENTS.md   # or: rm AGENTS.md"
    }
  ],
  "caveats": [
    "Support varies by agent; check your agent's docs."
  ],
  "works_with": [
    "aider",
    "mcp-servers"
  ],
  "sources": [
    "https://github.com/agentsmd/agents.md",
    "https://agents.md/"
  ],
  "sponsored": false,
  "verified_on": "2026-10-15",
  "gap_score": {
    "value": null,
    "status": "pending test on Mac Studio",
    "baseline": "frontier reference (see /about#gap-score)"
  },
  "benchmarks": {
    "status": "pending test on Mac Studio",
    "rig": "Mac Studio, Apple Silicon, 128GB unified memory",
    "results": []
  },
  "hardware_tested": [],
  "repo_meta": {
    "stars": 24944,
    "stars_as_of": "2026-10-15",
    "last_push": "2026-09-10",
    "archived": false,
    "license_spdx": "MIT"
  },
  "stack_layer": "harness",
  "summary": {
    "what": "A README written for AI agents.",
    "why": "Clear instructions help small models act smarter."
  }
}