使用说明

项目简介

JMeter MCP 服务器是一个基于 Model Context Protocol (MCP) 构建的应用后端,它将 Apache JMeter 性能测试工具的能力暴露给支持 MCP 协议的 LLM 客户端,例如 Claude、Cursor 和 Windsurf。通过此服务器,用户可以使用自然语言指令,让 LLM 客户端调用 JMeter 执行性能测试,并获取测试结果,从而实现更智能化的性能测试流程。

主要功能点

  • 执行 JMeter 测试:支持在非 GUI 模式和 GUI 模式下执行 JMeter 性能测试脚本(.jmx 文件)。
  • 返回测试结果:对于非 GUI 模式,服务器能够捕获 JMeter 的执行输出,并将结果返回给 LLM 客户端。
  • 错误处理:服务器会对测试文件进行基础校验,例如文件是否存在、是否为 .jmx 文件等,并返回相应的错误信息。

安装步骤

  1. 安装 uv:按照仓库 README.md 中的指引安装 'uv' 包管理工具。(请参考 uv installation guide
  2. 安装 JMeter:确保您的系统上已安装 Apache JMeter,并可通过命令行访问 'jmeter' 命令。
  3. 配置 JMeter 可执行权限:如果 JMeter 可执行文件没有执行权限,请使用 'chmod +x /path/to/jmeter/bin/jmeter' 命令添加执行权限。
  4. 配置环境变量:复制仓库中的 '.env.example' 文件为 '.env',并根据您的 JMeter 安装路径修改以下环境变量:
    • 'JMETER_HOME': JMeter 的安装根目录,例如 '/path/to/apache-jmeter-5.6.3'。
    • 'JMETER_BIN': JMeter 可执行文件的完整路径,例如 '${JMETER_HOME}/bin/jmeter'。
    • 'JMETER_JAVA_OPTS' (可选): JMeter 的 Java 虚拟机参数,例如 '-Xms1g -Xmx2g'。

服务器配置

MCP 客户端需要配置以下 JSON 信息以连接到 JMeter MCP 服务器。请根据您的实际情况进行配置。

{
  "serverName": "jmeter-mcp-server",
  "command": "python",
  "args": ["jmeter_server.py"]
}
  • 'serverName': 自定义服务器名称,用于在 MCP 客户端中识别。
  • 'command': 启动服务器的命令,这里使用 'python' 解释器。
  • 'args': 命令参数,指定服务器脚本 'jmeter_server.py' 的路径。请确保在 MCP 客户端能够执行 'python jmeter_server.py' 命令来启动服务器。

基本使用方法

  1. 启动服务器:在安装并配置好 JMeter MCP 服务器后,通过 MCP 客户端配置的 'command' 和 'args' 启动服务器。
  2. 连接客户端:使用支持 MCP 协议的 LLM 客户端(如 Claude Desktop, Cursor, Windsurf)连接到已启动的 JMeter MCP 服务器。
  3. 发送指令:在 LLM 客户端中,使用自然语言指令指示服务器执行 JMeter 测试,例如:'Run JMeter test /path/to/test.jmx'。
  4. 获取结果:服务器会根据指令调用相应的工具执行 JMeter 测试,并将结果返回给 LLM 客户端。对于非 GUI 模式,您将收到 JMeter 的测试执行输出。

信息

分类

开发者工具