在AI 辅助编程领域,AGENTS.md 正在迅速成为一个新兴的行业标准文件。它的核心理念可以简单概括为:“写给 AI 看的 README”。下面介绍 AGENTS.md 的作用、使用方法总结以及主流支持该标准的 IDE 列表。
AGENTS.md 的作用
传统的 README.md 是写给人类开发者看的(项目介绍、安装指南),而 AGENTS.md 是专门为 AI Coding Agents(AI 编程智能体) 准备的“操作手册”。
它的主要作用包括:
- 统一上下文(Context Source):
解决 AI “记性差”或“不懂行”的问题。它告诉 AI 项目的技术栈、构建工具、目录结构,而无需每次对话都重复输入。
- 规范代码行为(Rule Enforcement):
强制 AI 遵守特定的编码规范。例如:“必须使用 TypeScript 严格模式”、“禁止使用
any 类型”、“React 组件必须是函数式组件”等。
- 跨工具通用性(Interoperability):
以前你可能需要分别为 Cursor 写
.cursorrules,为 Github Copilot 写 instructions.md。AGENTS.md 旨在通过一个文件统一这些配置,让你的项目在不同的 AI 编辑器中都能获得一致的辅助体验。
- 自动化指引(Automation Hooks):
告诉 AI 如何运行测试、如何启动本地服务、如何进行 Lint 检查,以便 Agent 在自主修复 Bug 时知道如何验证结果。
使用总结与最佳实践
基本用法
- 创建文件:在项目根目录下创建一个名为
AGENTS.md 的文件。
- 格式:使用标准的 Markdown 语法。
- 层级支持:在大型项目(Monorepo)中,你可以在子目录下创建独立的
AGENTS.md,Agent 通常会优先读取离当前编辑文件最近的配置。
文件内容结构(模板示例)
一个高质量的 AGENTS.md 通常包含以下部分:
# AI Agent Configuration
## 1. Project Overview (项目概览)
- **Type**: Next.js 14 App Router application
- **Language**: TypeScript
- **Styling**: Tailwind CSS + Shadcn UI
- **State**: Zustand
## 2. Coding Standards (编码规范)
- **Strict Rules**:
- Do NOT use `any` type.
- Use `const` over `let`.
- Functional components only.
- Use server components by default unless `use client` is needed.
- **Naming**: camelCase for functions, PascalCase for components.
## 3. Commands (常用命令)
- **Install**: `pnpm install`
- **Dev Server**: `pnpm dev`
- **Test**: `pnpm test` (Run this after fixing bugs)
- **Lint**: `pnpm lint`
## 4. Architecture (架构指引)
- `/src/app`: Page routes
- `/src/components/ui`: Shadcn primitives (Do not modify manually)
- `/src/lib`: Utility functions
## 5. Workflow (工作流)
- Before committing code, always run the linter.
- If writing a test, use Jest/React Testing Library.
主流支持 AGENTS.md 的 IDE 和工具
目前,越来越多的 AI IDE 和工具开始原生支持或兼容这一标准:
| IDE / 工具 |
支持程度 |
说明 |
| Windsurf (by Codeium) |
原生支持 |
Windsurf 的 “Cascade” 引擎会自动检测并索引 AGENTS.md 作为核心规则,其优先级通常很高。 |
| Cursor |
支持 (作为规则) |
Cursor 用户传统上使用 .cursorrules,但现在也支持识别 AGENTS.md。如果根目录存在此文件,Cursor Agent 会将其内容纳入上下文。 |
| GitLab Duo |
原生支持 |
GitLab 官方文档明确支持 AGENTS.md 规范,用于指导 Duo Chat 和 Workflow。 |
| Kilo Code |
原生支持 |
作为一个新兴的 AI 原生编辑器,Kilo Code 强制将 AGENTS.md 作为项目配置的核心。 |
| Aider (CLI Tool) |
支持 |
著名的命令行 AI 编程工具,会自动读取该文件来理解项目上下文。 |
| GitHub Copilot |
兼容 |
虽然 Copilot 原生倾向于 .github/copilot-instructions.md,但许多开发者通过软链接(Symlink)将 AGENTS.md 指向 Copilot 的配置,或在 Copilot 企业版配置中引用它。 |
| OpenDevin / OpenHands |
核心支持 |
开源自主智能体框架,通常依赖此类文件来理解如何操作未知的代码库。 |
总结
如果你正在开发一个新项目,推荐直接使用 AGENTS.md 而不是特定工具的专用配置文件(如 .cursorrules)。这样做可以让你的项目对所有协作者(无论他们使用 Windsurf、Cursor 还是 VS Code + Copilot)都保持一致的 AI 辅助标准。