arabold/docs-mcp-server

Grounded Docs MCP Server: Open-Source Alternative to Context7, Nia, and Ref.Tools

什么是 Docs MCP Server

Grounded Docs MCP Server 是一个开源工具,为任何您使用的代码库或框架构建可搜索的、版本特定的文档索引。它从官方站点、GitHub 仓库、npm / PyPI 包、本地文件夹或 ZIP 归档中获取最新文档,将其转换为纯文本/Markdown 格式,并(可选地)存储向量嵌入,以便语言模型能够检索所需的确切段落。该服务器在本地运行,提供一个简单的 MCP(消息流端点)API,AI 编码助手(如 Claude、Cline、Copilot、Gemini‑CLI 等)可以查询该 API。


为什么重要

  • 减少幻觉 – LLM 从真实、最新的文档中回答问题,而不是猜测。
  • 版本感知 – 您可以索引项目所依赖的特定库版本。
  • 私有且本地化 – 所有处理都在您的机器上进行;代码或文档不会离开您的网络。
  • 广泛格式支持 – PDF、Office 文件、Markdown、Jupyter 笔记本以及超过 90 种源代码语言均可自动解析。
  • 与现有 AI 工具即插即用 – 可与任何 MCP 兼容客户端(Claude、Cline、VS Code 扩展等)配合使用。

核心功能(如 README 所述)

功能 描述
CLI 优先工作流 scrapesearchfetch-url 命令允许脚本或代理索引文档、执行语义搜索并获取原始页面。
Web UI 可通过 http://localhost:6280 访问;可通过浏览器添加文档、查看索引并管理设置。
MCP 服务器 长期运行的 SSE 端点(/sse),AI 客户端可在其配置文件中指向该端点。
嵌入支持 可选的向量嵌入(OpenAI、Ollama、Gemini、Azure 等)可提高语义搜索质量。
Docker 镜像 官方容器(ghcr.io/arabold/docs-mcp-server:latest)用于隔离部署。
哈希路由 SPA 处理 --preserve-hashes 标志(或 UI 复选框)可告知爬虫保留 URL 片段,并在需要时回退到 Playwright 进行客户端渲染。
Markdown 优先爬取 发送 Accept: text/markdown 头部;如果网站可直接提供 Markdown,爬虫将跳过 HTML 到 Markdown 的转换。
广泛的格式列表 PDF、Word/Excel/PowerPoint、OpenDocument、RTF、EPUB、Jupyter 笔记本、归档文件、HTML、Markdown 变体、多种编程语言、配置文件、数据格式等。
认证与安全 文档提到支持 OAuth2/OIDC,并提供生产部署的加固指南。

快速入门指南(来自 README)

  1. 安装 / 运行 – 无需永久安装;使用 npx(Node 22+):
    npx @arabold/docs-mcp-server@latest          # 启动服务器和 UI
    
    或运行 Docker 容器:
    docker run --rm -v docs-mcp-data:/data -v docs-mcp-config:/config \
      -p 6280:6280 ghcr.io/arabold/docs-mcp-server:latest \
      --protocol http --host 0.0.0.0 --port 6280
    
  2. 索引文档源(CLI 示例):
    npx @arabold/docs-mcp-server@latest scrape react https://react.dev/reference/react
    
    对于基于哈希的 SPA 文档,请添加 --preserve-hashes
  3. 搜索索引
    npx @arabold/docs-mcp-server@latest search react "useEffect cleanup" --output yaml
    
  4. 连接 AI 客户端 – 将服务器添加到客户端的 MCP 配置中,例如 Claude 桌面端:
    {
      "mcpServers": {
        "docs-mcp-server": { "type": "sse", "url": "http://localhost:6280/sse" }
      }
    }
    
  5. (可选)启用嵌入 – 在启动服务器前设置 OPENAI_API_KEY(或其他提供方环境变量)以获得语义搜索功能。

哪些人可能使用它?

  • 开发者:构建需要可靠参考材料的 AI 辅助编码工具。
  • 团队:希望为内部库建立私有、版本锁定的知识库。
  • 研究人员:实验检索增强生成(RAG)管道。
  • 工具制作者:需要为 Claude、Cline、Copilot、Gemini‑CLI 等提供即插即用的 MCP 端点。

获取更多信息的途径

  • 安装与设置docs/setup/installation.md
  • 连接客户端docs/guides/mcp-clients.md
  • 嵌入模型配置docs/guides/embedding-models.md
  • 支持的格式列表docs/concepts/supported-formats.md
  • 架构概览ARCHITECTURE.md
  • 贡献指南CONTRIBUTING.md

许可证

MIT – 可自由使用、修改和重新分发。

相关

  • 项目
  • 项目
  • 项目
  • 项目
  • 项目