Katalon True Platform MCP README
The full upstream README, mirrored here for reference. Install config, tool schemas, adoption signals, and an original overview live on the Katalon True Platform MCP listing page.
Ask your coding agent to read a requirement, design the test cases, run them with AI, upload the reports, and tell you whether the release is safe to ship. The skills do the platform work through the Katalon MCP, so the agent operates your real project instead of guessing at it.
An example session. Your requirement keys, suites, and verdicts come from your own workspace.
Quickstart
1. Install the skills. The skills CLI detects the agent you already run (70+ supported) and drops the skills into its native directory.
2. Point it at your Katalon workspace. Add the MCP server to your agent's config file (the install section says which file yours is):
First connect opens a browser OAuth flow and lets you pick your workspace. Nothing to fill in, no tokens to paste, no keys to store.
3. Ask for something real.
Or hand over the whole chain: "Analyze CEL-6, design and import the cases, build a suite, run it with AI, and tell me if we can ship."
Start where you are
Four jobs. Say the situation in your own words and the agent picks the skill.
| You are a | You say | It starts at |
|---|---|---|
| Manual tester QA analyst, test analyst | I just got requirement CEL-6 and need cases · Run this suite with AI and tell me what broke · Is this failure the app or my test | create-test-cases → test-data → execute-test → analyze-failures Unscripted session? exploratory-charter. |
| Automation tester SDET, automation engineer | Turn TC-1042 into a Playwright spec · Get my run into the platform · Our suite went flaky this month | test-case-to-playwright → playwright-execute → test-maintenance |
| Test lead QA lead, QE lead | What should we test first this sprint · Is this suite ready for the pipeline · Which requirements have no coverage | test-plan → test-estimation → test-review → test-management |
| Test manager QA manager, head of quality | Can we ship 3.2 · How long will this take and with how many people · Build the summary I present upward | release-analyze → test-estimation → test-reporting |
Not connected yet? Start at platform-setup, which everyone runs once.
Not sure which one you are, or the request spans several? Ask true-platform-testing and it routes by role and by stage. The full map from intent to skill, including what to fall back to for the parts not built yet, is in lifecycle-map.md.
The skills
Eighteen skills, one folder each under skills/. The agent picks the right one from its description, so you rarely name a skill yourself.
| Skill | Stage | What it does |
|---|---|---|
| platform-setup | setup | Installs and verifies the Katalon MCP, and diagnoses auth or access failures. Start here. |
| test-plan | 1 plan | Turns quality goals into scope, ranks the work by requirement coverage and risk, and builds the folder and suite structure that acts as the executable plan. |
| test-estimation | 1 plan | Sizes a test cycle from scope, risk, and historical execution data, resources it across the manual and automated lanes, and states the uncertainty instead of inventing precision. |
| create-test-cases | 2 design | Reads a requirement or free text, designs atomic manual cases with ISTQB techniques as reference, skips duplicates, imports only what is missing, and links each case back to the requirement. |
| test-data | 2 design | Designs the data a case runs on, decides what must exist before a run, keeps literals out of the step text, and resets state afterwards so the next run starts clean. |
| exploratory-charter | 2 design | Writes a charter with a mission, areas, oracles, and a timebox, runs the session, and turns what was found into defects and scripted cases. |
| test-management | 3 manage | Organizes folders and suites, finds assets at scale, and produces a requirement to case to suite traceability report with coverage percentage and orphans. |
| test-review | 4 review | Reviews coverage, case quality, and flakiness before anything enters the pipeline, and returns Approve, Approve with fixes, or Reject plus the specific weak cases. |
| execute-test | 5 execute | Runs a case, a list, or a suite as a manual run, a Run with AI session, or scheduled automation, then reports pass, fail, and blocked. |
| upload-report | 5 execute | Runs automation and uploads or verifies Katalon Studio/KRE, JUnit XML, and Playwright reports on the platform. |
| test-case-to-playwright | 5 execute | Converts manual cases into Playwright TypeScript with Page Object Model and fixtures. |
| test-case-to-katalon-studio | 5 execute | Converts manual cases into Katalon Studio test cases and Groovy scripts, keeping the .tc and .ts pair GUID-consistent. |
| playwright-execute | 5 execute | Runs Playwright specs, ships the report with @katalon/playwright-reporter, and verifies the run landed. |
| analyze-failures | 6 analyze | Sorts failures into product defect, automation defect, and environment noise, clusters them by signature, and files ALM defects for the real bugs. |
| release-analyze | 6 analyze | Reads coverage, stability, and defect data to return Ready, Ready with risk, or Not ready, with the reasons attached. |
| test-reporting | 6 analyze | Turns platform quality data into the few metrics that answer a stakeholder question, trended across releases, as a summary a manager can present upward. |
| test-maintenance | 7 maintain | Finds flaky and broken cases from stability history, repairs or regenerates them, and hands the refreshed gap list back to planning. |
| true-platform-testing | all | The router and end to end runner. Routes any request to the right stage, or drives the full chain from requirement to ship decision. |
Multi-skill playbooks live in combination-recipes.md. Copy-paste prompts and cross-model notes are in prompt-recipes.md.
The lifecycle
Seven stages, each owned by a skill. The loop closes when maintenance feeds its gap list back into the plan.
platform-setup sits before all seven, connecting the MCP. Every skill states which Katalon MCP tools it uses and where the platform stops. Full stage map: lifecycle-map.md. Every tool in one line each: mcp-tool-index.md. A self-contained visual for humans: docs/lifecycle.html.
Where the boundary is
Each skill names its limits up front so the agent does not promise work the platform cannot do.
Through the MCP: list projects and repositories, read requirements, create and update and link test cases, manage suites and folders, create manual runs, start Run with AI, poll AI sessions, read results, fetch quality metrics, and file ALM-linked defects.
Not through the MCP: creating requirements, creating a formal Test Plan entity, guaranteeing an AI run finishes, or inspecting the live app UI without a browser tool. A named suite plus a release or sprint association stands in for the Test Plan entity.
Some work is a product surface rather than an API call: object capture and resilience design in Studio, custom fields and Git config and governance in the TestOps UI, self-healing and Time Capsule and TrueTest regeneration, and rerun, terminate, and Live Monitor. The full list is in unavailable-capabilities.md.
Install
Every path needs the Katalon MCP configured.
Any agent via the skills CLI
The CLI installs skill files only. Configure the MCP yourself with the snippet below, or use the Claude Code and Codex plugin paths, which bundle it.
Any agent via the Agent Plugins standard
This repository conforms to the Agent Plugins specification 1.0.0: plugin.json + skills/ + mcp.json at the repo root form a portable plugin any conformant client can load directly, and plugins/katalon-true-platform/ ships the same contract as a standalone plugin directory. Skills follow the Agent Skills format. Point your standard-aware client at either directory; mcp.json already declares the canonical endpoint as a streamable-http server, so there is nothing to fill in.
Claude Code plugin marketplace
Developing against a checkout:
The plugin ships the skills and an .mcp.json. If your setup does not auto-load the bundled MCP, add it manually.
Codex plugin marketplace
Open Plugins in Codex and install Katalon True Platform. Set your subdomain in the plugin's .mcp.json.
GitHub Copilot agent skills + MCP
- VS Code (agent mode) - skills in
.github/skills/load automatically; prompt files stay available as/platform-setupetc. Start thekatalon-prod-mcpserver when VS Code offers it: it signs you in through the browser OAuth flow and you pick your workspace. Nothing to configure, no token pasting. - Copilot CLI - the same skills are auto-discovered (
/skills listto see them). The MCP server auto-loads from.github/mcp.jsonwith no edits; or register it interactively with/mcp add(typehttp, same URL). The CLI does not read.vscode/mcp.json. - Copilot coding agent & code review - read
.github/skills/from your repository automatically. Neither surface supports OAuth remote MCP servers yet, so keep Katalon platform operations in VS Code or the CLI for now.
Cursor project rules
Rules in .cursor/rules/*.mdc load by description when relevant. MCP config lives in .cursor/mcp.json.
Kiro steering docs
Steering docs use manual inclusion, so reference one in chat with #true-platform-testing. MCP config lives in .kiro/settings/mcp.json.
Kiro Crew app
Kiro Crew installs this as an app — apps/katalon-testing-skills/ carries an app.json manifest that registers all 18 skills and the katalon-prod-mcp server on install. From the dashboard's Apps page, install from the local path, or submit the repo to the Kiro Crew app registry so it appears under Apps → Discover. First MCP connect opens the browser OAuth flow and a workspace picker.
Details in apps/katalon-testing-skills/README.md.
Windsurf rules
Rules in .windsurf/rules/*.md trigger on their description. Add the MCP under Settings → MCP, or in ~/.codeium/windsurf/mcp_config.json.
Cline project rules
Cline loads every file in .clinerules/. Add the MCP through its MCP Servers panel.
Continue rules and MCP block
Rules live in .continue/rules/*.md, the MCP block in .continue/mcpServers/katalon.yaml.
Anything else via AGENTS.md
Point your agent at AGENTS.md. It indexes every skill and tells the agent to open skills/<name>/SKILL.md. Use the root .mcp.json for the server config.
Connect the Katalon MCP
One endpoint serves every workspace: https://platform.katalon.io/mcp. Sign-in presents a workspace picker, so there is no subdomain to look up. The canonical shape lives in .mcp.json:
Agents without native remote-MCP support (Kiro, Continue, Codex) use the mcp-remote wrapper against the same endpoint:
- Complete the browser OAuth flow that opens on first connect.
- Pick your workspace.
- Reload the agent if the tools do not show up.
On a dedicated Katalon domain, substitute https://<your-sub-domain>.katalon.io/mcp.
Auth is browser OAuth only. Never paste passwords, API tokens, cookies, JWTs, MFA codes, or OAuth callback URLs into chat, and never commit them. The skills enforce this.
How it is built
The skill bodies live once. Everything each agent needs is generated from them, so no adapter can drift.
Contributing
Edit skills/ only. Everything else is generated. Then:
The build is deterministic. Re-running it with no skill changes produces no diff, and CI rejects out-of-sync adapters. Details in CONTRIBUTING.md.
Support
- Bugs, questions, and skill requests: open an issue
- Katalon platform and MCP support: support.katalon.com, or your Katalon Customer Success Manager
- MCP server documentation: docs.katalon.com
Privacy
The skills are plain markdown that runs inside the agent you already use. This repository collects nothing. Platform operations go to your own Katalon workspace over OAuth, and what Katalon does with that data is covered by the Katalon Privacy Policy.
License
MIT © Katalon. "Katalon" and "Katalon True Platform" are trademarks of Katalon, Inc.