使用说明
项目简介
Brightsy MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器实现,它充当 MCP 客户端和 Brightsy AI Agent 之间的桥梁。该服务器通过 MCP 协议与客户端通信,接收客户端的工具调用请求,并将这些请求转发到 Brightsy AI Agent 进行处理,最终将 Agent 的响应返回给客户端。简单来说,它允许你通过 MCP 客户端调用 Brightsy AI 的能力。
主要功能点
- 工具代理: 将 MCP 客户端对名为 'brightsy' (或自定义名称) 工具的调用请求,代理到 Brightsy AI Agent API。
- 消息转发: 接收 MCP 客户端发送的消息,并以 Brightsy AI Agent API 要求的格式转发。
- 响应返回: 接收 Brightsy AI Agent 的 API 响应,并将其转换为 MCP 协议的响应格式返回给客户端。
- 会话管理: 通过维护 'conversationHistory' 变量,在一定程度上支持简单的会话上下文 (仅在服务器重启后会丢失)。
- 可配置工具名称: 允许用户自定义注册到 MCP 服务器的工具名称,默认为 'brightsy'。
- 基于 Stdio 传输: 使用标准的 Stdio (标准输入/输出) 作为 MCP 服务器的传输协议。
安装步骤
- 安装 Node.js 和 npm: 确保你的系统已安装 Node.js 和 npm (Node 包管理器)。
- 克隆仓库: 将 Brightsy MCP Server 仓库克隆到本地:
git clone https://github.com/mattlevine/brightsy-mcp.git cd brightsy-mcp - 安装依赖: 在仓库根目录下运行以下命令安装项目依赖:
npm install
服务器配置
MCP 客户端需要配置以下信息才能连接到 Brightsy MCP 服务器。以下是一个 JSON 格式的配置示例,你需要根据实际情况进行修改:
{ "serverName": "BrightsyMCP", "transport": { "type": "stdio", "command": "/path/to/node", // 【请替换为你的Node.js可执行文件路径】例如:/usr/bin/node 或 C:\\Program Files\\nodejs\\node.exe "args": [ "/path/to/brightsy-mcp/dist/index.js", // 【请替换为你的 dist/index.js 文件路径】例如:/home/user/brightsy-mcp/dist/index.js 或 C:\\Users\\User\\brightsy-mcp\\dist\\index.js "<your-agent-id>", // 【请替换为你的Brightsy Agent ID】你需要从 Brightsy AI 平台获取 Agent ID "<your-api-key>", // 【请替换为你的Brightsy API Key】你需要从 Brightsy AI 平台获取 API Key "--tool-name", "brightsy" // (可选) 自定义工具名称,默认为 brightsy,可以根据需要修改 ] } }
配置参数说明:
- 'serverName': MCP 服务器的名称,可以自定义。
- 'transport.type': 传输协议类型,这里固定为 'stdio'。
- 'transport.command': 启动 MCP 服务器的命令,通常是 Node.js 的可执行文件路径。
- 'transport.args': 启动命令的参数,包括:
- 'dist/index.js': 服务器入口文件路径。
- '<your-agent-id>': 你的 Brightsy AI Agent ID,必填。
- '<your-api-key>': 你的 Brightsy AI API Key,必填。
- '--tool-name "brightsy"': (可选) 指定注册到 MCP 服务器的工具名称。
请务必根据你的实际环境和 Brightsy AI 账户信息,替换配置信息中的占位符路径和密钥。
基本使用方法
-
启动 MCP 服务器: 在 Brightsy MCP Server 仓库根目录下,打开终端并运行以下命令启动服务器 (请根据需要替换 Agent ID 和 API Key):
npm start -- --agent-id=<your-agent-id> --api-key=<your-api-key>或使用位置参数:
npm start -- <your-agent-id> <your-api-key>服务器成功启动后,会显示 "Brightsy MCP Server running on stdio" 等信息。
-
配置并启动 MCP 客户端: 使用任何支持 MCP 协议的客户端(例如 Cursor 编辑器或其他 MCP 客户端 SDK),根据上述 服务器配置 部分提供的 JSON 配置信息,配置客户端连接到 Brightsy MCP 服务器。
-
调用工具: 在 MCP 客户端中,你可以通过调用注册的工具 (默认为 'brightsy' 或自定义名称) 来与 Brightsy AI Agent 交互。例如,在客户端中调用 'brightsy' 工具并发送消息:
// 假设你已经初始化了 MCP 客户端 client const response = await client.callTool("brightsy", { messages: [ { role: "user", content: "你好,可以帮我做点什么吗?" } ] }); console.log(response); // 查看 Agent 的响应客户端会将工具调用请求通过 Stdio 发送给 Brightsy MCP 服务器,服务器转发给 Brightsy AI Agent,并将 Agent 的响应返回给客户端。
注意: 该 MCP 服务器实现主要功能是代理请求到 Brightsy AI Agent,本身不提供资源管理或 Prompt 模板等 MCP 定义的其他核心功能。
信息
分类
AI与计算