我个人总结 AGENTS.md 尽量简短,因为每次对话都要加入 token 中,我们的目的是要尽量利用AGENTS.md尽量的节省 token,给AI方向,所以不能有废话,比如项目背景介绍(那是给人看的),我自己总结了下面几条,仅供参考
-
告诉AI 项目的结构,避免全量搜索
-
项目的编码规范和架构规则,比如DTO类要放在哪个项目下,不要写在Controller 里
-
全栈项目都要有各自的 AGENTS.md(前端一个AGENTS.md,后端一个AGENTS.md),这样分开也符合渐进式加载的原则,不然AI干活时读取不必要的上下文(比如生成前端代码时,去读取 AGENTS.md 中描写后端的内容)
我问了三个大模型(DeepSeek 0825新版,MiniMax M2.5,GLM 5),关于 "写 AGENTS.md 的原则和建议", 我觉得 ,GLM 5 回答最优秀,内容如下
根据搜索结果,编写高效 AGENTS.md 文件的核心在于平衡信息量与 AI 的处理能力,避免"用力过猛"导致 AI 迷路。以下是编写 AGENTS.md 的核心原则与具体建议。
一、 核心编写原则
在编写 AGENTS.md 时,应遵循"最小化"、"稳定性"和"渐进式"三大核心原则,以确保 AI 助手能准确理解指令且不被冗余信息干扰。
- 最小化原则
- 稳定性优先原则
- 渐进式披露原则
二、 内容编写建议
关于具体应该往 AGENTS.md 里写什么,建议分为"必填项"和"选填项"进行规划,并采用分层策略。
1. 必要内容(基础层)
根据最小化原则,以下内容是 AGENTS.md 的核心骨架:
| 内容类别 | 建议写法 | 示例 |
|---|---|---|
| 项目描述 | 一句话概括,相当于给 AI 的角色提示 | "This is a React component library for accessible data visualization."1 |
| 包管理器 | 如果不是默认的 npm,必须明确指出 | "Use pnpm for package management."1 |
| 构建/检查命令 | 如果非标准命令,需明确说明 | "Run pnpm build:lib for build."1 |
2. 扩展内容(项目层与团队层)
除了基础信息,可以根据项目情况补充以下内容,但需注意引用方式:
- 项目架构说明 :清晰描述代码组织结构和模块关系,但避免具体路径2 。
- 编码规范定义 :统一团队的代码风格和最佳实践。建议将具体的
.eslintrc或.prettierrc规则通过链接引用,而非直接展开2 。 - 分层配置策略 :
- 基础层:环境设置、通用工具。
- 项目层:特定技术栈、目录结构说明。
- 团队层 :协作规范、提交风格2 。
三、 避坑指南与实践技巧
在实际操作中,很多开发者容易陷入误区,导致 AGENTS.md 适得其反。