使用说明

以下内容帮助你快速理解、安装与运行 MCPxHub，以及如何在本地环境中通过 MCP 客户端与 IDE 进行交互。

• 项目简介

  • MCPxHub 是一个本地 MCP 服务器桥接，遵循 Model Context Protocol (MCP) 2.0 规范，通过本地 IPC 方式将 MCP 客户端（如 Claude Desktop）与本地 IDE（如 VS Code、JetBrains 系列等）连接起来。
  • 主要职责包括：向 MCP 客户端提供工具调用、资源读取等能力的入口，转发工具请求到已安装的 IDE 插件实现、以及对端点的发现与重连进行管理。

• 主要功能点

  • MCP 2.0 兼容：实现对 List Tools、Call Tool 等常用 MCP 请求的处理，并返回符合 MCP 2.0 规范的响应格式。
  • 远程调用转发：将工具调用请求转发给本地 IDE 插件，获得执行结果后再回传给 MCP 客户端。
  • 端点发现与缓存：自动扫描本地 IDE 的可能端口，支持缓存上一次成功的端点以提升稳定性。
  • 自动重连与健康检查：在 IDE 重启或网络状态变化时进行自动重连和状态回填，提升鲁棒性。
  • 纯本地传输（Stdio）：当前默认通过标准输入输出（stdio）方式与 MCP 客户端通信，避免将数据暴露到网络。

• 安装步骤

  • 全局安装 MCPxHub
    • npm install -g @bugstan/mcpxhub
  • 安装对应的 IDE 插件（需在 IDE 中安装）
    • VS Code 插件：ggMCP4VSCode
    • JetBrains 插件：MCP Server Plugin
  • 启动 MCPxHub（在命令行中执行安装完成后的启动命令，具体如 README 所示）
  • 配置 Claude Desktop（或其他 MCP 客户端）以连接 MCPxHub，示例配置会包含服务器名称、启动命令及参数等信息

• 服务器配置（MCP 客户端所需，不需要改动服务器端代码）

  • 服务器名称（serverName）: MCPxHub
  • 启动命令（command）: npx
  • 启动参数（args）: ["-y", "@bugstan/mcpxhub"]
  • 环境变量（env）: { "IDE_TYPE": "vscode" } // 也可改为 "jetbrains"
  • 备注：该配置用于 MCP 客户端启动 MCPxHub 服务，确保 IDE 与 MCP 客户端能够建立通信通道

• 基本使用方法

  • 第一步：在 IDE 启动并安装相应的 MCP 服务端插件（VS Code 的 ggMCP4VSCode，JetBrains 的 MCP Server Plugin）。
  • 第二步：在 Claude Desktop（或其他 MCP 客户端）中配置 MCPxHub 作为 MCP 服务器，通过给定的启动命令与参数启动服务器实例。
  • 第三步：在 MCP 客户端中通过 MCPxHub 提供的接口访问工具、资源以及提示模板，IDE 将作为后端执行工具调用并返回结果。
  • 第四步：如遇 IDE 未启动或网络问题，MCPxHub 会自动扫描并重试，确保在 IDE 就绪后可以正常工作。