Locust MCP Server

🚀 ⚡️ Locust-MCP-Server

An implementation of the Model Context Protocol (MCP) server for running Locust load tests. This server seamlessly integrates Locust load testing capabilities with AI-driven development environments.

🚀 Quick Start

1. Create a Locust test script (e.g., 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. Configure the MCP server in your favorite MCP client (Claude Desktop, Cursor, Windsurf, etc.) using the following specification:

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

3. Now, let the LLM run the test, for example: Run Locust test to analyze hello.py. The Locust MCP server will start the test using the following tools:

• run_locust: A test runner with configuration options (headless mode, host, duration, number of users, and spawn rate)

✨ Features

• Simple integration into the Model Context Protocol framework
• Support for headless mode and UI mode
• Configurable test parameters (number of users, spawn rate, run time)
• Easy-to-use API for running Locust load tests
• Real-time test execution output
• Native support for HTTP/HTTPS protocols
• Support for custom task scenarios

🔧 Technical Details

Prerequisites

Before you begin, ensure you have installed the following:

• Python 3.13 or higher
• uv package manager (Installation Guide)

📦 Installation

1. Clone the repository:

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

2. Install the required dependencies:

uv pip install -r requirements.txt

3. Set environment variables (optional): Create a .env file in the project root directory:

LOCUST_HOST=http://localhost:8089  # Default host for testing
LOCUST_USERS=3                     # Default number of users
LOCUST_SPAWN_RATE=1               # Default user spawn rate
LOCUST_RUN_TIME=10s               # Default test duration

📝 API Documentation

Run Locust Test

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

Parameters:

• test_file: Path to the Locust test script
• headless: Headless mode (True) or with UI (False)
• host: Target host for load testing
• runtime: Test duration (e.g., "30s", "1m", "5m")
• users: Number of simulated concurrent users
• spawn_rate: User spawn rate

✨ Usage Scenarios

• LLM-driven result analysis
• Effective debugging with the help of LLM

🤝 Contribution

Contributions are welcome! Please feel free to submit a Pull Request.

📄 License

This project is under the MIT License. For detailed information, please refer to the LICENSE file.