Brightsy MCP

🚀 Brightsy MCP 服务器

这是一个连接到 Brightsy AI 代理的模型上下文协议（MCP）服务器，可将请求转发到 AI 代理并返回响应，为用户与 AI 代理的交互提供支持。

🚀 快速开始

本部分将引导你完成 Brightsy MCP 服务器的安装、启动及使用。

📦 安装指南

使用以下命令安装所需依赖：

npm install

💻 使用示例

基础用法

启动服务器，你可以使用以下几种方式：

• 使用命名参数：

npm start -- --agent-id=<your-agent-id> --api-key=<your-api-key>

• 使用位置参数：

npm start -- <your-agent-id> <your-api-key> [tool-name] [message]

• 提供初始消息：

npm start -- --agent-id=<your-agent-id> --api-key=<your-api-key> --message="Hello, agent!"

高级用法

自定义工具名称

默认情况下，MCP 服务器注册名为 "brightsy" 的工具，你可以通过以下方式自定义工具名称：

• 使用 --tool-name 参数：

npm start -- --agent-id=<your-agent-id> --api-key=<your-api-key> --tool-name=<custom-tool-name>

• 使用位置参数：

npm start -- <your-agent-id> <your-api-key> <custom-tool-name>

• 使用环境变量：

export BRIGHTSY_TOOL_NAME=custom-tool-name
npm start -- --agent-id=<your-agent-id> --api-key=<your-api-key>

环境变量配置

以下环境变量可用于配置服务器：

• BRIGHTSY_AGENT_ID：使用的代理 ID（命令行参数的替代）
• BRIGHTSY_API_KEY：使用的 API 密钥（命令行参数的替代）
• BRIGHTSY_TOOL_NAME：注册的工具名称（默认："brightsy"）

测试 agent_proxy 工具

agent_proxy 工具允许你将请求代理到 Brightsy AI 代理，你可以使用提供的测试脚本进行测试。

先决条件

运行测试前，你可以通过以下方式设置必要的参数：

• 使用环境变量：

export AGENT_ID=your-agent-id
export API_KEY=your-api-key
# 可选：自定义工具名称用于测试
export TOOL_NAME=custom-tool-name

• 使用命令行参数：

# 使用命名参数
npm run test:cli -- --agent-id=your-agent-id --api-key=your-api-key --tool-name=custom-tool-name

# 使用位置参数
npm run test:cli -- your-agent-id your-api-key custom-tool-name

运行测试

• 运行所有测试：

npm test

• 运行特定测试：

# 测试命令行接口
npm run test:cli

# 测试直接 MCP 协议
npm run test:direct

测试脚本说明

• 命令行测试 (test-agent-proxy.ts)：通过运行 MCP 服务器并发送测试消息来测试 agent_proxy 工具。
• 直接 MCP 协议测试 (test-direct.ts)：通过直接向服务器发送格式正确的 MCP 请求来测试 agent_proxy 工具。

工具的工作原理

MCP 服务器注册一个工具（默认名称为 "brightsy"），该工具将请求转发到一个 OpenAI 兼容的 AI 代理，并返回响应。它接受一个 messages 参数，这是一个包含消息对象的数组，每个对象具有 role 和 content 属性。

示例用法（在 MCP 客户端中）：

// 使用默认工具名称
const response = await client.callTool("brightsy", {
  messages: [
    {
      role: "user",
      content: "Hello, can you help me with a simple task?"
    }
  ]
});

// 或者使用自定义的工具名称（如果已配置）
const response = await client.callTool("custom-tool-name", {
  messages: [
    {
      role: "user",
      content: "Hello, can you help me with a simple task?"
    }
  ]
});

响应将包含代理的回复在 content 字段中。