KubeSphere

What is KubeSphere MCP Server?

The KubeSphere MCP Server is a Model Context Protocol (MCP) server designed to integrate with KubeSphere APIs. It enables users to access and manage resources within a KubeSphere cluster through a standardized protocol.

How to use KubeSphere MCP Server?

To use the KubeSphere MCP Server, you first need a KubeSphere cluster with its access address, username, and password. Installation involves generating a KSConfig file, similar to kubeconfig, which contains HTTP connector information for your KubeSphere instance. You then obtain the ks-mcp-server binary by building it from source (go build -o ks-mcp-server cmd/main.go) or downloading it from GitHub releases. Finally, you configure the MCP Server within an AI Agent like Claude Desktop or Cursor by specifying the ks-mcp-server command and providing the absolute path to your KSConfig file and the KubeSphere cluster address.

Key Features of KubeSphere MCP Server

KubeSphere API Integration: Seamlessly connects with KubeSphere APIs to retrieve resources.
Modular Design: Organized into four distinct modules for focused management:
- Workspace Management
- Cluster Management
- User and Roles
- Extensions Center
Model Context Protocol (MCP) Compliance: Adheres to the MCP standard for interoperability with AI Agents.
Configurable Access: Allows configuration of KubeSphere access details via a KSConfig file.

Use Cases of KubeSphere MCP Server

AI Agent Integration: Enables AI agents (e.g., Claude Desktop, Cursor) to interact with and manage KubeSphere resources programmatically.
Automated KubeSphere Operations: Facilitates automation of tasks within KubeSphere through external tools.
Centralized KubeSphere Resource Access: Provides a unified interface for accessing various KubeSphere functionalities.

FAQ from KubeSphere MCP Server

What are the prerequisites for using KubeSphere MCP Server? You must have a KubeSphere cluster with its access address, username, and password.
How do I generate a KSConfig file? The KSConfig file is a YAML configuration similar to kubeconfig, containing details like certificate-authority-data, server address, KubeSphere username, and password.
Can I use HTTP for KubeSphere access? While the KSConfig server field requires an HTTPS address, you can specify an HTTP KubeSphere address using the --ks-apiserver parameter during MCP Server configuration.
Where can I download the ks-mcp-server binary? You can download it from the GitHub releases page or build it from source.

KubeSphere MCP Server

The KubeSphere MCP Server is a Model Context Protocol(MCP) server that provides integration with KubeSphere APIs, enabling to get resources from KubeSphere. Divided into four tools modules: Workspace Management, Cluster Management, User and Roles, Extensions Center.

Prerequisites

You must have a KubeSphere cluster. contains: Access Address, Username, Password.

Installation

Generate KSConfig

The format is similar to kubeconfig. This configuration contains HTTP connector information. The default context for KubeSphere is kubesphere, which can be modified via the environment variable KUBESPHERE_CONTEXT.

apiVersion: v1
clusters:
- cluster:
    certificate-authority-data: <CA file>
    server: <Server Address>
  name: kubesphere
contexts:
- context:
    cluster: kubesphere
    user: admin
  name: kubesphere
current-context: kubesphere
kind: Config
preferences: {}
users:
- name: admin
  user:
    username: <KubeSphere Username>
    password: <KubeSphere Password>

<CA file>: Optional. Fill in the CA certificate in base64-encoded format when KubeSphere is accessed via HTTPS.
<Server Address>: Required Must be an HTTPS address. (If using HTTP, enter any HTTPS address here, then modify via the parameter --ks-apiserver http://xxx)
<KubeSphere Username>: Required The user for the KubeSphere cluster.
<KubeSphere Password>: Required The password for the KubeSphere cluster user.

Get ks-mcp-server binary

you can run command go build -o ks-mcp-server cmd/main.go or download from (github releases)[https://github.com/kubesphere/ks-mcp-server/releases] and then move it to $PATH.

Configuration MCP Server in AI Agent

Claude Desktop

According to Claude Desktop should change the MCP Configuration. like:

{
  "mcpServers": {
    "KubeSphere": {
      "args": [
        "stdio",
        "--ksconfig", "<ksconfig file absolute path>",
        "--ks-apiserver", "<KubeSphere Address>"
      ],
      "command": "ks-mcp-server"
    }
  }
}

<ksconfig file absolute path>: Required The absolute path of the ksconfig file.
<KubeSphere Address>: Optional (but required for HTTP access) The access address of the KubeSphere cluster, supporting either the ks-console or ks-apiserver service address (e.g., http://172.10.0.1:30880).

chat with mcp server

Cursor

According to Curosr should change the MCP Configuration. like:

{
  "mcpServers": {
    "KubeSphere": {
      "args": [
        "stdio",
        "--ksconfig", "<ksconfig file absolute path>",
        "--ks-apiserver", "<KubeSphere Address>"
      ],
      "command": "ks-mcp-server"
    }
  }
}

chat with mcp server

KubeSphere Overview