JinDaGe - docsscrapermcp MCP Details

article

README

🚀 DocsScraper MCP 服务器

DocsScraper MCP 服务器可连接到 DocsScraper 网络 API，通过文档片段提供语义搜索功能。

✨ 主要特性

语义搜索：利用嵌入向量和人工智能验证技术，对文档片段进行搜索。
API 集成：通过 REST API 连接到你的 DocsScraper 网络应用程序。
备用源：当本地没有搜索结果时，自动回退到抓取源。
可配置结果：控制搜索结果的数量（范围为 1 - 10，默认值为 5）。
服务过滤：按特定服务名称过滤搜索结果（不区分大小写）。

📦 安装指南

npm install
npm run build

💻 使用示例

基础用法

在 mcp.json 中进行配置：

{
  "mcpServers": {
    "docs-scraper": {
      "command": "node",
      "args": [
        "/Users/tanevanwifferen/Documents/Cline/MCP/docs-scraper-server/build/index.js"
      ],
      "env": {
        "DOCS_SCRAPER_API_KEY": "###",
        "DOCS_SCRAPER_BASE_URL": "https://api.mcpdocsscraper.click"
      },
      "disabled": false,
      "alwaysAllow": [
        "search_docs"
      ],
      "timeout": 900 // 重要，我们需要足够的时间来处理请求
    }
}

高级用法

使用 search_docs 工具进行语义搜索：

{
  "query": "how to configure authentication",
  "service": "Binance",
  "top": 3
}

{
  "query": "React hooks documentation",
  "top": 5,
  "service": "React"
}

📚 详细文档

工具

search_docs

通过语义搜索在文档片段中进行查找。

参数：

query（字符串，必需）：用于查找相关文档的搜索查询。
top（数字，可选）：返回结果的最大数量（范围为 1 - 10，默认值为 5）。
service（字符串，必需）：用于过滤结果的服务名称（不区分大小写）。

资源

docs-scraper://api/info

提供有关已连接的 DocsScraper API 的信息，包括：

基础 URL 配置
API 密钥状态
端点详情
认证方法

API 集成

此服务器连接到 DocsScraper 网络 API 端点：

端点：GET /api/chunks/search
认证：通过 X-API-Key 头部使用 API 密钥进行认证。
参数：query（字符串）、top（数字）、service（字符串，可选）

搜索端点的工作流程：

使用嵌入向量查找语义相似的片段。
应用人工智能验证以确保相关性。
如果本地没有搜索结果，则回退到抓取源。
返回带有分数和源信息的片段。

使用说明

该服务器旨在与 MCP 兼容的客户端一起使用。请配置你的客户端，设置适当的环境变量以连接到该服务器。

错误处理

服务器针对常见问题提供详细的错误消息：

认证失败（401）
无效请求（400）
连接问题（ECONNREFUSED）

开发

# 构建服务器
npm run build

# 在开发过程中监听文件变化
npm run watch

# 使用 MCP 检查器进行测试
npm run inspector

docsscrapermcp