MCP Server for Node.js API Documentation

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 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 文件的绝对路径，或者确保客户端可访问的 PATH 环境变量中包含 node。

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

   • 查找 Node 路径： 在终端中运行 which node。
   • 查找项目路径： 进入项目目录并运行 pwd。

有关添加基于 stdio 的服务的具体步骤，请参阅相应 MCP 客户端的文档。

使用 Cursor 的示例：

1. 前往 Settings -> Cursor Settings -> MCP Servers。
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. 现在，你应该可以在聊天提示词中使用 @NodeJS API Documentation 标签（或你选择的其他名称）。

作者

Liran Tal