SuperAPI AI 工具集

research-codebase

编程与开发

查看项目

更新于 10-15 17:17

技能介绍

用途:research-codebase 用于围绕用户提出的代码库问题开展全面调研,只记录现状,不实现代码、不做改进建议。最终产出一组位于 research/ 目录下的研究文档,供后续撰写规格或设计文档使用。

主要能力:接收研究问题($ARGUMENTS),先用提示工程优化问题表述,然后拆解为可并行研究的子任务,用 TodoWrite 跟踪;读取用户明确提到的文件(完整读取,不带 limit/offset);判断项目兼容性立场(是否允许破坏性变更,即 breaking_changes_allowed 为 true 或 false),并贯穿研究计划、子代理提示、文档 frontmatter 与“Compatibility Context”章节。

并行子代理:codebase-locator 定位文件与组件位置,codebase-analyzer 说明代码如何工作,codebase-pattern-finder 查找既有模式;codebase-research-locator 与 codebase-research-analyzer 用于检索 research/ 中的历史文档;遇到外部依赖时用 codebase-online-researcher 获取在线资料。联网抓取顺序为:先试 curl https://<site>/llms.txt,再试 curl <url> -H "Accept: text/markdown",最后回退到 playwright-cli 解析 HTML。所有代理均为记录者而非评价者。

输出结构:代码库研究发现写入 research/docs/,命名如 YYYY-MM-DD-topic.md(有工单时含编号);网页资料缓存到 research/web/<YYYY-MM-DD>-<kebab-case-topic>.md,frontmatter 记录 source_url、fetched_at、fetch_method、topic。研究文档包含 YAML frontmatter(date、researcher、git_commit、branch、repository、topic、tags、status、last_updated、last_updated_by、breaking_changes_allowed、compatibility_context)以及 Research Question、Compatibility Context、Summary、Detailed Findings、Code References、Architecture Documentation、Historical Context、Related Research、Open Questions 等章节;尽量提供 GitHub permalink,并保留具体文件路径与行号。

使用方式:由调用者以研究问题作为参数触发,按固定步骤顺序执行;子代理完成后再统一综合,写文档前先收集元数据,不使用占位值。

限制:该阶段不实现任何功能;不生成 research/ 目录之外的文件;不依赖既有研究文档代替最新代码调研;发现原问题假设错误时应先向用户指出;兼容性立场无法从请求中推断时需先询问用户;文档中不写建议或评价。具体收费、价格、平台支持与效果等资料暂未提供。