MCP Opsbeacon Server

MCP Opsbeacon 服务

这是一个面向 Opsbeacon 运维的 MCP（Model Context Protocol）服务实现。通过此服务，你可以使用 Claude 与 Opsbeacon API 交互，并获取列出命令和连接的工具。

功能

• 列出可用的 Opsbeacon 命令
• 列出可用的 Opsbeacon 连接
• 使用 bearer token 进行身份验证
• 错误处理和日志记录
• 返回结构化 JSON 响应

前提条件

• Python 3.10 或更高版本
• 可访问 Opsbeacon API
• 有效的 bearer token

安装

1. 克隆代码仓库：

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

2. 安装软件包：

pip install -e .

配置

提供 Opsbeacon 配置有以下三种方式：

选项 1：与 Claude Desktop 搭配使用

如果你想将 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  # Optional, defaults to https://api.console.opsbeacon.com

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

基础 URL 配置

OPSBEACON_BASE_URL 配置为可选项。如果未指定，服务将使用默认 URL：

https://api.console.opsbeacon.com

你可以通过上述任一配置方式设置 OPSBEACON_BASE_URL，以覆盖此默认值。

配置优先级

你可以同时使用上述任意选项。使用多个选项时，优先级如下：

1. 环境变量
2. .env 文件
3. Claude 配置
4. 默认基础 URL

测试

要测试服务功能，请先使用上述任一方式配置所需变量（推荐在开发时使用 .env 文件），然后运行：

python test_server.py

用法

可用工具

1. list_commands

   • 列出所有可用的 Opsbeacon 命令
   • 无需其他参数
   • 以 JSON 格式返回命令详情

2. list_connections

   • 列出所有可用的 Opsbeacon 连接
   • 无需其他参数
   • 以 JSON 格式返回连接详情

使用 Claude 的示例

Human: List all available Opsbeacon commands.
Claude: Let me help you list the available commands using the Opsbeacon MCP server.

错误处理

常见错误情况：

1. OPSBEACON_TOKEN environment variable is not set：确保已在 claude_desktop_config.json 中正确配置 token
2. Error listing commands/connections：检查网络连接和 token 是否有效
3. Connection refused：确保 Opsbeacon API 可访问

开发

要添加新功能或修改现有功能：

1. 进行更改
2. 运行测试脚本以验证功能
3. 根据需要更新文档