🚀 ⚡️ locust-mcp-server

一个用于运行 Locust 负载测试的模型上下文协议 (MCP) 服务器实现。该服务器能够将 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 客户端（Claude Desktop、Cursor、Windsurf 等）中使用以下规范配置 MCP 服务器：

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

3. 现在，要求 LLM 运行测试，例如 run locust test for 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: 用户生成的速率

🤝 贡献

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

📄 许可证

该项目根据 MIT 许可证获得许可 - 有关详细信息，请参阅 LICENSE 文件。