Honeycomb MCP Server 使用说明

项目简介

Honeycomb MCP Server 是一个基于 Model Context Protocol (MCP) 构建的应用后端,旨在连接大型语言模型 (LLM) 如 Claude AI 和 Honeycomb 可观测性平台。它允许 LLM 通过标准化的 MCP 协议,调用 Honeycomb API 提供的各种功能,例如查询监控数据、创建仪表板、设置告警等,从而实现可观测性数据的智能访问和自动化运维任务。

主要功能点

  • 数据集管理: 支持数据集的创建、查询、更新等操作。
  • 列管理: 支持列出数据集中的所有列。
  • 查询管理: 支持创建和执行 Honeycomb 查询,获取查询结果。
  • 事件管理: 支持在 Honeycomb 中创建新的事件或批量创建事件。
  • 仪表板管理: 支持仪表板的列表、创建、查询、更新和删除操作。
  • 标记管理: 支持在 Honeycomb 数据集中创建、查询、更新和删除标记 (Marker)。
  • SLO 管理: 支持服务级别目标 (SLO) 的列表、创建、查询和更新。
  • 触发器管理: 支持告警触发器 (Trigger) 的列表、创建、查询、更新和删除。
  • 工具集成: 提供了一系列预定义的工具 (Tools),方便 LLM 通过自然语言指令调用 Honeycomb 的各项功能。

安装步骤

  1. 安装 Node.js: 确保你的环境中安装了 Node.js 18 或更高版本。
  2. 安装 Honeycomb MCP Server: 可以通过 npm 全局安装,或者使用 npx 直接运行。
    # 全局安装
    npm install -g @kajirita2002/honeycomb-mcp-server
    
    # 或者使用 npx 直接运行
    npx @kajirita2002/honeycomb-mcp-server
  3. 设置环境变量: 需要设置 Honeycomb API Key 环境变量 'HONEYCOMB_API_KEY',用于服务器认证 Honeycomb API。
    export HONEYCOMB_API_KEY="your_honeycomb_api_key"

服务器配置

MCP 客户端需要配置 MCP 服务器的启动信息,以下是 'mcp_config.json' 的配置示例,用于连接 Honeycomb MCP Server:

{
  "honeycomb": {
    "command": "npx",
    "args": ["-y", "@kajirita2002/honeycomb-mcp-server"],
    "env": {
      "HONEYCOMB_API_KEY": "your_honeycomb_api_key"
    }
  }
}

配置参数说明:

  • 'command': 启动服务器的命令,这里使用 'npx'。
  • 'args': 命令参数,'-y' 自动确认,'@kajirita2002/honeycomb-mcp-server' 是要执行的 npm 包名,即 Honeycomb MCP Server。
  • 'env': 环境变量配置,'HONEYCOMB_API_KEY' 用于传递 Honeycomb API 密钥给服务器。

基本使用方法

  1. 启动 MCP 服务器: 在安装并配置环境变量后,可以通过以下命令启动 Honeycomb MCP Server。

    npm start

    或者如果你使用 npx 安装,则无需额外启动,MCP 客户端调用时会自动启动。

  2. 配置 MCP 客户端: 在 MCP 客户端 (例如 Claude AI) 中配置上述 'mcp_config.json' 文件,指定 Honeycomb MCP Server 的连接信息。

  3. 通过 LLM 调用工具: 在 LLM 中,可以使用自然语言指令指示 LLM 调用 Honeycomb 提供的工具,例如:

    • "Claude, 列出 Honeycomb 中所有的数据集" (对应 'honeycomb_datasets_list' 工具)
    • "Claude, 创建一个名为 'Application Monitoring' 的数据集" (对应 'honeycomb_datasets_create' 工具)
    • "Claude, 创建一个查询,显示 'api-gateway' 服务的平均延迟" (对应 'honeycomb_query_create' 和 'honeycomb_query_result_create' 工具)

    LLM 将解析自然语言指令,并根据配置调用 Honeycomb MCP Server 提供的相应工具,从而实现与 Honeycomb 的交互。

信息

分类

开发者工具