基于真实文档：您的 AI 最新文档专家

Docs MCP Server 通过为您的 AI 编码助手提供一个个人化、始终最新的文档索引，解决了 AI 幻觉和知识过时的问题。它可以从网站、GitHub、npm、PyPI 以及本地文件中抓取官方文档，使您的 AI 能够查询您正在使用的精确版本。

✨ 为什么选择 Grounded Docs MCP Server？

它是 Context7、Nia 和 Ref.Tools 的开源替代方案。

• ✅ 最新上下文： 按需直接从官方来源获取文档。
• 🎯 版本特定： 查询针对您项目中的确切库版本。
• 💡 减少幻觉： 将 LLM 置于真实的文档基础上。
• 🔒 私密且本地： 完全在您的机器上运行；您的代码永远不会离开您的网络。
• 🧩 广泛兼容： 可与任何兼容 MCP 的客户端（Claude、Cline 等）配合使用。
• 📁 多源支持： 可索引网站、GitHub 仓库、本地文件夹和 ZIP 压缩包。
• 📄 丰富的文件支持： 支持处理 HTML、Markdown、PDF、Office 文档（Word、Excel、PowerPoint）、OpenDocument、RTF、EPUB、Jupyter Notebooks，以及 90 多种源代码语言。

📄 支持的格式

完整参考请参阅 支持的格式，其中包含 MIME 类型和处理细节。

🚀 快速入门

CLI 首选

对于代理和脚本来说，CLI 通常是使用 Grounded Docs 的最简单方式。

1. 索引文档（需要 Node.js 22+）：

npx @arabold/docs-mcp-server@latest scrape react https://react.dev/reference/react

2. 查询索引：

npx @arabold/docs-mcp-server@latest search react "useEffect cleanup" --output yaml

3. 以 Markdown 格式获取单个页面：

npx @arabold/docs-mcp-server@latest fetch-url https://react.dev/reference/react/useEffect

输出行为

• 结构化命令在非交互式运行中默认输出干净的 JSON 到 stdout。
• 使用 --output json|yaml|toon 来选择结构化的格式。
• 纯文本命令（如 fetch-url）会将文本内容直接输出到 stdout。
• 诊断信息会通过共享的日志记录器输出，在非交互式运行中不会显示在 stdout 上。
• 使用 --quiet 来抑制非错误类的诊断信息，或使用 --verbose 来启用调试输出。

代理技能

skills/ 目录中包含了 Agent Skills，这些技能可以教会 AI 编码助手如何使用 CLI——涵盖文档搜索、索引管理和 URL 获取等功能。

MCP 服务器

如果您希望为 Claude、Cline、Copilot、Gemini CLI 或其他 MCP 客户端提供一个长期运行的 MCP 端点：

1. 启动服务器：

npx @arabold/docs-mcp-server@latest

2. 打开 Web UI，地址是 http://localhost:6280，以添加文档。

3. 连接您的 AI 客户端，只需在您的 MCP 设置中添加以下内容（例如 claude_desktop_config.json）：

{
  "mcpServers": {
    "docs-mcp-server": {
      "type": "sse",
      "url": "http://localhost:6280/sse"
    }
  }
}

有关 VS Code（Cline、Roo）和其他设置选项，请参阅 连接客户端。

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

🧠 配置嵌入模型（推荐）

使用嵌入模型是 可选 的，但它可以通过启用语义向量搜索来显著提升搜索质量。

示例：启用 OpenAI 嵌入

OPENAI_API_KEY="sk-proj-..." npx @arabold/docs-mcp-server@latest

有关配置 Ollama、Gemini、Azure 等嵌入模型的信息，请参阅 嵌入模型。

📚 文档

入门指南

• 安装：详细的 Docker、Node.js (npx) 和嵌入模式设置指南。
• 连接客户端：如何连接 Claude、VS Code（Cline/Roo）以及其他 MCP 客户端。
• 基本用法：使用 Web UI、CLI 以及抓取本地文件。
• 配置：配置文件和环境变量的完整参考。
• 支持的格式：完整的文件格式和 MIME 类型参考。
• 嵌入模型：配置 OpenAI、Ollama、Gemini 等提供商。

核心概念与架构

• 部署模式：独立部署与分布式部署（Docker Compose）。
• 身份验证：使用 OAuth2/OIDC 保护您的服务器。
• 遥测：注重隐私的使用数据收集。
• 架构：深入探讨系统设计。

🤝 贡献

我们欢迎贡献！请参阅 CONTRIBUTING.md，了解开发指南和设置说明。

许可证

本项目采用 MIT 许可证。详情请参阅 LICENSE。

docs-mcp-server 快速上手指南

docs-mcp-server 是一个开源的 MCP（Model Context Protocol）服务器，旨在解决 AI 助手因知识过时或产生幻觉而导致的代码错误。它能实时抓取官方文档、GitHub 仓库、本地文件等来源，为你的 AI 编程助手提供精确到特定版本的最新上下文。

环境准备

在开始之前，请确保你的开发环境满足以下要求：

• 操作系统：Windows, macOS, 或 Linux
• Node.js：版本 22+ (必须)
  • 检查版本：node -v
  • 如未安装或版本过低，请访问 Node.js 官网 下载最新版。
• 网络环境：需要能够访问 npm registry 及目标文档网站（如 react.dev, github.com 等）。
  • 提示：如果在国内访问 npm 较慢，可临时配置淘宝镜像源：

  npm config set registry https://registry.npmmirror.com
  

安装步骤

本项目无需全局安装，推荐使用 npx 直接运行最新稳定版，确保始终获取最新功能。

方式一：直接使用 CLI (推荐用于脚本或一次性任务)

无需额外安装步骤，直接在终端运行以下命令即可调用：

npx @arabold/docs-mcp-server@latest --help

方式二：作为 MCP 服务器长期运行 (推荐用于 IDE 集成)

若需让 Claude Desktop、Cline (VS Code) 等客户端持续连接，可直接启动服务：

npx @arabold/docs-mcp-server@latest

启动后，服务将默认运行在 http://localhost:6280。

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

基本使用

1. 命令行快速体验 (CLI Mode)

你可以立即通过三条核心命令体验文档索引、搜索和抓取功能。

第一步：建立文档索引 将指定网站的文档抓取并建立索引（以 React 文档为例）：

npx @arabold/docs-mcp-server@latest scrape react https://react.dev/reference/react

第二步：搜索文档内容 在已建立的索引中搜索特定关键词（支持语义搜索）：

npx @arabold/docs-mcp-server@latest search react "useEffect cleanup" --output yaml

注：使用 --output json 或 --output yaml 可获得结构化数据，便于程序处理。

第三步：抓取单页内容 直接将某个 URL 转换为 Markdown 格式输出：

npx @arabold/docs-mcp-server@latest fetch-url https://react.dev/reference/react/useEffect

2. 集成到 AI 助手 (MCP Mode)

要让 Cursor、Claude Desktop 或 VS Code (Cline/Roo) 自动使用该工具：

1. 启动服务器： 在终端运行：

   npx @arabold/docs-mcp-server@latest
   

2. 配置客户端： 打开你的 AI 客户端配置文件（例如 Claude Desktop 的 claude_desktop_config.json），添加以下配置：

   {
     "mcpServers": {
       "docs-mcp-server": {
         "type": "sse",
         "url": "http://localhost:6280/sse"
       }
     }
   }
   

3. 管理文档： 浏览器访问 http://localhost:6280，在 Web 界面中添加你需要关注的文档源（支持 GitHub 仓库、本地文件夹、ZIP 包、各类办公文档及 90+ 种编程语言源码）。

💡 进阶提示：提升搜索质量

虽然可选，但强烈建议配置嵌入模型（Embedding Model）以启用语义向量搜索，大幅提升检索准确度。

示例：使用 OpenAI Embeddings 在启动命令前设置环境变量：

OPENAI_API_KEY="sk-proj-..." npx @arabold/docs-mcp-server@latest

支持配置 Ollama (本地运行)、Gemini、Azure 等多种模型提供商。