Opsbeacon命令连接服务器

一个用于Opsbeacon操作的MCP服务器实现,提供通过Claude与Opsbeacon API交互的工具,包括列出命令和连接的功能。

  • by OpsBeaconInc
  • Python
  • 本地部署
  • 更新于
在 GitHub 查看 opsbeaconinc/mcp-opsbeacon-server

使用说明

MCP Opsbeacon服务器

用于Opsbeacon操作的MCP(模型上下文协议)服务器实现。该服务器允许您通过Claude与Opsbeacon API交互,提供列出命令和连接的工具。

特性

  • 列出可用的Opsbeacon命令
  • 列出可用的Opsbeacon连接
  • 通过承载令牌进行身份验证
  • 错误处理和日志
  • 返回结构化JSON响应

先决条件

  • Python 3.10或更高版本
  • 访问Opsbeacon API
  • 有效的持票人令牌

安装

  1. 克隆存储库:
git clone [repository-url]
cd mcp-opsbeacon-server
  1. 安装软件包:
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. 克劳德配置
  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中的令牌配置正确
  2. Error listing commands/connections:检查您的网络连接和令牌有效性
  3. Connection refused:确保可访问Opsbeacon API

发展

要添加新功能或修改现有功能,请执行以下操作:

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