STARWARCLOUD STARWAR.AI
返回市场
麦克佩斯-K8S

麦克佩斯-K8S

作者：silenceper129 星标更新：2025-11-20
安装使用来源：spider==github.com

项目介绍

mcp-k8s

Go 版本 许可证 最新版本 Go 报告卡 Go CI 欢迎 PR

一个 Kubernetes MCP（模型控制协议）服务器，通过 MCP 工具与 Kubernetes 集群进行交互。

功能

  • 查询支持的 Kubernetes 资源类型（内置资源和 CRD）
  • 具有细粒度控制的 Kubernetes 资源操作
    • 读取操作：获取资源详情，按类型列出资源并提供过滤选项
    • 写入操作：创建、更新和删除资源（每个操作可以独立启用/禁用）
    • 支持所有 Kubernetes 资源类型，包括自定义资源
  • 使用 kubeconfig 连接到 Kubernetes 集群
  • 具有细粒度控制的 Helm 支持
    • Helm 发布管理（列表、获取、安装、升级、卸载）
    • Helm 仓库管理（列表、添加、移除）
    • 每个操作可以独立启用/禁用

预览

通过光标进行交互

使用场景

1. 通过 LLM 管理 Kubernetes 资源

  • 交互式资源管理：通过自然语言与 LLM 交互来管理 Kubernetes 资源，无需记忆复杂的 kubectl 命令
  • 批量操作：使用自然语言描述复杂的批量操作需求，让 LLM 将其转换为具体的资源操作
  • 资源状态查询：使用自然语言查询集群资源状态，并接收易于理解的响应

2. 自动化操作场景

  • 智能操作助手：作为日常集群管理任务中的智能助手
  • 问题诊断：通过自然语言问题描述协助集群问题诊断
  • 配置审查：利用 LLM 的理解能力帮助审查和优化 Kubernetes 资源配置

3. 开发和测试支持

  • 快速原型验证：开发者可以通过自然语言快速创建和验证资源配置
  • 环境管理：简化测试环境资源管理，快速创建、修改和清理测试资源
  • 配置生成：根据需求描述自动生成遵循最佳实践的资源配置

4. 教育和培训场景

  • 交互式学习：新手可以通过自然语言交互学习 Kubernetes 概念和操作
  • 最佳实践指导：LLM 在资源操作过程中提供最佳实践建议
  • 错误解释：当操作失败时，提供易于理解的错误解释和纠正建议

架构

1. 项目概述

一个基于 stdio 的 MCP 服务器，连接到 Kubernetes 集群并提供以下功能：

  • 查询 Kubernetes 资源类型（包括内置资源和 CRD）
  • Kubernetes 资源的 CRUD 操作（写操作可配置）
  • Helm 操作用于发布和仓库管理

2. 技术栈

  • Go
  • mcp-go SDK
  • Kubernetes client-go 库
  • Helm v3 客户端库
  • 使用 stdio 进行通信

3. 核心组件

  1. MCP 服务器：使用 mcp-go 的 mcp-k8s 包创建基于 stdio 的 MCP 服务器
  2. K8s 客户端：使用 client-go 连接到 Kubernetes 集群
  3. Helm 客户端：使用 Helm v3 库进行 Helm 操作
  4. 工具实现：实现各种 MCP 工具以支持不同的 Kubernetes 操作

4. 可用工具

资源类型查询工具

  • get_api_resources：获取集群中所有支持的 API 资源类型

资源操作工具

  • get_resource：获取特定资源的详细信息
  • list_resources：列出某种资源类型的实例
  • create_resource：创建新资源（可禁用）
  • update_resource：更新现有资源（可禁用）
  • delete_resource：删除资源（可禁用）

Helm 操作工具

  • list_helm_releases：列出集群中的所有 Helm 发布
  • get_helm_release：获取特定 Helm 发布的详细信息
  • install_helm_chart：安装 Helm 图表（可禁用）
  • upgrade_helm_chart：升级 Helm 发布（可禁用）
  • uninstall_helm_chart：卸载 Helm 发布（可禁用）
  • list_helm_repositories：列出已配置的 Helm 仓库
  • add_helm_repository：添加新的 Helm 仓库（可禁用）
  • remove_helm_repository：移除 Helm 仓库（可禁用）

使用方法

mcp-k8s 支持两种通信模式：

1. Stdio 模式（默认）

在 stdio 模式下，mcp-k8s 通过标准输入/输出流与客户端通信。这是默认模式，适用于大多数使用场景。

# 在 stdio 模式下运行（默认）
{
    "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 模式

在 SSE（服务器发送事件）模式下，mcp-k8s 向 mcp 客户端暴露一个 HTTP 端点。你可以将服务部署在远程服务器上（但需要注意安全性）

# 在 SSE 模式下运行
./bin/mcp-k8s -kubeconfig=/path/to/kubeconfig -transport=sse -port=8080 -host=localhost -enable-create -enable-delete -enable-list -enable-update -enable-helm-install
# 此命令将开启所有操作

mcp 配置

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

SSE 模式配置：

  • -transport：设置为 "sse" 以启用 SSE 模式
  • -port：HTTP 服务器端口（默认：8080）
  • --host：HTTP 服务器主机（默认："localhost"）

3. Docker 环境

SSE 模式

  1. 完整示例 假设你的镜像名称是 mcp-k8s 并且你需要映射端口和设置环境参数，可以运行：
docker run --rm -p 8080:8080 -i -v ~/.kube/config:/root/.kube/config ghcr.io/silenceper/mcp-k8s:latest -transport=sse

stdio 模式

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

快速开始

直接使用

你可以直接从 发布页面 下载适用于你平台的二进制文件并立即使用。

Go 安装

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

构建

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

命令行参数

Kubernetes 资源操作

  • -kubeconfig：Kubernetes 配置文件路径（未指定时使用默认配置）
  • -enable-create：启用资源创建操作（默认：false）
  • -enable-update：启用资源更新操作（默认：false）
  • -enable-delete：启用资源删除操作（默认：false）
  • -enable-list：启用资源列表操作（默认：true）

Helm 操作

  • -enable-helm-release-list：启用 Helm 发布列表操作（默认：true）
  • -enable-helm-release-get：启用 Helm 发布获取操作（默认：true）
  • -enable-helm-install：启用 Helm 图表安装（默认：false）
  • -enable-helm-upgrade：启用 Helm 图表升级（默认：false）
  • -enable-helm-uninstall：启用 Helm 图表卸载（默认：false）
  • -enable-helm-repo-list：启用 Helm 仓库列表操作（默认：true）
  • -enable-helm-repo-add：启用 Helm 仓库添加操作（默认：false）
  • -enable-helm-repo-remove：启用 Helm 仓库移除操作（默认：false）

传输配置

  • -transport：传输类型（stdio 或 sse）（默认："stdio"）
  • -host：SSE 传输的主机（默认 "localhost"）
  • -port：SSE 传输的 TCP 端口（默认 8080）

与 MCP 客户端集成

mcp-k8s 是一个基于 stdio 的 MCP 服务器，可以与任何兼容 MCP 的 LLM 客户端集成。请参阅您的 MCP 客户端文档以获取集成说明。

安全注意事项

  • 通过独立配置开关严格控制写操作
  • 使用 RBAC 确保 K8s 客户端只有必要的权限
  • 验证所有用户输入以防止注入攻击
  • Helm 操作遵循相同的安全部署原则，默认启用读操作，禁用写操作

关注微信公众号

AI技术小林