@kosiakmd/artillery-mcp
v0.1.7
Published
MCP server for Artillery 2.x — full CLI flag surface (run/run-fargate), counter-rich parse_results, raw-text output parser, and an optional config-driven project launcher.
Maintainers
Readme
@kosiakmd/artillery-mcp
Richer drop-in MCP server for Artillery 2.x — exposes the full artillery run
and artillery run-fargate flag surface, parses raw text output (artillery-output.txt),
returns every counter/rate/summary Artillery produces (not just http.*), and
optionally adds a config-driven project launcher and counter-grouping for your
custom counters.
Why another MCP server?
The upstream @jch1887/artillery-mcp-server
was a solid start but missed several flags our team needed day-to-day. This package is
a MIT-licensed fork with broader coverage. See Credits.
| Feature | upstream | this package |
|---|---|---|
| run_test_from_file flags | path + output only | + --record/--key/--tags/--name/--note/-t/-e/--scenario-name/-v/--overrides/-p/--dotenv/-k/--count/-s |
| AWS Fargate (run-fargate) | ❌ | ✅ full flag set |
| parse_results counters | http.* only | ALL counters + rates + nested summaries |
| Parse raw stdout (artillery-output.txt) | ❌ | ✅ read_artillery_output tool |
| HTML report generation | passes invalid --report flag | ✅ separate artillery report call |
| --dry-run validation | broken (flag doesn't exist in 2.x) | ✅ client-side YAML structural check |
| Opt-in project launcher | ❌ | ✅ run_project_lt (when config present) |
| Opt-in counter grouping | ❌ | ✅ counterBreakdown (when config present) |
| Tests | 122 | 146 |
Quickstart for agents (Claude Code / Cursor)
# In your project root
npx @kosiakmd/artillery-mcp initScaffolds two files (skipped if they already exist, use --force to overwrite):
.artillery-mcp.config.json— starter template with commented fields.ai/skills/artillery-mcp/SKILL.md— agent-oriented guidance (when to call which tool, common patterns, gotchas)
After editing the config with your real flows/paths, register the MCP in your agent and restart the session:
claude mcp add artillery-mcp -s user \
-e ARTILLERY_WORKDIR="$PWD" \
-e ARTILLERY_CLOUD_API_KEY=a9_... \
-- npx -y @kosiakmd/artillery-mcpInstall / Quickstart (zero-config)
Runs out of the box — no config file needed. Works as an MCP server over stdio for Claude Code, Claude Desktop, Cursor, and any MCP-compatible client.
# Using npx (no install)
npx -y @kosiakmd/artillery-mcp
# Or install globally
npm install -g @kosiakmd/artillery-mcp
artillery-mcpClaude Code / Cursor — register as an MCP server in your client config:
{
"mcpServers": {
"artillery-mcp": {
"command": "npx",
"args": ["-y", "@kosiakmd/artillery-mcp"],
"env": {
"ARTILLERY_WORKDIR": "/absolute/path/to/your/project",
"ARTILLERY_CLOUD_API_KEY": "a9_..."
}
}
}
}Claude Code CLI:
claude mcp add artillery-mcp -s user \
-e ARTILLERY_WORKDIR=/abs/path/to/project \
-e ARTILLERY_CLOUD_API_KEY=a9_... \
-- npx -y @kosiakmd/artillery-mcpPrerequisites: Node.js ≥ 20; Artillery CLI on PATH (npm i -g artillery).
Docker
Multi-arch image — linux/amd64 and linux/arm64, Artillery CLI preinstalled. ~500 MB (Chromium/Playwright browsers skipped — see below). Published to both Docker Hub and GitHub Container Registry from the same build; identical digests.
# Docker Hub (discoverable via `docker search artillery-mcp`)
docker pull kosiakmd/artillery-mcp:latest
# GitHub Container Registry
docker pull ghcr.io/kosiakmd/artillery-mcp:latestRun (mount your project as /workspace):
docker run -i --init --rm \
-v "$PWD":/workspace \
-e ARTILLERY_CLOUD_API_KEY="$ARTILLERY_CLOUD_API_KEY" \
kosiakmd/artillery-mcp:latest--init ensures the Node process gets reaped on stdin close. Mount /workspace read-write if you want save_config tools to persist to /workspace/saved-configs/; read-only is fine otherwise (the save-config family will simply return errors when called).
MCP client config (Claude Desktop / Cursor) — point the MCP at docker instead of npx:
{
"mcpServers": {
"artillery-mcp": {
"command": "docker",
"args": [
"run", "-i", "--init", "--rm",
"-v", "/absolute/path/to/your/project:/workspace",
"-e", "ARTILLERY_CLOUD_API_KEY",
"kosiakmd/artillery-mcp:latest"
],
"env": { "ARTILLERY_CLOUD_API_KEY": "a9_..." }
}
}
}Playwright engine? If you use engine: playwright in your Artillery scripts, extend the base image with Chromium:
FROM kosiakmd/artillery-mcp:latest
ENV PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=0
RUN apk add --no-cache chromium nss freetype harfbuzz ttf-freefont \
&& npm i -g @playwright/test \
&& npx playwright install chromiumImage tags:
latest— most recent releasev0.1.1,v0.1,v0— pinned by semver (patch / minor / major)
Environment variables
| Var | Purpose | Default |
|---|---|---|
| ARTILLERY_BIN | Path to artillery binary | auto-detected via which artillery |
| ARTILLERY_WORKDIR | Working directory for runs | cwd |
| ARTILLERY_TIMEOUT_MS | Max duration of a single run | 1800000 (30 min) |
| ARTILLERY_MAX_OUTPUT_MB | Cap on captured stdout/stderr | 10 |
| ARTILLERY_ALLOW_QUICK | Enable quick_test tool | true |
| ARTILLERY_CLOUD_API_KEY | Used when a tool is called with record: true | — |
| ARTILLERY_MCP_CONFIG | Absolute path to project config (opt-in) | — |
| DEBUG | artillery:mcp:* for verbose logs | — |
16 base tools (no config needed)
run_test_from_file— full-flagartillery runwrapper (see flag surface above).run_test_inline— same but takes YAML text, writes to a tmp file.quick_test—artillery quick <url>with rate/count/duration/method/headers/body.run_fargate—artillery run-fargatewith--region,--cluster,--cpu,--memory,--launch-type,--spot,--subnet-ids,--security-group-ids,--task-role-name,--task-ephemeral-storage,--container-dns-servers,--max-duration,--packages,--secret,--no-assign-public-ip+ all run-shared flags.list_capabilities— versions of Artillery/Node/this server, configured paths, limits.parse_results— reads an Artillery JSON report; returnssummary+allCounters+allRates+allSummaries+ scenarios + metadata.read_artillery_output— reads a raw Artillery stdout dump (e.g.artillery-output.txtsaved from CI), returnsrawText(with tail-truncation),summaryBlock,counters,rates,metrics(nested percentiles).save_config/list_configs/get_config/delete_config— persistent named Artillery configs.run_saved_config— re-run a saved config by name.wizard_start/wizard_step/wizard_finalize— interactive test builder.run_preset_test— smoke / baseline / soak / spike presets against a URL.compare_results— diff two Artillery JSON results for regression detection.
Optional feature #1 — Project launcher (run_project_lt)
Activated when a .artillery-mcp.config.json file is discovered. Gives you
one-liner invocations instead of writing full artillery run ... flag lists.
Discovery precedence:
ARTILLERY_MCP_CONFIGenv var (absolute path)- Walk up from
ARTILLERY_WORKDIR/cwdlooking for.artillery-mcp.config.json - No config → this tool is not registered
Config (.artillery-mcp.config.json):
{
"flows": {
"browse": "tests/load/browse.yml",
"buy": "tests/load/buy.yml",
"combined": "tests/load/combined.yml"
},
"environments": ["local", "staging", "prod"],
"defaultTags": { "repo": "my-app", "owner": "Platform" },
"tagTemplates": ["type:{flow}", "env:{env}", "source:mcp"],
"outputDir": "load-test-results"
}Call:
{ "flow": "buy", "environment": "staging", "note": "canary v42" }Effective command:
artillery run \
--record \
--name "buy-staging-2026-04-15T00-35-00-000Z" \
--tags "repo:my-app,owner:Platform,type:buy,env:staging,source:mcp" \
-e staging \
--note "canary v42" \
-o /abs/project/load-test-results/buy-staging-2026-04-15T00-35-00-000Z.json \
/abs/project/tests/load/buy.ymlOptional fields:
tagTemplates—{flow},{env}, plus any caller-suppliedtemplateVars(e.g.{round})outputDir— relative to project root; if missing, outputs land at project rootdefaultTags— merged before templatesenvironments— if empty, any environment name is accepted
Override on the call side: name, note, extraTags, outputJson, reportHtml,
variables, overrides, record: false, validateOnly, extraArgs, templateVars.
Optional feature #2 — Counter-group bucketing (counterBreakdown)
When you emit custom counters via events.emit('counter', 'shop.step.add_item.happy', 1),
Artillery aggregates them into aggregate.counters. This server returns ALL of
them in allCounters. Add counterGroups to your config to also get a
pre-bucketed counterBreakdown in parse_results and read_artillery_output
responses — ideal for CI pass/fail views and semantic grouping.
Config:
{
"counterGroups": {
"name": "shopBreakdown",
"prefix": "shop.",
"buckets": [
{ "key": "steps", "match": "^shop\\.step\\." },
{ "key": "cart", "match": "^shop\\.cart\\." },
{ "key": "payment", "match": "^shop\\.payment\\." },
{ "key": "flow", "match": "^shop\\.flow\\." },
{ "key": "other", "default": true }
]
}
}Example response (parse_results):
{
"summary": { "requestsTotal": 1500, "rpsAvg": 25, "latencyMs": { "p95": 850 }, "errors": {} },
"allCounters": { "shop.step.add_item.happy": 90, "http.requests": 1500, /* ... */ },
"allRates": { "http.request_rate": 25 },
"allSummaries": { "http.response_time": { "min": 45, "p99": 1800 } },
"counterBreakdown": {
"steps": { "shop.step.add_item.happy": 90, "shop.step.add_item.fail": 2 },
"cart": { "shop.cart.failure.quantity_update": 1 },
"payment": {},
"flow": { "shop.flow.started": 100 },
"other": {}
}
}Rules:
prefix(optional) — counters not starting with this string are ignoredbuckets— ordered; first match wins- One bucket may have
default: true— catches everything that didn't match - Invalid regex → throws at parse time (fix your config)
Without counterGroups, the counterBreakdown field is simply absent from responses.
Full config reference
{
"flows": { "<name>": "<relative yaml path>" }, // enables run_project_lt
"environments": ["<name>", "..."], // optional whitelist
"defaultTags": { "<k>": "<v>" },
"tagTemplates": ["type:{flow}", "env:{env}"],
"outputDir": "load-test-results",
"counterGroups": { // enables counterBreakdown
"name": "<output field name, cosmetic>",
"prefix": "<optional prefix filter>",
"buckets": [
{ "key": "<name>", "match": "<regex>" },
{ "key": "<name>", "default": true }
]
}
}Security
- No network I/O — only spawns the local
artilleryCLI. - No
eval/Function/ dynamic imports. - No install hooks.
- Dependencies pinned via
package-lock.json(committed). - Published with
npm --provenance(SLSA attestation).
Roadmap
v0.2 (next)
- [x] ~~Docker image (multi-arch amd64/arm64; Artillery CLI preinstalled; config via volume mount)~~ — shipped in v0.1.1
- [ ] Artillery Cloud API integration —
list_recent_runs,get_run_details(runUrl),compare_to_baseline(runUrl) - [ ]
run_reporttool — standalone wrapper aroundartillery report(JSON → HTML) - [ ] Config schema validation with helpful error messages (zod) on startup
- [ ] YAML config support (
.artillery-mcp.config.yml) - [ ] Playwright-engine Docker variant (
kosiakmd/artillery-mcp:latest-playwright) with Chromium preinstalled
v0.3+
- [ ] Artillery Lambda (
run-lambda) and Azure ACI (run-aci) tools — parity withrun-fargate - [ ]
run_project_ltmatrix mode — iterate over{ flow × env }combinations in one call - [ ] Per-flow config overrides (different counter-group rules / tag sets / env overrides)
- [ ] Streaming intermediate metrics via MCP progress events during long runs
- [ ] Built-in presets library (smoke/baseline/soak/spike) selectable via config
- [ ] Published JSON Schema at a stable URL for IDE autocompletion of config files
- [ ] Plugin API for custom counter-group matchers (beyond regex)
Under consideration
- [ ] Integration with Grafana/Prometheus for live metrics dashboards
- [ ] Native support for Artillery Pro / enterprise features
- [ ] TUI dashboard for long-running tests when invoked outside MCP
Issues and feature requests welcome: github.com/kosiakMD/artillery-mcp/issues.
Credits
Forked from jch1887/artillery-mcp-server (MIT). See NOTICE for the list of additions and modifications.
License
MIT — see LICENSE. Both the upstream and this fork's copyright notices must be preserved in substantial portions of the software.
