JMeter Docs

io.github.QAInsights由 GitHub 账号 QAInsights 发布v1.4.0更新于 Oct 24, 2026

Apache JMeter community documentation, conversion tools, linters, and calculators for AI agents.

已验证Streamable HTTP可网页运行知识与记忆开发者工具数据与分析

概览

AI 生成的概览

JMeter 社区文档与工具服务器,让助手查询 JMeter 文档、检查测试计划、换算负载模型并转换成 JMX。

可以做什么
搜索并读取 docs.jmeter.ai 上的 JMeter 文档页面,查询组件、函数与属性参考。检查 JMX 测试计划片段与 Groovy JSR223 脚本,找出结构问题与性能反模式。根据目标 RPS/TPS 与 SLA 计算线程数、pacing、ramp-up 与 JVM 堆内存建议。把 cURL 命令、HAR 跟踪或 OpenAPI/Swagger 文档转成 JMeter .jmx 测试计划。生成分布式测试的端口与配置、Linux 系统调优配置,以及关联练习用的沙箱测试计划。按错误信息匹配文档中的错误处理手册,并提供 Groovy 示例脚本。
适用场景
当你需要编写、调试或调优 JMeter 性能测试计划,或把 cURL、HAR、OpenAPI 转成 JMX 时使用。也适合查询 JMeter 属性、函数、组件以及常见错误的处理方式。
运行要求
远程端点,无需安装包或 API 密钥。部分工具会把错误文本发送到外部分类服务。
安装前请注意
triage_errors 与错误手册查询会把未匹配的错误文本发送到第三方分类服务,声称会先遮蔽明显机密且不存储。生成的配置与脚本需自行审阅后再用于正式环境。这是独立社区资源,与 Apache 软件基金会无关。部分工具输出包含网址与命令示例。

安装

在 SourceWeft 中

  1. 打开 控制台中的 JMeter Docs,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Web executable,通过 Streamable HTTP。 远程服务在工作区中配置后即可从网页运行时运行。

交给智能体安装

把这段提示词粘贴到 Claude Code、Codex、Cursor 等智能体,或 SourceWeft 对话中。智能体会读取该服务器的安装指南,先向你展示发布者、端点和登录方式,经你同意后再把它添加到你的客户端。密钥不会写进任何命令。

阅读 https://sourceweft.com/mcp/io.github.QAInsights%2Fjmeter-docs/install.md,并按其中说明把这个 MCP 服务器接入我的客户端。修改任何配置之前,先告诉我它的发布者、端点和登录方式,等我确认。不要把 API 密钥写进命令或我会提交的文件;问我密钥应从哪里获取。

查看智能体所依据的安装指南

其他 MCP 客户端

把它添加到你客户端的 mcpServers 配置中。

{
  "mcpServers": {
    "jmeter-docs": {
      "type": "http",
      "url": "https://docs.jmeter.ai/api/mcp"
    }
  }
}

README

[JMeter Docs]

JMeter Docs

Community-maintained documentation for Apache JMeter built with Astro + Starlight

docs.jmeter.ai

[CI] [smithery badge] [License] [Astro]


Disclaimer: This is an independent community resource and is not affiliated with the Apache Software Foundation.

Features

  • Full-text search powered by Pagefind
  • Dark mode with system preference detection
  • Organized sidebar: User Manual, Reference, Extending, Legal
  • LLM-friendly text exports (llms.txt / llms-full.txt)
  • Custom landing page with terminal hero, metrics strip, and bento grid
  • SEO optimized with structured data (FAQ, HowTo schemas)

Getting Started

Prerequisites

  • Node.js 18+
  • npm

Installation

bash
npm install

Development

bash
npm run dev

Build

bash
npm run build

Preview Production Build

bash
npm run preview

Scripts

ScriptDescription
npm run devStart dev server
npm run buildGenerate llms-full.txt then build the site
npm run previewPreview the production build locally
npm testRun unit tests
npm run test:watchRun tests in watch mode
npm run test:coverageRun tests with coverage report
npm run convertConvert upstream JMeter docs to Starlight format
npm run generate-llms-fullGenerate LLM-friendly text export

Markdown for AI agents

Every prerendered docs page (everything except the site homepage) has a Markdown twin: append index.md to a page URL (e.g. https://docs.jmeter.ai/user-manual/best-practices/index.md), or request the page URL with an Accept: text/markdown header and the CDN rewrites the request to the .md file. Browsers are unaffected — the rule only fires when Accept lacks text/html.

The index.md files are generated at build time by scripts/generate-page-markdown.mjs (part of pnpm build), served with Content-Type: text/markdown via public/_headers, and the Accept: text/markdown mapping is a Cloudflare zone URL Rewrite Rule provisioned once with:

bash
pnpm setup-markdown-rule   # needs CLOUDFLARE_API_TOKEN + CLOUDFLARE_ZONE_ID

The index.md files are produced by the build script — the production build command must run pnpm run build (not a bare astro build), otherwise the Markdown links 404; the generator exits non-zero if it writes nothing.

See scripts/setup-markdown-rule.mjs and public/llms.txt for details.

Contributing

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

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes using Conventional Commits
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Important: MDX files are generated

The src/content/docs/**/*.mdx files are generated artifacts produced by tools/convert.mjs from the upstream Apache JMeter xdocs/ XML. A nightly workflow (.github/workflows/sync-upstream.yml) regenerates them and opens a sync PR.

Direct edits to MDX files will be overwritten by the next sync run. To make a lasting change to documentation content:

  • Prefer fixing the converter in tools/convert.mjs so the change applies to all generated pages and survives syncs.
  • Or upstream the change to apache/jmeter xdocs/ so it flows down naturally.
  • Or open an issue describing the desired change so maintainers can decide the best path.

Changes to non-generated files (components, styles, tools, tests, config) are not affected by the sync and can be edited directly.

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Apache JMeter is a trademark of The Apache Software Foundation. This project is not endorsed by or affiliated with the ASF.

来源:README.md,提交 647d76a

工具

16

search_jmeter_docs

Search JMeter documentation

Search the Apache JMeter documentation on docs.jmeter.ai. Returns the most relevant pages with titles, URLs, and snippets. Use for any question about JMeter test plans, components, functions, properties, distributed testing, reports, or troubleshooting.

输入参数query必填

get_jmeter_page

Read a JMeter documentation page

Fetch the full markdown text of one docs.jmeter.ai page. Accepts the page URL (e.g. https://docs.jmeter.ai/topics/api-load-testing/) or a bare path (e.g. topics/api-load-testing).

输入参数url必填

lint_jmx_snippet

Lint JMX Test Plan Snippet

Validate a JMeter test plan XML string or snippet against best practices and performance anti-patterns, and return a structural inventory with thread groups, sampler/listener/assertion counts, HTTP Defaults/Header/Cookie/CSV presence, plugin classes, and JMeter version.

输入参数jmxContent必填

calculate_workload_model

Calculate Workload Model & Little's Law Sizing

Compute required thread concurrency, pacing delays, ramp-up schedules, and JVM heap recommendations based on target RPS/TPS and SLA response times using Little's Law.

输入参数targetRps必填thinkTimeMssafetyFactoravgResponseTimeMs必填testDurationMinutes

lookup_jmeter_property

Lookup JMeter Tuning Property

Search or lookup curated JMeter properties (e.g. "httpclient4.idletimeout", "jmeter.save.saveservice.*", "remote_hosts", "summariser"). Returns category, defaults, and recommendations.

输入参数query必填

get_jsr223_recipe

Get Verified JSR223 Groovy Recipe

Fetch production-ready, performant Groovy scripts for JMeter JSR223 samplers, preprocessors, and postprocessors (e.g., JWT parsing & expiration, HMAC-SHA256 signing, dynamic header injection, nested JSON array extraction, custom CSV failure logging).

输入参数query

lint_groovy_script

Lint JMeter Groovy (JSR223) Script

Statically analyze a Groovy script for a JMeter JSR223 element. Flags Thread.sleep, ${var} interpolation, System.out, BeanShell APIs, per-call Random or Pattern.compile, and bindings such as prev, SampleResult, or sampler that the selected element type does not expose; optionally returns ready-to-paste JMX element XML.

输入参数code必填nameparameterselementTypeincludeJmxElement

lookup_error_playbook

Lookup Error & Exception Diagnostic Playbook

Get immediate root causes, OS/JVM config fixes, and remediation steps for common JMeter exceptions (e.g. "BindException", "SocketTimeoutException", "OutOfMemoryError", "NoHttpResponseException", "SSLHandshakeException", "401/403 after recording"). When keywords miss, unmatched text is sent to classifier.dev for zero-shot semantic matching (public keyless calls are not stored).

输入参数query必填classifierApiKey

triage_errors

Triage a Batch of JMeter Error Signatures

Map a run's distinct failure signatures to docs.jmeter.ai error playbooks. Error text is sent to classifier.dev for zero-shot classification (public keyless calls are not stored; obvious secrets are redacted first). Prefer signatures shaped as "sampler | response code | response message".

输入参数tiererrors必填minConfidenceclassifierApiKey

lookup_component

Lookup JMeter Component Reference Page

Find the dedicated reference page for a JMeter test plan component (e.g. "HTTP Request", "JSON Extractor", "Thread Group") and return its full markdown content with properties, defaults, and related guides.

输入参数name必填

lookup_function

Lookup JMeter Function Reference Page

Find the dedicated reference page for a built-in JMeter function (e.g. "__time", "__Random", "__P") and return its full markdown content with syntax, parameters, and examples.

输入参数name必填

plan_distributed_testing

Plan Distributed Testing Ports & Firewall Rules

Generate Master-Worker RMI port assignments, user.properties, CLI commands, firewall/security group rules, and Docker Compose manifests for distributed load testing.

输入参数modeworkerIps必填disableSslserverPortenvironmentcontrollerIpclientRmiLocalPortserverRmiLocalPort

tune_linux_os

Linux Kernel & OS Tuning for Load Injectors

Generate production sysctl.conf, limits.conf, systemd overrides, and Docker/K8s configs tuned for high-concurrency JMeter load testing (fixing ulimit nofile, BindException port exhaustion, somaxconn backlog, and JVM swappiness).

输入参数roleramGbconcurrencytrafficTypetargetDistro

convert_curl_or_har_to_jmx

Convert cURL or HAR to JMeter JMX Test Plan

Convert one or more cURL commands or HAR (HTTP Archive 1.2) JSON traces into a valid, production-ready Apache JMeter .jmx test plan XML with HTTP Request Defaults, Header Managers, Cookie Managers, timeouts, and assertions. Supports GET, POST, PUT, DELETE, PATCH, and RFC 9838 QUERY methods.

输入参数input必填threadsloopCounttestPlanNamerampUpSecondsdurationSecondsparameterizeAuthparameterizeHostincludeAssertionsfilterStaticAssetsincludeCookieManager

convert_openapi_to_jmx

Convert OpenAPI / Swagger to JMeter JMX Test Plan

Convert an OpenAPI 3.0/3.1 or Swagger 2.0 document (JSON or YAML) into a JMeter 5.6.3 .jmx test plan: servers become HTTP Request Defaults/${BASE_URL}, path parameters become User Defined Variables, request bodies are sampled from schemas, bearer/basic/apiKey security becomes ${AUTH_TOKEN}/${BASIC_AUTH}/${API_KEY}, with optional method, tag, and deprecated-operation filters.

输入参数tagsinput必填methodsthreadsloopCountserverIndextestPlanNamemaxOperationsrampUpSecondsdurationSecondsparameterizeHostuseExampleValues另有 4 个

get_correlation_sandbox

Get Correlation & Practice Sandbox Test Plan

Generate a ready-to-run Apache JMeter 5.6.3 .jmx practice test plan (either "solved" with Boundary/JSON/Header extractors or "challenge" with broken hardcoded tokens) targeting the live docs.jmeter.ai/api/sandbox endpoints or local localhost:8787 server.

输入参数modeflowIdtarget

版本历史

1
  1. v1.4.0最新Sep 16, 2026

评分

已满足适用检查项的 100%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通必需25 分
  • 已声明认证方式必需10 分
  • 已列出工具必需15 分
  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分