Locust MCP Server

🚀 Locust-MCP-Server

Locust-MCP-Server 是一個用於運行 Locust 負載測試的模型上下文協議（MCP）服務器實現，它能讓 Locust 負載測試功能與 AI 驅動開發環境實現無縫集成。

🚀 快速開始

在使用 Locust-MCP-Server 前，請確保你已完成以下操作：

1. 確保安裝了 Python 3.13 或更高版本以及 uv 包管理器（安裝指南）。
2. 克隆倉庫：

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

3. 安裝所需的依賴項：

uv pip install -r requirements.txt

4. （可選）設置環境變量：在項目根目錄中創建一個 .env 文件：

LOCUST_HOST=http://localhost:8089  # 測試默認主機
LOCUST_USERS=3                     # 默認用戶數
LOCUST_SPAWN_RATE=1               # 用戶默認spawn率
LOCUST_RUN_TIME=10s               # 默認測試持續時間

完成上述準備工作後，你就可以開始進行 Locust 負載測試了：

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 運行測試，例如：運行 Locust 測試以分析 hello.py。Locust MCP 服務器將使用以下工具啟動測試：

• run_locust：帶有配置選項的測試運行器（無頭模式、主機、持續時間、用戶數和 spawn 率）

✨ 主要特性

• 可簡單集成到模型上下文協議框架。
• 支持無頭模式和 UI 模式。
• 可配置測試參數（用戶數、spawn 率、運行時間）。
• 提供運行 Locust 負載測試的易用性 API。
• 能即時輸出測試執行情況。
• 原生支持 HTTP/HTTPS 協議。
• 支持自定義任務場景。

📦 安裝指南

1. 克隆倉庫：

git clone https://github.com/qainsights/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               # 用戶默認spawn率
LOCUST_RUN_TIME=10s               # 默認測試持續時間

💻 使用示例

基礎用法

創建一個 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"})

高級用法

使用 run_locust API 啟動測試：

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

📚 詳細文檔

📝 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：用戶的 spawn 率。

✨ 使用場景

• 通過 LLM 驅動的結果分析。
• 藉助 LLM 進行有效調試。

🤝 貢獻

歡迎貢獻！請隨意提交 Pull Request。

📄 許可證

此項目在 MIT 許可證下，詳細信息請參閱 LICENSE 文件。