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 字段中。