MCP Server for Node.js API Documentation

基本能力

产品定位

该MCP服务器主要用于提供Node.js API文档的访问和查询服务，旨在帮助开发者更高效地查找和使用Node.js的API文档。

核心功能

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

适用场景

• 开发者在编写Node.js代码时需要快速查找API文档。
• 团队协作中需要统一访问和查询Node.js API文档。
• 开发者需要自动化工具来辅助查询和搜索Node.js API文档。

工具列表

• node-search：用于查找模块或列出所有可用模块及其方法。
• node-list：用于获取所有可用模块的摘要。

常见问题解答

• 如何调试服务器？ 服务器日志记录在/tmp/mcp-server-nodejs-docs.log，可以使用tail -f /tmp/mcp-server-nodejs-docs.log命令实时查看日志。
• 如何测试服务器？ 可以使用内置的debug脚本或通过npx -y @modelcontextprotocol/inspector node index.js命令进行测试。

使用教程

使用依赖

1. 安装Node.js和npm：确保系统中已安装Node.js和npm。

安装教程

1. 克隆仓库（如果适用）： bash git clone <repository_url> cd <repository_directory>
2. 安装依赖： bash npm install

启动服务器

运行以下命令启动MCP服务器：

npm run start

调试方式

1. 启用调试日志： bash node index.js --debug
2. 查看日志： bash tail -f /tmp/mcp-server-nodejs-docs.log
3. 测试服务器： bash npm run debug 或 bash npx -y @modelcontextprotocol/inspector node index.js

连接MCP客户端

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

示例配置（概念性）：

1. 名称：例如“Node.js API Documentation”。
2. 命令：执行服务器的命令。确保提供node和index.js文件的绝对路径，或确保node在客户端的PATH环境变量中可访问。 bash /path/to/your/node /path/to/your/project/index.js

使用Cursor的示例：

1. 转到Settings -> Cursor Settings -> MCP Servers。
2. 点击Add Server。
3. 输入名称（例如“NodeJS API Documentation”）。
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标签（或您选择的名称）。

许可证

该项目遵循 Other 开源许可条款，请参阅 Other 了解完整条款。