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

Install MCP Server

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.1.tar.gz (84.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.1-py3-none-any.whl (20.5 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for awslabs_prometheus_mcp_server-0.2.1.tar.gz
Algorithm Hash digest
SHA256 02d171201ba944f1ea5ba3f484a82e031e6c9d0d02877f3fe3b85b5cea1e635e
MD5 85d5adbbf5770c0f3d56cf5e979de30f
BLAKE2b-256 9cdd8dd1ea887fdb61c00b3612dc0be3bbaf7294b43447f891a9dbbf9e2aa0c4

See more details on using hashes here.

Provenance

The following attestation bundles were made for awslabs_prometheus_mcp_server-0.2.1.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.1-py3-none-any.whl.

File metadata

File hashes

Hashes for awslabs_prometheus_mcp_server-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 460bb3c51d19251525b9006e349293d85c3fd8f0aeeec6dda3bccd8c52450ce9
MD5 62995571da02e6df71a700dd6b70663d
BLAKE2b-256 7e494a4bc501bb85d9e7d85efd8ed0008b679fe91463a49b3e2598d7eb24fc4c

See more details on using hashes here.

Provenance

The following attestation bundles were made for awslabs_prometheus_mcp_server-0.2.1-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