Documentation Index
Fetch the complete documentation index at: https://docs.wiremock.io/llms.txt
Use this file to discover all available pages before exploring further.
The WireMock Cloud agent skills plugin gives coding agents specialised knowledge and workflows for building and managing mock APIs in WireMock Cloud. Once installed, your agent can generate complete API simulations, create and validate stubs, convert stubs to stateful or data-driven variants, author response templates, and search the WireMock Cloud documentation - all without leaving your editor or terminal.
Agent Skills is an open format for extending AI agents with domain-specific capabilities. A skill is a folder containing a SKILL.md file with instructions and optional supporting resources. Agents discover skills at startup, load them when relevant, and follow the instructions to complete tasks.
Available skills
The plugin bundles seven skills:
| Skill | Description |
|---|
/build-api-simulation | Generate a complete mock API for any REST API - OpenAPI spec, Arazzo test workflows, and WireMock stubs, optionally recorded from a live sandbox |
| Create stubs | Create and import WireMock stubs for a mock API |
| Convert to stateful | Convert existing stubs to be stateful using the key-value state store |
| Convert to data-driven | Convert existing stubs to use CSV or database data sources |
| Validate and fix stubs | Validate stubs against the OpenAPI schema and fix any errors |
| Author response templates | Author and debug Handlebars response templates for WireMock stubs |
| Search WireMock Cloud docs | Search cached WireMock Cloud documentation for accurate answers about stubs, request matching, response templating, CLI, Runner, and more |
/build-api-simulation is a user-invocable slash command - type it to kick off a full API simulation workflow. The remaining skills are triggered automatically by context when relevant to the task at hand.
Prerequisites
Before using the skills you need the WireMock CLI installed and authenticated, as several skills interact with the WireMock Cloud API through MCP:
npm i -g @wiremock/cli
wiremock login
Supported agents
The Agent Skills format is supported by a growing number of coding agents. The table below lists agents that can use the WireMock Cloud skills plugin, with installation instructions for each.
Claude Code
GitHub Copilot
GitHub Copilot CLI
VS Code + Copilot
Cursor
Cursor CLI
Other agents
Claude Code has native support for agent skills via its plugin system.Add the marketplace registry containing the WireMock skills, then install the plugin from your terminal:claude plugin marketplace add wiremock-inc/skills
claude plugin install wiremock-cloud@wiremock-inc-skills
/plugin marketplace add wiremock-inc/skills
/plugin install wiremock-cloud@wiremock-inc-skills
What skills are available?
The GitHub Copilot coding agent and VS Code agent mode discover skills from .github/skills/ or .claude/skills/ directories in your repository.Clone the skills into your project’s .github/skills/ directory:git clone https://github.com/wiremock-inc/skills.git /tmp/wiremock-skills
cp -r /tmp/wiremock-skills/skills/* .github/skills/
rm -rf /tmp/wiremock-skills
git submodule add https://github.com/wiremock-inc/skills.git .github/wiremock-skills
GitHub Copilot CLI has a built-in plugin system for installing skills from marketplaces and Git repositories.Add the marketplace registry containing the WireMock skills, then install the plugin:copilot plugin marketplace add wiremock-inc/skills
copilot plugin install wiremock-cloud@wiremock-inc-skills
/plugin marketplace add wiremock-inc/skills
/plugin install wiremock-cloud@wiremock-inc-skills
copilot plugin install wiremock-inc/skills
VS Code discovers agent skills from .github/skills/ or .claude/skills/ directories in your workspace.Copy the skills into your project:git clone https://github.com/wiremock-inc/skills.git /tmp/wiremock-skills
cp -r /tmp/wiremock-skills/skills/* .github/skills/
rm -rf /tmp/wiremock-skills
Cursor automatically discovers skills from .cursor/skills/ or .claude/skills/ directories.Option 1: Import from GitHub (recommended)
- Open Cursor Settings (
Cmd+Shift+J on Mac, Ctrl+Shift+J on Windows/Linux).
- Navigate to Rules.
- In the Project Rules section, click Add Rule.
- Select Remote Rule (Github).
- Enter
https://github.com/wiremock-inc/skills.
Option 2: Copy manuallygit clone https://github.com/wiremock-inc/skills.git /tmp/wiremock-skills
cp -r /tmp/wiremock-skills/skills/* .cursor/skills/
rm -rf /tmp/wiremock-skills
The Cursor CLI provides terminal-based access to the Cursor agent. It automatically discovers skills from the same directories as the Cursor editor - .cursor/skills/ and .claude/skills/ in your project.Copy the skills into your project:git clone https://github.com/wiremock-inc/skills.git /tmp/wiremock-skills
mkdir -p .cursor/skills
cp -r /tmp/wiremock-skills/skills/* .cursor/skills/
rm -rf /tmp/wiremock-skills
The Agent Skills format is supported by many other coding agents including Gemini CLI, OpenAI Codex, JetBrains Junie, Windsurf, Goose, Roo Code, and more. See agentskills.io for the full list.For any compatible agent, clone the skills repository and copy the skills/ directory contents into the location your agent expects:git clone https://github.com/wiremock-inc/skills.git /tmp/wiremock-skills
cp -r /tmp/wiremock-skills/skills/* <your-agent-skills-directory>/
rm -rf /tmp/wiremock-skills
| Agent | Directory |
|---|
| Gemini CLI | .gemini/skills/ |
| OpenAI Codex | .codex/skills/ |
| JetBrains Junie | .junie/skills/ |
| Goose | .goose/skills/ |
| Roo Code | .roo/skills/ |
Skills vs MCP
The WireMock Cloud agent skills and the WireMock MCP server are complementary:
- MCP gives your agent tools - the ability to call the WireMock Cloud API, search stubs, manage mock APIs, and make HTTP requests.
- Skills give your agent expertise - knowledge of WireMock Cloud concepts, best practices, and multi-step workflows that orchestrate those tools effectively.
For the best experience, install both. The skills rely on MCP tools to interact with WireMock Cloud, while MCP tools are more effective when the agent has the domain knowledge that skills provide.
