Mcp K8s

什么是 MCP-K8s？

MCP-K8s，即 Kubernetes 的模型控制协议，是一个旨在通过各种 MCP 工具促进与 Kubernetes 集群交互的服务器。该项目旨在简化 Kubernetes 资源的管理和编排，使开发人员和运维人员能够更轻松地在云原生环境中部署和管理应用程序。

MCP-K8s 的特点

• 无缝集成：MCP-K8s 可以与现有的 Kubernetes 集群无缝集成，使用户能够在不进行重大更改的情况下利用现有基础设施。
• 用户友好的界面：该项目提供了一个简单明了的界面来管理 Kubernetes 资源，使所有技能水平的用户都能轻松访问。
• 可扩展架构：MCP-K8s 在设计时考虑了可扩展性，允许开发人员根据需要添加自定义功能和工具。
• 强大的文档：提供全面的文档，指导用户安装、配置和使用 MCP-K8s 服务器。
• 社区支持：作为一个开源项目，MCP-K8s 受益于一个充满活力的社区，该社区为其开发做出贡献并为用户提供支持。

如何使用 MCP-K8s

1. 安装：首先从 GitHub 克隆 MCP-K8s 仓库。使用以下命令：

   git clone https://github.com/silenceper/mcp-k8s.git
   

2. 配置：克隆后，导航到项目目录，并根据您的 Kubernetes 集群要求配置服务器设置。
3. 运行服务器：使用提供的脚本或命令启动 MCP-K8s 服务器。确保您的 Kubernetes 集群正在运行并且可访问。
4. 与集群交互：利用 MCP 工具与您的 Kubernetes 资源进行交互。您可以通过 MCP-K8s 界面部署应用程序、管理服务和监控集群健康。
5. 扩展功能：如有需要，探索可扩展性选项，以添加自定义功能或集成适合您工作流程的其他工具。

常见问题解答

Q1: MCP-K8s 的主要目的是什么？

A1: MCP-K8s 的主要目的是提供一个服务器，使用户能够通过各种工具轻松与 Kubernetes 集群交互，从而简化 Kubernetes 资源的管理。

Q2: MCP-K8s 适合初学者吗？

A2: 是的，MCP-K8s 设计了用户友好的界面和强大的文档，使其对不同经验水平的用户都易于访问。

Q3: 我可以为 MCP-K8s 项目做贡献吗？

A3: 当然可以！MCP-K8s 是一个开源项目，欢迎贡献。您可以通过报告问题、提交拉取请求或改善文档来参与。

Q4: 我在哪里可以找到有关 MCP-K8s 的更多信息？

A4: 更多信息，包括安装指南和使用说明，可以在 官方 MCP-K8s 文档页面 找到。

Q5: MCP-K8s 使用什么许可证？

A5: MCP-K8s 采用 Apache-2.0 许可证，允许在适当归属的情况下进行个人和商业使用。

mcp-k8s

A Kubernetes MCP (Model Control Protocol) server that enables interaction with Kubernetes clusters through MCP tools.

Features

• Query supported Kubernetes resource types (built-in resources and CRDs)
• Kubernetes resource operations with fine-grained control
  • Read operations: get resource details, list resources by type with filtering options
  • Write operations: create, update, and delete resources (each can be independently enabled/disabled)
  • Support for all Kubernetes resource types, including custom resources
• Connects to Kubernetes cluster using kubeconfig
• Helm support with fine-grained control
  • Helm releases management (list, get, install, upgrade, uninstall)
  • Helm repositories management (list, add, remove)
  • Each operation can be independently enabled/disabled

Preview

Interaction through cursor

Use Cases

1. Kubernetes Resource Management via LLM

• Interactive Resource Management: Manage Kubernetes resources through natural language interaction with LLM, eliminating the need to memorize complex kubectl commands
• Batch Operations: Describe complex batch operation requirements in natural language, letting LLM translate them into specific resource operations
• Resource Status Queries: Query cluster resource status using natural language and receive easy-to-understand responses

2. Automated Operations Scenarios

• Intelligent Operations Assistant: Serve as an intelligent assistant for operators in daily cluster management tasks
• Problem Diagnosis: Assist in cluster problem diagnosis through natural language problem descriptions
• Configuration Review: Leverage LLM's understanding capabilities to help review and optimize Kubernetes resource configurations

3. Development and Testing Support

• Quick Prototype Validation: Developers can quickly create and validate resource configurations through natural language
• Environment Management: Simplify test environment resource management, quickly create, modify, and clean up test resources
• Configuration Generation: Automatically generate resource configurations that follow best practices based on requirement descriptions

4. Education and Training Scenarios

• Interactive Learning: Newcomers can learn Kubernetes concepts and operations through natural language interaction
• Best Practice Guidance: LLM provides best practice suggestions during resource operations
• Error Explanation: Provide easy-to-understand error explanations and correction suggestions when operations fail

Architecture

1. Project Overview

An stdio-based MCP server that connects to Kubernetes clusters and provides the following capabilities:

• Query Kubernetes resource types (including built-in resources and CRDs)
• CRUD operations on Kubernetes resources (with configurable write operations)
• Helm operations for release and repository management

2. Technical Stack

• Go
• mcp-go SDK
• Kubernetes client-go library
• Helm v3 client library
• Stdio for communication

3. Core Components

1. MCP Server: Uses mcp-go's mcp-k8s package to create an stdio-based MCP server
2. K8s Client: Uses client-go to connect to Kubernetes clusters
3. Helm Client: Uses Helm v3 library for Helm operations
4. Tool Implementations: Implements various MCP tools for different Kubernetes operations

4. Available Tools

Resource Type Query Tools

• get_api_resources: Get all supported API resource types in the cluster

Resource Operation Tools

• get_resource: Get detailed information about a specific resource
• list_resources: List all instances of a resource type
• create_resource: Create new resources (can be disabled)
• update_resource: Update existing resources (can be disabled)
• delete_resource: Delete resources (can be disabled)

Helm Operation Tools

• list_helm_releases: List all Helm releases in the cluster
• get_helm_release: Get detailed information about a specific Helm release
• install_helm_chart: Install a Helm chart (can be disabled)
• upgrade_helm_chart: Upgrade a Helm release (can be disabled)
• uninstall_helm_chart: Uninstall a Helm release (can be disabled)
• list_helm_repositories: List configured Helm repositories
• add_helm_repository: Add a new Helm repository (can be disabled)
• remove_helm_repository: Remove a Helm repository (can be disabled)

Usage

mcp-k8s supports two communication modes:

1. Stdio Mode (Default)

In stdio mode, mcp-k8s communicates with the client through standard input/output streams. This is the default mode and is suitable for most use cases.

### Run in stdio mode (default)
{
    "mcpServers":
    {
        "mcp-k8s":
        {
            "command": "/path/to/mcp-k8s",
            "args":
            [
                "-kubeconfig",
                "/path/to/kubeconfig",
                "-enable-create",
                "-enable-delete",
                "-enable-update",
                "-enable-list",
                "-enable-helm-install",
                "-enable-helm-upgrade"
            ]
        }
    }
}

2. SSE Mode

In SSE (Server-Sent Events) mode, mcp-k8s exposes an HTTP endpoint to mcp client. You can deploy the service on a remote server (but you need to pay attention to security)

### Run in SSE mode
./bin/mcp-k8s -kubeconfig=/path/to/kubeconfig -transport=sse -port=8080 -host=localhost -enable-create -enable-delete -enable-list -enable-update -enable-helm-install
### This command will open all operations

mcp config

{
  "mcpServers": {
    "mcp-k8s": {
      "url": "http://localhost:8080/sse",
      "args": []
    }
  }
}

SSE mode configuration:

• -transport: Set to "sse" to enable SSE mode
• -port: HTTP server port (default: 8080)
• --host: HTTP server host (default: "localhost")

3. Docker environment

SSE Mode

1. Complete Example Assuming your image name is mcp-k8s and you need to map ports and set environment parameters, you can run:

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

stdio Mode

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

Getting Started

Direct Usage

You can directly download the binary for your platform from the releases page and use it immediately.

Go Install

go install github.com/silenceper/mcp-k8s/cmd/mcp-k8s@latest

Build

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

Command Line Arguments

Kubernetes Resource Operations

• -kubeconfig: Path to Kubernetes configuration file (uses default config if not specified)
• -enable-create: Enable resource creation operations (default: false)
• -enable-update: Enable resource update operations (default: false)
• -enable-delete: Enable resource deletion operations (default: false)
• -enable-list: Enable resource list operations (default: true)

Helm Operations

• -enable-helm-release-list: Enable Helm release list operations (default: true)
• -enable-helm-release-get: Enable Helm release get operations (default: true)
• -enable-helm-install: Enable Helm chart installation (default: false)
• -enable-helm-upgrade: Enable Helm chart upgrade (default: false)
• -enable-helm-uninstall: Enable Helm chart uninstallation (default: false)
• -enable-helm-repo-list: Enable Helm repository list operations (default: true)
• -enable-helm-repo-add: Enable Helm repository add operations (default: false)
• -enable-helm-repo-remove: Enable Helm repository remove operations (default: false)

Transport Configuration

• -transport: Transport type (stdio or sse) (default: "stdio")
• -host: Host for SSE transport (default "localhost")
• -port: TCP port for SSE transport (default 8080)

Integration with MCP Clients

mcp-k8s is an stdio-based MCP server that can be integrated with any MCP-compatible LLM client. Refer to your MCP client's documentation for integration instructions.

Security Considerations

• Write operations are strictly controlled through independent configuration switches
• Uses RBAC to ensure K8s client has only necessary permissions
• Validates all user inputs to prevent injection attacks
• Helm operations follow the same security principles with read operations enabled by default and write operations disabled by default

Follow WeChat Official Account