Skip to main content

MCP server for interacting with AWS Managed Prometheus

Project description

Prometheus MCP Server

The Prometheus MCP Server provides a robust interface for interacting with AWS Managed Prometheus, enabling users to execute PromQL queries, list metrics, and retrieve server information with AWS SigV4 authentication support.

This MCP server is designed to be fully compatible with Amazon Q developer CLI, allowing seamless integration of Prometheus monitoring capabilities into your Amazon Q workflows. You can load the server directly into Amazon Q to leverage its powerful querying and metric analysis features through the familiar Q interface.

Features

  • Execute instant PromQL queries against AWS Managed Prometheus
  • Execute range queries with start time, end time, and step interval
  • List all available metrics in your Prometheus instance
  • Get server configuration information
  • AWS SigV4 authentication for secure access
  • Automatic retries with exponential backoff

Installation

Cursor VS Code
Install MCP Server Install on VS Code

Prerequisites

  • Python 3.10 or higher
  • AWS credentials configured with appropriate permissions
  • AWS Managed Prometheus workspace

Configuration

The server is configured through the Amazon Q MCP configuration file as shown in the Usage section below.

Usage with Amazon Q

Here are some ways you can work with MCP across AWS, and we'll be adding support to more products including Amazon Q Developer CLI soon:

  1. Create a configuration file:
mkdir -p ~/.aws/amazonq/
  1. Add the following to ~/.aws/amazonq/mcp.json:

Basic Configuration

{
  "mcpServers": {
    "prometheus": {
      "command": "uvx",
      "args": [
        "awslabs.prometheus-mcp-server@latest"
      ],
      "env": {
        "FASTMCP_LOG_LEVEL": "DEBUG"
      }
    }
  }
}

Configuration with Optional Arguments

{
  "mcpServers": {
    "prometheus": {
      "command": "uvx",
      "args": [
        "awslabs.prometheus-mcp-server@latest",
        "--url",
        "https://aps-workspaces.<AWS Region>.amazonaws.com/workspaces/ws-<Workspace ID>",
        "--region",
        "<Your AWS Region>",
        "--profile",
        "<Your CLI Profile>"
      ],
      "env": {
        "FASTMCP_LOG_LEVEL": "DEBUG"
      }
    }
  }
}
  1. In Amazon Q, you can now use the Prometheus MCP server to query your metrics.

Available Tools

  1. GetAvailableWorkspaces

    • List all available Prometheus workspaces in the specified region
    • Parameters: region (optional)
    • Returns: List of workspaces with IDs, aliases, and status
  2. ExecuteQuery

    • Execute instant PromQL queries against Prometheus
    • Parameters: workspace_id (required), query (required), time (optional), region (optional)
  3. ExecuteRangeQuery

    • Execute PromQL queries over a time range
    • Parameters: workspace_id (required), query, start time, end time, step interval, region (optional)
  4. ListMetrics

    • Retrieve all available metric names from Prometheus
    • Parameters: workspace_id (required), region (optional)
    • Returns: Sorted list of metric names
  5. GetServerInfo

    • Retrieve server configuration details
    • Parameters: workspace_id (required), region (optional)
    • Returns: URL, region, profile, and service information

Example Queries

# Get available workspaces
workspaces = await get_available_workspaces()
for ws in workspaces['workspaces']:
    print(f"ID: {ws['workspace_id']}, Alias: {ws['alias']}, Status: {ws['status']}")

# Execute an instant query
result = await execute_query(
    workspace_id="ws-12345678-abcd-1234-efgh-123456789012",
    query="up"
)

# Execute a range query
data = await execute_range_query(
    workspace_id="ws-12345678-abcd-1234-efgh-123456789012",
    query="rate(node_cpu_seconds_total[5m])",
    start="2023-01-01T00:00:00Z",
    end="2023-01-01T01:00:00Z",
    step="1m"
)

# List available metrics
metrics = await list_metrics(
    workspace_id="ws-12345678-abcd-1234-efgh-123456789012"
)

# Get server information
info = await get_server_info(
    workspace_id="ws-12345678-abcd-1234-efgh-123456789012"
)

Troubleshooting

Common issues and solutions:

  1. AWS Credentials Not Found

    • Check ~/.aws/credentials
    • Set AWS_PROFILE environment variable
    • Verify IAM permissions
  2. Connection Errors

    • Verify Prometheus URL is correct
    • Check network connectivity
    • Ensure AWS VPC access is configured correctly
  3. Authentication Failures

    • Verify AWS credentials are current
    • Check system clock synchronization
    • Ensure correct AWS region is specified

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

awslabs_prometheus_mcp_server-0.2.3.tar.gz (94.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

awslabs_prometheus_mcp_server-0.2.3-py3-none-any.whl (20.9 kB view details)

Uploaded Python 3

File details

Details for the file awslabs_prometheus_mcp_server-0.2.3.tar.gz.

File metadata

File hashes

Hashes for awslabs_prometheus_mcp_server-0.2.3.tar.gz
Algorithm Hash digest
SHA256 ca2998064147f0ccf47e9cde2ab94ea18a24ee8a2b90d626babb0df1743b1cc5
MD5 7a81ddfb2863631bf348ecfd4e8ddb94
BLAKE2b-256 6d59683919444f98ad97270f8b3da009cca95d9a02b299c22a413b08a277cb32

See more details on using hashes here.

Provenance

The following attestation bundles were made for awslabs_prometheus_mcp_server-0.2.3.tar.gz:

Publisher: release.yml on awslabs/mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file awslabs_prometheus_mcp_server-0.2.3-py3-none-any.whl.

File metadata

File hashes

Hashes for awslabs_prometheus_mcp_server-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 0f12f1ea31048ecd1afc29b4a395ace1797e23694002adf1c3d4479cae01dc7d
MD5 8650563b4db1b7c1838c4a5d3b25c994
BLAKE2b-256 5198477beb7e9480ae2a5bbfe71a3a2414a423e99d39a474f51e0be400cfbda8

See more details on using hashes here.

Provenance

The following attestation bundles were made for awslabs_prometheus_mcp_server-0.2.3-py3-none-any.whl:

Publisher: release.yml on awslabs/mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page