AGENTS.md examples from real projects

How real projects brief Codex, Cursor and every other agent that reads AGENTS.md.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Worked for most · soon

jaakla Hiding risky files

jaaklaAGENTS.md

openmapstack

jaakla/openmapstack/AGENTS.md

This file is the canonical maintainer guide for coders (including AI coding agents) working on the OpenMapStack repository. Keep repository-wide development guidance here and keep it vendor-neutral. OpenMapStack is a managed agent-skill codebase, not an OpenMapStack GIS analysis project. The repository develops and quality-assures a distributable geospatial agent skill: Do not treat a shipped SKILL.md as maintainer instructions for this repository. Read or edit it when the task concerns the shipped skill behavior, but do not preload or follow its…

7645d agoReviewMount

CLAUDE.md vs AGENTS.md

About AGENTS.md

What is AGENTS.md?

An open format for instructions to coding agents, read by Codex, Cursor and others. Think of it as a README written for agents.

Where does it go?

At the repository root, with more specific files in subdirectories. Agents read the one closest to the file they're editing.

What should it contain?

Setup and test commands, code style, and the rules a new contributor would need to know.

Does Claude Code read it?

Claude Code reads CLAUDE.md. A one-line CLAUDE.md that points at AGENTS.md covers both.