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 分