用途
agents-md 用于创建或重构 AGENTS.md 文件。根据资料,该技能仅在 /agents-md 触发时启用。其目标是生成最小化、聚焦的 AGENTS.md,采用渐进式披露(progressive disclosure)方式组织给 AI 编码智能体的指令。
核心原则
- 指令预算:LLM 能稳定遵循约 150-200 条指令,且每个 token 都会在每次请求中加载。
- 渐进式披露:只给智能体当前需要的内容,具体细节指向其他文件。
- 避免陈旧:不要记录文件路径(它们会变化),应记录能力与领域概念。
根 AGENTS.md 应包含的内容
仅保留以下要点:
- 一句话项目描述(用于锚定智能体的决策)
- 包管理器(若不是 npm)
- 非标准的构建/类型检查命令
其余内容都放到别处。
重构工作流
重构已有 AGENTS.md 时:
- 发现矛盾:识别相互冲突的指令,询问用户保留哪一条。
- 提取要点:只抽出应放在根级的内容。
- 对其余内容分组:按逻辑类别整理(如 TypeScript、测试、API 设计等)。
- 创建文件结构:输出最小化根文件加独立文件,并用 markdown 链接关联。
- 标记删除:移除以下指令——冗余(智能体已知)、过于含糊无法执行、过于显而易见(如“写整洁代码”)。
渐进式披露模式
分离文件:
# Root AGENTS.md
For TypeScript conventions, see docs/TYPESCRIPT.md
嵌套文档:
docs/
├── TYPESCRIPT.md → references TESTING.md
├── TESTING.md → references test runners
└── BUILD.md → references build config
Monorepo 结构:
| 层级 | 内容 |
|---|---|
| 根 | Monorepo 用途、导航、共享工具 |
| 包 | 包用途、技术栈、约定 |
最小 AGENTS.md 示例:
React component library for accessible data visualization.
Uses pnpm workspaces.
## Conventions
- TypeScript: see docs/TYPESCRIPT.md
- Testing: see docs/TESTING.md
- API patterns: see docs/API.md
需要修复的反模式
- 自动生成的文件:塞满“对大多数场景有用”的内容。
- 文件路径文档:很快过时,污染上下文。
- 累积的规则:数月一次性添加形成的“泥球”。
- 强制语气:过多的“ALWAYS”“NEVER”、全大写指令。
- 显而易见的指令:模型已经知道的东西。
创建工作流
创建新的 AGENTS.md 时:
- 向用户询问一句话项目描述。
- 识别包管理器(默认 npm 无需提及)。
- 检查是否存在非标准的构建/类型检查命令。
- 尽量控制在 10 行以内。
- 为领域特定指导创建独立的 docs/ 文件。
适用场景与限制
该技能适用于为 AI 编码智能体编写或整理 AGENTS.md 的项目,尤其是需要拆分指令、控制上下文预算的仓库。资料未提供具体支持的平台、收费方式、价格或可用性信息;其功能边界以本文所述创建与重构工作流为准。