SuperAPI AI 工具集

docs-search

编程与开发

查看项目

更新于 10-15 20:09

技能介绍

用途:在企业内部库文档中检索 API、用法与约束,适用于写代码或回答问题前需要内部库事实、用户要求检索内部库文档,或在宿主项目入口指令中写入内部库检索指引的场景。一个技能覆盖全部已收录库,动态发现,不为每个库单独建技能。

主要能力:脚本 scripts/query.mjs(Node ≥ 24,零依赖)提供四类命令——libraries 列出已收录库的 slug 与文档数;search 跨库全文检索(最多 20 条,--limit 可调 1~50,按相关度降序,结果含 library/path/title/description/snippet/sections);get 取全文或 --section 取单个 ## 章节切片;toc 只取元数据与章节列表。

使用方式:命令均在用户仓库根目录(.pe.jsonc 所在处)执行,脚本路径写成绝对路径,不 cd 进技能目录。首次需读仓库根目录 .pe.jsonc 确认含 docs_server_url;缺失时向用户询问文档服务地址(形如 http://docs.internal:8080),不编造猜测,写入 .pe.jsonc 并提交入 git。含空格参数须加引号。检索写法:标识符按源码原样,中文用 2~6 字实体词,可用组件名加场景词组合;搜不到时依次减词、换同义词、换英文标识符、用 libraries 核对或 toc 浏览结构。stdout 为服务端 JSON,直接读取,不向用户展示原始 JSON。

适用场景与限制:适合已部署内部文档服务并通过 slug 收录的企业团队。依赖 .pe.jsonc 配置与服务连通性,请求超时 10 秒;配置缺失、地址格式错误、服务不通、库或路径不存在、章节名不一致等均会导致非零退出,需按提示核对而非盲目重试。宿主项目需在 AGENTS.md / CLAUDE.md 等入口指令写明内部库与 slug,AI 才会主动检索;本技能不引导安装或配置其它技能。未检索就凭训练数据实现内部库调用、为单库新建检索技能、硬编码地址等均为反模式。