K6 Load Testing

🚀 k6-mcp-server

k6-mcp-server是一個用於運行k6負載測試的Model Context Protocol（MCP）服務器實現，它能簡單集成到MCP框架中，支持自定義測試參數，還提供易於使用的API來執行負載測試，同時可通過環境變量進行配置，並即時輸出測試執行情況。

✨ 主要特性

• 可簡單集成到Model Context Protocol框架中。
• 支持自定義測試時長和虛擬用戶（VUs）數量。
• 提供易於使用的API來執行k6負載測試。
• 可通過環境變量進行靈活配置。
• 能即時輸出測試執行情況。

🔧 先決條件

在開始使用前，請確保已安裝以下內容：

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

💻 使用示例

基礎用法

# 執行k6測試，使用默認選項
execute_k6_test(
    script_file='test.js'
)

高級用法

# 執行k6測試，使用自定義持續時間和VU數
execute_k6_test_with_options(
    script_file='test.js',
    duration='60s',
    vus=20
)

📚 詳細文檔

執行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下許可，詳細信息請參閱LICENSE文件。