MCP Kubernetes 服务器

一个 Kubernetes 管理 MCP (模型上下文协议) 服务器，提供用于获取 Kubernetes 集群信息、执行操作、监控状态和分析资源的接口。

功能

• 集群信息: 获取关于 Kubernetes 资源的详细信息 (Pod、Deployment、Service 等)。
• 集群操作: 对 Kubernetes 资源执行操作 (创建、更新、删除、伸缩等)。
• 监控: 监控 Kubernetes 集群和资源的状态。
• 分析: 分析 Kubernetes 资源并提供建议。
• 提示: 包含用于常见 Kubernetes 分析任务的提示。

安装

从源码安装

git clone https://github.com/yourusername/mcp-k8s-server.git
cd mcp-k8s-server
pip install -e .

使用 pip 安装

pip install mcp-k8s-server

使用方法

直接运行

# 使用默认设置运行
mcp-k8s-server

# 指定传输类型
mcp-k8s-server --transport sse

# 指定 SSE 传输的端口
mcp-k8s-server --port 8000

# 指定配置文件
mcp-k8s-server --config /path/to/config.yaml

使用 Docker

Dockerfile 使用 command 和 args 模式来运行服务器：

CMD ["python", "-m", "mcp_k8s_server.main", \
     "--transport", "sse", \
     "--port", "8000", \
     "--host", "0.0.0.0", \
     "--config", "/etc/rancher/rke2/rke2.yaml", \
     "--debug"]

构建并运行 Docker 容器：

# 构建 Docker 镜像
docker build -t mcp-k8s-server .

# 运行 Docker 容器
docker run -p 8000:8000 -v ~/.kube:/home/mcp/.kube mcp-k8s-server

或者，您可以使用提供的脚本：

# 使脚本可执行
chmod +x docker-run.sh

# 运行脚本
./docker-run.sh

此脚本构建 Docker 镜像并使用必要的卷挂载运行容器。

部署到 Kubernetes

# 应用 Kubernetes 清单
kubectl apply -f k8s/

部署到 Kubernetes 时，服务器将自动使用集群内配置。 k8s/ 目录中的 Kubernetes 清单设置为：

1. 创建具有适当权限的 ServiceAccount
2. 挂载服务帐户令牌和证书
3. 使用命令行参数配置服务器

您可以通过编辑清单来自定义部署：

# k8s/deployment.yaml (示例)
apiVersion: apps/v1
kind: Deployment
metadata:
  name: mcp-k8s-server
  # ...
spec:
  # ...
  template:
    # ...
    spec:
      serviceAccountName: mcp-k8s-server  # 使用 rbac.yaml 中定义的 ServiceAccount
      containers:
      - name: mcp-k8s-server
        # ...
        command:
        - python
        - -m
        - mcp_k8s_server.main
        args:
        - --transport
        - sse
        - --port
        - "8000"
        - --host
        - "0.0.0.0"
        - --config
        - "/app/config/config.yaml"
        - --debug

此方法使用 command 和 args 模式来配置服务器，这是 Kubernetes 中的常见模式。 command 指定要运行的可执行文件，args 指定要传递给可执行文件的命令行参数。

KUBERNETES_SERVICE_HOST 和 KUBERNETES_SERVICE_PORT 环境变量在创建 Pod 时由 Kubernetes 自动设置，因此您无需在部署清单中指定它们。

配置

可以使用 YAML 配置文件、环境变量或命令行参数配置服务器。

集群内配置

在 Kubernetes 集群内部运行时，服务器会自动使用集群内配置。 这依赖于以下内容：

1. 环境变量：

   • KUBERNETES_SERVICE_HOST: 由 Kubernetes 设置为 Kubernetes API 服务器的 IP 地址
   • KUBERNETES_SERVICE_PORT: 由 Kubernetes 设置为 Kubernetes API 服务器的端口

2. 服务帐户令牌和证书：

   • /var/run/secrets/kubernetes.io/serviceaccount/token: 服务帐户令牌
   • /var/run/secrets/kubernetes.io/serviceaccount/ca.crt: CA 证书

这些在 Pod 中运行时由 Kubernetes 自动设置。 如果您在 Kubernetes 集群外部运行服务器但想测试集群内配置，则需要手动设置这些环境变量并创建令牌和证书文件。

在集群外部运行时，服务器会回退到使用 kubeconfig 文件。

在本地测试集群内配置

如果您想在本地（Kubernetes 集群外部）测试集群内配置，您可以手动设置所需的环境变量和文件：

1. 设置环境变量：

   export KUBERNETES_SERVICE_HOST=<kubernetes-api-server-ip>
   export KUBERNETES_SERVICE_PORT=<kubernetes-api-server-port>
   

   您可以通过运行以下命令获取这些值：

   kubectl cluster-info
   

2. 创建服务帐户令牌和证书目录：

   mkdir -p /var/run/secrets/kubernetes.io/serviceaccount/
   

3. 复制您的 Kubernetes 证书并创建一个令牌：

   # 复制 CA 证书
   kubectl config view --raw -o jsonpath='{.clusters[0].cluster.certificate-authority-data}' | base64 -d > /var/run/secrets/kubernetes.io/serviceaccount/ca.crt
   
   # 创建一个令牌文件（您可以使用服务帐户令牌或生成一个临时令牌）
   echo "your-service-account-token" > /var/run/secrets/kubernetes.io/serviceaccount/token
   

请注意，此方法需要 root 权限才能在 /var/run/secrets/ 中创建文件。 或者，您可以修改代码以使用不同的路径进行测试。

配置文件

# config.yaml
server:
  name: mcp-k8s-server
  transport: both  # stdio, sse, or both
  port: 8000
  host: 0.0.0.0

kubernetes:
  config_path: ~/.kube/config
  context: default
  namespace: default

MCP 资源

服务器通过模型上下文协议 (MCP) 提供对 Kubernetes 资源的访问。 资源由遵循 k8s:// 协议的 URI 模式标识。

资源 URI 模式

资源以分层结构组织：

• k8s://resources - 所有可用的 Kubernetes 资源列表
• k8s://namespaces - 所有 Kubernetes 命名空间列表
• k8s:///{namespace} - 命名空间中所有资源的概述

命名空间资源

• k8s://{namespace}/{resource_type} - 列出命名空间中特定类型的资源

  • 示例：k8s://default/pods - 'default' 命名空间中的所有 Pod

• k8s://{namespace}/{resource_type}/{name} - 获取特定的命名空间资源

  • 示例：k8s://default/deployments/nginx - 'default' 命名空间中的 'nginx' Deployment

支持的资源类型：

• pods
• deployments
• services
• persistentvolumeclaims
• events

集群范围资源

• k8s:///{resource_type} - 列出特定类型的集群范围资源

  • 示例：k8s:///nodes - 集群中的所有节点

• k8s:///{resource_type}/{name} - 获取特定的集群范围资源

  • 示例：k8s:///nodes/worker-1 - 'worker-1' 节点

支持的资源类型：

• nodes
• persistentvolumes
• namespaces

MCP 工具

服务器提供以下 MCP 工具：

资源信息

• get_resources: 获取特定类型的资源列表
• get_resource: 获取关于特定资源的详细信息
• get_resource_status: 获取特定资源的状态
• get_resource_events: 获取与特定资源相关的事件
• get_resource_logs: 获取特定资源的日志

资源操作

• create_resource: 创建新资源
• update_resource: 更新现有资源
• delete_resource: 删除资源
• scale_deployment: 伸缩 Deployment
• restart_deployment: 重启 Deployment
• execute_command: 在 Pod 中执行命令

监控

• get_cluster_status: 获取集群的整体状态
• get_node_status: 获取集群节点的状态
• get_resource_metrics: 获取特定资源的指标
• get_cluster_metrics: 获取整个集群的指标
• check_cluster_health: 对集群执行全面的健康检查并获取详细摘要

许可证

MIT