Kubesphere

🚀 KubeSphere MCP Server

The KubeSphere MCP Server is a Model Context Protocol (MCP) server that integrates with the KubeSphere API, enabling resource retrieval from KubeSphere. It consists of four tool modules: Workspace Management, Cluster Management, Users and Roles, and Extension Center.

🚀 Quick Start

Prerequisites

You must have a KubeSphere cluster, including the access address, username, and 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. When accessing KubeSphere via HTTPS, fill in the Base64-encoded CA certificate.
• <Server address>: Required. Must be an HTTPS address. (If using HTTP, fill in any HTTPS address here and then modify it via the parameter --ks-apiserver http://xxx).
• <KubeSphere username>: Required. The user of the KubeSphere cluster.
• <KubeSphere password>: Required. The password of the KubeSphere user.

Obtain the ks-mcp-server Binary

You can run the command go build -o ks-mcp-server cmd/main.go or download it from GitHub Releases, and then move it to $PATH.

Configure the MCP Server in AI Agents

Claude Desktop

1. Modify the MCP configuration according to the requirements of Claude Desktop. For example:

{
  "mcpServers": {
    "KubeSphere": {
      "args": [
        "stdio",
        "--ksconfig", "<Absolute path to the ksconfig file>",
        "--ks-apiserver", "<KubeSphere address>"
      ],
      "command": "ks-mcp-server"
    }
  }
}

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

2. Chat using the MCP server

Cursor

1. Modify the MCP configuration according to the requirements of Cursor. For example:

{
  "mcpServers": {
    "KubeSphere": {
      "args": [
        "stdio",
        "--ksconfig", "<Absolute path to the ksconfig file>",
        "--ks-apiserver", "<KubeSphere address>"
      ],
      "command": "ks-mcp-server"
    }
  }
}

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

2. Chat using the MCP server