🚀 ⚡️ k6-mcp-server

🚀 ⚡️ k6-mcp-server

用于运行 k6 负载测试的模型上下文协议（MCP）服务实现。

✨ 功能

• 与模型上下文协议框架轻松集成
• 支持自定义测试时长和虚拟用户（VU）
• 提供易于使用的 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  # Optional: defaults to 'k6' in system PATH

🚀 快速开始

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. 现在，让大模型运行测试，例如 run k6 test for hello.js。k6 MCP 服务将使用以下任一工具启动测试。

• execute_k6_test：使用默认选项运行测试（时长 30s，10 个 VU）
• execute_k6_test_with_options：使用自定义时长和 VU 运行测试

📝 API 参考

执行 K6 测试

execute_k6_test(
    script_file: str,
    duration: str = "30s",  # Optional
    vus: int = 10          # Optional
)

使用自定义选项执行 K6 测试

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

✨ 使用场景

• 使用大模型分析结果
• 高效调试负载测试

🤝 贡献

欢迎贡献！请随时提交 Pull Request。

📄 许可证

本项目基于 MIT License 授权，详情请参阅 LICENSE 文件。