Prometheus MCP

🚀 Prometheus MCP Server

Prometheus MCP Server 是一個模型上下文協議（MCP）服務器，它能讓 AI 助手與 Prometheus 實現無縫集成，支持通過自然語言與監控基礎設施進行交互。藉助該服務器，你可以通過 Visual Studio Code、Cursor、Windsurf、Claude Desktop 等 MCP 客戶端輕鬆查詢、發現和分析指標。

🚀 快速開始

首先，將 Prometheus MCP 服務器與你的客戶端進行安裝。典型的配置如下：

{
  "mcpServers": {
    "prometheus": {
      "command": "npx",
      "args": ["prometheus-mcp@latest", "stdio"],
      "env": {
        "PROMETHEUS_URL": "http://localhost:9090"
      }
    }
  }
}

# 對於 VS Code
code --add-mcp '{"name":"prometheus","command":"npx","args":["prometheus-mcp@latest","stdio"],"env":{"PROMETHEUS_URL":"http://localhost:9090"}}'

# 對於 VS Code Insiders
code-insiders --add-mcp '{"name":"prometheus","command":"npx","args":["prometheus-mcp@latest","stdio"],"env":{"PROMETHEUS_URL":"http://localhost:9090"}}'

{
  "mcpServers": {
    "prometheus": {
      "command": "npx",
      "args": ["prometheus-mcp@latest", "stdio"],
      "env": {
        "PROMETHEUS_URL": "http://localhost:9090"
      }
    }
  }
}

{
  "mcpServers": {
    "prometheus": {
      "command": "npx",
      "args": ["prometheus-mcp@latest", "stdio"],
      "env": {
        "PROMETHEUS_URL": "http://localhost:9090"
      }
    }
  }
}

{
  "mcpServers": {
    "prometheus": {
      "command": "npx",
      "args": ["prometheus-mcp@latest", "stdio"],
      "env": {
        "PROMETHEUS_URL": "http://localhost:9090"
      }
    }
  }
}

✨ 主要特性

• 快速輕量：與 Prometheus 直接進行 API 集成，無需複雜解析。
• 對大語言模型友好：結構化的 JSON 響應經過優化，便於 AI 助手使用。
• 可配置功能：可根據安全和運營需求啟用或禁用工具類別。
• 雙傳輸支持：支持 stdio 和 HTTP 兩種傳輸方式，具備最大兼容性。

📦 安裝指南

系統要求

• Node.js 20.19.0 或更高版本
• 能夠訪問 Prometheus 服務器
• 需安裝 VS Code、Cursor、Windsurf、Claude Desktop 或其他 MCP 客戶端

安裝命令

具體安裝命令可參考快速開始部分的不同客戶端安裝步驟。

📚 詳細文檔

配置

Prometheus MCP 服務器支持以下參數，可在上述 JSON 配置的 "args" 列表中提供：

> npx prometheus-mcp@latest --help

Commands:
  stdio  Start Prometheus MCP server using stdio transport
  http   Start Prometheus MCP server using HTTP transport

Options:
  --help     Show help                          [boolean]
  --version  Show version number                [boolean]

環境變量

你還可以使用環境變量來配置服務器：

• PROMETHEUS_URL - Prometheus 服務器的 URL
• ENABLE_DISCOVERY_TOOLS - 設置為 "false" 可禁用發現工具（默認值：true）
• ENABLE_INFO_TOOLS - 設置為 "false" 可禁用信息工具（默認值：true）
• ENABLE_QUERY_TOOLS - 設置為 "false" 可禁用查詢工具（默認值：true）

獨立 MCP 服務器

當在服務器環境中運行或需要使用 HTTP 傳輸時，可使用 http 命令啟動 MCP 服務器：

npx prometheus-mcp@latest http --port 3000

然後在你的 MCP 客戶端配置中，將 url 設置為 HTTP 端點：

{
  "mcpServers": {
    "prometheus": {
      "command": "npx",
      "args": ["mcp-remote", "http://localhost:3000/mcp"]
    }
  }
}

Docker 部署

使用 Docker 運行 Prometheus MCP 服務器：

{
  "mcpServers": {
    "prometheus": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "--init",
        "--pull=always",
        "-e",
        "PROMETHEUS_URL=http://host.docker.internal:9090",
        "ghcr.io/idanfishman/prometheus-mcp",
        "stdio"
      ]
    }
  }
}

工具

Prometheus MCP 服務器提供了 10 個工具，分為三個可配置的類別：

示例用法

以下是一些你可以與 AI 助手進行交互的示例：

基本查詢

• "Show me all available metrics in Prometheus"（顯示 Prometheus 中所有可用的指標）
• "What's the current CPU usage across all instances?"（所有實例的當前 CPU 使用率是多少？）
• "Get the memory usage for the last hour"（獲取過去一小時的內存使用情況）

發現和探索

• "List all scrape targets and their status"（列出所有抓取目標及其狀態）
• "What labels are available for the http_requests_total metric?"（http_requests_total 指標有哪些可用的標籤？）
• "Show me all metrics related to 'cpu'"（顯示所有與 "cpu" 相關的指標）

高級分析

• "Compare CPU usage between production and staging environments"（比較生產環境和暫存環境的 CPU 使用率）
• "Show me the top 10 services by memory consumption"（顯示內存消耗排名前十的服務）
• "What's the error rate trend for the API service over the last 24 hours?"（API 服務在過去 24 小時內的錯誤率趨勢如何？）

安全考慮

• 網絡訪問：服務器需要網絡訪問你的 Prometheus 實例。
• 資源使用：範圍查詢可能會消耗大量資源，請監控你的 Prometheus 服務器負載。

故障排除

連接問題

• 驗證你的 Prometheus 服務器在配置的 URL 上是否可訪問。
• 檢查防火牆設置和網絡連接。
• 確保 Prometheus API 已啟用（默認端口為 9090）。

權限錯誤

• 驗證 MCP 服務器是否有網絡訪問 Prometheus 的權限。
• 檢查你的 Prometheus 設置是否需要身份驗證。

工具可用性

• 如果某些工具缺失，請檢查是否通過配置禁用了它們。

📄 許可證

本項目採用 MIT 許可證 - 詳情請參閱 LICENSE 文件。

支持

• GitHub 問題：報告錯誤或請求功能
• 文檔：模型上下文協議文檔
• Prometheus：Prometheus 文檔

本項目是為 Prometheus 和 MCP 社區精心打造的 ❤️