Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/gatling/gatling.io-doc/llms.txt

Use this file to discover all available pages before exploring further.

Writing effective Gatling simulations requires knowing the SDK, structuring user journeys correctly, and choosing the right injection profiles and checks. Gatling’s AI extensions accelerate every part of that process by bringing AI-powered assistance directly into your editor — whether you use VS Code, Cursor, Windsurf, or any other IDE that supports the Model Context Protocol. The extensions can generate new simulations from scratch, explain complex expressions, refine existing scenarios, and even deploy and run tests on Gatling Enterprise Edition without leaving your editor.

What the AI Extensions Provide

Gatling AI assistance is packaged in two complementary forms:

IDE Assistants

Extensions for VS Code, Cursor, and Windsurf that add an AI chat panel, contextual code explanation, and refine-selection capabilities directly in your editor.

MCP Server

A Model Context Protocol server that exposes your Gatling Enterprise Edition resources (teams, packages, simulations, locations) to any MCP-compatible AI assistant.
Gatling AI extensions generate code using AI language models. AI models can make mistakes or produce incomplete solutions. Always validate generated simulations by running them against your application, reviewing them in code review, and checking assertion results before using them in production load tests.

IDE Assistants

VS Code

The Gatling AI Assistant for VS Code integrates into your editor’s activity bar and supports JavaScript, TypeScript, Java, Scala, and Kotlin simulations.

Installation

From the VS Code Marketplace:
code --install-extension GatlingCorp.gatling-ai-assistant
For VSCodium or Open VSX-compatible editors:
codium --install-extension GatlingCorp.gatling-ai-assistant

Configure an API Key

The extension communicates directly with your chosen AI provider — no data passes through Gatling servers.
1

Open the Command Palette

Press Ctrl+Shift+P (Windows/Linux) or Cmd+Shift+P (macOS).
2

Run Gatling: Set API Key

Type Gatling: Set API Key and press Enter.
3

Choose your provider

Select one of:
  • OpenAI (gpt-4o-2024-11-20) — recommended for general use
  • Anthropic Claude (claude-3-5-sonnet-20241022) — strong for complex reasoning
  • Azure OpenAI — enterprise deployments with data residency requirements
4

Paste your API key

The key is stored securely in VS Code’s encrypted secrets storage.

Key Features

FeatureHow to use
Create simulationClick the Gatling icon in the activity bar and ask the chat to generate a simulation
Explain codeSelect any Gatling code → right-click → Explain Code
Refine selectionSelect code → right-click → Refine Selection → describe your goal
Ask questionsOpen the Gatling panel and type any question about Gatling concepts
Persistent chatConversations are saved per workspace and restored across sessions

Privacy

  • API keys and conversations never touch Gatling’s servers
  • Code sent to AI providers is automatically redacted — API tokens, passwords, and secrets are stripped before submission
  • Each workspace has an isolated conversation history

Cursor

The Gatling AI Assistant for Cursor is identical in scope to the VS Code extension. Install from the Cursor Marketplace:
  1. Open Cursor
  2. Go to Extensions
  3. Search for Gatling AI Assistant
  4. Click Install
Configure an API key using Ctrl+Shift+PGatling: Set API Key, exactly as in VS Code. All features — create, explain, refine, chat — work identically.

Windsurf

The Gatling AI Assistant for Windsurf is also feature-equivalent to the VS Code extension. Install from the Windsurf Marketplace:
  1. Open Windsurf
  2. Go to Extensions
  3. Search for Gatling AI Assistant
  4. Click Install
Use the Command Palette (Ctrl+Shift+PGatling: Set API Key) to configure your preferred AI provider.

MCP Server

The Gatling MCP Server exposes your Gatling Enterprise Edition resources — teams, packages, simulations, and load generator locations — to any AI assistant that supports the Model Context Protocol. This enables natural-language queries like “list my simulations” or “start simulation X in region Y” without opening the Gatling Enterprise web UI.

Prerequisites

  • A Gatling Enterprise Edition account
  • An API token with at least the Configure role
  • Node.js v24+ (for the npx installation method) or Docker
Set the token in your shell:
export GATLING_ENTERPRISE_API_TOKEN=<your-api-token>
claude mcp add gatling \
  --env 'GATLING_ENTERPRISE_API_TOKEN=${GATLING_ENTERPRISE_API_TOKEN}' \
  -- npx -y @gatling.io/gatling-mcp-server
Or with Docker:
claude mcp add gatling \
  --env 'GATLING_ENTERPRISE_API_TOKEN=${GATLING_ENTERPRISE_API_TOKEN}' \
  -- docker run --rm --interactive --env GATLING_ENTERPRISE_API_TOKEN \
     gatlingcorp/gatling-mcp-server

Claude Desktop

Add to claude_desktop_config.json (location varies by OS):
{
  "mcpServers": {
    "gatling": {
      "command": "npx",
      "args": ["-y", "@gatling.io/gatling-mcp-server"],
      "env": {
        "GATLING_ENTERPRISE_API_TOKEN": "<your-api-token>"
      }
    }
  }
}

VS Code MCP Integration

Add to your VS Code settings.json or .vscode/mcp.json:
{
  "servers": {
    "gatling": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "@gatling.io/gatling-mcp-server"],
      "env": {
        "GATLING_ENTERPRISE_API_TOKEN": "<your-api-token>"
      }
    }
  }
}

Available MCP Tools

ToolDescription
list_gatling_enterprise_teamsList all teams in your Gatling Enterprise organisation
list_gatling_enterprise_packagesList all uploaded simulation packages
list_gatling_enterprise_testsList all configured simulations (tests)
list_gatling_enterprise_locationsList all public and private load generator locations

Claude Code Plugin (One-Step Setup)

The quickest way to get all Gatling AI capabilities — IDE skills and MCP server — in Claude Code is through the Gatling plugin in the Claude Marketplace:
/plugin marketplace add gatling/gatling-ai-extensions
/plugin install gatling@gatling-ai-extensions
Then reload Claude. The plugin bundles:
  • Bootstrap project — create a new Gatling project from scratch
  • Build tools — deploy and start tests on Gatling Enterprise
  • Configuration as code — generate or update .gatling/package.conf
  • Convert from JMeter — convert .jmx test plans to Gatling
  • Convert from LoadRunner — migrate LoadRunner scripts to Gatling
A valid GATLING_ENTERPRISE_API_TOKEN environment variable with at least the Configure role is required for all skills and MCP tools that interact with Gatling Enterprise Edition.

Build docs developers (and LLMs) love