AGENTS.md 生成器
填写一份表单，即可生成包含命令、约定和硬性限制的 AGENTS.md。你还会获得一条路径范围规则，分别适用于 Cursor、GitHub Copilot、Claude Code、Cline 和 Devin Desktop；此外，还会生成桥接文件，供默认不会读取 AGENTS.md 的工具使用。
# Acme Web 应用
面向客户的 Web 应用，包含管理后台和一个小型 REST API。
## 技术栈
Next.js, React, TypeScript, pnpm
## 命令
- 安装: `pnpm install`
- 本地运行: `pnpm dev`
- 测试: `pnpm test`
- Lint 和类型检查: `pnpm lint && pnpm tsc --noEmit`
- 构建: `pnpm build`
## 代码风格
- 遵循 linter 强制执行的格式规范，不要修改未涉及的文件。
- 优先编写输入和输出清晰的小函数；将副作用限制在边界处。
- 添加新依赖前先征求同意。
- 为不明显的代码说明其原因，而不是逐行解释代码的作用。
## 测试
- 每次修改行为时，都添加或更新对应的测试。
- 完成前运行测试命令并修复失败项。
- 不要为了让测试套件通过而删除或跳过失败的测试。
## Commit 和 pull request
- Commit 标题使用祈使语气，且少于 72 个字符。
- 每个 pull request 只包含一项更改，并在描述中说明测试方式。
- 每次 commit 前运行 lint 和测试。
## 禁止事项
- 绝不要提交密钥、API key 或 .env 文件。
- 绝不要手动编辑 src/generated/ 下的生成文件；应重新生成。
- 绝不要对生产环境运行有破坏性的数据库命令。
- 绝不要对 main 执行强制推送或改写共享历史。
一条规则，适用于五种工具
---
description: 匹配此 glob 的文件所遵循的约定
globs: app/**/*.tsx
alwaysApply: false
---
遵循此文件夹中相邻文件使用的现有模式。每个导出的函数都必须有文档字符串，并在对应的测试文件中有测试。
---
applyTo: "app/**/*.tsx"
---
遵循此文件夹中相邻文件使用的现有模式。每个导出的函数都必须有文档字符串，并在对应的测试文件中有测试。
---
paths:
- "app/**/*.tsx"
---
遵循此文件夹中相邻文件使用的现有模式。每个导出的函数都必须有文档字符串，并在对应的测试文件中有测试。
---
paths:
- "app/**/*.tsx"
---
遵循此文件夹中相邻文件使用的现有模式。每个导出的函数都必须有文档字符串，并在对应的测试文件中有测试。
---
trigger: glob
globs: app/**/*.tsx
---
遵循此文件夹中相邻文件使用的现有模式。每个导出的函数都必须有文档字符串，并在对应的测试文件中有测试。
如何编写有效的指令文件
将准确的命令放在靠前位置
在文件靠前位置列出实际使用的安装、测试和 lint 命令及其 flags。明确写出技术栈和版本；如果文字描述不够清楚，就附上简短的代码示例。
明确写出禁止事项
明确说明 agent 不得做什么，例如不得接触密钥、vendored 代码或生产环境。GitHub 审阅的文件中，最常见且最有帮助的约束是禁止提交密钥。
让每条指令都可验证
“提交前运行 npm test”可以验证；“测试你的改动”则不行。消除相互矛盾的内容，因为两条指令不一致时，模型可能会遵循其中任意一条。
保持简短，并按路径拆分
Anthropic 建议每个文件少于 200 行，Cursor 建议每条规则少于 500 行。将针对某个区域的指导放入按路径限定的规则中，这样只有处理相关文件时才会加载。导入可以让文件更整洁，但不会降低上下文成本。
省略 agent 已经知道的内容
一项针对四种 coding agent 的研究发现，上下文文件无法稳定提升任务成功率，还会使推理成本增加 20% 以上。由 LLM 编写的文件略微降低了效果，仓库概览也没有帮助，因此文件中只保留不明显的要求，例如特定工具的用法。
错误反复出现时再添加规则
从少量规则开始；如果发现 agent 重复犯同一个错误，就添加一条规则。与其粘贴整份风格指南，不如将现有文件作为范例。
AGENTS.md 常见问题
Claude Code 会读取 AGENTS.md 吗？
会，从 v2.1.277 开始支持。默认情况下，只有当工作目录及其上级目录中不存在 CLAUDE.md、.claude/CLAUDE.md 或 CLAUDE.local.md 时，才会读取 AGENTS.md 或 .claude/AGENTS.md。设置 claude-md-and-agents-md 可同时加载两者；在 CLAUDE.md 中添加 @AGENTS.md 则适用于任何版本。
AGENTS.md 需要 frontmatter 或特定标题吗？
不需要。AGENTS.md 是纯 Markdown，没有必填字段，标题也可以自行设置。agents.md 网站建议包含项目概览、构建和测试命令、代码风格、测试、安全说明和 pull request 指南等部分。
如何在 monorepo 中使用 AGENTS.md？
在根目录放置一个 AGENTS.md，并在每个需要独立规则的 package 中再放置一个。agent 会读取距离正在编辑的代码最近的文件；如果规则冲突，以该文件为准。agents.md 记录时，OpenAI 主仓库中有 88 个这样的文件。
如何让 Gemini CLI 读取 AGENTS.md？
Gemini CLI 默认仍读取 GEMINI.md。在 .gemini/settings.json 的 context.fileName 中添加 AGENTS.md，例如 ["AGENTS.md", "GEMINI.md"]。运行 /memory show 可检查已加载的内容。
哪些 coding agent 支持 AGENTS.md？
我们查阅了 OpenAI Codex、Claude Code、Cursor、GitHub Copilot、Devin Desktop、Cline 和 OpenClaw 的文档，这些工具都能原生读取该文件；Gemini CLI 和 Aider 则需要添加一行配置。agents.md 网站共列出 23 款兼容工具，其中包括 Zed、Warp、goose、opencode、Jules 和 JetBrains Junie。
谁负责维护 AGENTS.md 格式？
OpenAI 已将 AGENTS.md 纳入 Agentic AI Foundation。该基金由 Linux Foundation 管理，于 2025-12-09 宣布成立，MCP 和 goose 也在同一时间加入。agents.md 网站称，已有超过 60k 个开源项目在使用该格式。