openshift-assisted/assisted-service-mcp

Assisted Service MCP Server

MCP server for interacting with the OpenShift assisted installer API.

Diagnose cluster failures and find out how to fix them.

Try it out:

1. Clone the repo:

git clone git@github.com:openshift-assisted/assisted-service-mcp.git

2. Get your OpenShift API token from https://cloud.redhat.com/openshift/token

3. The server is started and configured differently depending on what transport you want to use

For STDIO:

In VSCode for example:

   "mcp": {
        "servers": {
            "AssistedService": {
                "command": "uv",
                "args": [
                    "--directory",
                    "/path/to/assisted-service-mcp",
                    "run",
                    "mcp",
                    "run",
                    "/path/to/assisted-service-mcp/server.py"
                ],
                "env": {
                    "OFFLINE_TOKEN": <your token>
                }
            }
        }
    }

For SSE (recommended):

Start the server in a terminal:

OFFLINE_TOKEN=<your token> uv run server.py

Configure the server in the client:

    "assisted-sse": {
      "transport": "sse",
      "url": "http://localhost:8000/sse"
    }

Providing the Offline Token via Request Header

If you do not set the OFFLINE_TOKEN environment variable, you can provide the token as a request header. When configuring your MCP client, add the OCM-Offline-Token header:

    "assisted-sse": {
      "transport": "sse",
      "url": "http://localhost:8000/sse",
      "headers": {
        "OCM-Offline-Token": "<your token>"
      }
    }

4. Ask about your clusters:

Available Tools

The MCP server provides the following tools for interacting with the OpenShift Assisted Installer:

Cluster Management

• list_clusters - Lists all current user assisted installer clusters. Returns minimal cluster information.

• cluster_info - Get detailed information about the assisted installer cluster with the given ID

  • cluster_id: Cluster ID (string, required)

• create_cluster - Create a new assisted installer cluster and infraenv. Set single_node to true only for single node clusters or when high availability is not needed. Returns cluster ID and infraenv ID as JSON.

  • name: Cluster name (string, required)
  • version: OpenShift version (string, required)
  • base_domain: Base domain for the cluster (string, required)
  • single_node: Whether to create a single node cluster (boolean, required)
  • ssh_public_key: SSH public key for accessing cluster nodes (string, optional)

• install_cluster - Trigger installation for the assisted installer cluster with the given ID

  • cluster_id: Cluster ID (string, required)

• set_cluster_vips - Set the API and ingress virtual IP addresses (VIPs) for the cluster

  • cluster_id: Cluster ID (string, required)
  • api_vip: API virtual IP address (string, required)
  • ingress_vip: Ingress virtual IP address (string, required)

Events and Monitoring

• cluster_events - Get the events related to a cluster with the given ID

  • cluster_id: Cluster ID (string, required)

• host_events - Get the events related to a specific host within a cluster

  • cluster_id: Cluster ID (string, required)
  • host_id: Host ID (string, required)

ISO Download URL

• cluster_iso_download_url - Get ISO download URL(s) for a cluster. A formatted string containing ISO download URLs and optional expiration times. Each ISO's information is formatted as:
  • URL:
  • Expires at: (if available) Multiple ISOs are separated by blank lines.
  • cluster_id: Cluster ID (string, required)

Host Management

• set_host_role - Update a host to a specific role. Role options are: 'auto-assign', 'master', 'arbiter', 'worker'
  • host_id: Host ID (string, required)
  • infraenv_id: Infrastructure environment ID (string, required)
  • role: Host role (string, required)

SSH Key Management

• set_cluster_ssh_key - Set or update the SSH public key for a cluster. This allows SSH access to cluster nodes during and after installation.
  • cluster_id: Cluster ID (string, required)
  • ssh_public_key: SSH public key in OpenSSH format (string, required)

OpenShift Versions and Operators

• list_versions - Lists the available OpenShift versions for installation with the assisted installer

• list_operator_bundles - Lists the operator bundles that can be optionally added to a cluster during installation

• add_operator_bundle_to_cluster - Request an operator bundle to be installed with the given cluster

  • cluster_id: Cluster ID (string, required)
  • bundle_name: Operator bundle name (string, required)

Usage Examples

• List all clusters: "Show me all my clusters"
• Get cluster details: "Give me detailed information about cluster abc123"
• Create a cluster: "Create a new cluster named 'my-cluster' with OpenShift 4.14 and base domain 'example.com'"
• Check cluster events: "What events happened on cluster abc123?"
• Install a cluster: "Start the installation for cluster abc123"
• Get cluster credentials: "Get the kubeconfig download link for cluster abc123"
• Update SSH key: "Set the SSH key for cluster abc123 so I can access the nodes"

Prometheus Metrics

The MCP server exposes Prometheus metrics to monitor tool usage and performance. The metrics are available at http://localhost:8000/metrics when the server is running.

Available Metrics

• assisted_service_mcp_tool_request_count - Number of tool requests.
• assisted_service_mcp_tool_request_duration_sum - Total time to run the tool, in seconds.
• assisted_service_mcp_tool_request_duration_count - Total number of tool requests measured.
• assisted_service_mcp_tool_request_duration_bucket - Number of tool requests organized in buckets.

Metric Labels

All metrics include the following label:

• tool - The name of the tool, for example cluster_info, list_clusters, etc.