MCP-K8S 项目文档

项目概述

MCP-K8S 是一个为 Kubernetes 和 Helm 提供支持的 MCP（机器学习平台）服务器。它能够处理 Kubernetes 资源操作和 Helm 包管理，并且可以通过两种传输模式与 MCP 客户端集成。

功能特性

• Kubernetes 资源操作：支持创建、更新、删除和列举 Kubernetes 资源。
• Helm 管理：支持 Helm 发版的列表、获取、安装、升级和卸载操作，以及 Helm 仓库的列表、添加和移除功能。
• 传输模式：
  • stdio 模式：直接在控制台运行并与 MCP 客户端集成。
  • SSE 模式：通过 HTTP 接口提供服务（注意安全）。

运行模式

1. 标准输入输出模式

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

2. SSE 模式

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

Docker 环境配置

SSE 模式示例

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

标准输入输出模式示例

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

快速上手

直接使用

从 发布页面 下载对应平台的二进制文件即可使用。

编译

git clone https://github.com/silenceper/mcp-k8s.git
cd mcp-k8s
go build -o bin/mcp-k8s cmd/server/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 包安装功能
• --enable-helm-upgrade：启用 Helm 包升级功能
• --enable-helm-uninstall：启用 Helm 包卸载功能
• --enable-helm-repo-list：启用 Helm 仓库列表功能（默认：true）
• --enable-helm-repo-add：启用 Helm 仓库添加功能
• --enable-helm-repo-remove：启用 Helm 仓库移除功能

SSE 模式配置

• --transport=sse：指定使用 SSE 模式
• --port=8080：指定服务监听端口（默认：8080）
• --host=localhost：指定服务绑定地址（默认：localhost）

微信公众号关注

如需了解更多信息，请扫描下方二维码关注我们的微信公众号：

注意：请确保在安全的网络环境下使用本项目，并妥善管理 Kubernetes 和 Helm 的权限配置。