Devdocs MCP

🚀 DevDocs-MCP：AI 智能体的文档权威来源

本项目可借助本地化、版本感知且权威的文档消除 AI 幻觉。

DevDocs-MCP 是一个遵循模型上下文协议（MCP）的服务器，它能为 AI 助手（如 Claude、RooCode、Cline、Copilot 等）提供源自 DevDocs.io 的版本固定、确定性的文档。它就像一个本地文档智能层，确保你的智能体始终拥有正确的 API 上下文，且不受网络延迟或训练数据漂移的影响。

该服务器遵循由 MCP 定义的 MCP 服务器标准，此标准正被整个生态系统中的 AI 工具和智能体采用，包括来自 Anthropic、OpenAI 和 Google 等供应商的工具和智能体。

⚠️ 项目状态通知 ⚠️ 本项目正在积极且大力地开发中。仍需对现有功能进行测试，并实现更多新功能，如优化缓存、自动更新最新文档（也支持按需更新）、优化查询等。设计决策、API 和结构预计会根据开发者社区的强烈意见、评审和反馈不断演变。热烈欢迎大家参与讨论、提出批评和贡献代码，以帮助本项目朝着正确的方向发展。

🚀 快速开始

1. 克隆并安装

git clone https://github.com/madhan-g-p/DevDocs-MCP.git
cd DevDocs-MCP
pnpm install

2. 配置环境

cp .env.example .env
# 编辑 .env 文件：将 DEVDOCS_DATA_PATH 设置为你想要存储文档的位置。

3. 构建并运行

pnpm build
pnpm start:prod

注意：开发和贡献时请严格使用 pnpm。

✨ 主要特性

• 离线优先：文档会缓存到本地，摄入后无需联网。
• 排名模糊搜索：可立即找到相关条目（如“intersection observer”）。
• 版本感知：自动映射到项目中特定库的版本。
• 纯 Node 架构：使用 sql.js，无需原生依赖（无需 Python/C++ 构建步骤）。
• 结构化输出：返回简洁、适合大语言模型的内容。

📦 安装指南

DevDocs-MCP 针对使用 pnpm 进行零麻烦设置进行了优化，是一个 仅支持 Node 的项目。

前提条件

• Node.js 18+（在 18.x 和 20.x 版本上进行过测试）。

🐳 Docker 使用方法

DevDocs-MCP 设计得轻量且持久。由于它会下载并缓存大量文档数据集，因此正确管理数据卷至关重要。

方法 A：Docker Compose（动态且持久）

这是推荐的方法。它通过 .env 文件中的 DEVDOCS_VOLUME_SOURCE 变量支持 3 种存储模式。

1. 在 .env 中配置你首选的存储方式：

# 模式 1：命名卷（默认 - 由 Docker 管理）
DEVDOCS_VOLUME_SOURCE=devdocs_data

# 模式 2：主机路径（Docker 外部 - 本地文件夹）
# DEVDOCS_VOLUME_SOURCE=./my-docs-storage

2. 启动服务器：

docker compose up -d

灵活性：每次启动容器时，只需更改 .env 文件中的 DEVDOCS_VOLUME_SOURCE，就可以指向一个 新卷（重新开始）或一个 现有卷（保留数据）。mcp.db（数据库库）和 data/（文档下载）都存储在这个卷中。

方法 B：Docker Run（手动）

如果你想直接从 Docker Hub 运行公共镜像：

docker run -d -p 3000:3000 \
  -v "devdocs_data:/app/data" \
  --name devdocs-mcp \
  madhandock1/devdocs-mcp:latest

💾 数据策略

该项目使用 /app/data 作为单一挂载点，其中包含：

• /app/data/mcp.db：SQLite 注册表。
• /app/data/docs/：缓存的文档文件。 这种统一的结构使得通过移动一个文件夹或卷就可以轻松备份或迁移整个文档源。

配置（.env）

摄入文档

服务器连接到智能体后，使用 ingest 工具为特定技术栈下载文档： 服务器启动并运行后，智能体将负责处理此操作，它会列出可用工具并相应地做出决策。

{
  "dependencies": {
    "react": "18.2.0",
    "typescript": "5.0.0"
  }
}

注意：摄入所需的 Devdocs 获取 URL 在 src/config/constants.ts 中定义。此 URL 当前指向正确且官方支持的路径。如果 devdocs 社区将来更改此路径，则可能需要相应地更新配置。
这种方法不涉及网页抓取。它遵循 DevDocs 用于提供 离线使用 文档的相同支持机制，类似于用户在 DevDocs 中下载文档的方式。

💻 使用示例

RooCode / Cline / Claude Desktop（推荐：STDIO）

将以下内容添加到 mcp_settings.json 中。通过设置 cwd（当前工作目录），服务器将自动从 .env 文件加载配置，从而可以使用相对路径进行数据存储。

{
  "mcpServers": {
    "devdocs": {
      "command": "node",
      "args": ["dist/main.js"],
      "cwd": "file://path/to/your/DevDocs-MCP"
    }
  }
}

专业提示：在 cwd 中使用项目的绝对路径。服务器将找到你的 .env 文件，并使用你在其中定义的 DEVDOCS_DATA_PATH 和 MCP_DB_PATH（例如 ./data 或 mcp.db），使设置具有可移植性！

远程 / Web 客户端（HTTP SSE）

如果你需要通过端口公开服务器（用于生产/远程设置）：

1. 使用端口标志启动服务器：

node dist/main.js --port 3000

2. 配置你的客户端：

• SSE URL：http://your-server:3000/mcp/sse
• 类型：SSE（大多数 MCP 客户端支持，至少我是这么认为的）

📚 详细文档

• ：深入了解数据流、架构和 sql.js 内部机制。
• ：工作流程、编码标准和拉取请求要求。
• ：MIT 许可证。

本项目灵感源自 devdocs-local 和 devdocs-local-demo，作者为 @Nathaniel Whiteinge。