Prometheus MCP Server

🚀 Prometheus MCP 服務器

Prometheus MCP 服務器是一個用於 Prometheus 的 Model Context Protocol (MCP) 服務器。它通過標準化的 MCP 接口，提供對 Prometheus 指標和查詢的訪問，允許 AI 助手執行 PromQL 查詢並分析指標數據。

🚀 快速開始

1. 確保您的 Prometheus 服務器可以從運行此 MCP 服務器的環境中訪問。
2. 配置環境變量以獲取 Prometheus 服務器信息，無論是通過 .env 文件還是系統環境變量：

# 必須：Prometheus 配置
PROMETHEUS_URL=http://your-prometheus-server:9090

# 可選：身份驗證憑證（如果需要）
# 根據需要選擇以下一種身份驗證方法：

# 對於基本認證
BASIC_AUTH_USERNAME=your_username
BASIC_AUTH_PASSWORD=your_password

# 對於bearer token 認證
BEARER_TOKEN=your_bearer_token

# 其他可選配置
SCrapeInterval=60  # 間隔（以秒為單位）
ScrapeTimeout=10    # scrape超時時間（以秒為單位）

3. 安裝並運行服務器：

uv install
uv run

✨ 主要特性

• 執行 PromQL 查詢：可執行 PromQL 查詢到 Prometheus。
• 指標發現和探索：
  • 列出可用指標。
  • 獲取特定指標的元數據。
  • 查看即時查詢結果。
  • 查看範圍查詢結果以及不同的步長間隔。
• 支持身份驗證：
  • 從環境變量使用基本認證。
  • 從環境變量使用 bearer token 認證。
• Docker 容器化支持：支持將服務打包為 Docker 容器。
• 提供交互式工具：為 AI 助手提供交互式工具，且工具列表可配置，您可以選擇要提供給 MCP 客戶端哪些工具，這在您不使用某些功能或不想佔用太多上下文窗口時很有用。

💻 使用示例

基礎用法

以下是配置環境變量的示例：

# 必須：Prometheus 配置
PROMETHEUS_URL=http://your-prometheus-server:9090

# 可選：身份驗證憑證（如果需要）
# 根據需要選擇以下一種身份驗證方法：

# 對於基本認證
BASIC_AUTH_USERNAME=your_username
BASIC_AUTH_PASSWORD=your_password

# 對於bearer token 認證
BEARER_TOKEN=your_bearer_token

# 其他可選配置
SCrapeInterval=60  # 間隔（以秒為單位）
ScrapeTimeout=10    # scrape超時時間（以秒為單位）

高級用法

安裝並運行服務器：

uv install
uv run

📚 詳細文檔

項目結構

該項目已經組織了一個 src 目錄結構：

prometheus-mcp-server/
├── src/
│   └── prometheus_mcp_server/
│       ├── __init__.py      # 包初始化文件
│       ├── server.py        # MCP 服務器實現
│       └── main.py          # 主應用邏輯
├── Dockerfile               # Docker 配置文件
├── docker-compose.yml       # Docker Compose 配置文件
├── .dockerignore            # Docker 忽略文件
└── README.md                # 本文件

測試

項目包含全面的測試套件，確保功能並幫助防止迴歸。運行測試：

# 安裝開發依賴項
uv pip install -e ".[dev]"

# 運行測試
pytest

# 生成覆蓋率報告
pytest --cov=src --cov-report=term-missing

工具

📄 許可證

本項目採用 MIT 許可證。