agentleFS
Sign inSign up

AGENTS.md examples from real projects

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

Best matchesWorked for most · soon
affaan-mAGENTS.md

ECC

affaan-m/ECC/AGENTS.md

Always-follow guidelines (common + per-language) scripts/ — Cross-platform Node.js utilities mcp-configs/ — 14 MCP server configurations tests/ — Test suite ``` `commands/` remains in the repo for compatibility, but the long

246k30d agoDiscuss
MicrosoftAGENTS.md

vscode / references

microsoft/vscode/extensions/copilot/assets/prompts/skills/agent-customization/references/agents.md

configuration and, when applicable, the parent agent. ## Tools Sources: built-in aliases, specific tools, MCP servers (` /*`), extension tools. **Special**: `[]` = no tools, omit = defaults. Body reference: `#tool: ` ### Tool Aliases | Alias | Purpose

193k21d agoDiscuss
MicrosoftAGENTS.md

vscode / copilotcli

microsoft/vscode/extensions/copilot/src/extension/chatSessions/copilotcli/AGENTS.md

shell, MCP) │ │ - Provides session persistence as events.jsonl files │ │ - Supports fleet mode and plan mode │ └─────────────────────────────────────────────────────────────────┘ │ ▼ ┌─────────────────────────────────────────────────────────────────┐ │ MCP Server (In-Process) │ │ (vscode-node/contribution.ts, vscode-node/inProcHttpServer.ts) │ │ - Provides VS Code-specific tools

193k21d agoDiscuss
MicrosoftAGENTS.md

vscode / agentHost

microsoft/vscode/src/vs/platform/agentHost/AGENTS.md

# Multi-Chat Architecture > Node runtime service construction is documented separately in [`node/serviceBootstrapping.md`](node/serviceBootstrapping.md). > Host

193k21d agoDiscuss
MicrosoftAGENTS.md

vscode / prompts

microsoft/vscode/src/vs/platform/agentHost/node/copilot/prompts/AGENTS.md

openBrowserPage`, `runTask`, `getTaskOutput`) — NOT the extension's snake_case ids, and NOT shell / server-SDK / MCP tools (MCP is discovered dynamically and isn't in the launch snapshot). A line

193k21d agoDiscuss
OpenAIAGENTS.md

codex

openai/codex/AGENTS.md

elsewhere. The exception is app-server API documentation, which is covered by the app-server guidance below. - Prefer private modules and explicitly exported public crate API. - If you change `ConfigToml

127k4mo agoDiscuss
JuliusBrusseeAGENTS.md

caveman / mcp

JuliusBrussee/caveman/mcp/AGENTS.md

mcp — the Caveman MCP server (commercial Go core + MIT launcher) A thin **stdio JSON-RPC** adapter exposing the compression [engine](../engine/CLAUDE.md) as five MCP tools to any host (Claude Code

108k6mo agoDiscuss
JuliusBrusseeAGENTS.md

caveman / mem

JuliusBrussee/caveman/mem/AGENTS.md

bm25.go` — deterministic tokenizer + BM25 scorer (non-negative scores, so the threshold is meaningful). - `cmd/cavemem/` — MCP server + `remember`/`recall`/`supersede`/`history`/`forget` CLI subcommands (JSON). - `js/` + `py/` — thin TS and Python

108k6mo agoDiscuss
JuliusBrusseeAGENTS.md

caveman / proxy

JuliusBrussee/caveman/proxy/AGENTS.md

silent no-op. `CAVE_SSRF_ALLOWLIST` opts loopback/private hosts back in (local model servers like Ollama; `localhost` as an entry covers 127.0.0.0/8 + ::1); metadata/link-local stay blocked in every mode

108k6mo agoDiscuss

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.