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。