2.3 KiB
2.3 KiB
title, type, tags, sources, last_updated
| title | type | tags | sources | last_updated | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| AGENTS.md | concept |
|
|
2026-03-21 |
Definition
AGENTS.md 是 AI Agent 框架中定义 Agent 工作说明书的核心文件。存在两种语境:
-
OpenCode 语境(自动生成):位于项目根目录,由
/init命令自动分析项目结构生成,包含项目结构、编码规范、约定俗成等上下文信息,帮助 AI 理解项目的整体背景。 -
OpenClaw 语境(手动配置):位于
~/.openclaw/workspace/,是用户手动编写的岗位说明书,定义 Agent 的职责、边界、多 Agent 协作流程。
OpenCode: 自动生成
运行 /init 命令后,OpenCode 会自动分析项目结构并生成 AGENTS.md:
cd /path/to/project
opencode
/init
最佳实践:
- 纳入版本控制:OpenCode 官方建议将 AGENTS.md 提交到 Git,以获得一致的跨团队体验
- 持续维护:随着项目演进,定期更新 AGENTS.md 以反映最新的架构决策
- 具体示例:提供代码示例和模式说明,帮助 AI 生成符合项目风格的代码
OpenClaw: 手动配置
在 OpenClaw 中,AGENTS.md 回答的是:
- 这个 Agent 叫什么,主要职责是什么?
- 遇到什么类型的任务该用什么方式处理?
- 有哪些事情是绝对不该做的?
- 当用户说某类话时,该优先走哪套流程?
- 在多 Agent 场景里,该怎么协调其他 Agent?
经验法则:300-500 字的 AGENTS.md,比 2000 字的更有效。边界比能力描述更重要——LLM 默认会"发挥创意",需要约束。
场景触发优于通用指令:与其写"始终保持专业语气",不如写"当用户问技术问题时,使用专业准确的措辞;当用户随意聊天时,语气可以轻松一些"。
Related Concepts
- OpenCode — OpenCode 语境下生成和使用 AGENTS.md 的核心工具
- OpenClaw — OpenClaw 语境下 AGENTS.md 所属的框架
- SOUL.md — Agent 性格档案,与 AGENTS.md 分工明确
- Agent Specialization — AGENTS.md 定义多 Agent 协作的核心机制
- Plan Mode — 利用 AGENTS.md 提供充足上下文以生成精准方案
- Vibe Coding — AI 辅助编程的工作流理念