SuperAPI AI 工具集

api-state

写作与研究

查看项目

更新于 10-15 22:40

技能介绍

api-state 是多角度技术调研体系中的一个调研角度,只聚焦一件事:特定库或协议版本当前的 API 语法、变更日志和破坏性变更。它独立运行,执行期间与其他调研角度不共享状态,所有发现以内容形式返回,不写入任何 backlog 条目。

用途与能力:先确认技术名称、版本和具体 API 表面;随后抓取该技术的主文档页,提取精确的方法/类/装饰器签名、全部参数形式(必填、可选、带类型、可变参数)、返回类型与异步行为、上下文注入模式、配置或初始化要求,并逐条附来源 URL 和访问日期。接着抓取原始变更日志(常见路径为仓库中的 CHANGELOG.md 或 CHANGES.md,或 GitHub Releases 页面),按版本提取与已确认 API 表面相关的条目;再从变更日志和发布说明中识别最新若干主版本之间的破坏性变更,包括无弃用警告即静默移除的内容、需要显式迁移的内容、以及弃用及移除版本;最后综合出使用陷阱,每条陷阱必须引用来源。

使用方式:由编排器传入调研目标($ARGUMENTS),技能按六个步骤执行:范围确认、当前 API 状态、变更日志、破坏性变更、陷阱、结构化报告输出。查找文档时优先使用 mcp__Ref__ref_search_documentation 定位规范文档 URL,再用 mcp__Ref__ref_read_url 读取;若库未被 Ref 索引,改用 context7(mcp__context7__resolve-library-id 再 mcp__context7__query-docs);对 Ref 不提供的原始 GitHub URL 回退到 WebFetch。URL 和版本相关语法需从已确认范围推导,不得依赖训练数据。

输出:含当前 API、相关变更日志、破坏性变更、陷阱、Gaps 五个部分的结构化报告,并以 STATUS 块结束。Gaps 部分为必填,若确无缺失则写“No gaps — all expected information was found in primary sources.”。若缺少技术名称、版本或 API 表面,则输出 STATUS: BLOCKED 并说明原因。“Not documented in [source]”是有效发现,应如实陈述而非省略。

适用场景与限制:适合需要核实具体版本 API 现状、迁移影响和已知坑点的技术调研。仅覆盖单一调研角度,不负责其他维度;不写 backlog;变更日志缺失或相关条目不存在时需明确说明,而非推测。