K6 Load Testing

🚀 ⚡️ k6-mcp-server

このプロジェクトは、k6負荷テストを実行するためのModel Context Protocol（MCP）サーバーの実装です。

🚀 クイックスタート

このサーバーを使用することで、簡単にk6負荷テストを実行できます。以下の手順に従って、始めましょう。

✨ 主な機能

• Model Context Protocolフレームワークへの簡単な統合
• テスト時間と仮想ユーザー（VUs）のカスタマイズが可能
• k6負荷テストを実行するための使いやすいAPI
• 環境変数による設定
• テスト実行のリアルタイム出力

🔧 技術詳細

🔧 前提条件

始める前に、以下のものがインストールされていることを確認してください。

• Python 3.12以上
• k6負荷テストツール（インストールガイド）
• uvパッケージマネージャー（インストールガイド）

📦 インストール

1. リポジトリをクローンします：

git clone https://github.com/qainsights/k6-mcp-server.git

2. 必要な依存関係をインストールします：

uv pip install -r requirements.txt

3. 環境変数を設定します（オプション）： プロジェクトのルートディレクトリに.envファイルを作成します：

K6_BIN=/path/to/k6  # オプション：デフォルトではシステムのPATHにある'k6'を使用します

💻 使用例

基本的な使用法

1. k6テストスクリプトを作成します（例：test.js）：

import http from "k6/http";
import { sleep } from "k6";

export default function () {
  http.get("http://test.k6.io");
  sleep(1);
}

2. お好きなMCPクライアント（例：Claude Desktop、Cursor、Windsurfなど）でMCPサーバーを設定します：

{
  "mcpServers": {
    "k6": {
      "command": "/path/to/bin/uv",
      "args": [
        "--directory",
        "/path/to/k6-mcp-server",
        "run",
        "k6_server.py"
      ]
    }
  }
}

3. LLMにテストを実行させます。例えば、hello.jsのk6テストを実行と指示すると、k6 MCPサーバーが以下のツールを使ってテストを開始します。

• execute_k6_test：デフォルトのオプションでテストを実行します（持続時間：30秒、VU数：10）
• execute_k6_test_with_options：カスタムの持続時間とVU数でテストを実行します

📚 ドキュメント

📝 APIドキュメント

基本的なk6テストの実行

execute_k6_test(
    script_file: str,
    duration: str = "30s",  # オプション：持続時間、デフォルトは30秒
    vus: int = 10          # オプション：仮想ユーザー数、デフォルトは10
)

オプション付きのk6テストの実行

execute_k6_test_with_options(
    script_file: str,
    duration: str,
    vus: int
)

✨ 使用シナリオ

• LLMによる結果分析
• 負荷テストの効果的なデバッグ

🤝 貢献

貢献は大歓迎です！自由にPull Requestを提出してください。

📄 ライセンス

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