使用说明
项目简介
Bitte MCP Proxy 是一个基于 Model Context Protocol (MCP) 的服务器实现,旨在为大型语言模型 (LLM) 应用提供上下文信息和功能。它包含两个主要服务:
- bitte-ai: 集成 Bitte AI 平台的功能,提供访问 AI Agent 和工具的能力。
- extra-tools: 提供额外的工具扩展服务,可以根据需要添加更多自定义工具。
主要功能点
- AI Agent 发现与访问: 通过工具获取 Bitte AI 平台上注册的 AI Agent 信息,例如 'get-all-agents', 'get-agent-by-id'。
- 工具发现与使用: 允许 LLM 客户端发现和调用 Bitte AI 平台及扩展工具服务提供的工具,例如 'get-all-tools', 'execute-agent', 'example-tool'。
- 可扩展的工具集: 'extra-tools' 服务提供了一个框架,可以轻松添加和管理额外的工具,扩展 LLM 应用的功能。
- 标准化的 MCP 接口: 使用 MCP 协议与客户端通信,确保与各种 MCP 客户端的兼容性。
- 会话管理: MCP 服务器负责管理用户会话,为每个客户端请求提供上下文环境。
安装步骤
- 安装 Bun: 确保你的系统已安装 Bun JavaScript 运行时环境。你可以访问 https://bun.sh 了解安装方法。
- 克隆仓库: 使用 Git 克隆 'bitte-mcp' 仓库到本地:
git clone https://github.com/BitteProtocol/bitte-mcp.git cd bitte-mcp - 安装依赖: 在仓库根目录下运行以下命令安装项目依赖:
bun install - 配置环境变量:
- 复制仓库中的 '.env.example' 文件并重命名为 '.env'。
- 根据需要修改 '.env' 文件中的环境变量。
- 对于 'bitte-ai' 服务,你可能需要配置 'BITTE_REGISTRY_URL', 'BITTE_RUNTIME_URL', 和 'BITTE_API_KEY' 以连接到 Bitte AI 平台。
- 'extra-tools' 服务可能需要配置 'EXTRA_TOOLS_API_KEY' 或其他自定义工具所需的配置。
服务器配置
MCP 客户端需要配置服务器连接信息才能与 Bitte MCP Proxy 服务器通信。以下是 MCP 客户端配置示例,你需要将此配置添加到你的 MCP 客户端应用的服务器配置中。
{ "servers": [ { "name": "bitte-ai-mcp-proxy", "command": "bun", "args": ["run", "dev:bitte-ai"] }, { "name": "extra-tools", "command": "bun", "args": ["run", "dev:extra-tools"] } ] }
配置说明:
- '"servers"': 定义一个服务器列表,可以配置多个 MCP 服务器。
- '"name"': 服务器的名称,例如 '"bitte-ai-mcp-proxy"' 或 '"extra-tools"',客户端可以通过名称来识别和调用特定的服务器。
- '"command"': 启动服务器的命令。这里使用 'bun' 运行器来执行 JavaScript 代码。
- '"args"': 传递给 'bun' 命令的参数数组。
- '["run", "dev:bitte-ai"]' 用于启动 'bitte-ai' 服务的开发模式。
- '["run", "dev:extra-tools"]' 用于启动 'extra-tools' 服务的开发模式。
注意: 上述配置适用于开发环境。在生产环境中,你可能需要使用 'bun run start' 命令并配置 Docker 或其他部署方式。
基本使用方法
-
启动服务器: 在仓库根目录下,根据需要运行以下命令启动服务:
- 启动所有服务 (bitte-ai 和 extra-tools): 'bun run start-dev'
- 仅启动 bitte-ai 服务: 'bun run dev:bitte-ai'
- 仅启动 extra-tools 服务: 'bun run dev:extra-tools'
启动后,'bitte-ai' 服务默认监听 'http://localhost:3000/sse','extra-tools' 服务默认监听 'http://localhost:3001/sse'。
-
配置 MCP 客户端: 将上面提供的服务器配置信息添加到你的 MCP 客户端应用中。确保客户端能够连接到服务器的 SSE 端点 ('/sse')。
-
使用 MCP 客户端: 通过 MCP 客户端,你可以向服务器发送 MCP 请求,例如:
- 请求 'bitte-ai-mcp-proxy' 服务器的 'get-all-agents' 工具,获取 Bitte AI 平台上的 Agent 列表。
- 请求 'extra-tools' 服务器的 'example-tool' 工具,体验扩展工具的功能。
具体的工具使用方法和参数,请参考每个工具的 'description' 和 'parameters' 定义。
信息
分类
网页与API