English Français العربية

JMeter Docs

Official registry Productivity

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

Source code Website Documentation

What can you do with JMeter Docs?

  • 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)

Install

Add this to your client's MCP configuration (Claude Desktop: claude_desktop_config.json; Cursor: .cursor/mcp.json; VS Code and others use the same "mcpServers" shape).

Remote (streamable-http)
Claude Code 
claude mcp add --transport http jmeter-docs 'https://docs.jmeter.ai/api/mcp'
JSON configuration (Claude Desktop, Cursor, VS Code) 
{
    "mcpServers": {
        "jmeter-docs": {
            "type": "http",
            "url": "https://docs.jmeter.ai/api/mcp"
        }
    }
}

Documentation

From the project's README on GitHub, refreshed weekly. Links open on GitHub.

Contents
  1. JMeter Docs
  2. Features
  3. Getting Started
  4. Scripts
  5. Markdown for AI agents
  6. Contributing
  7. License

JMeter Docs

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

docs.jmeter.ai

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
npm install
Development
npm run dev
Build
npm run build
Preview Production Build
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:

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.

Frequently asked questions

What is JMeter Docs?

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

How do I install JMeter Docs?

It runs as a remote server. In Claude Code: claude mcp add --transport http jmeter-docs 'https://docs.jmeter.ai/api/mcp'. For other clients, paste the JSON configuration from this page into their MCP settings.

Does JMeter Docs need an API key?

Its registry entry lists no required key or secret. Some features may still need an account with the service it connects to.

Is JMeter Docs open source?

Yes. Its code is on GitHub under the Apache-2.0 license.

Who maintains JMeter Docs?

It is published by QAInsights. AI.tn lists it but does not maintain or endorse it.

From the official MCP Registry. Listing is not an endorsement: review a server's code and permissions before giving it access to your data.