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. 提交更改并创建拉取请求

完成后，建议更新文档以反映任何新的功能或更改。