🚀 ⚡️ k6-mcp-server

🚀 ⚡️ k6-mcp-server

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

✨ 功能

• 与模型上下文协议框架轻松集成
• 支持自定义测试时长和虚拟用户（VUs）
• 易于使用的 API，可运行 k6 负载测试
• 可通过环境变量进行配置
• 实时测试执行输出

🔧 前提条件

开始之前，请确保已安装以下内容：

• Python 3.12 或更高版本
• k6 负载测试工具（安装指南）
• uv 包管理器（安装指南）

📦 安装

1. 克隆仓库：

git clone https://github.com/yourusername/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 客户端（Claude Desktop、Cursor、Windsurf 等）中，使用以下规范配置 MCP 服务：

{
  "mcpServers": {
    "k6": {
      "command": "/Users/naveenkumar/.local/bin/uv",
      "args": [
        "--directory",
        "/Users/naveenkumar/Gits/k6-mcp-server",
        "run",
        "k6_server.py"
      ]
    }
  }
}

3. 现在，让大模型运行测试，例如 run k6 test for hello.js。k6 MCP 服务将使用以下工具之一启动测试。

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

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