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

安装

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 检查器测试

使用内建的 debug 脚本：

npm run debug

或直接通过 npx：

npx -y @modelcontextprotocol/inspector node index.js

连接到 MCP 客户端

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

示例配置（概念性）：

大多数客户端都有设置部分，您可以添加自定义的 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. 转到 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. 按照客户端的说明完成其余配置

作者信息

[作者姓名]
[联系方式]