MCP Server - Documentation - OctoPerf
Skip to content
Initializing search
Account
Notifications
Usage logs
MCP Server
MCP Server
Connect a client
Claude Code
Claude Desktop
Codex
ChatGPT
Gemini CLI
GitHub Copilot (VS Code)
Cursor
Where to go next
Tutorials
Blog Tutorials
Interactive Tutorials
Design
HAR Recorder
JMeter JMX Recording
Postman collection
Playwright
Edit a Virtual User
Post Processors
JSR223 Actions
Web Driver
Playwright Actions
Configuration
Secret
Auto Correlation
SLA Profiles
Files
Data generation
Search and Replace
VU Validation
Plugins Usage
Functions
Code Editor
Runtime
Integrations & Automation
Application Performance Management
CI/CD
Launching a Test
IP Ranges
Test startup process
Scheduler
Monitoring
Edit a Connection
Threshold Usage
Analysis
Agent monitoring
Test Logs
Report Templates
Runtime Properties
Export
Compare Test Results
Trend Test Results
Import JTL
Test status
On-Premise Agent
Cloud Instances
Dedicated IPs
On-Premise Infra
Miscellaneous
Connect a client
Claude Code
Claude Desktop
Codex
ChatGPT
Gemini CLI
GitHub Copilot (VS Code)
Cursor
Where to go next
MCP Server¶
The OctoPerf MCP server lets any Model Context Protocol - aware AI agent drive your OctoPerf account - import Virtual Users, edit them, validate, run load scenarios, and read back metrics - all from a chat or IDE, without leaving the agent.
It is exposed at https://api.octoperf.com/mcp.
What it does¶
The MCP server is a thin, stateless bridge between an LLM agent and the OctoPerf REST API. Every tool call is authenticated as you : there are no service identities and no API keys - and resolves to a regular OctoPerf API call. Anything you can do from the web UI as your user, the agent can do on your behalf when you authorize it.
Concretely, the server exposes around 100 tools grouped into the following areas:
Discovery : list workspaces, projects, scenarios, Virtual Users, Docker providers
Virtual User import : bring in recordings from HAR, JMX, Postman, Playwright, WebDriver, URL lists, or previously exported archives
Virtual User edit : rename, re-tag, patch the action tree via JSON Patch, manage variables, HTTP servers, correlation rules and project files
Validation : kick off a functional check, read back the per-action validation index, drill into failing requests / responses, fetch HTTP bodies
Bench run : start a scenario, monitor progress, stop a running run, read Docker launch logs
Analysis : list and read bench reports, fetch the value series behind any chart / table / summary / top widget, expand error rows, run trend reports
Each tool returns a deep-link to the matching page in the OctoPerf UI so the agent can hand you a clickable URL when it summarizes a result.
Public HTTP downloads¶
The MCP server also serves a small set of public, unauthenticated markdown files under /mcp/public/**, so any agent host can bootstrap an OctoPerf project before it has IdP credentials:
URL<br>Body
https://api.octoperf.com/mcp/public/AGENTS.md<br>Cross-vendor agent guide - drop at the root of a project
https://api.octoperf.com/mcp/public/skills/auto-correlation.md<br>Skill: fix replay failures caused by dynamic values (CSRF, sessions)
https://api.octoperf.com/mcp/public/skills/validation-triage.md<br>Skill: triage a Virtual User with many validation failures
https://api.octoperf.com/mcp/public/skills/scenario-diagnosis.md<br>Skill: investigate a poor or failing scenario run
https://api.octoperf.com/mcp/public/skills/real-browser-probe.md<br>Skill: convert a JMeter VU to Playwright and compose a hybrid load + UX-probe scenario
https://api.octoperf.com/mcp/public/skills/scheduling.md<br>Skill: schedule scenarios (one-shot / cron) with the right UTC + Unix cron semantics
https://api.octoperf.com/mcp/public/skills/bench-reports.md<br>Skill: pick the right tool per bench-report widget, decode metric semantics, read trends
https://api.octoperf.com/mcp/public/skills/export-bench-report-pdf.md<br>Skill: export a bench report as PDF (submit print task, poll, download)
https://api.octoperf.com/mcp/public/skills/async-polling.md<br>Skill: polling cadence and terminal conditions for async tasks (validations, runs, ...)
These files are also available in OctoPerf Claude Plugins repository
JSON schemas¶
The entity schemas used to build patch_* payloads (JSON Schema 2020-12, one oneOf branch per polymorphic subtype) are served the same way, as plain JSON under /mcp/public/schema/. These are the HTTP fallback for clients that call tools but don't read MCP resources — the body is identical to the matching octoperf://schema/* resource:
URL<br>Schema
https://api.octoperf.com/mcp/public/schema/vu.json<br>Virtual User action tree
https://api.octoperf.com/mcp/public/schema/scenario.json<br>Scenario + user profiles
https://api.octoperf.com/mcp/public/schema/bench-report.json<br>Bench report...