MCP K8s

🚀 MCP-K8S Project Documentation

MCP-K8S is an MCP (Machine Learning Platform) server that provides support for Kubernetes and Helm. It can handle Kubernetes resource operations and Helm package management, and can be integrated with MCP clients through two transport modes.

✨ Features

• Kubernetes Resource Operations: Supports creating, updating, deleting, and listing Kubernetes resources.
• Helm Management: Supports operations such as listing, getting, installing, upgrading, and uninstalling Helm releases, as well as listing, adding, and removing Helm repositories.
• Transport Modes:
  • stdio Mode: Runs directly in the console and integrates with MCP clients.
  • SSE Mode: Provides services through HTTP interfaces (pay attention to security).

🚀 Quick Start

Direct Use

Download the binary file for your platform from the Releases page and you're ready to go.

Compilation

git clone https://github.com/silenceper/mcp-k8s.git
cd mcp-k8s
go build -o bin/mcp-k8s cmd/server/main.go

📦 Installation

Running Modes

1. Standard Input/Output Mode

./bin/mcp-k8s --kubeconfig=/path/to/kubeconfig [--enable-create] [--enable-update] [--enable-delete] [--enable-list]

2. SSE Mode

./bin/mcp-k8s --transport=sse --port=8080 --host=localhost [--enable-create] [--enable-update] [--enable-delete] [--enable-list] [--enable-helm-install] [--enable-helm-upgrade]

Docker Environment Configuration

SSE Mode Example

docker run --rm -p 8080:8080 -i -v ~/.kube/config:/root/.kube/config ghcr.io/silenceper/mcp-k8s:latest --transport=sse

Standard Input/Output Mode Example

{
  "mcpServers": {
    "mcp-k8s": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "-v",
        "~/.kube/config:/root/.kube/config",
        "--rm",
        "ghcr.io/silenceper/mcp-k8s:latest"
      ]
    }
  }
}

📚 Documentation

Command-Line Parameter Explanation

Kubernetes Resource Operations

• --kubeconfig: Specify the path to the Kubernetes configuration file (uses environment variable configuration by default).
• --enable-create: Enable the resource creation function (default: false).
• --enable-update: Enable the resource update function (default: false).
• --enable-delete: Enable the resource deletion function (default: false).
• --enable-list: Enable the resource listing function (default: true).

Helm Operations

• --enable-helm-release-list: Enable the Helm release listing function (default: true).
• --enable-helm-release-get: Enable the Helm release information retrieval function (default: true).
• --enable-helm-install: Enable the Helm package installation function.
• --enable-helm-upgrade: Enable the Helm package upgrade function.
• --enable-helm-uninstall: Enable the Helm package uninstallation function.
• --enable-helm-repo-list: Enable the Helm repository listing function (default: true).
• --enable-helm-repo-add: Enable the Helm repository addition function.
• --enable-helm-repo-remove: Enable the Helm repository removal function.

SSE Mode Configuration

• --transport=sse: Specify to use the SSE mode.
• --port=8080: Specify the service listening port (default: 8080).
• --host=localhost: Specify the service binding address (default: localhost).

WeChat Official Account

Scan the QR code below to follow our WeChat official account for more information:

⚠️ Important Note

Please ensure that you use this project in a secure network environment and properly manage the permission configurations of Kubernetes and Helm.