返回 MCP 目录
public公开dns本地运行

mcp-server-prometheus

一个基于TypeScript的MCP服务器,提供与Prometheus指标数据交互的API接口,实现Claude与Prometheus服务器之间的桥梁功能。

article

README

🚀 mcp-server-prometheus

mcp-server-prometheus是一个与Prometheus指标和数据交互的MCP服务器。它基于TypeScript构建,实现了Prometheus API接口,通过模型上下文协议(MCP)在Claude和Prometheus服务器之间搭建了桥梁。

🚀 快速开始

mcp-server-prometheus是一个强大的工具,它能让Claude与Prometheus服务器实现交互。下面将为你介绍它的使用步骤。

✨ 主要特性

资源

  • 可列出并访问Prometheus指标模式。
  • 每个指标资源提供以下信息:
    • 指标名称和描述。
    • 来自Prometheus的详细元数据。
    • 统计信息(计数、最小值、最大值)。
  • 支持JSON MIME类型,方便获取结构化数据。

当前功能

  • 列出所有可用的Prometheus指标及其描述。
  • 读取详细的指标信息,包括:
    • 元数据和帮助文本。
    • 当前统计数据(计数值、最小值、最大值)。
  • 支持基本身份验证,可用于受保护的Prometheus实例。

📦 安装指南

环境变量配置

服务器需要以下环境变量:

  • PROMETHEUS_URL:您的Prometheus实例的基础URL。

可选的身份验证配置:

  • PROMETHEUS_USERNAME:基本认证的用户名(如果需要)。
  • PROMETHEUS_PASSWORD:基本认证的密码(如果需要)。

与Claude Desktop集成

要与Claude Desktop一起使用,请添加服务器配置:

  • 在MacOS上:~/Library/Application Support/Claude/claude_desktop_config.json
  • 在Windows上:%APPDATA%/Claude/claude_desktop_config.json
{
  "mcpServers": {
    "mcp-server-prometheus": {
      "command": "/path/to/mcp-server-prometheus/build/index.js",
      "env": {
        "PROMETHEUS_URL": "http://your-prometheus-instance:9090"
      }
    }
  }
}

依赖安装与构建

安装依赖项:

npm install

构建服务器:

npm run build

使用自动重建进行开发:

npm run watch

调试

由于MCP服务器通过标准输入输出进行通信,调试可能具有挑战性。我们建议使用MCP Inspector

npm run inspector

Inspector将提供一个在浏览器中访问调试工具的URL。

💻 使用示例

基础用法

以下是使用该服务器的基本步骤:

  1. 配置好环境变量。
  2. 安装依赖并构建服务器。
  3. 按照上述配置与Claude Desktop集成。

高级用法

如果需要对受保护的Prometheus实例进行操作,可配置PROMETHEUS_USERNAMEPROMETHEUS_PASSWORD进行基本身份验证。

📚 详细文档

演示

演示

API结构

服务器通过以下URI结构公开Prometheus指标:

  • 基础URI:http://your-prometheus-instance:9090
  • 指标URI:http://your-prometheus-instance:9090/metrics/{metric_name}

每个指标资源返回包含以下内容的JSON数据:

  • 指标名称
  • 元数据(帮助文本、类型)
  • 当前统计信息(计数、最小值、最大值)
help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端