MCP Server for Node.js API 文档

该项目实现了一个模型上下文协议（MCP）服务器，提供对官方Node.js API文档的访问。该服务器从nodejs.org获取文档并通过MCP工具公开。

特性

• 获取最新的Node.js API文档。
• 提供MCP工具来查询特定模块、类或方法的文档。
• 提供一个搜索工具（node-search），用于查找模块或列出所有可用模块及其方法。
• 提供一个列表工具（node-list），用于获取所有可用模块的概要。
• 使用pino将活动和错误记录到/tmp/mcp-server-nodejs-docs.log。

安装

1. 克隆仓库（如果适用）：

   git clone <repository_url>
   cd <repository_directory>
   

2. 安装依赖项： 本项目需要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 Inspector进行测试

使用内置的debug脚本：

npm run debug

或者直接通过npx：

npx -y @modelcontextprotocol/inspector node index.js

连接到MCP客户端

此服务器通过标准输入/输出（stdio）通信。要将其连接到像Cursor或Qodo AI这样的MCP客户端，您需要配置客户端以使用其命令启动服务器。

示例配置（概念性）：

大多数客户端都有一个设置区域，您可以在其中添加自定义MCP服务器。通常需要提供：

1. 名称： 例如，“Node.js API文档”

2. 命令： 执行服务器的命令。确保提供node和index.js文件的绝对路径，或者确保node在客户端可访问的PATH环境变量中。

   # 示例 - 替换为您实际的绝对路径
   /path/to/your/node /path/to/your/project/index.js
   

   • 找到Node路径： 在您的终端中运行which node。
   • 找到项目路径： 导航到项目目录并运行pwd。

请参阅您特定的MCP客户端文档，了解添加基于stdio的服务器的确切步骤。

使用Cursor的示例：

1. 前往设置 -> Cursor设置 -> MCP服务器。
2. 点击添加服务器。
3. 输入名称（例如，“NodeJS API文档”）。
4. 在命令字段中输入完整的命令，如：/Users/youruser/.nvm/versions/node/v22.11.1/bin/node /Users/youruser/projects/mcp-server-nodejs-docs/index.js（替换路径为您实际的路径）。
5. 保存服务器配置。
6. 您现在应该能够在聊天提示中使用@NodeJS API文档标签（或您选择的任何名称）。

作者

Liran Tal