项目简介
MCP-Bridge 充当 OpenAI API 和 MCP (Model Context Protocol) 工具之间的桥梁,允许开发者通过 OpenAI API 接口利用 MCP 工具。它提供了一组兼容 OpenAI API 的端点,使得任何兼容 OpenAI API 的客户端都能无缝使用 MCP 工具,无需显式支持 MCP 协议。例如,可以使用 Open Web UI 等客户端与 MCP 的 fetch 工具集成。
主要功能点
- OpenAI API 兼容性: 提供与 OpenAI API 接口兼容的 RESTful API 端点,可以使用任何 OpenAI 客户端与之交互。
- MCP 工具集成: 能够集成和管理多种 MCP 工具,允许 LLM 通过工具调用扩展功能。
- SSE Bridge: 提供 SSE (Server-Sent Events) 桥接,支持具有 MCP 感知的客户端直接连接并使用 MCP 工具。
- REST API 端点: 暴露丰富的 REST API 端点,用于管理和操作 MCP 资源、工具和 Prompt 模板。
- 灵活配置: 通过 'config.json' 文件配置 MCP 服务器连接信息,支持 API Key 认证保障服务器安全。
安装步骤
Docker 安装 (推荐):
- 克隆仓库: 'git clone https://github.com/SecretiveShell/MCP-Bridge'
- 编辑 'compose.yml' 文件: 根据需要配置 'config.json' 文件的加载方式,例如将 'config.json' 放置在 'compose.yml' 同目录下并配置 volume 挂载。
- 运行服务: 'docker-compose up --build -d'
手动安装 (不使用 Docker):
- 克隆仓库: 'git clone https://github.com/SecretiveShell/MCP-Bridge'
- 安装依赖: 'uv sync'
- 创建 'config.json' 文件: 在项目根目录下创建 'config.json' 文件,并根据需要配置。
- 运行应用: 'uv run mcp_bridge/main.py'
服务器配置
MCP-Bridge 的核心配置通过 'config.json' 文件进行管理。以下是关于 MCP 服务器配置的关键部分 ('mcp_servers' 字段) 的说明:
{ "mcp_servers": { "server_name_1": { // MCP 服务器的名称,可以自定义,用于在 MCP-Bridge 中唯一标识和引用该服务器 "command": "your_mcp_server_command", // MCP 服务器的启动命令,例如 'mcp-server-fetch' 或其他 MCP 服务器的可执行文件路径 "args": ["arg1", "arg2"] // 启动命令的参数列表,根据具体的 MCP 服务器要求配置,例如 fetch 服务器可能不需要参数,而其他服务器可能需要指定配置文件路径等 }, "server_name_2": { // 可以配置多个 MCP 服务器 "command": "another_mcp_server_command", "args": [] } // ... 更多 MCP 服务器配置 } // ... 其他配置项,如 inference_server, sampling, network, logging, security 等 }
配置说明:
- 'mcp_servers': 该字段是一个 JSON 对象,用于配置需要连接的 MCP 服务器。
- 'server_name_1', 'server_name_2', ...: 每个键代表一个 MCP 服务器的名称,您可以自定义名称以便在 MCP-Bridge 中引用。
- 'command': 指定 MCP 服务器的可执行命令。这通常是 MCP 服务器程序的文件名(如果已添加到系统路径)或完整的文件路径。
- 'args': 一个字符串数组,包含传递给 MCP 服务器启动命令的参数。参数的具体内容取决于您使用的 MCP 服务器的类型和配置需求。例如,某些 MCP 服务器可能需要配置文件路径、端口号或其他初始化参数。
重要提示: 您需要根据您实际使用的 MCP 服务器,填写正确的 'command' 和 'args'。MCP-Bridge 仅作为桥梁,它本身不包含具体的 MCP 服务器实现,而是连接到已有的 MCP 服务器。
基本使用方法
- 查看文档: 服务启动后,访问 'http://yourserver:8000/docs' 查看 OpenAPI 文档,了解所有可用的 API 端点和使用方法。
- 使用 OpenAI 客户端: 配置任何兼容 OpenAI API 的客户端(例如 Open Web UI)连接到 MCP-Bridge 服务器地址 'http://yourserver:8000/v1',即可开始使用集成了 MCP 工具的聊天功能。
- 使用 SSE 客户端: 对于支持 MCP 协议的客户端,可以直接连接到 MCP-Bridge 的 SSE 端点 'http://yourserver:8000/mcp-server/sse',以 MCP 服务器的方式使用 MCP-Bridge 提供的工具和服务。
- 测试配置: 可以通过访问 '/mcp/tools' 或 '/mcp-server/sse' 端点,查看 MCP-Bridge 是否成功加载并连接到配置的 MCP 服务器及其工具列表,以验证配置是否正确。
信息
分类
网页与API