如何编写出色的 agents.md 文件?GitHub 分析超 2500 个仓库的经验总结GitHub Copilot 新推出的自定义代理功能,允许你通过
agents.md 文件构建专属的 AI 专家团队,例如
@docs-agent (文档工程师) 或
@test-agent (测试工程师).
然而,大多数代理文件因指令模糊而效果不佳。“你是一个有用的编程助手” 这类宽泛的描述是行不通的.
GitHub 团队通过分析超过 2500 个
agents.md 文件,总结出了编写高效代理的关键要素:
为 AI 提供具体的操作手册,而不是模糊的提示。
成功的 agents.md 文件都具备以下特点:1. 明确角色与专长清晰定义代理的身份,例如:“你是一名测试工程师,为 React 组件编写测试”.
2. 提供可执行命令将 npm test, pytest -v 等具体命令放在前面,代理会频繁引用它们.
3. 代码范例优于解释一个真实的代码片段比三段描述更能清晰地传达你的代码风格.
4. 设定清晰的边界明确告知 AI 不能做什么,例如:“绝不提交密钥”、“不要修改 src/ 目录下的源代码”.
5. 详细说明技术栈使用 “React 18 with TypeScript, Vite, and Tailwind CSS”,而不是笼统的 “React project”.
6. 覆盖六大核心领域命令、测试、项目结构、代码风格、Git 工作流和边界.
如何开始?从一个简单的任务开始,比如编写单元测试或修复 lint 错误. 你可以让 Copilot 帮助生成初始的
agents.md 文件,然后在此基础上进行迭代优化.
原文链接#GitHub #Copilot #AI #Agents #Developer
The GitHub Blog
How to write a great agents.md: Lessons from over 2,500 repositories
Learn how to write effective agents.md files for GitHub Copilot with practical tips, real examples, and templates from analyzing 2,500+ repositories.