agentleFS
Sign inStart free

AGENTS.md examples from real projects

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

Popular:code reviewtestingpdfMCP serverfrontendsecuritydocumentation
Worked for most · soon
TencentCloudBase remove filter1k+ stars remove filterHiding risky files remove filter
TencentCloudBaseAGENTS.md

CloudBase-AI-Toolkit

TencentCloudBase/CloudBase-AI-Toolkit/AGENTS.md

注：specs/ 已加入 .gitignore，spec 文档只写在本地、不要 git add 到公开仓库（含内部信息，完整历史归档在私有仓库 cloudbase-mcp-specs-archive）。 4. 项目子目录规则 - dsh-plugin/ 已有自己的 AGENTS.md（源）+ CLAUDE.md、CODEBUDDY.md 软链；新增子包照此补齐 - mcp/ 不设自己的 AGENTS.md —— mcp 包的约定已全部写在根文件里（mcptoolschemarules、addaiide、idemcpupgrade、cloudapibackendrules 等段都是针对它的），该目录下不得出现任何 IDE 兼容产物 </projectrules> - 真源在仓库 plugins/experts/<expert-name>/（一个专家一个子目录，版本控制）；与对外发布目录 plugin/（CodeBuddy plugin）区分 - WorkBuddy 专家目录 ~/.workbuddy/plugins/marketplaces/my-experts/plugins/ 是同步产物（build output），禁止手改（会被覆盖）；修改一律走"改仓库源码 → 同步命令" - 同步：npm run experts:sync [expert-name]（脚本 scripts/sync-experts.mjs：rsync --delete 镜像 → validateexpert.py → registerexpert.py）；expert-manager 脚本在 WorkBuddy app bundle 内，路径可用 EXPERTMANAGERSCRIPTSDIR 覆盖 - 内容原则：精简有效、引用为主——Agent MD 只留角色/SOP/铁律/路由，领域知识引用运行时官方 skills，不复制进包防漂移；踩坑经验官方 skill 未覆盖的才留包内 - 后续加新专家 = 在 plugins/experts/ 建目录（手工建骨架，initexpert.py 强制写 my-experts 目录与仓库真源冲突）→ npm run experts:sync；删除专家 = 删源码目录…

1.2k2d agoReviewMountCreate a free account to mount
TencentCloudBaseAGENTS.md

CloudBase-AI-Toolkit / evals

TencentCloudBase/CloudBase-AI-Toolkit/evals/AGENTS.md

No summary in the file. Open it to read it.

Steady12 mentions in 2 weeks

2 projects use a version of this

1.2k2d agoReviewMountCreate a free account to mount
TencentCloudBaseAGENTS.md

CloudBase-AI-ToolKit

TencentCloudBase/CloudBase-AI-ToolKit/AGENTS.md

注：specs/ 已加入 .gitignore，spec 文档只写在本地、不要 git add 到公开仓库（含内部信息，完整历史归档在私有仓库 cloudbase-mcp-specs-archive）。 4. 项目子目录规则 - dsh-plugin/ 已有自己的 AGENTS.md（源）+ CLAUDE.md、CODEBUDDY.md 软链；新增子包照此补齐 - mcp/ 不设自己的 AGENTS.md —— mcp 包的约定已全部写在根文件里（mcptoolschemarules、addaiide、idemcpupgrade、cloudapibackendrules 等段都是针对它的），该目录下不得出现任何 IDE 兼容产物 </projectrules> - 真源在仓库 plugins/experts/<expert-name>/（一个专家一个子目录，版本控制）；与对外发布目录 plugin/（CodeBuddy plugin）区分 - WorkBuddy 专家目录 ~/.workbuddy/plugins/marketplaces/my-experts/plugins/ 是同步产物（build output），禁止手改（会被覆盖）；修改一律走"改仓库源码 → 同步命令" - 同步：npm run experts:sync [expert-name]（脚本 scripts/sync-experts.mjs：rsync --delete 镜像 → validateexpert.py → registerexpert.py）；expert-manager 脚本在 WorkBuddy app bundle 内，路径可用 EXPERTMANAGERSCRIPTSDIR 覆盖 - 内容原则：精简有效、引用为主——Agent MD 只留角色/SOP/铁律/路由，领域知识引用运行时官方 skills，不复制进包防漂移；踩坑经验官方 skill 未覆盖的才留包内 - 后续加新专家 = 在 plugins/experts/ 建目录（手工建骨架，initexpert.py 强制写 my-experts 目录与仓库真源冲突）→ npm run experts:sync；删除专家 = 删源码目录…

Steady12 mentions in 2 weeks

1 project uses a version of this

1.1k3mo 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.