Kubectl MCP Server

🚀 Kubectl MCP 工具使用指南

本項目提供的 kubectl-mcp 工具，可與 Kubernetes 集群進行交互。該工具具備多種功能模塊，涵蓋診斷、核心操作、安全性監控以及自然語言處理等，能有效提升 Kubernetes 集群的管理效率。

🚀 快速開始

核心功能模塊

• 診斷模塊：可對 Kubernetes 集群進行健康檢查和故障排查。
• 核心操作模塊：提供如 get pods、describe nodes 等基礎的 kubectl 命令實現。
• 安全性模塊：增強集群安全性，包含身份驗證、授權和加密等功能。
• 監控模塊：集成監控工具，即時跟蹤 Kubernetes 資源狀態。

自然語言處理

支持通過自然語言輸入執行 Kubernetes 操作，例如：

kubectl mcp "顯示所有運行中的pod"

✨ 主要特性

• 具備多種功能模塊，滿足不同場景下對 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 .

💻 使用示例

基礎用法

列出 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