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文件。