Qainsights K6 MCP Server

🚀 k6-mcp-server

k6-mcp-server 是一個用於運行 k6 負載測試的 Model Context Protocol（MCP）服務器實現，能簡單集成到 MCP 框架中，支持自定義測試參數，還可通過環境變量配置，提供即時測試輸出，助力高效開展負載測試。

🚀 快速開始

在使用 k6-mcp-server 之前，你需要完成一些準備工作，然後按照步驟進行安裝和配置，最後就可以啟動測試啦。

🔧 先決條件

在開始之前，請確保安裝了以下內容：

• 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 客戶端中配置 MCP 服務器（例如 Claude Desktop、Cursor、Windsurf 等）：

{
  "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 秒，10 個 VU）
• execute_k6_test_with_options：使用自定義持續時間和 VU 數量運行測試

✨ 主要特性

• 簡單集成到 Model Context Protocol 框架中
• 支持自定義測試持續時間和虛擬用戶數量（VUs）
• 易於使用的 API 來運行 k6 負載測試
• 通過環境變量配置
• 即時測試執行輸出

📚 詳細文檔

📄 API 參考

執行 k6 測試

execute_k6_test(
    script_file: str,
    duration: str = "30s",  # 可選，默認為"30s"
    vus: int = 10          # 可選，默認為10
)

使用自定義選項執行 k6 測試

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

✨ 使用場景

• 通過 LLM 進行結果分析
• 有效調試負載測試

🤝 貢獻

歡迎貢獻！請隨意提交 Pull Request。

📄 許可證

該項目在 MIT License 下許可，詳情請參閱 LICENSE 文件。