使用说明
- 项目简介
- Polar MCP 服务器桥接是 Polar 应用中用于实现 MCP(模型上下文协议)的后端桥接部分。它通过本地 HTTP 服务对外提供 MCP 的核心能力:获取工具定义、执行工具,以及健康检查等接口。实现方式基于 Electron 主进程与渲染进程的 IPC 通信机制,服务器端绑定在本地端口,通过 localhost 访问。
- 主要功能点
- 工具定义读取:提供 /health 与 /api/mcp/tools 接口,LLM 客户端可获取当前可用工具清单。
- 工具执行:提供 /api/mcp/execute 接口,客户端发送要执行的工具名称及参数,服务器通过 IPC 将执行请求转发给渲染进程工作的工具实现,返回执行结果。
- 健康检查:/health 端点用于探测服务器状态。
- 本地主机绑定:默认监听 37373 端口(可通过 POLAR_MCP_PORT 环境变量覆盖)。
- 安全性设计:仅允许来自本地主机的请求(origin 限制),并对跨域请求做了简单处理。
- 安装与运行步骤
- 安装依赖:在 Polar 项目根目录执行安装命令安装依赖(如 yarn install 或 npm install)。
- 启动应用:运行 Polar 的 Electron 应用。MCP 服务器作为主进程的一部分在应用启动时自动启动。
- 端口配置:默认端口为 37373,可通过设置环境变量 POLAR_MCP_PORT 来修改端口(如 POLAR_MCP_PORT=40000)。
- 测试端点:
- 健康检查:访问 http://localhost:37373/health,返回服务状态信息。
- 获取工具:访问 http://localhost:37373/api/mcp/tools,服务器将通过 IPC 获取当前可用工具列表并返回给客户端。
- 执行工具:向 http://localhost:37373/api/mcp/execute 发送包含 tool 与 args 的请求,服务器将通过 IPC 转发并把结果返回。
- 配置与对接(客户端侧不需要,下面给出服务器侧的配置信息示例说明):
- MCP 客户端需要知道服务器的启动信息以发起连接,通常通过一个配置对象来描述服务器名称、启动命令以及参数等。该部分信息将用于 MCP 客户端在需要时启动或连接服务器。下面给出配置示例的说明性描述(非可执行代码):
- 服务器名称(serverName):Polar MCP Bridge
- 启动命令(command):yarn start 或 npm start(启动 Polar 应用的 MCP Bridge 组件所依赖的命令,需在实际环境中以项目的启动方式执行)
- 启动参数(args):如需自定义端口,则包含 ["--port","37373"] 或环境变量设置,例如 POLAR_MCP_PORT=37373
- MCP 客户端需要知道服务器的启动信息以发起连接,通常通过一个配置对象来描述服务器名称、启动命令以及参数等。该部分信息将用于 MCP 客户端在需要时启动或连接服务器。下面给出配置示例的说明性描述(非可执行代码):
- 服务器配置(MCP 客户端的配置示例说明,便于理解但不直接给出客户端代码)
- serverName: "Polar MCP Bridge"
- command: "yarn start"(或 "npm start")
- args: ["--mcp-port=37373"](如需自定义端口时传入的参数说明;实操中请按实际项目启动脚本来传递)
- 备注:MCP 客户端通常仅需要知道服务器的名称与启动方式以便在需要时启动与连接;实际客户端配置通常以 JSON 形式提供 server、command、args 等字段,但此处仅为说明,不作为直接可执行代码。
- 基本使用方法
- 启动后,MCP 客户端向本地 MCP 服务器发送请求,读取工具定义、执行工具或获取健康信息。
- 工具执行结果会通过服务器返回给客户端;如需持续监听,请使用服务器提供的响应通道和 IPC 回传机制。
- 如遇端口冲突,请调整 POLAR_MCP_PORT 变量重新启动 Polar 应用,以使 MCP 服务绑定到新的端口。
信息
分类
AI与计算