MCP Server Nodejs Docs

🚀 Node.js API 文檔 MCP 服務器文檔

本項目實現了一個 Model Context Protocol (MCP) 服務器，能夠讓用戶通過 MCP 工具訪問官方 Node.js API 文檔。服務器會從 nodejs.org 抓取最新文檔，並將其通過 MCP 工具公開，為開發者提供便捷的文檔查詢服務。

✨ 主要特性

• 抓取最新的 Node.js API 文檔，確保用戶獲取到的信息始終是最新的。
• 提供 MCP 工具，方便用戶查詢特定模塊、類或方法的文檔。
• 提供搜索工具 (node-search)，可用於查找模塊或列出所有可用模塊及其方法。
• 提供列表工具 (node-list)，幫助用戶獲取所有可用模塊的概要。
• 使用 pino 將活動和錯誤記錄到 /tmp/mcp-server-nodejs-docs.log，便於後續的調試和問題排查。

📦 安裝指南

克隆倉庫（如果需要）

git clone <repository_url>
cd <repository_directory>

安裝依賴項

該項目依賴 Node.js 和 npm，請確保已安裝。

npm install

💻 使用示例

啟動 MCP 服務器

在終端中運行以下命令啟動服務器：

npm run start

服務器啟動後，會進行初始化操作，抓取文檔，創建必要的工具，然後通過標準輸入輸出（stdio）偵聽連接。

啟用調試日誌記錄

若需要啟用調試日誌記錄，可使用 --debug 標誌啟動服務器：

node index.js --debug

🔧 技術細節

調試信息記錄

服務器會將詳細的操作信息，包括抓取、工具執行和錯誤等，記錄到以下文件：

/tmp/mcp-server-nodejs-docs.log

您可以使用以下命令監視此文件以調試問題：

tail -f /tmp/mcp-server-nodejs-docs.log

使用 MCP 檢查器測試

您可以使用內建的 debug 腳本進行測試：

npm run debug

或者直接通過 npx 進行測試：

npx -y @modelcontextprotocol/inspector node index.js

連接到 MCP 客戶端

此服務器通過標準輸入輸出（stdio）進行通信。若要將其連接到 MCP 客戶端（如 Cursor 或 Qodo AI），需要配置客戶端使用其命令啟動服務器。

示例配置（概念性）

大多數客戶端都有設置部分，您可以添加自定義的 MCP 服務器。通常需要提供以下信息：

查找 Node 路徑：在終端中運行 which node。 查找項目路徑：導航到項目目錄並運行 pwd。

使用 Cursor 的示例

1. 轉到 Settings -> Cursor Settings -> MCP 服務器。
2. 點擊 Add Server。
3. 輸入一個名稱（例如，“NodeJS API 文檔”）。
4. 在 Command 字段中輸入完整的命令，例如：/Users/youruser/.nvm/versions/node/v20.11.1/bin/node /Users/youruser/projects/mcp-server-nodejs-docs/index.js（替換為您的實際路徑）。
5. 保存設置。
6. 按照客戶端的說明完成其餘配置。

📄 許可證

文檔中未提及許可證相關信息，若有需要請聯繫作者獲取。

👨‍💻 作者信息

• 作者姓名：[作者姓名]
• 聯繫方式：[聯繫方式]