DocReader MCP Tool

DocReader MCP 工具

DocReader 是一款功能强大的文档阅读与搜索工具，基于 Model Context Protocol（MCP）构建。它使大模型能够搜索、提取和综合网页文档中的信息，帮助 AI 助手据此回答问题。

功能

• 在文档网站中搜索相关页面
• 提取特定页面的内容
• 汇总并总结检索到的信息
• 一步完成文档问答工作流

安装

要求

• Python 3.7 或更高版本
• fastmcp
• beautifulsoup4
• requests
• openai
• python-dotenv

安装步骤

1. 克隆或下载此仓库。

2. 安装所需依赖：

pip install fastmcp beautifulsoup4 requests openai python-dotenv

1. 创建 .env 文件并添加 API 密钥，建议使用 NetMind API 密钥：

API_KEY=your_api_key_here

使用方法

直接运行

cd path/to/DocReaderMCP
python DocReader.py

使用 fastmcp CLI 运行

cd path/to/DocReaderMCP
fastmcp run DocReader.py

在 Cursor 中使用

方法 1：临时添加

1. 在 Cursor 界面中，点击左侧边栏的扩展/插件图标。
2. 找到 MCP 区域或选择“添加工具”。
3. 选择“添加本地 MCP 工具”。
4. 输入工具名称，例如“DocReader”。
5. 选择执行方式（指向脚本路径或通过 URL 连接）。

方法 2：持久安装

cd path/to/DocReaderMCP
fastmcp install DocReader.py --name "DocReader" --with beautifulsoup4 requests openai python-dotenv

工具集

DocReader MCP 提供以下工具函数：

1. search_docs：搜索文档页面，查找与查询最相关的页面。
2. extract_content：从指定 URL 提取内容。
3. summarize_findings：总结收集到的信息。
4. read_doc：一步完成整个工作流——搜索、提取和总结。

推荐工作流

1. 首先使用 search_docs 在文档网站中查找相关页面。
2. 使用 extract_content 获取最相关页面的内容。
3. 使用 summarize_findings 总结检索结果。
4. 或者，使用 read_doc 一次性完成以上所有步骤。

示例

有关如何使用各工具函数的更多示例，请参阅 test_doc_reader.py。

简要示例：

from DocReader import search_docs, extract_content, summarize_findings, read_doc

doc_url = "https://flax.readthedocs.io/en/latest/index.html"
query = "How do I train a model with flax? Please help me write the training code and the inference code after training."

# 1. Search for relevant pages
results = search_docs(doc_url, query, depth=2, max_results=3)

# 2. Extract content
if results:
    page_content = extract_content(results[0]['url'], query)

# 3. Summarize findings
summary = summarize_findings(query)
print(summary['summary'])

# 4. One-step workflow
final_answer = read_doc(doc_url, query)
print(final_answer)