Locust

🚀 本地群載測試 MCP 服務器

這是一個基於 Locust 進行負載測試的模型上下文協議 (MCP) 服務器實現，它實現了 Locust 負載測試功能與 AI 驅動開發環境的無縫集成。

🚀 快速開始

1. 創建 Locust 測試腳本

創建一個 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 等）中配置 MCP 服務器：

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

3. 運行測試

讓大語言模型運行測試，例如：運行 locust 測試以分析 hello.py。Locust MCP 服務器將使用 run_locust 工具來啟動測試，該工具可根據配置選項運行測試（包括無頭模式、主機、時長、用戶數和生成率）。

✨ 主要特性

• 簡單易用的 Model Context Protocol 框架集成
• 支持無頭模式和有圖形界面模式
• 可配置的測試參數（用戶數、生成率、運行時間）
• 用於運行 Locust 負載測試的簡單 API
• 即時測試執行輸出
• 原生支持 HTTP/HTTPS 協議
• 支持自定義任務場景

🔧 先決條件

在開始之前，請確保安裝以下內容：

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

📦 安裝指南

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               # 用戶生成率
LOCUST_RUN_TIME=10s               # 默認測試時長

💻 使用示例

基礎用法

創建的 hello.py 腳本就是一個基礎的 Locust 測試腳本示例，它定義了用戶的行為和任務。

高級用法

可以根據不同的測試需求，調整 run_locust 函數的參數，以實現不同的測試場景。例如：

from locust_mcp_server import run_locust

# 以無頭模式運行測試，指定不同的用戶數、生成率和測試時長
run_locust(test_file="hello.py", headless=True, host="http://localhost:8089", runtime="20s", users=5, spawn_rate=2)

📚 詳細文檔

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）或有圖形界面（False）運行
• host：默認測試主機地址
• runtime：默認測試時長
• users：默認用戶數
• spawn_rate：用戶生成率

✨ 使用場景

• 性能測試：通過配置不同的用戶數和生成率，模擬高併發訪問場景。
• 穩定性測試：驗證系統在極端負載下的穩定性和響應能力。
• 壓力測試：識別系統瓶頸並評估其承受壓力的能力。

📄 注意事項

⚠️ 重要提示

• 確保安裝的 Python 版本符合要求（3.13 或更高）。
• 在運行高負載測試時，建議監控系統資源使用情況。
• 如果遇到性能問題，請考慮優化代碼或增加硬件資源。

通過以上步驟，您可以輕鬆配置和運行基於 Locust 的負載測試，並將其集成到 AI 驅動的開發環境中。