SuperAPI AI 工具集

docs-seeker

写作与研究

查看项目

更新于 10-15 15:32

技能介绍

用途

docs-seeker 用于智能地发现和分析技术文档,覆盖库、框架、网站与代码仓库等目标。当用户需要查找某项目的安装、配置、API 参考、核心概念、示例或最佳实践时,可借助该技能完成检索与整理。

主要能力

  1. llms.txt 优先检索:优先寻找标准化的、对 AI 友好的 llms.txt 文档,并优先使用 context7.com 的地址模式。
  2. 仓库分析:当找不到 llms.txt 时,通过 WebSearch 定位 GitHub 仓库,再用 Repomix 将整个仓库打包成单一文件进行分析。
  3. 并行探索:当 URL 数量较多时,派出多个 Explorer 智能体并行读取不同文档章节,最后汇总为统一报告。
  4. 兜底研究:在没有 GitHub 仓库时,派出多个 Researcher 智能体,围绕官方文档、教程、API 参考和社区指南展开研究并汇总。
  5. 版本与主题处理:支持指定版本(默认最新),并支持通过 ?topic= 参数进行主题定向搜索。

使用方式

整体分为四个阶段:

第一阶段:初始发现。从用户请求中提取库或框架名称,注意版本要求(默认最新),明确目标属于 GitHub 仓库还是网站,然后优先尝试 context7.com 的 llms.txt 地址模式。

  • 针对 GitHub 仓库的模式:https://context7.com/{org}/{repo}/llms.txt
  • 针对网站的模式:https://context7.com/websites/{normalized-domain-path}/llms.txt
  • 主题定向检索:https://context7.com/{path}/llms.txt?topic={query}

若未命中,则回退到传统 llms.txt 搜索,例如使用 WebSearch 搜索 "[library name] llms.txt site:[docs domain]",或尝试常见模式如 https://docs.[library].com/llms.txt、https://[library].dev/llms.txt、https://[library].io/llms.txt。

第二阶段:llms.txt 处理。单一 URL 直接抓取并提取信息;多个 URL(3 个及以上)时并行启动多个 Explorer 智能体,每个智能体负责一个主要文档章节(首批最多 5 个),最后汇总为一份整合报告。

第三阶段:仓库分析。在未找到 llms.txt 时,先通过 WebSearch 找到 GitHub 仓库,再用 Repomix 打包,例如:

npm install -g repomix # if needed git clone [repo-url] /tmp/docs-analysis cd /tmp/docs-analysis repomix --output repomix-output.xml

随后读取 repomix-output.xml 并提取文档内容。Repomix 的优势是将整个仓库放入单个 AI 友好文件、保留目录结构、便于 AI 消费。

第四阶段:兜底研究。当不存在 GitHub 仓库时,并行启动多个 Researcher 智能体,围绕官方文档、教程、API 参考和社区指南展开,再汇总为统一报告。

智能体分配建议:1–3 个 URL 使用单个 Explorer 智能体;4–10 个 URL 使用 3–5 个 Explorer 智能体(每个 2–3 个 URL);11 个以上 URL 使用 5–7 个 Explorer 智能体(优先最相关的)。

版本处理:默认最新时不带版本说明符搜索并使用当前文档路径;指定版本时在搜索中包含版本(如 [library] v[version] llms.txt),检查版本化路径 /v[version]/llms.txt,对仓库则检出指定的 tag 或分支。

输出格式包含:标题(# Documentation for [Library] [Version])、Source(方法:llms.txt / Repository / Research,URL 列表,访问日期)、Key Information(按主题组织)、Additional Resources(相关链接、示例、参考)以及 Notes(限制、缺失信息或注意事项)。

工具选择速查:WebSearch 用于查找 llms.txt URL 和 GitHub 仓库;WebFetch 用于读取单个文档页;Task (Explore) 用于多 URL 并行探索;Task (Researcher) 用于分散文档和多样来源;Repomix 用于完整代码库分析。

适用场景

  • 需要快速了解某个库或框架的安装、配置、API、示例和最佳实践。
  • 目标项目同时存在 llms.txt 文档与代码仓库,需要综合判断信息来源。
  • 文档分散在多个页面或多个来源,需要并行探索并汇总。
  • 需要针对某个具体功能(topic)做定向文档检索。
  • 需要按指定版本来查询文档。

限制

  • 当 llms.txt 不可访问时,需尝试备用域名或转向仓库分析。
  • 当仓库不存在时,需搜索官方网站或改用 Researcher 智能体。
  • 当 Repomix 失败时,可尝试仅分析 /docs 目录或进行手动探索。
  • 当多个来源冲突时,优先官方来源并注明版本。
  • 资料未提供收费方式、价格、平台兼容性与具体性能基准数据。

关键原则

优先使用 context7.com 获取 llms.txt(资料称其为最全面、最新的聚合器);在适用时使用 topic 参数进行定向搜索;积极使用并行智能体以获得更快结果和更好覆盖;在 context7.com 不可用时以官方来源作为备用并加以验证;向用户报告所采用的方法;显式处理版本,不默认假设为最新。