BeigeBox MCP 服务器

使用说明 (Markdown 格式)

  • 项目简介 BeigeBox 集成了一个基于 MCP 的服务器端实现,允许 MCP 客户端通过 POST /mcp 与 BeigeBox 的工具注册表进行交互:枚举可用工具、调用指定工具、初始化会话等。MCP 服务器与现有的 OpenAI 兼容后端循环结合,确保 LLM 客户端能够跨模型、跨后端安全地访问资源和工具。

  • 主要功能点

    • 支持 MCP 的核心方法 initialize、tools/list、tools/call,并对通知类型的请求有规范处理。
    • 通过 /mcp 提供可扩展的工具注册表,使 MCP 客户端可发现并直接调用 BeigeBox 的工具。
    • 结合现有的工具注册体系,自动导出所有工具及其输入描述,便于客户端理解输入格式。
    • 集成在 Beigebox 的 FastAPI 应用中,与现有 API、路由和安全策略共存。
    • 和现有代理、路由、工具、以及安全策略(如多密钥鉴权)无缝协作,确保 MCP 请求同样受到 API 网关的保护。
  • 安装步骤

    1. 克隆仓库并安装依赖。安装 Python 运行环境并安装所需依赖。
    2. 运行 BeigeBox 服务(使用 README 的快速启动方式,例如 Docker Compose 或直接运行主应用)。
    3. 确保服务监听端口(默认配置下为 1337/1337v1 路径等)可从 MCP 客户端访问。
    4. MCP 客户端将目标 MCP 服务器指向 http://<主机>:1337/mcp,即可通过 initialize、tools/list、tools/call 等方法与 Beigebox 进行交互。
  • 服务器配置示例(MCP 客户端配置信息,非客户端代码,仅用于说明如何连接 MCP 服务器) 服务器名称: beigebox-mcp 启动命令: uvicorn 启动参数: ["beigebox.main:app", "--host", "0.0.0.0", "--port", "1337"] MCP 端点: "http://<host>:1337/mcp" 认证方式(可选): Bearer Token(若启用鉴权,请在请求头中加上 Authorization: Bearer <token>

    注意:上述信息仅为客户端如何连接 MCP 服务器的示例配置。实际使用中,MCP 客户端不需要 BeigeBox 的完整启动代码;只需提供连接端点、所需鉴权信息以及要调用的工具名称即可。

服务器信息