agentleFS

AGENTS.md examples from real projects

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

Best matches · from page 12Worked for most · soon
Model Context ProtocolAGENTS.md

servers / everything

modelcontextprotocol/servers/src/everything/AGENTS.md

Everything" Server - Development Guidelines ## Build, Test & Run Commands - Build: `npm run build` - Compiles TypeScript to JavaScript - Watch mode: `npm run watch` - Watches for changes and rebuilds automatically - Run STDIO server

No other project uses it yet

92k19d agoReviewMountCreate a free account to mount
storybookjsAGENTS.md

storybook

storybookjs/storybook/AGENTS.md

repository root unless stated otherwise. - After editing, format with `cd code && yarn fmt:write`. - Test React components with stories and `play` functions, never `*.test.tsx`. - Log through `storybook/internal/node-logger` or `storybook/internal/client-logger

No other project uses it yet

92k5d agoReviewMountCreate a free account to mount
koala73AGENTS.md

worldmonitor

koala73/worldmonitor/AGENTS.md

from `.nvmrc`. Run `npm run --silent agent:preflight -- --mode review` for source inspection, `--mode tests` before tests, or `--mode repair` before implementation. Add `--pr ` or `--issue ` when applicable. 3. Read

Steady4 mentions in 2 weeks

No other project uses it yet

91k2d agoReviewMountCreate a free account to mount
koala73AGENTS.md

worldmonitor

koala73/worldmonitor/public/agents.md

Machine interfaces, authentication, request policy, and rate limits.

Steady4 mentions in 2 weeks

No other project uses it yet

91k2d agoReviewMountCreate a free account to mount
gohugoioAGENTS.md

hugo

gohugoio/hugo/AGENTS.md

been solved before, look hard for helper functions before creating new ones. * In tests, almost always write end-to-end integration tests using `hugolib.Test` or one of its siblings. Write

No other project uses it yet

90k3y agoReviewMountCreate a free account to mount
sveltejsAGENTS.md

svelte

sveltejs/svelte/AGENTS.md

monorepo. **Important:** Read and follow [`CONTRIBUTING.md`](./CONTRIBUTING.md) as well - it contains essential information about testing, code structure, and contribution guidelines that applies here. When submitting a PR, you **MUST** read

No other project uses it yet

89k8mo agoReviewMountCreate a free account to mount
cheaper-inferenceReads credentialsAGENTS.md

OmniRoute

cheaper-inference/OmniRoute/AGENTS.md

clean) npm run typecheck:noimplicit:core # Strict check (no implicit any) npm run test:coverage # Unit tests + coverage gate (67.33 / 67.33 / 72.02 / 65.08 — statements/lines/functions/branches, enforced by the blocking ratchet

Steady26 mentions in 2 weeks

1 project uses a version of this

88k26d agoReviewMountCreate a free account to mount
lobehubReads credentialsAGENTS.md

lobe-chat

lobehub/lobe-chat/AGENTS.md

data fetching; TRPC for type-safe backend - Drizzle ORM with PostgreSQL; Vitest for testing ## Agent Skills `AGENTS.md` owns repository-wide architecture and workflow. Keep detailed implementation rules in skills

1 project uses a version of this

86k2d agoReviewMountCreate a free account to mount
bytedanceAGENTS.md

deer-flow

bytedance/deer-flow/AGENTS.md

load the nested files on their own. | Area | Guide | | --- | --- | | Backend: harness, Gateway, channels, tests | [backend/AGENTS.md](backend/AGENTS.md) | | Frontend | [frontend/AGENTS.md](frontend/AGENTS.md) | | nginx, Compose, provisioner | [docker/AGENTS.md](docker/AGENTS.md) | | Orchestration scripts, `scripts/pnpm.py` | [scripts/AGENTS.md](scripts/AGENTS.md) | | Skill

Steady13 mentions in 2 weeks

No other project uses it yet

85k5mo agoReviewMountCreate a free account to mount
bytedanceAGENTS.md

deer-flow / backend

bytedance/deer-flow/backend/AGENTS.md

provider's own guide | | Gateway, routers, IM channels | [gateway](app/gateway/AGENTS.md), [routers](app/gateway/routers/AGENTS.md), [channels](app/channels/AGENTS.md) | | Tests, benchmarks | [tests](tests/AGENTS.md), [benchmarks](scripts/benchmark/AGENTS.md) | ## Verify ```bash make test # offline suite in parallel shards make

Steady13 mentions in 2 weeks

No other project uses it yet

85k5mo agoReviewMountCreate a free account to mount
bytedanceReads credentialsAGENTS.md

deer-flow / docker

bytedance/deer-flow/docker/AGENTS.md

chart in `deploy/helm/` carries the same nginx routes. ```bash cd backend && python -m pytest tests -q -k "nginx or compose or sigterm" ``` - **Place the browser-stream WebSocket location before

Steady13 mentions in 2 weeks

No other project uses it yet

85k5mo agoReviewMountCreate a free account to mount
bytedanceAGENTS.md

deer-flow / frontend

bytedance/deer-flow/frontend/AGENTS.md

user management | [core/auth](src/core/auth/AGENTS.md) | | Memory, background tasks | [core/memory](src/core/memory/AGENTS.md), [core/background-tasks](src/core/background-tasks/AGENTS.md) | | End-to-end tests | [tests/e2e](tests/e2e/AGENTS.md) | ## Verify ```bash cd frontend pnpm check # ESLint and TypeScript; run before you commit

Steady13 mentions in 2 weeks

No other project uses it yet

85k5mo agoReviewMountCreate a free account to mount
bytedanceReads credentialsAGENTS.md

deer-flow / scripts

bytedance/deer-flow/scripts/AGENTS.md

with `--help` or read its header. ## Verify ```bash cd backend python -m pytest tests -q -k "serve or deploy or compose or doctor or dotenv or script or wizard

Steady13 mentions in 2 weeks

No other project uses it yet

85k5mo agoReviewMountCreate a free account to mount
bytedanceAGENTS.md

deer-flow / skills

bytedance/deer-flow/skills/AGENTS.md

Skills (`skills/`) `public/` holds committed skills and `custom/` holds local, gitignored skills. Tests for public skill scripts are in `tests/skills/` at the repository root and run in Skill Review

Steady13 mentions in 2 weeks

No other project uses it yet

85k5mo agoReviewMountCreate a free account to mount
bytedanceAGENTS.md

deer-flow / data-analysis

bytedance/deer-flow/skills/public/data-analysis/AGENTS.md

Data analysis skill (`skills/public/data-analysis/`) ```bash python -m pytest tests/skills -q -k "data_analysis" ``` Tests use real DuckDB. Default tests never download the spatial extension. XLSX integration tests run only with

Steady13 mentions in 2 weeks

No other project uses it yet

85k5mo agoReviewMountCreate a free account to mount
bytedanceAGENTS.md

deer-flow / video-generation

bytedance/deer-flow/skills/public/video-generation/AGENTS.md

invalid duration string is reported before submission. The provider checks the model-specific combinations. - **Tests mock HTTP and check request metadata and the exact input bytes** for both providers. Offline

Steady13 mentions in 2 weeks

No other project uses it yet

85k5mo agoReviewMountCreate a free account to mount
heygen-comAGENTS.md

hyperframes

heygen-com/hyperframes/AGENTS.md

changes only within the task's authorization and verify the resulting GitHub state. ## Build & Test ```bash bun install # Install dependencies (NOT pnpm — do not create pnpm-lock.yaml) bun run build # Build

Steady30 mentions in 2 weeks

No other project uses it yet

85k7d agoReviewMountCreate a free account to mount
heygen-comAGENTS.md

hyperframes

heygen-com/hyperframes/docs/AGENTS.md

page, read its complete body and verify product behavior in the current source, tests, CLI help, or shipped skills. - Write for a smart general user first. Do not assume they

Steady30 mentions in 2 weeks

No other project uses it yet

85k7d agoReviewMountCreate a free account to mount
jesseduffieldAGENTS.md

lazygit

jesseduffield/lazygit/AGENTS.md

Windows box has only `just`). - `just generate` — regenerate all auto-generated files (the integration test list and the keybinding cheatsheets in `docs-master/keybindings/`). Run this whenever you add/remove/rename

Steady4 mentions in 2 weeks

No other project uses it yet

84k6mo agoReviewMountCreate a free account to mount
opendatalabAGENTS.md

MinerU

opendatalab/MinerU/AGENTS.md

bash # 在项目根目录中创建虚拟环境 uv venv .venv # 激活虚拟环境 source .venv/bin/activate # 安装依赖 uv pip install -e ".[dev,test]" ``` 运行 Python 代码须在项目根目录 `MinerU` 中执行: ```bash .venv/bin/python -m mineru.path.to.submodule ``` ## GitHub Issue / PR 处理规范 处理 GitHub

Steady11 mentions in 2 weeks

No other project uses it yet

84k4d agoReviewMountCreate a free account to mount
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.