使用说明（Markdown 格式）

• 项目简介 Sub Bridge 是一个基于 MCP 的后端服务，旨在为大语言模型客户端（如 Cursor、ChatGPT、Claude 等）提供结构化的上下文信息、资源访问、工具执行以及可定制的提示模板。它支持通过 JSON-RPC 的方式与客户端进行请求/响应交互，并具备对外部 API 的代理能力。

• 主要功能点

  • MCP 服务端核心：实现 MCP 的服务器端能力，能够注册、暴露和执行资源、工具、以及 Prompts，供 LLM 客户端通过标准化接口调用。
  • Proxied 外部 API：内置对 OpenAI、Claude 等 API 的代理能力，允许以统一的 MCP 服务侧来管理外部模型调用。
  • OAuth 与 DCR：包含 OpenID/OAuth 相关端点、动态客户端注册等能力，用于对接外部账户。
  • 会话与授权：实现会话管理、授权码流程、PKCE、令牌交换等，提供安全的认证与授权机制。
  • 灵活的路由与传输：支持多种传输方式（如 基于 HTTP 的 API 以及数据流式传输）以及健康检查、日志输出等运维特性。
  • Tunnel 与部署辅助：提供本地隧道管理能力，方便在本地开发或部署后与客户端建立稳定的连接。

• 安装步骤

  1. 将仓库源码克隆到本地或服务器上。
  2. 安装运行依赖（如 Node.js 运行环境、ts-node/tsx 运行时等）。
  3. 启动 HTTP 服务器与 MCP 服务：
     • 开发模式：单独运行开发版本入口，http 服务器通过 src/server.ts 启动，MCP 代理通过 src/mcp.ts 启动。
     • 生产模式：MCP 代理会在本地发现端口并内联启动服务器，或连接到已存在的服务器。
  4. 在 Cursor 等 MCP 客户端中进行配置，指向 Sub Bridge 的 MCP 服务器地址。

• 服务器配置（MCP 客户端可用的启动信息，JSON 格式，服务器名称、启动命令及参数等） { "server_name": "sub-bridge", "command": "tsx", "args": ["watch", "src/server.ts"], "notes": "开发模式下启动 HTTP 服务器入口。MCP 代理（src/mcp.ts）可作为独立进程或与服务器同进程启动，并通过标准输入输出（stdio）与 MCP 客户端通信。" }

• 基本使用方法

  • 启动后，Sub Bridge 将暴露 MCP 服务与 HTTP API，客户端可通过 /mcp/tools 调用工具、通过 REST/JSON-RPC 请求获取资源、执行工具、及渲染 Prompt。
  • 使用 OpenAI/Claude 等 API 时，可在 MCP 配置中通过 Tokens、路由映射以及账户信息进行模型路由与鉴权。
  • 通过游览 /health、/api/config 等端点可检查服务运行状态、端口、云隧道等信息。