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

Elastic Hiding risky files

ElasticAGENTS.md

grafana-promql-extractor

elastic/grafana-promql-extractor/AGENTS.md

A Go CLI that extracts PromQL queries from Grafana dashboards. make build builds it, make help lists every target. The README covers what a user can observe: the flags worth knowing, the output format, what ends up in the file and what does not, rough expectations at scale. How it works goes in a package doc comment, in a doc.go when it runs long, where go doc finds it and where it gets updated along with the code. Do not…

03mo agoReviewMount

ElasticAGENTS.md

isomer

elastic/isomer/AGENTS.md

Canonical, tool-agnostic instructions for any coding agent working in this repository. Isomer turns one typed Composition into React, HTML, SVG, PNG, Slack Block Kit, Markdown, and plain text. It owns…

03d agoReviewMount

ElasticAGENTS.md

shared-otel-sdk-demo

elastic/shared-otel-sdk-demo/AGENTS.md

This file describes the conventions that govern this repository. Read it before making any change. This repository holds standalone tools shared across EDOT SDK demo applications. Tools are kept here so consuming repos can reference a released artifact instead of copying source. Each tool is independent: its own directory, its own build, its own release lifecycle. There is no root-level build system. Each tool directory is entirely self-contained. Do not leave the root README out of sync with the actual…

03mo 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.