README
🚀 MCP-Bridge 中文文档
MCP-Bridge 是一款强大的桥梁工具,它能无缝连接 OpenAI API 和推理引擎。通过在请求中添加所有可用的 MCP 工具定义,将请求精准转发到推理引擎,处理工具调用结果后,再把结果返回给 OpenAI API,极大提升了工作效率和数据交互的流畅性。
🚀 快速开始
MCP-Bridge 是一个连接 OpenAI API 和推理引擎的桥梁工具。它通过在请求中添加所有可用的 MCP 工具定义,将请求转发到推理引擎,并处理工具调用的结果,最终将结果返回给 OpenAI API。
✨ 主要特性
- 支持多种 MCP 服务器:可灵活配置多个 MCP 服务器,每个服务器具备不同的命令和参数,满足多样化需求。
- API Key 认证:通过配置 API 密钥来保护服务器,为服务访问加上安全锁,确保只有授权用户可以访问服务。
- 灵活的采样设置:支持自定义采样超时时间和模型性能参数(如智能度、成本和速度),让使用更加个性化。
- 网络配置:能根据实际需求调整服务器的绑定地址和端口,适应不同的网络环境。
- 日志记录:支持不同级别的日志输出,无论是调试还是监控,都能轻松应对。
📦 安装指南
1. 下载代码
从 GitHub 克隆项目仓库:
git clone https://github.com/your-repository.git
cd mcp-bridge
2. 配置环境
编辑 config.json 文件,根据需求填写推理服务器地址、MCP 服务器命令和其他参数。例如:
{
"inference_server": {
"base_url": "http://localhost:8000/v1",
"api_key": "None"
},
"mcp_servers": {
"fetch": {
"command": "uvx",
"args": ["mcp-server-fetch"]
}
}
}
3. 启动服务
运行以下命令启动 MCP-Bridge:
python main.py
📚 详细文档
配置详解
1. 基本配置
- 推理服务器:指定推理引擎的 API 地址和密钥。
- MCP 服务器:定义可用工具及其调用命令。
2. 安全设置
启用 API Key 认证:
{
"security": {
"auth": {
"enabled": true,
"api_keys": [
{"key": "your-api-key"}
]
}
}
}
3. 网络配置
调整服务器的绑定地址和端口:
{
"network": {
"host": "0.0.0.0",
"port": 9090
}
}
4. 日志设置
控制日志输出级别:
{
"logging": {
"log_level": "DEBUG"
}
}
💻 使用示例
基础用法
发送一个简单的请求到 MCP-Bridge,包含工具调用:
POST /v1/chat/completions HTTP/1.1
Content-Type: application/json
Authorization: Bearer your-api-key
{
"model": "gpt-4",
"messages": [
{
"role": "user",
"content": "请列出所有可用的 MCP 工具。"
}
],
"tools": {
"enabled": true
}
}
高级用法
MCP-Bridge 返回工具调用的结果并转发到推理引擎,最终将响应返回给 OpenAI API。
🔧 技术细节
项目结构
mcp-bridge/
├── main.py # 主程序入口
├── config.json # 配置文件
├── README.md # 用户文档
└── requirements.txt # 依赖管理文件
🤝 贡献与支持
如果遇到问题或有任何建议,请在 GitHub Issues 提交反馈。我们也欢迎社区贡献代码和文档。
📄 许可证
MCP-Bridge 采用 MIT 许可证,详情请查看 LICENSE 文件。
感谢使用 MCP-Bridge!如果有任何问题,请随时联系我们。
扫码联系在线客服