Skip to main content

Kiali MCP Server (Model Context Protocol) with special support for OpenShift

Project description

Kiali MCP Server

GitHub License npm PyPI - Version GitHub release (latest SemVer) Build

https://github.com/user-attachments/assets/d88a3b72-980c-43db-a69a-a19ad564cf49

Kiali MCP Server is a thin extension of the upstream Kubernetes MCP Server. It adds Kiali-specific tooling while keeping the same core behavior and configuration.

  • Based on kubernetes-mcp-server (native Go MCP server for Kubernetes/OpenShift)
  • For the full set of tools and behavior adopted from upstream, see the upstream README: openshift/openshift-mcp-server README

✨ Features | 🚀 Getting Started | 🎥 Demos | ⚙️ Configuration | 🛠️ Tools | 🧑‍💻 Development

✨ Features

  • ✅ Istio Objects:
    • validations_list: Lists Istio object validations aggregated by namespace and cluster from a Kiali instance.

🚀 Getting Started

Requirements

  • Access to a Kubernetes or OpenShift cluster (kubeconfig or in-cluster service account)
  • A reachable Kiali server URL

Cursor

Install the Kubernetes MCP server extension in Cursor by pressing the following link:

Install MCP Server

Alternatively, you can install the extension manually by editing the mcp.json file:

{
  "mcpServers": {
    "kiali-mcp-server": {
      "command": "npx",
      "args": ["-y", "kiali-mcp-server@latest"]
    }
  }
}

Note: You must specify the Kiali endpoint if the MCP cannot detect it.You must also specify whether it should skip TLS.

{
  "mcpServers": {
    "kiali-mcp-server": {
      "command": "npx",
      "args": [
        "-y",
        "kiali-mcp-server@latest",
        "--kiali-server-url",
        "https://kiali-istio-system.apps-crc.testing/",
        "--kiali-insecure"
      ]
    }
  }
}

Configuration

Kiali MCP Server reuses the same configuration and flags as the upstream Kubernetes MCP Server. In addition, it adds the following Kiali-specific flags:

By default, Kubernetes and Kiali tools are exposed. If you want to only Kiali use this configuration

  • --toolsets: kiali

You can run the server via npx, uvx, or the compiled binary. Example using npx:

npx -y kiali-mcp-server@latest \
  --kiali-server-url "https://kiali-istio-system.apps-crc.testing/" \
  --kiali-insecure

Or using the binary after building:

./kiali-mcp-server \
  --kiali-server-url "https://kiali-istio-system.apps-crc.testing/" \
  --kiali-insecure

Refer to the upstream README for the rest of the flags and features (ports, auth, read-only, list output, etc.): openshift/openshift-mcp-server README

🛠️ Tools and Functionalities

The Kiali MCP server supports enabling or disabling specific groups of tools and functionalities (tools, resources, prompts, and so on) via the --toolsets command-line flag or toolsets configuration option. This allows you to control which Kubernetes functionalities are available to your AI tools. Enabling only the toolsets you need can help reduce the context size and improve the LLM's tool selection accuracy.

Available Toolsets

The following sets of tools are available (only Kiali by default):

Toolset Description
kiali Most common tools for managing Kiali

Tools

kiali
  • validations_list - List all the validations in the current cluster from all namespaces

    • namespace (string) - Optional single namespace to retrieve validations from (alternative to namespaces)
    • namespaces (string) - Optional comma-separated list of namespaces to retrieve validations from
  • graph - Check the status of my mesh by querying Kiali graph

    • namespace (string) - Optional single namespace to include in the graph (alternative to namespaces)
    • namespaces (string) - Optional comma-separated list of namespaces to include in the graph

🎥 Demos

In this video, we explore how the Mesh Control Plane (MCP) in Kubernetes/OpenShift works together with Kiali to validate Istio configuration objects directly in your editor (Cursor).

Cursor: Kiali-mcp-server running

🧑‍💻 Development

Running with mcp-inspector

Compile the project and run the Kiali MCP server with mcp-inspector to inspect the MCP server.

# Compile the project
make build
# Run the Kubernetes MCP server with mcp-inspector
npx @modelcontextprotocol/inspector@latest $(pwd)/kiali-mcp-server --kiali-server-url "https://kiali-istio-system.apps-crc.testing/" --kiali-insecure

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

kiali_mcp_server-0.2.0.tar.gz (5.0 kB view details)

Uploaded Source

Built Distribution

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

kiali_mcp_server-0.2.0-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

Details for the file kiali_mcp_server-0.2.0.tar.gz.

File metadata

  • Download URL: kiali_mcp_server-0.2.0.tar.gz
  • Upload date:
  • Size: 5.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.0

File hashes

Hashes for kiali_mcp_server-0.2.0.tar.gz
Algorithm Hash digest
SHA256 d602a3533da47a3e567df12a586608386f22046c9e865edd65490408a9423571
MD5 3a7bd9a9ca5412197d73717ba28375f4
BLAKE2b-256 f18111bd5e403e238042536e05d6852a2c59c699a90ce29efeb402e96b09a492

See more details on using hashes here.

File details

Details for the file kiali_mcp_server-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for kiali_mcp_server-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ffddf101280e784f81f61306d2ee073212badb3d53fcbdf66d00b385db4600b6
MD5 40404483b57359e92fc204632084fb69
BLAKE2b-256 3d7856160b25ebb7b63d416df8dd81dd2e898e51b5f90b63677d45a5126fd5b8

See more details on using hashes here.

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