JMeter

You deploy the MCP server to let AI assistants interact with Apache JMeter for performance testing. It provides commandable actions to run tests, analyze results, generate reports, and manage test plans, all through a standardized MCP interface. This guide walks you through practical usage, installation steps, and essential configurations so you can start testing quickly and safely.

How to use

You interact with the server by expressing your testing intent to the MCP client, which translates your requests into JMeter actions. You can validate your JMeter installation, execute test plans in non-GUI mode, launch the GUI for test development, programmatically generate test plans, analyze results, and produce HTML dashboards. For distributed testing, you can run tests across multiple remote machines and then review combined results. Each action is exposed as a distinct tool you can call through the MCP client to accomplish concrete performance-testing goals.

To use the server with a client, you configure the client to connect to the MCP endpoint using the stdio-based runtime. You provide the runtime command and any environment variables the server needs, such as the path to your JMeter installation. After setup, you can issue requests like validating the JMeter setup, running tests, and retrieving analysis or reports, all through the client’s MCP interface.

How to install

Prerequisites you need before installation are Node.js version 18 or higher and Apache JMeter version 5.0 or higher. You also need a package manager such as npm or yarn.

Step 1: Prepare your environment
- Install Node.js 18 or higher
- Install Apache JMeter 5.0 or higher
- Install npm or yarn if not already present

Step 2: Clone or download the MCP server project into your working directory and navigate into it

• This guide uses the project directory as the working context for installation steps

Step 3: Install dependencies
```bash
npm install

Step 4: Configure environment

• Create a copy of the environment template and adjust paths as needed

cp .env.example .env```Edit .env and set your JMeter path, for example```env
JMETER_HOME=C:/apache-jmeter-5.6.3```

Step 5: Build the project

npm run build

Additional configuration and startup details

To run the MCP server locally via a client, you will typically use a stdio configuration that specifies the runtime command and the script to execute. The example shows starting the server with Node.js and pointing to the compiled index script, along with the JMETER_HOME environment variable.

Example environment and startup snippet you can adapt in your client configuration is shown below.

Configuration and environment

The MCP server relies on the JMETER_HOME variable to locate your JMeter installation. You should expose this variable to the server process, either via your shell environment or via the client’s configuration. If your setup requires additional Java options, you can provide JMETER_JAVA_OPTS or similar properties as needed.

Troubleshooting

If the MCP server cannot locate JMeter, ensure JMETER_HOME is set in your environment or .env file. Typical issues include missing executable permissions or incorrect paths.

Common fixes you may need:

• Verify Node.js 18+ is installed
• Verify JMeter is installed and accessible from JMETER_HOME
• Reinstall dependencies if build fails and re-run the build process

Tools and endpoints overview

The server exposes a set of tools for common performance testing tasks. Each tool is designed to be invoked through the MCP client, enabling you to execute tests, validate installations, and analyze results.

Available tools

validate_jmeter

Validate JMeter installation and get version info.

execute_jmeter_test

Execute a test plan in non-GUI mode with optional results, logs, and HTML report.

launch_jmeter_gui

Launch the JMeter GUI for interactive test development.

generate_html_report

Generate an HTML dashboard report from JTL results.

analyze_test_results

Provide a comprehensive analysis of test results including bottlenecks and recommendations.

create_http_test_plan

Create a new HTTP test plan programmatically with customizable parameters.

execute_distributed_test

Run a test plan across multiple remote hosts for distributed testing.

list_jmeter_plugins

List all installed JMeter plugins.

get_jmeter_properties

Retrieve current JMeter properties.

set_jmeter_property

Set a specific JMeter property by key and value.