Curated Search

📚 权威技术文档,一搜即得

面向精选技术文档白名单的受限全文搜索,返回权威干净的结果,杜绝网络垃圾信息干扰。

收藏
3.7k
安装
1.4k
版本
1.0.3
CLS 安全扫描中
预计需要 3 分钟...

使用说明

核心用法

Curated Search Skill 是一套针对技术文档领域的受限搜索工具,仅索引预配置白名单内的权威源(如 MDN、Python 官方文档等)。开发者通过 curated-search.search 工具执行全文检索,支持关键词查询、域名过滤、相关性阈值控制及分页。

显著优点

1. 结果可信度高:严格限定在人工审核的权威技术文档域,天然排除 SEO 垃圾、论坛闲聊和低质博客。
2. 输出简洁专注:返回结构化 JSON,包含标题、规范 URL、摘要片段及 BM25 相关性分数,便于 Agent 直接消费。

3. 灵活过滤机制:支持 domain 限定特定文档站,min_score 剔除低相关结果,limitoffset 实现高效分页。

4. 可私有化部署:基于 YAML 配置与本地索引文件,可在隔离环境运行,敏感查询无需外流至公共搜索 API。

潜在缺点与局限性

  • 覆盖范围受限:白名单机制意味着未配置的文档源(如新兴框架官网、小众库文档)无法被检索。
  • 索引 freshness 依赖爬取crawled_at 字段提示结果可能滞后,需主动维护爬取计划以同步上游更新。
  • 配置门槛:首次使用需正确设置 config.yaml(域名白名单、爬取策略、索引路径),否则触发 config_missingindex_not_found 错误。
  • BM25 分数非归一化score 字段虽通常在 0–1 范围,但未强制归一化,跨查询比较需谨慎。

适合人群

  • 需要为编程 Agent 提供高置信度技术参考的开发者
  • 构建离线/隔离环境代码助手的企业或安全敏感团队
  • 希望替代通用搜索引擎、减少结果噪声的技术文档站点维护者

常规风险

  • 索引失效风险:磁盘索引文件可能损坏或过期,需定期重建(npm run crawl)。
  • 查询注入风险:虽为本地索引,仍建议对 query 参数长度进行校验(上限 1000 字符),避免异常输入触发解析异常。
  • 域名配置漂移:白名单域名若变更 DNS 或证书过期,爬取阶段可能静默失败,导致搜索结果逐渐枯竭。

Curated Search 内容

docs文件夹
scripts文件夹
src文件夹
手动下载zip · 98.7 kB
deployment.mdtext/markdown
请选择文件