🚀 ⚡️ k6-mcp-server

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

✨ 特性

• 与模型上下文协议框架简单集成
• 支持自定义测试时长和虚拟用户（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运行测试，例如 run k6 test for hello.js。k6 mcp服务器将利用以下工具之一启动测试。

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

📝 API参考

执行K6测试

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

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

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

✨ 使用场景

• 基于LLM的结果分析
• 负载测试的有效调试

🤝 贡献

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

📄 许可证

本项目采用MIT许可证——详情见LICENSE文件。 </中文翻译>