🚀 Node.js API 文档 MCP 服务器文档
本项目实现了一个 Model Context Protocol (MCP) 服务器，可提供对官方 Node.js API 文档的访问。它会从 nodejs.org 抓取文档，并通过 MCP 工具将其公开，方便开发者查询使用。
✨ 主要特性
- 抓取最新的 Node.js API 文档，确保信息的时效性。
- 提供 MCP 工具，可查询特定模块、类或方法的文档。
- 提供搜索工具 (
node-search)，用于查找模块或列出所有可用模块及其方法。 - 提供列表工具 (
node-list)，可获取所有可用模块的概要。 - 使用
pino将活动和错误记录到/tmp/mcp-server-nodejs-docs.log，便于后续排查问题。
📦 安装指南
克隆仓库（如果需要）
git clone
cd
安装依赖项
该项目要求 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.js API 文档”
- 命令：执行服务器的命令。请确保提供
node的绝对路径和index.js文件的路径，或者确保node在客户端可访问的 PATH 环境变量中。
# 示例 - 用您的实际路径替换
/path/to/your/node /path/to/your/project/index.js
- 查找 Node 路径：在终端中运行
which node。 - 查找项目路径：导航到项目目录并运行
pwd。
请参阅特定的 MCP 客户端文档以获取添加基于 stdio 的服务器的确切步骤。
使用 Cursor 的示例
- 转到
Settings->Cursor Settings->MCP 服务器。 - 点击
Add Server。 - 输入一个名称（例如，“NodeJS API 文档”）。
- 在
Command字段中输入完整的命令，例如：/Users/youruser/.nvm/versions/node/v20.11.1/bin/node /Users/youruser/projects/mcp-server-nodejs-docs/index.js（替换为您的实际路径）。 - 保存设置。
- 按照客户端的说明完成其余配置。
📄 许可证
文档中未提及许可证相关信息。
👨💻 作者信息
[作者姓名]
[联系方式]