Node.js API文档查询服务

用于Node.js API的MCP服务器文档

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

特性

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

安装

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）进行通信。要将其连接到像Cursor或Qodo AI这样的MCP客户端，您需要配置客户端以使用其命令启动服务器。

示例配置（概念性）：

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

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

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

   复制

   # Example - replace with your actual absolute paths
   /path/to/your/node /path/to/your/project/index.js
   

   • 查找节点路径： 跑 which node 在你的终端。
   • 查找项目路径： 导航到项目目录并运行 pwd.

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

使用游标的示例：

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 聊天提示中的标签（或您选择的任何名称）。

作者

利兰·塔尔