Node Omnibus MCP 服务器使用说明

项目简介

Node Omnibus MCP 服务器是一个基于 Model Context Protocol (MCP) 构建的应用后端，旨在为 Node.js 开发提供全面的工具和自动化能力。它通过标准化的 MCP 协议与客户端通信，提供项目创建、组件生成、配置管理、文档生成和 AI 辅助等功能，帮助开发者提升 Node.js 项目的开发效率。

主要功能点

项目管理: 支持创建 React, Next.js, Express, Fastify 和纯 Node.js 项目，自动配置 TypeScript 和包管理。
组件生成: 快速生成 React 组件（函数式或类式），自动生成 TypeScript 接口、Prop 类型定义和组件文档。
配置管理: 管理 TypeScript 配置、NPM 脚本、更新 package.json 和环境配置。
文档生成: 自动生成项目 README、API 文档和组件文档。
AI 辅助: 提供项目创建指导、代码分析和改进建议、组件生成辅助、Git 提交信息建议和错误调试帮助。

安装步骤

克隆仓库到本地：

git clone https://github.com/bsmi021/mcp-node-omnibus-server.git
cd mcp-node-omnibus-server

安装项目依赖：
```
npm install
```
构建项目 (可选，如果需要运行编译后的代码)：
```
npm run build
```

服务器配置

要将 Node Omnibus MCP 服务器集成到 MCP 客户端（例如 VSCode），您需要配置客户端以连接到该服务器。以下是 VSCode 'settings.json' 的配置示例，其他 MCP 客户端的配置方式类似，请参考各自客户端的文档：

{
  "mcpServers": {
    "node-omnibus": {
      "command": "node",
      "args": ["/path/to/node-omnibus-server/dist/index.js"] // 将 "/path/to/node-omnibus-server" 替换为你的本地仓库路径
    }
  }
}

配置参数说明:

'"node-omnibus"': 服务器名称，可以自定义，用于在客户端中标识和引用该服务器。
'"command": "node"': 启动服务器的命令，这里使用 Node.js 运行时环境来执行 JavaScript 文件。
'"args": [...]"': 传递给启动命令的参数数组。
- '"/path/to/node-omnibus-server/dist/index.js"': 请务必替换为 'node-omnibus-server' 仓库 'dist/index.js' 文件的绝对路径。这是编译后的服务器入口文件。如果未执行 'npm run build'，也可以指向 'src/index.ts' 文件，但需要确保客户端环境支持直接运行 TypeScript 文件或已配置了 ts-node 等工具。

配置完成后，MCP 客户端应该能够检测到并连接到 Node Omnibus MCP 服务器，从而可以使用服务器提供的工具和 Prompt。

基本使用方法

启动服务器: 在仓库根目录下运行 'npm start' 命令启动服务器。服务器将通过 stdio 协议与客户端通信。
客户端连接: 配置并启动 MCP 客户端（例如 VSCode），客户端会自动连接到运行中的 Node Omnibus MCP 服务器。
使用工具和 Prompt: 在 MCP 客户端中，您可以调用服务器提供的工具 (Tools) 来执行各种 Node.js 开发任务，例如创建项目、生成组件等。您也可以使用 Prompt (提示) 功能，向 AI 助手请求项目创建指导、代码分析等帮助。
- 可用的工具 (Tools) 包括: 'create_project', 'install_packages', 'generate_component', 'create_type_definition', 'add_script', 'update_tsconfig', 'create_documentation'。
- 可用的 Prompt (提示) 包括: 'create-project', 'analyze-code', 'generate-component', 'git-commit', 'debug-error'。
- 工具和 Prompt 的详细参数和使用方法请参考仓库 README.md 文件中的 "Available Tools" 和 "Available Prompts" 部分。

关键词