🚀 ⚡️ Locust-MCP-Server

一个支持模型上下文协议（MCP）的Locust负载测试服务器实现。该服务器使Locust负载测试功能与AI驱动开发环境无缝集成。

✨ 功能特性

• 简单集成到模型上下文协议框架
• 支持无头模式和UI模式
• 可配置测试参数（用户数、启动率、运行时间）
• 易用的API用于运行Locust负载测试
• 实时测试执行输出
• 原生支持HTTP/HTTPS协议
• 支持自定义任务场景

🔧 先决条件

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

• Python 3.13或更高版本
• uv包管理器（安装指南）

📦 安装

1. 克隆仓库：

git clone https://github.com/yourusername/locust-mcp-server.git

2. 安装所需的依赖项：

uv pip install -r requirements.txt

3. 设置环境变量（可选）：在项目根目录创建一个.env文件：

LOCUST_HOST=http://localhost:8089  # 测试默认主机
LOCUST_USERS=3                     # 默认用户数
LOCUST_SPAWN_RATE=1               # 用户启动率默认值
LOCUST_RUN_TIME=10s               # 默认测试持续时间

🚀 快速入门

1. 创建一个Locust测试脚本（例如hello.py）：

from locust import HttpUser, task, between

class QuickstartUser(HttpUser):
    wait_time = between(1, 5)

    @task
    def hello_world(self):
        self.client.get("/hello")
        self.client.get("/world")

    @task(3)
    def view_items(self):
        for item_id in range(10):
            self.client.get(f"/item?id={item_id}", name="/item")
            time.sleep(1)

    def on_start(self):
        self.client.post("/login", json={"username":"foo", "password":"bar"})

2. 使用您最喜欢的MCP客户端配置MCP服务器（Claude Desktop、Cursor、Windsurf等）：

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

3. 现在让LLM运行测试，例如：运行Locust测试以执行hello.py。Locust MCP服务器将使用以下工具启动测试：

• run_locust：带有配置选项的测试运行（无头模式、主机、持续时间、用户数和启动率）

📝 API参考

运行Locust测试

run_locust(
    test_file: str,
    headless: bool = True,
    host: str = "http://localhost:8089",
    runtime: str = "10s",
    users: int = 3,
    spawn_rate: int = 1
)

参数：

• test_file：Locust测试脚本的路径
• headless：无头模式（True）或带UI（False）
• host：要负载测试的目标主机
• runtime：测试持续时间（例如，“30s”、“1m”、“5m”）
• users：模拟的并发用户数
• spawn_rate：用户的启动率

🤝 贡献

欢迎贡献！请随意提交拉取请求。

📄 许可证

本项目在MIT许可证下，有关详细信息，请参阅LICENSE文件。