SuperAPI AI 工具集

harness-step1-create-agents-md

智能体与模型

查看项目

更新于 10-16 01:48

技能介绍

用途:为项目建立 agent 可读的知识库地基,生成一份简短的 AGENTS.md(作为目录而非百科全书)和一套 docs/ 目录结构,存放真正的项目知识。核心原则是 agent 看不到的东西就不存在,业务定位、目标用户、架构决策、命名约定等必须以文件形式存在于仓库中。

主要能力:按步骤扫描项目根目录结构、识别技术栈、检查已有文档与 README,提取项目名称用途、业务定位、典型场景、技术栈、目录结构和已有文档。随后创建 AGENTS.md 及 docs/business-solution.md、ARCHITECTURE.md、CONVENTIONS.md、TECH_DECISIONS.md、QUALITY.md,以及 exec-plans/ 下的 active、completed、backlog.md、tech-debt-tracker.md;有需要时可选建 design-docs、product-specs、references。

使用方式:按 Step 1 至 Step 4 执行,先扫描再生成,AGENTS.md 控制在约100行内,包含项目说明、快速定向、知识库地图、工作规范和禁止事项。扫描命令包括 find、cat package.json 等包管理文件、ls 文档目录、head README。

适用场景:希望为项目添加 agent 支持、让 AI 更好理解项目、开始 harness engineering、创建 AGENTS.md 或搭建 agent 知识库时。

限制:业务内容须区分仓库明确声明的现有能力与推断的潜在场景,仅有营销描述而无代码或产品文档证据的内容标注「待 Step 2 验证」;无法判断的决策标注「待补充」;backlog 与 tech-debt-tracker 不可混用;生成后需自检链接与内容是否真实存在。下一步为运行 harness-step2-fill-docs 深度验证。