Kubectl MCP 工具使用指南

项目概述

此项目提供了一个名为 kubectl-mcp 的工具，用于与 Kubernetes 集群交互。该工具支持多种功能模块，包括诊断、核心操作、安全性监控以及自然语言处理等。

安装说明

1. 克隆仓库

git clone https://github.com/rohitg00/kubectl-mcp-server.git
cd kubectl-mcp-server

2. 安装依赖

pip install -r requirements.txt

3. 开发模式安装

pip install -e .

快速入门

核心功能模块

• 诊断模块：用于执行 Kubernetes 集群的健康检查和故障排查。
• 核心操作模块：提供基础的kubectl命令实现，如 get pods, describe nodes 等。
• 安全性模块：增强集群的安全性，包括身份验证、授权和加密等功能。
• 监控模块：集成监控工具，实时跟踪 Kubernetes 资源的状态。

自然语言处理

支持通过自然语言输入执行 Kubernetes 操作。例如：

kubectl mcp "显示所有运行中的pod"

使用示例

列出Pod

列出默认命名空间中所有正在运行的pod。

部署应用

创建一个名为 `nginx-test` 的部署，使用 `nginx:latest` 镜像，并设置 3 个副本。

查看日志

获取名为 `nginx-test` 的pod的日志输出。

端口转发

将本地的8080端口转发到pod的80端口。

进阶功能

自动配置

运行安装脚本以自动完成所有支持的AI助手配置：

bash install.sh

集成指南

• Helm 支持：通过 Helm v3 管理 Kubernetes 应用。
• 日志分析：集成日志收集工具，便于排查问题。

项目结构

├── kubectl_mcp_tool/         # 主程序包
│   ├── __init__.py           # 包初始化文件
│   ├── cli.py                # CLI 入口点
│   ├── mcp_server.py         # MCP 服务器实现
│   ├── mcp_kubectl_tool.py   # 主 kubectl MCP 工具实现
│   ├── natural_language.py   # 自然语言处理模块
│   ├── diagnostics.py        # 诊断功能模块
│   ├── core/                 # 核心功能模块 
│   ├── security/             # 安全操作模块
│   ├── monitoring/           # 监控功能模块
│   ├── utils/                # 工具函数包
│   └── cli/                  # CLI 功能组件
├── python_tests/             # 测试套件
│   ├── run_mcp_tests.py      # 测试运行器脚本
│   ├── mcp_client_simulator.py # MCP 客户端模拟器用于 mock 测试
│   ├── test_utils.py         # 测试工具包
│   ├── test_mcp_core.py      # 核心 MCP 测试
│   ├── test_mcp_security.py  # 安全性测试
│   ├── test_mcp_monitoring.py # 监控测试
│   ├── test_mcp_natural_language.py # 自然语言处理测试
│   └── test_mcp_diagnostics.py # 诊断功能测试
├── config/                   # 配置文件和示例
│   ├── kubectl-mcp-config.yaml # MCP 工具配置文件模板
│   └── example_usage.md       # 示例使用文档
└── scripts/                  # 脚本工具
    ├── install.sh            # 安装脚本
    └── setup_helm.sh         # Helm 集成脚本

项目依赖

• Python 版本：3.8+
• Kubernetes 版本：1.20+

贡献指南

欢迎社区贡献！请参考 CONTRIBUTING.md 了解如何参与开发。

许可证

MIT License

联系方式

• 邮箱：support@kubectl-mcp.org
• GitHub：https://github.com/rohitg00/kubectl-mcp-server