Mkp

🚀 MKP プロジェクトドキュメント

MKP は、Kubernetes クラスタとのインタラクションに使用するツールです。モデルコンテキストプロトコル (MCP) を通じてリソースへのアクセスとサービスを提供します。リソースの検出、操作、および構成管理などの一連の機能を備えています。

🚀 クイックスタート

MKP を使用するには、まずインストールしてサーバーを起動する必要があります。以下に手順を示します。

📦 インストール

クイックインストール

# リポジトリをクローンしてビルド
git clone https://github.com/StacklokLabs/mkp.git
cd mkp
make build

サーバーの起動

# デフォルトで起動
./build/mkp-server

# kubeconfig ファイルを指定して起動
./build/mkp-server --kubeconfig=/path/to/kubeconfig

# 読み取り専用モードで起動（デフォルト）
./build/mkp-server --read-only=true

# リソース検出を無効にして起動
./build/mkp-server --serve-resources=false

💻 使用例

MCP ツールの使用

リソース情報の取得

# サンプルコマンド
echo '{
  "id": "get_resource",
  "method": "GET",
  "params": {
    "uri": "k8s://clustered/apps/v1/deployments/nginx-deployment"
  }
}' | ./build/mkp-server --tool stdout

リソースの一覧表示

# サンプルコマンド
echo '{
  "id": "list_resources",
  "method": "GET",
  "params": {
    "uri": "k8s://clustered/apps/v1/deployments"
  }
}' | ./build/mkp-server --tool stdout

リソース構成の適用

# サンプルコマンド
echo '{
  "id": "apply_resource", 
  "method": "POST",
  "params": {
    "uri": "k8s://namespaced/default/apps/v1/deployments/nginx-deployment",
    "manifest": {
      "apiVersion": "apps/v1",
      "kind": "Deployment",
      "metadata": {
        "name": "nginx-deployment",
        "namespace": "default"
      },
      "spec": {
        "replicas": 3,
        "selector": {
          "matchLabels": {
            "app": "nginx"
          }
        },
        "template": {
          "metadata": {
            "labels": {
              "app": "nginx"
            }
          },
          "spec": {
            "containers": [
              {
                "name": "nginx",
                "image": "nginx:latest",
                "ports": [80]
              }
            ]
          }
        }
      }
    }
  }
}' | ./build/mkp-server --tool stdout

🔧 技術詳細

リソース検出とサービスモード

設定オプション

• リソース検出：--serve-resources パラメータでリソース検出機能の有効/無効を制御します。
• サービスモード：デフォルトは読み取り専用モードで、--read-only または --read-write で読み書き権限を設定できます。

開発情報

コードテスト

make test

コードのフォーマット

make fmt

依存関係の管理

go mod tidy

ToolHive との統合

インスタンスの起動

# MCP サーバーを起動
./build/mkp-server --tool stdout

# ToolHive を使用してデプロイ
poetry run mcp run \
    --name mkp-service \
    --image ./build/mkp-server \
    --command "mkp-server" \
    --port 8080

インスタンスの検証

poetry run mcp ls

インスタンスの停止

poetry run mcp stop mkp-service

📄 ライセンス

このプロジェクトは MIT ライセンスの下で提供されています。詳細は LICENSE ファイルを参照してください。