SuperAPI AI 工具集

agents-md-generator

编程与开发

查看项目

更新于 10-15 15:12

技能介绍

AGENTS.md Generator(根目录 + 嵌套,可移植)用于维护小而高信号的 AGENTS.md 文件。

用途

该技能用于创建、生成、更新、修复、精简或拆分 AGENTS.md 文件,覆盖仓库根目录和已确认的嵌套模块,采用渐进式披露策略。根 AGENTS.md 说明仓库用途、导航、通用工具链、规范命令以及文档和技能链接;嵌套 AGENTS.md 说明模块/包用途、本地命令和模块引用。

何时运行

当 AGENTS.md 缺失、臃肿、矛盾或过时时;当需要生成、修复、精简、拆分或更新 AGENTS.md 时;当出现新的包/服务/模块时;当仓库结构变化(monorepo 增长或拆分)时;当团队希望在多样技术栈间保持一致的代理上下文时。

主要能力

  • 发现仓库形态:识别仓库根(如可用则用 git 根),检测语言/工具标记(package.json、pnpm-workspace.yaml、go.mod、go.work、pyproject.toml、Cargo.toml、pubspec.yaml、pom.xml、build.gradle),定位 docs/、README.md、现有 AGENTS.md。
  • 检测模块边界:若目录包含独立构建/包清单,或代表可部署/服务单元(apps/、services/、packages/),且相比父范围增加了不同的命令、文档、所有权、部署说明或工具链指导,则创建嵌套 AGENTS.md;不创建仅重复根指令的嵌套文件。
  • 生成/更新根 AGENTS.md:理想大小 ≤ 60 行,必须包含一句话仓库用途、主要工具链/包管理器、规范命令(如非标准)、文档链接、进入模块时阅读嵌套 AGENTS.md 的指示,以及可选的技能引用(自适应:本地或外部)。保留现有根 AGENTS.md 中已验证的命令、文档、安全/密钥/部署警告和重要本地规则。
  • 生成/更新嵌套 AGENTS.md:理想大小 ≤ 40 行,必须包含一句话模块用途、模块特定命令、本地文档引用、可选技能引用(自适应)。保留现有嵌套 AGENTS.md 中已验证的模块警告、所有权、部署说明和本地规则。

使用方式

工作流是确定性的:1)发现仓库形态;2)检测模块边界;3)生成/更新根 AGENTS.md;4)生成/更新嵌套 AGENTS.md;5)应用渐进式披露规则;6)通过安全/正确性门禁。

渐进式披露规则:不嵌入风格指南、CI 策略或架构细节;优先链接到现有文档和外部或本地技能;只包含存在或明确引用为命令/策略来源的链接;当存在权威文档时,用链接替换过时的长文段落;除非对正确性/安全至关重要,避免“总是/从不”规则。

安全/正确性门禁:绝不编造命令;从包脚本、Makefile、CI 配置、README 推断命令;如果不确定,写“Known commands: see <existing file>”;保留关键警告(安全、密钥、部署)。

输出契约:只创建或更新 <repo_root>/AGENTS.md 和 <module_dir>/AGENTS.md;不创建代理配置文件夹。

技能引用策略:添加技能引用时,若检测到本地技能目录,使用 See: <detected-skill-root>/<skill-name>/SKILL.md;若不存在本地目录,使用 Skill: agents-md-generator (external);绝不假设文件系统路径。

资源路由:模板仅作为骨架,不是字面输出;仅在创建或更新根 AGENTS.md 时读取 references/AGENTS_TEMPLATE_ROOT.md;仅在目录被确认为需要自己的 AGENTS.md 的嵌套模块后,读取 references/AGENTS_TEMPLATE_MODULE.md;替换或移除每个占位符,最终 AGENTS.md 文件不得包含未解析的 <...> 模板标记。

技能位置(代理特定):不要假设 .agents/ 或任何固定目录存在;技能可能位于仓库内(嵌入式)或外部/全局技能库(外部);如果引用本地技能,仅使用项目已使用的现有技能根或仓库文档已提及的现有项目路径;如果不存在本地技能目录,仅按名称引用技能(外部);绝不创建隐藏代理目录来存储技能。

验证

完成前验证:只创建或更新了根/模块 AGENTS.md 文件;最终 AGENTS.md 文件不包含未解析的 <...> 占位符;相对文档链接存在或明确指向命令/策略的源文件;命令由包脚本、Makefile、CI 配置或 README 支持,若无验证命令,使用 Known commands: see <existing file>;遵守行数预算:根 ≤ 60 行,嵌套模块 ≤ 40 行;嵌套文件仅存在于已确认的模块边界;保留现有 AGENTS.md 文件中的关键警告。

适用场景

适用于需要维护仓库级和模块级代理上下文的项目,尤其是 monorepo、多技术栈团队、新增包/服务/模块或仓库结构调整时。

限制

该技能不编造命令,不创建代理配置文件夹,不假设固定技能目录,不嵌入风格指南、CI 策略或架构细节。关于收费、价格、平台、效果等信息暂未提供。