使用说明

项目简介

Prometheus Server MCP 服务器是一个基于 Model Context Protocol (MCP) 构建的后端服务,它充当了 LLM 客户端(如 Claude)与 Prometheus 监控系统之间的桥梁。通过该服务器,LLM 可以访问 Prometheus 收集的监控指标数据,从而理解系统运行状态或进行更智能的运维操作。

主要功能点

  • Prometheus 指标资源浏览: 允许 LLM 客户端列出并查看 Prometheus 服务器中可用的所有监控指标,并获取每个指标的简要描述。
  • Prometheus 指标数据读取: 允许 LLM 客户端读取特定监控指标的详细信息,包括指标的元数据(如帮助文本、类型)以及当前的统计数据(如计数、最小值、最大值)。
  • 基础认证支持: 支持连接到需要用户名和密码进行身份验证的 Prometheus 服务器。

安装步骤

  1. 安装 Node.js 和 npm: 确保你的系统已安装 Node.js 和 npm (Node 包管理器)。
  2. 下载仓库代码: 从 GitHub 仓库 https://github.com/loglmhq/mcp-server-prometheus 下载代码到本地。
  3. 安装依赖: 在仓库根目录下打开终端,运行命令 'npm install' 安装项目依赖。
  4. 构建项目: 运行命令 'npm run build' 构建项目,编译 TypeScript 代码到 'build' 目录。

服务器配置

要将此 MCP 服务器配置到 MCP 客户端(例如 Claude),你需要提供服务器的启动命令和相关参数。以下是一个 'claude_desktop_config.json' 配置文件示例,你需要根据你的实际环境进行修改:

{
  "mcpServers": {
    "prometheus-server": {  // MCP 服务器的名称,可以自定义
      "command": "/path/to/mcp-server-prometheus/build/index.js", //  指向编译后的服务器入口文件 index.js 的路径,请替换为实际路径
      "env": {
        "PROMETHEUS_URL": "http://your-prometheus-instance:9090"  //  你的 Prometheus 服务器的 URL,例如 http://localhost:9090。请替换为实际地址
        // "PROMETHEUS_USERNAME": "your_username",  // 可选:如果 Prometheus 需要用户名验证,请配置
        // "PROMETHEUS_PASSWORD": "your_password"   // 可选:如果 Prometheus 需要密码验证,请配置
      }
    }
  }
}

配置说明:

  • '"prometheus-server"': 是你在 MCP 客户端中引用的服务器名称,可以自定义。
  • '"command"': 是 MCP 服务器的启动命令,这里指向了构建后 'build/index.js' 文件的绝对路径。请务必将 '/path/to/mcp-server-prometheus' 替换为你本地仓库的实际路径。
  • '"env"': 是传递给服务器的环境变量。
    • '"PROMETHEUS_URL"': 必填,这是你的 Prometheus 服务器的访问地址。请替换为你的实际 Prometheus 服务器地址。
    • '"PROMETHEUS_USERNAME"' 和 '"PROMETHEUS_PASSWORD"': 可选,如果你的 Prometheus 服务器启用了 Basic Authentication,则需要配置用户名和密码。如果 Prometheus 不需要认证,则无需配置这两项。

Claude Desktop 配置文件路径:

  • MacOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
  • Windows: '%APPDATA%/Claude/claude_desktop_config.json'

基本使用方法

  1. 启动 MCP 服务器: 无需手动启动该 MCP 服务器。当你在 MCP 客户端(如 Claude)中配置并使用该服务器后,客户端会自动根据配置启动该服务器。
  2. 在 MCP 客户端中使用: 在支持 MCP 协议的 LLM 客户端(如 Claude)中,配置并连接到名为 '"prometheus-server"' (或你在 'claude_desktop_config.json' 中配置的名称) 的 MCP 服务器。
  3. 通过 LLM 客户端访问 Prometheus 数据: 配置成功后,你可以在 LLM 客户端中,通过自然语言指令,让 LLM 利用 Prometheus Server MCP 服务器提供的能力,访问和分析 Prometheus 监控数据。例如,你可以询问 "列出所有可用的监控指标" 或 "查询 CPU 使用率指标的详细信息"。具体如何与 LLM 交互取决于 LLM 客户端的功能。

注意: 确保你的 Prometheus 服务器可以被 MCP 服务器访问到(网络可达)。

信息

分类

开发者工具