Jmeter MCP Server

🚀 JMeter MCP Server

This is a Model Context Protocol (MCP) server that supports executing JMeter tests through MCP-compatible clients.

⚠️ Important Note

📢 Looking for an AI assistant in JMeter? 🚀 Check out Feather Wand

✨ Features

• 📊 Execute JMeter tests in non-graphical interface mode.
• 🖥️ Launch JMeter in graphical interface mode.
• 📝 Capture and return execution outputs.

📦 Installation

Local Installation

1. Install uv:

2. Ensure that JMeter is installed on the system and can be accessed via the command line.

⚠️ Important Note

Make sure JMeter is executable. You can verify this by running the following command:

chmod +x /path/to/jmeter/bin/jmeter

3. Configure the .env file. Refer to the .env.example file for detailed information.

# JMeter Configuration
JMETER_HOME=/path/to/apache-jmeter-5.6.3
JMETER_BIN=${JMETER_HOME}/bin/jmeter

# Optional: JMeter Java Options
JMETER_JAVA_OPTS="-Xms1g -Xmx2g"

💻 Usage of MCP

1. Connect to the server using an MCP-compatible client (e.g., Claude Desktop, Cursor, Windsurf).

2. Send the following prompt to the server:

Run JMeter test /path/to/test.jmx

3. MCP-compatible clients will use the following tools:
   • 🖥️ execute_jmeter_test: Launch JMeter in graphical interface mode, but the test will not be executed (due to JMeter's design).
   • 🚀 execute_jmeter_test_non_gui: Execute JMeter tests in non-graphical interface mode (default mode for better performance).

📚 MCP Configuration

Add the following content to your MCP client configuration:

{
    "mcpServers": {
      "jmeter": {
        "command": "/path/to/uv",
        "args": [
          "--directory",
          "/path/to/jmeter-mcp-server",
          "run",
          "jmeter_server.py"
        ]
      }
    }
}

✨ Use Cases

• LLM-Enhanced Result Analysis: Collect and analyze test results.
• Debugging: Execute tests in non-graphical interface mode for easier debugging.

🔧 Error Handling

The server will:

• Verify the existence of the test file.
• Check if the file has a .jmx extension.
• Capture and return any execution errors.