工程开发
doc-reader avatar

doc-reader

通过 llms.txt、MCP 搜索与智能解析策略,有效率地读取并导航外部技术文档。

简介

doc-reader 技能为阅读技术文档提供了一个结构化的框架,能避免过度消耗内容窗口空间。该技能专为开发人员与技术写作人员设计,能精确地从 API、SDK、程序库与第三方服务中检索信息。通过优先使用模型内容协议 (MCP) 进行语义搜索,并利用如 llms.txt 等 AI 友好资源,该技能可在最大限度提升对复杂技术需求理解的同时,降低 Token 的浪费。

  • 利用 MCP 搜索工具,对文档网站执行语义查找,以获取精确的函数、端点或配置详情。

  • 支持识别与解析 llms.txt 和 llms-full.txt 文件,以读取结构化的摘要或完整的站点内容。

  • 实作智能抓取策略,包括优先使用 Markdown URL 变体以进行更清晰的解析,并在无法进行语义索引时使用基于 grep 的局部搜索。

  • 在内容注入前评估内容长度,提供安全防护机制,以防止过度的内容消耗或检索到截断的信息。

  • 当需要宏观概览或交互式 UI 组件时,通过导航至相关 HTML 页面来协助探索文档网站。

  • 每当您需要整合新程序库、调试陌生的错误代码,或根据官方文档验证实现需求时,请调用此技能。

  • 请务必检查文档根端点是否存在现有的 MCP 服务器,以建立更高效、具备上下文感知能力的服务通信。

  • 当遇到长篇文档时,建议采取针对性搜索或分段加载,而非全量读取,以维持内容效率。

  • 输入通常包含文档 URL 或特定的搜索查询;输出则提供技术摘要、代码参照以及指向所需信息的直接路径。

  • 约束条件:可靠性取决于目标网站是否提供 AI 原生资源 (llms.txt/MCP);虽然支持回退至 HTML 爬取,但对于超大型文档可能容易产生噪声或遭截断。

仓库统计

Star 数
384
Fork 数
231
Open Issue 数
93
主要语言
MDX
默认分支
main
同步状态
空闲
最近同步时间
2026年5月3日 04:49
在 GitHub 查看