This is documentation for the next version of Grafana k6 documentation. For the latest stable release, go to the latest version.

Documentationbreadcrumb arrow Grafana k6breadcrumb arrow Set upbreadcrumb arrow Configure your AI assistant
Open source

Configure your AI assistant

k6 is AI-native. It ships a dedicated toolset that plugs straight into any modern AI editor or agentic workflow, so your assistant can plan, write, validate, and run k6 tests without leaving your codebase.

Two k6 subcommands form the integration:

  • k6 x agent bootstraps your editor in one command. It installs portable k6 skills (planning, smoke / load / browser tests, Playwright→k6 conversion) and registers the MCP server with Claude Code, Cursor, GitHub Copilot, Codex CLI, OpenCode, or Cline.
  • k6 x mcp runs the k6 Model Context Protocol server (currently in preview), exposing the tools, prompts, and resources your assistant calls to validate scripts, look up documentation, and execute tests.

If you want the fastest path, jump straight to Bootstrap your editor with k6 x agent. The rest of this page covers running and configuring the MCP server itself.

What your assistant can do for you

Through the k6 MCP server, your AI assistant can:

  • Write accurate scripts: Create up-to-date scripts by referring to embedded k6 documentation and TypeScript definitions to reduce API hallucinations.
  • Validate scripts: Catch syntax errors, missing imports, and export default function declarations before execution.
  • Run tests locally: Execute scripts and review results without leaving your editor.
  • Generate scripts: Create tests from requirements using guided prompts that follow k6 best practices.
  • Convert browser tests: Transform Playwright tests into k6 browser scripts while preserving test logic.
  • Automate provisioning: Discover Terraform resources in your project to automate Grafana Cloud k6 setup.

Quick start with k6 x agent

The fastest way to wire everything up is the k6 x agent command, shipped with k6. From your project root:

sh
k6 x agent init claude-code   # or: cursor, vscode-copilot, codex-cli, opencode, cline, --all

k6 x agent init registers the k6 MCP server in your editor’s MCP config and installs portable k6 skills that auto-activate when you ask your assistant to plan, write, or convert tests. See Bootstrap your editor with k6 x agent for the full set of supported editors, bundled skills, and flags.

If your editor isn’t supported by k6 x agent, or you want to author the configuration yourself, see Editors not supported by k6 x agent.

Run the k6 MCP server

The simplest path is to invoke the server through k6 itself. To pin a specific version or run without a k6 install on the host, use the standalone mcp-k6 distribution instead.

If you already have k6 installed, you also have the k6 MCP server — invoke it as a subcommand:

sh
k6 x mcp

The server is registered as an official subcommand extension. The first time you run k6 x mcp, k6 transparently fetches and runs the extension; subsequent invocations start immediately. By default the server speaks the stdio transport that every MCP client expects.

To also drop in editor skills and auto-register the server in your editor, use k6 x agent init instead of wiring up the server manually.

Verify the command works:

sh
k6 x mcp --help

Note

Auto-extension resolution runs the latest released version. To pin a specific version, use the standalone mcp-k6 distribution below.

Docker

Pull the image:

sh
docker pull grafana/mcp-k6:latest
docker run --rm grafana/mcp-k6 --version

Homebrew (macOS)

Note

If you run mcp-k6 natively, you must also have k6 installed and available in your PATH.

sh
brew tap grafana/grafana
brew install mcp-k6
mcp-k6 --version

Linux packages (deb/rpm)

Install mcp-k6 from the .deb or .rpm packages published on the mcp-k6 GitHub releases.

  1. Open the releases page and select a version.
  2. Download the package that matches your Linux distribution and CPU architecture.

You can check your CPU architecture with:

sh
uname -m

Use the following mapping to pick the right asset:

uname -mDebian/Ubuntu assetFedora/RHEL asset
x86_64amd64 (.deb)x86_64 (.rpm)
aarch64arm64 (.deb)aarch64 (.rpm)

Debian/Ubuntu (.deb)

If you have the GitHub CLI (gh) installed, you can download a specific release asset from the terminal:

sh
MCP_K6_VERSION="vX.Y.Z"

# For amd64/x86_64:
gh release download "$MCP_K6_VERSION" --repo grafana/mcp-k6 --pattern "*linux*amd64*.deb"

# For arm64/aarch64:
# gh release download "$MCP_K6_VERSION" --repo grafana/mcp-k6 --pattern "*linux*arm64*.deb"

sudo apt install ./mcp-k6_*.deb
mcp-k6 --version

If you downloaded the .deb in your browser, run apt from the directory where you saved it:

sh
sudo apt install ./mcp-k6_*.deb
mcp-k6 --version

Fedora/RHEL (.rpm)

sh
MCP_K6_VERSION="vX.Y.Z"

# For x86_64:
gh release download "$MCP_K6_VERSION" --repo grafana/mcp-k6 --pattern "*linux*x86_64*.rpm"

# For aarch64:
# gh release download "$MCP_K6_VERSION" --repo grafana/mcp-k6 --pattern "*linux*aarch64*.rpm"

sudo dnf install ./mcp-k6-*.rpm
mcp-k6 --version

If your distro uses yum instead of dnf, run:

sh
sudo yum install ./mcp-k6-*.rpm

Build from source

Clone and install with make:

sh
git clone https://github.com/grafana/mcp-k6
cd mcp-k6
make install

Server flags

The k6 MCP server accepts the following flags, whether you launch it via k6 x mcp or the standalone mcp-k6 binary:

FlagDefaultDescription
--transportstdioTransport to use: stdio or http.
--addr:8080Listen address (HTTP transport only).
--endpoint/mcpHTTP endpoint path (HTTP transport only).
--statelessfalseDisable session tracking (HTTP transport only).
--preloadfalseDownload all embedded documentation bundles at startup.

Run over HTTP

For shared development hosts where multiple clients connect to one server, start the k6 MCP server with the streamable HTTP transport:

sh
k6 x mcp --transport=http --addr=:8080

Clients then connect to http://<host>:8080/mcp.

Caution

The HTTP transport has no built-in authentication. Don’t expose it on a public network — bind it to localhost or a trusted internal interface, and put it behind your own auth proxy if multiple users need access.

Troubleshooting

If your AI assistant cannot connect to the server:

  • Check the logs: Most editors (like Cursor or VS Code) have an “MCP Output” or “Logs” tab. Check there for “command not found” errors.
  • Verify k6 is on PATH: If running via k6 x mcp, run which k6 to confirm k6 is globally accessible. If running natively, also run which mcp-k6.
  • Check k6 version: Auto-extension resolution requires a recent k6 release. Run k6 version and confirm you’re on a version that supports k6 x subcommands.
  • Docker permissions: Ensure the Docker daemon is running and that your user has permission to execute docker run.
  • Use MCP Inspector: Use the MCP Inspector to debug the connection independently of your editor.

Configure your editor

Once k6 x mcp runs (or you’ve installed mcp-k6 standalone), wire it up to your editor:

  • Bootstrap your editor with k6 x agent — one-command setup for Claude Code, Cursor, GitHub Copilot, Codex CLI, OpenCode, and Cline. Manual setup for other MCP clients is documented at the bottom of the same page.

Next steps