AGENTS.md 项目上下文生成器
为缺少项目说明的代码仓库生成可执行的 AGENTS.md 上下文文件。
技能明确要求仅在缺失时创建 AGENTS.md,并列出跳过目录、避免秘密和危险操作,具备一定权限边界与数据安全意识;但未要求生成前获得用户确认,未说明备份、回滚、写入范围、数据流或外部依赖安全,因此扣分。
流程步骤相互一致,包含存在性检查、配置读取、真实路径验证和异常输入的跳过规则;但仅有静态说明,没有针对该技能关键路径的可执行测试、生成结果校验或明确失败恢复反馈,按静态校准不超过10分。
目标用户、AGENTS.md生成场景、根目录与嵌套目录规则及仅缺失时触发条件较清晰;但非适用范围、语义误触发边界和复杂项目处理边界仍不完整。核心工作主要依赖本地仓库文件,不完全依赖海外服务;中文支持未声明,因此扣分。
YAML元数据包含名称、描述、MIT许可证、作者和版本;文档结构清楚,含模板、示例、质量原则、反模式和维护性提示;但没有变更日志、明确维护责任、更新路径或依赖安装说明,因此扣分。
技能对扫描目录、提取命令、识别结构、编写边界和生成模板提供了可直接执行的核心流程,能够覆盖主要任务;但示例部分通用内容较多,未提供该技能的代表性已验证输出,也未证明与手工编写相比的边际收益,静态评估保守扣分。
技能提出了可核验的文件路径、命令和“不得虚构”规则,仓库还提供通用CI与测试线索;但提供的测试并非该技能关键路径的专门覆盖,缺少独立复现结果和多源交叉证据,因此只能给低分。
- 生成操作会写入 AGENTS.md 和可能的 CLAUDE.md,但未明确要求用户确认、备份或提供回滚方案。
- 模板和命令提取依赖项目文件存在性;复杂、非标准或多语言仓库可能产生不完整指导。
- 文档未声明中文输出策略,也未给出生成内容的自动质量检查或专门测试证据。
它能做什么 & 适用场景
该技能为仓库文件夹生成高质量的 AGENTS.md,帮助编码代理了解构建命令、测试方式、项目结构、代码风格和操作边界。它会检查每个文件夹中是否已有 AGENTS.md,只有在文件缺失时才生成。技能会根据实际存在的配置、源代码和目录识别技术栈与约定,并避免编造命令、路径或章节。它适合需要为现有仓库补充编码代理上下文的开发团队。
读取目标文件夹及其配置文件、CI 配置和部分源代码;检查 AGENTS.md 与 CLAUDE.md 是否已经存在;识别构建工具、测试框架、目录结构、命名和导入约定;为适用的仓库根目录、wiki、源码、测试、包或带构建清单的目录生成 AGENTS.md;在生成 AGENTS.md 的同一目录中,仅当 CLAUDE.md 缺失时生成固定内容的 CLAUDE.md;对已有文件报告跳过。
- 维护大型仓库的团队希望为根目录和各个子项目补充编码代理须知。
- 接手一个缺少构建和测试说明的项目,需要从现有配置中整理可执行上下文。
- 管理包含 packages、apps 或 services 的单仓库,需要为不同边界生成嵌套说明。
- 使用 deep-wiki 生成 wiki 后,需要为 VitePress wiki 目录补充专属 AGENTS.md。
- 希望避免代理覆盖现有 AGENTS.md,同时自动为新目录建立上下文文件的团队。
优缺点一览
- 明确规定绝不覆盖已有 AGENTS.md,降低误改项目指导文件的风险。
- 要求使用真实配置、CI 和源代码证据,避免虚构命令和路径。
- 覆盖根目录、嵌套目录、wiki、源码、测试目录和单仓库包等常见范围。
- 能同时生成受保护的 CLAUDE.md 引导文件。
- 技能本身没有提供专属测试套件或验收场景;README 只说明整个集合的测试基础设施。
- 生成质量依赖目标仓库是否包含可读取的配置、CI 和源代码证据。
- 技能只在文件缺失时生成,不能用于更新已有 AGENTS.md。
- 源材料没有说明各编码代理的具体触发命令或权限模型。
如何安装
从整个集合安装:运行 npx skills add microsoft/skills,在向导中选择需要的技能。集合会安装到所选编码代理的目录,例如 GitHub Copilot 使用 .github/skills/,并可在多个代理之间建立符号链接。源材料没有提供仅安装 wiki-agents-md 的独立命令;该技能位于 .github/plugins/deep-wiki/skills/wiki-agents-md/SKILL.md。
如何使用
在已安装该技能的仓库中提出类似请求:为这个仓库中缺少 AGENTS.md 的相关目录生成 AGENTS.md,并同时在缺失时生成 CLAUDE.md。先检查文件是否存在,使用真实的构建、测试、结构和代码风格信息,不要覆盖现有文件。 技能的具体代理触发语法未在源材料中说明。
对比同类
AGENTS.md 用于描述项目上下文,例如命令、约定和边界;README.md 面向人类读者,二者互为补充。.github/agents/*.agent.md 定义代理角色,而不是项目上下文。