SuperAPI AI 工具集

generate-agents-md

编程与开发

查看项目

更新于 10-16 05:47

技能介绍

用途:在项目根目录创建或完整重新生成 AGENTS.md,把智能体写代码前需要了解的约定固化下来,该文件会在每次智能体会话开始时被读取,从而省去每次重新发现构建命令、测试模式、命名规则和目录结构所消耗的 2-5k tokens。

适用时机:项目尚无 AGENTS.md;smart-start 检测到缺失;项目经历重大重构(新增模块、更换构建系统);首次将项目接入 AI 辅助开发。若只需小幅修改,建议手动编辑 AGENTS.md。

执行模型:由主智能体直接运行该技能,因为生成过程需要分析 package.json、Makefile、CI 配置、lint 配置等项目文件并综合约定,主智能体具备对话上下文,可通过 question 工具提出澄清问题。输出为项目根目录下的 AGENTS.md 文件。

工作流程:1)检测技术栈,依据关键文件识别 Node.js(package.json、tsconfig.json、eslint.config.*)、Python(pyproject.toml、setup.py、requirements.txt、ruff.toml)、Go(go.mod、go.sum)、Rust(Cargo.toml)、Java/Kotlin(pom.xml、build.gradle),并检查 monorepo 迹象(packages/、apps/、services/),读取配置提取项目名称、依赖版本、构建与测试命令;2)分析目录布局、模块边界、源码与测试目录约定、配置文件位置;3)提取代码风格、命名、测试、Git 与 CI/CD 约定;4)阅读 CONTRIBUTING.md、README 开发章节、.editorconfig 及已有 AGENTS.md;5)按固定结构生成文件,包含项目概览、技术栈、项目结构、开发命令表、代码约定、测试、模块规则、Do NOT 清单;6)用 question 工具向用户确认是否有未覆盖的约定、特殊模块规则或明确禁止事项,纳入反馈后定稿。

规则与限制:所有陈述必须来自实际项目文件,不得臆测;文件控制在约 50-150 行,详细内容以链接代替复制;每节应给出可执行指令;构建与测试命令须在 package.json/Makefile 中验证存在,不得编造;应记录清晰的模块边界以防跨模块依赖;不要使用内置 explore 子智能体。