K8s MCP Server

🚀 Kubernetes MCP 服務器

Kubernetes MCP 服務器是一個靈活的機器通信協議（MCP）服務器，它提供了與 Kubernetes 的接口，支持自動檢測擴展腳本參數、Pydantic 模型支持等多種功能，能有效提升系統的兼容性與擴展性。

🚀 快速開始

在使用 Kubernetes MCP 服務器前，請確保滿足以下先決條件：

• 操作系統：Linux 或 macOS（Windows 可通過WSL運行）
• Python 版本：3.8+
• 已安裝 kubectl，並配置到系統路徑中

安裝步驟如下：

1. 從項目倉庫克隆代碼：

   git clone https://github.com/your-repository/kubernetes-mcp.git
   cd kubernetes-mcp
   

2. 安裝依賴項：

   pip install -r requirements.txt
   

3. 啟動 MCP 服務器：

   python3 bin/start_mcp_server.py
   

✨ 主要特性

• 自動檢測擴展腳本參數：無需手動配置，系統會自動識別並解析腳本參數。
• Pydantic 模型支持：通過 Pydantic 進行數據校驗和序列化，確保數據結構正確。
• 多環境兼容：支持不同的 Kubernetes 環境配置。
• 擴展性強：便於集成新的功能模塊和協議。

📦 安裝指南

克隆代碼

git clone https://github.com/your-repository/kubernetes-mcp.git
cd kubernetes-mcp

安裝依賴

pip install -r requirements.txt

啟動服務器

python3 bin/start_mcp_server.py

💻 使用示例

基本用法

# 運行MCP服務器，默認監聽localhost:50051
python3 bin/k8s-mcp-server run

# 以調試模式運行
DEBUG=1 python3 bin/k8s-mcp-server run

# 指定配置文件路徑
CONFIG_PATH=/path/to/config.yaml python3 bin/k8s-mcp-server run

自定義腳本使用

from kubernetes_mcp_sdk import KubernetesMCPClient

client = KubernetesMCPClient()
response = client.invoke_command(
    command_name="your_command",
    parameters={
        "param1": "value1",
        "param2": 123
    }
)
print(response)

📚 詳細文檔

目錄結構

項目根目錄下應包含以下文件夾：

kubernetes-mcp/
├── bin/                 # 存放可執行腳本，如啟動腳本等
├── config/             # 項目配置文件，包括MCP服務器配置
├── scripts/            # 自定義擴展腳本存放位置，默認為scripts/
└── src/                # 核心源代碼目錄，包含各個功能模塊

創建自定義腳本

腳本模板

#!/usr/bin/env python3
"""
示例腳本名

簡要描述腳本的功能。

參數：
    --param1: 參數1的描述（必填）
    --param2: 參數2的描述（默認值：default_value）
"""

import argparse
import json
import sys
import os

def main():
    """
    腳本主函數，負責解析參數和執行邏輯
    
    返回:
        dict: 執行結果
    """
    parser = argparse.ArgumentParser(
        description="詳細描述腳本功能",
        formatter_class=argparse.ArgumentDefaultsHelpFormatter
    )
    
    # 定義參數
    parser.add_argument(
        "--param1", 
        type=str, 
        required=True, 
        help="參數1的描述（必填）"
    )
    
    parser.add_argument(
        "--param2", 
        type=int,
        default=42, 
        help="參數2的描述"
    )
    
    # 處理--args-file參數
    parser.add_argument("--args-file", help="包含參數的JSON文件路徑")
    args, _ = parser.parse_known_args()
    
    if args.args_file:
        with open(args.args_file, 'r') as f:
            arguments = json.load(f)
        for arg_name, arg_value in arguments.items():
            setattr(args, arg_name, arg_value)
    else:
        args = parser.parse_args()
    
    # 使用參數
    print(f"參數1: {args.param1}")
    print(f"參數2: {args.param2}")
    
    # 添加自定義邏輯

if __name__ == "__main__":
    main()

環境變量

• SCRIPTS_DIR：覆蓋默認的腳本目錄位置

  SCRIPTS_DIR=/path/to/scripts python3 bin/k8s-mcp-server run
  

🔧 技術細節

架構組成

1. MCP 服務器：使用 FastMCP SDK 實現 MCP 協議。
2. Kubernetes 客戶端：負責與 kubectl 的交互。
3. 擴展腳本：提供專業功能，參數自動檢測。

Pydantic 模型應用

• 數據校驗和序列化。
• 類型安全的數據模型。
• 提升 IDE 支持和錯誤檢測能力。

📄 許可證

項目使用 MIT License 開源協議。

🤝 貢獻指南

歡迎貢獻！請通過 GitHub 提交代碼或提出問題。

📞 聯繫方式

如需幫助，請聯繫維護人員。