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. 擴展功能：如有需要，探索可擴展性選項以添加自定義功能或集成適合您工作流程的其他工具。

常見問題解答

問題 1：MCP-K8s 的主要目的是什么？

回答 1：MCP-K8s 的主要目的是提供一個伺服器，使通過各種工具輕鬆與 Kubernetes 集群互動，簡化 Kubernetes 資源的管理。

問題 2：MCP-K8s 適合初學者嗎？

回答 2：是的，MCP-K8s 設計有友好的用戶界面和強大的文檔，使其對不同經驗水平的用戶都能輕鬆訪問。

問題 3：我可以為 MCP-K8s 項目做貢獻嗎？

回答 3：當然可以！MCP-K8s 是一個開源項目，歡迎貢獻。您可以通過報告問題、提交拉取請求或改善文檔來參與。

問題 4：我可以在哪裡找到有關 MCP-K8s 的更多信息？

回答 4：有關安裝指南和使用說明的更多信息，可以在 官方 MCP-K8s 文檔頁面 上找到。

問題 5：MCP-K8s 使用什麼許可證？

回答 5：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