K8s MCP Server

🚀 Kubernetes MCP サーバー

柔軟なマシン通信プロトコル（MCP）サーバーで、Kubernetes とのインターフェースを提供し、様々な機能をサポートします。

✨ 主な機能

• 拡張スクリプトパラメータの自動検出：手動での設定は不要で、システムが自動的にスクリプトパラメータを識別して解析します。
• Pydantic モデルのサポート：Pydantic を通じてデータの検証とシリアライズを行い、データ構造の正確性を確保します。
• 多環境互換性：異なる Kubernetes 環境設定をサポートします。
• 高い拡張性：新しい機能モジュールやプロトコルの統合が容易です。

📦 インストール

前提条件

• オペレーティングシステム：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
   

💻 使用例

基本的な使用法

# 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)

📚 ドキュメント

カスタムスクリプトの作成

スクリプトテンプレート

#!/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 のサポートとエラー検出能力の向上

🔧 技術詳細

ディレクトリ構造

プロジェクトのルートディレクトリには以下のフォルダが含まれている必要があります。

kubernetes-mcp/
├── bin/                 # 実行可能スクリプト（起動スクリプトなど）を格納します。
├── config/             # プロジェクトの設定ファイル（MCPサーバーの設定を含む）を格納します。
├── scripts/            # カスタム拡張スクリプトの格納場所で、デフォルトはscripts/です。
└── src/                # コアソースコードのディレクトリで、各機能モジュールが含まれています。

📄 ライセンス

このプロジェクトは MIT License のオープンソースライセンスを使用しています。

コントリビューションガイド

コントリビューションを歓迎します！GitHub を通じてコードを提出するか、問題を報告してください。

連絡先

ヘルプが必要な場合は、メンテナに連絡してください。