MCP Opsbeacon Server

🚀 MCP 作戰號令服務器

MCP 作戰號令服務器是一個用於 Opsbeacon 操作的 Model Context Protocol (MCP) 服務器實現。它允許您通過 Claude 與 Opsbeacon API 進行交互，具備列出命令和連接等實用功能。

🚀 快速開始

MCP 作戰號令服務器可幫助您藉助 Claude 與 Opsbeacon API 交互，實現列出命令和連接等操作。在使用前，請確保滿足以下先決條件：

• Python 3.10 或更高版本
• 對 Opsbeacon API 的訪問權限
• 有效的 bearer token

✨ 主要特性

• 列出可用的 Opsbeacon 命令
• 列出可用的 Opsbeacon 連接
• 使用 bearer token 進行身份驗證
• 錯誤處理和日誌記錄
• 返回結構化的 JSON 響應

📦 安裝指南

克隆倉庫

git clone [repository-url]
cd mcp-opsbeacon-server

安裝包

pip install -e .

📚 詳細文檔

配置方式

有三種方式可以提供您的 Opsbeacon 配置：

選項 1：與 Claude 桌面一起使用

若想將 MCP 服務器與 Claude 一起使用，請在 Claude Desktop 的配置文件中添加所需的配置：

{
  "mcpServers": {
    "opsbeacon": {
      "command": "python",
      "args": [
        "-m",
        "mcp_opsbeacon_server"
      ],
      "env": {
        "OPSBEACON_TOKEN": "your-bearer-token-here",
        "OPSBEACON_BASE_URL": "your-base-url-here"
      }
    }
  }
}

選項 2：使用環境變量

您可以直接設置所需的環境變量：

export OPSBEACON_TOKEN="your-bearer-token-here"
export OPSBEACON_BASE_URL="your-base-url-here"

選項 3：使用 .env 文件（開發推薦）

在項目根目錄中創建一個 .env 文件。您可以使用提供的模板：

cp .env.example .env

然後編輯 .env 文件，輸入實際值：

OPSBEACON_TOKEN=your-bearer-token-here
OPSBEACON_BASE_URL=your-base-url-here  # 可選，默認為 https://api.console.opsbeacon.com

.env 文件被 git 忽略，以防止提交敏感信息。

基 URL 配置

OPSBEACON_BASE_URL 配置是可選的。如果沒有指定，默認使用以下 URL：

https://api.console.opsbeacon.com

您可以通過任何配置方法（如環境變量或 .env 文件）覆蓋此默認值。

配置優先級

您可以同時使用這些選項。當多個選項被使用時，優先順序如下：

1. 環境變量
2. .env 文件
3. Claude 配置文件
4. 默認基 URL

測試

要測試服務器功能，請確保已配置所需的變量（推薦在開發中使用 .env 文件），然後運行：

python test_server.py

💻 使用示例

可用工具

list_commands

• 功能：列出所有可用的 Opsbeacon 命令
• 參數：不需要額外參數
• 返回：命令詳細信息（JSON 格式）

list_connections

• 功能：列出所有可用的 Opsbeacon 連接
• 參數：不需要額外參數
• 返回：連接詳細信息（JSON 格式）

示例用法與 Claude

Human: 列出命令。
Claude: 運行以下命令：`list_commands`

結果：
返回所有可用命令的列表。

🔧 技術細節

錯誤處理

• 如果沒有有效的 bearer token，您將無法訪問受保護的端點
• 如果基 URL 無效或無法連接到服務器，可能會出現連接錯誤
• 如果請求參數無效，可能會返回驗證錯誤

開發

要添加新功能或修改現有代碼，請按照以下步驟操作：

1. 克隆倉庫並安裝依賴項
2. 修改代碼以實現所需的功能
3. 添加測試用例以確保功能正常工作
4. 提交更改並創建拉取請求

完成後，建議更新文檔以反映任何新的功能或更改。