Skip to main content

Katalon True Platform MCP Server

Last updated: June 2026

This document lists tool descriptions of Katalon True Platform MCP server, and explains how to connect to the server using an external AI provider.

Overview​

Katalon True Platform integrates with modern AI tools through the Model Context Protocol (MCP).

With the Katalon True Platform MCP Server, you can use your AI assistant (Claude, GitHub Copilot, or ChatGPT with MCP support) to work directly with Katalon True Platform artifacts, such as Test Cases, Test Suites, Test Runs, Test Folders, Requirements, Defects, Iterations (Sprints/Releases), Repositories, and Projects.

This integration lets you create, update, move, duplicate, delete, and search Katalon True Platform assets, as well as query configuration and quality insights, all from within your AI toolβ€”streamlining test management, reporting, and analysis workflows.

Connect to the MCP Server​

Availability Notice
  • The Katalon True Platform MCP Server integration is available only for Katalon True Platform.
  • If you are using TestOps Legacy, please contact your Customer Success Manager (CSM) for upgrade guidance and compatibility support.
Requirements
  • Ensure your AI tool supports MCP server connection.
  • For tools that do not support remote MCP servers natively, install the required utilities such as npx.
  • Confirm that your AI tools (e.g., Claude Desktop, ChatGPT) is configured to connect with an external MCP server.

To True Platform MCP​

To connect your AI tool with Katalon True Platform, point it to the Katalon True Platform MCP endpoint:

  • Recommended: use the canonical endpoint https://platform.katalon.io/mcp in any AI tool that supports configuring a remote MCP server natively. This single endpoint works for every workspace: on first connect it starts a browser sign-in and then prompts you to choose your workspace/account (the same picker as logging in to True Platform), so you do not need to know your subdomain in advance.
  • Dedicated domains only: if your organization uses a dedicated Katalon domain, you can substitute https://<your-sub-domain>.katalon.io/mcp instead. See Sub Domain for more information.
  • If your tool does not support remote MCP servers natively (for example, Claude Desktop), add the following JSON configuration to your MCP server setup.

Run the following command in your terminal:

claude mcp add katalon-prod-mcp -- npx -y mcp-remote https://platform.katalon.io/mcp --transport http-first

Alternatively, add the server to your project's .mcp.json file:

{
"mcpServers": {
"katalon-prod-mcp": {
"command": "npx",
"args": [
"-y",
"mcp-remote",
"https://platform.katalon.io/mcp",
"--transport",
"http-first"
]
}
}
}

To Katalon Documentation MCP​

Use the public MCP endpoint for Katalon Documentation if you need to search or fetch public Katalon documentation from an MCP-compatible client.

{
"mcpServers": {
"katalon-docs": {
"url": "https://mcp.katalon.com/mcp",
"type": "http"
}
}
}

The public Katalon documentation MCP endpoint does not require authentication. To learn more, see Katalon MCP Server.

After updating the configuration:

  1. Restart your AI application to detect the new MCP server connection.
  2. Your browser will display a prompt asking you to log in to your Katalon True Platform account, then to choose the workspace/account you want to work with.
  3. In your AI tool, make sure to toggle on the katalon-prod-mcp tool to activate it.

Katalon True Platform MCP Server tool list​

The Katalon True Platform MCP Server currently supports the following tools:

Workspace Details tools​

Use these tools to understand your current workspace context before taking action in a project.

ToolDescription
list_projectsList Katalon True Platform projects the user has access to.
list_repositoriesList repositories under a Katalon True Platform project.
find_iterationsFind the iterations (sprints or releases) of a Katalon True Platform project.
find_execution_profilesList execution profiles for the given projectId and testProjectId (repository ID).
get_user_contextRetrieve the currently authenticated user's profile information.

ALM Requirements tools​

Use these tools to work with requirements pulled from your integrated ALM tool.

ToolDescription
find_requirementsFind requirements from integrated issue tracking systems (JIRA, Azure ADO).
read_requirementRetrieve a specific requirement by its internal ID or source system key (e.g. JUL-3449, TO-12345).
link_requirements_to_test_caseLink requirements to a specific test case.
unlink_requirements_from_test_caseUnlink requirements from a specific test case.
find_test_cases_by_requirementFind test cases linked to a requirement, identified by its source key or external issue ID.
find_alm_integration_projectsList ALM integration projects configured for a Katalon True Platform project.

ALM Defects tools​

Use these tools to turn failed test outcomes into actionable defects in your integrated ALM tool.

ToolDescription
create_defectCreate a new bug or new defect in the Alm project and link it to a specific test result.

Test Artifact Management tools​

Use these tools to organize and manage testing assets used across your project.

ToolDescription
find_test_casesFind test cases within a repository.
read_test_caseGet the details of a specific test case by its ID.
create_test_caseCreate a manual test case with optional test steps.
move_test_caseMove a test case to a new folder while keeping its existing name.
duplicate_test_caseDuplicate a test case.
delete_test_caseDelete a test case.
update_test_caseUpdate metadata and content of existing test cases.
find_test_suitesFind test suites within a repository.
read_test_suiteGet details of a specific test suite by its ID, including list of test cases within test suite.
manage_test_suiteManage test suites and their relationships with test cases.
find_test_suite_collectionsFind test suite collections within a repository.
find_test_foldersFind test folders within repository of project.
manage_test_folderManage test folders.

Automated Test Run tools​

Use these tools to prepare, schedule, and manage automated executions across supported environments.

ToolDescription
build_run_configurationBuild a configuration object suitable for schedule_test_run.
build_scheduleBuild a schedule payload for schedule_test_run or create_manual_test_run.
schedule_test_runSchedule a Katalon True Platform test run.
read_execution_test_resultsRetrieve job-grouped test results for a Katalon True Platform execution.
rerun_executionRe-run a test execution with optional job targets.
list_scheduleList saved schedules for a project.
update_schedule_configurationUpdate an existing schedule's configuration or timing.
read_schedule_detailRead the current schedule definition (ScheduleResource) for a given id.

Manual Test Run tools​

Use these tools to launch and follow manual test runs, including AI-assisted execution flows.

ToolDescription
read_autsReturn available Application Under Test (AUT) entries with their nested environments.
create_manual_test_runCreate a manual test run in Katalon Katalon True Platform.
create_manual_ai_sessionOpen an AI-assisted session for an existing manual test run.
read_manual_ai_sessionGet the current status of all runner sessions in a manual AI execution.
read_manual_test_run_detail_by_orderSearch manual test executions by execution order.

Cloud Execution tools​

Use these tools to set up and manage Cloud executions.

ToolDescription
list_test_cloud_environmentsFetch environments from Test Execution Cloud API with optional RSQL filter and pagination.
list_test_cloud_agentsList available Test Execution Cloud agents scoped to the current account and project.
list_test_cloud_appsList uploaded Test Execution Cloud apps with optional RSQL filters and pagination.
manage_test_cloud_dynamic_appManage Test Execution Cloud dynamic apps.
delete_test_cloud_appDelete one or multiple apps from Test Execution Cloud.
get_upload_test_cloud_app_urlReturns a temporary upload URL so you can upload an app file to Test Execution Cloud via curl, then register it for use.
create_test_cloud_appCreate a Test Execution Cloud app from an uploaded app file.
list_test_cloud_tunnelsList active Test Execution Cloud tunnels.
prepare_test_cloud_tunnel_startGather download URLs, API keys, and commands to guide users through the Test Execution Cloud tunnel setup experience.
build_private_local_testing_configBuild a private local testing configuration payload.
stop_test_cloud_tunnelStop an active Test Execution Cloud tunnel via DELETE /tc/ees/tunnels/{id}.

Test Result query tools​

Use these tools to investigate execution outcomes and review run history.

ToolDescription
find_test_resultsFind test results (execution test results) within a project.
read_test_resultGet the details of a specific execution test result.
list_executionsList test executions with optional filtering.
read_executionGet detailed information about a specific test execution.
list_execution_outputsList execution outputs or discover recent executions.

Insights tools​

Use these tools to understand insights evaluate quality trends, coverage, and stability across your testing activities.

ToolDescription
get_defect_insightsRetrieves defect insight for a specific sprint/release iteration or time range.
get_requirement_insightsRetrieves requirement insight for a specific sprint/release iteration.
get_test_case_insightsRetrieves test case insight for a specific sprint/release iteration or date range.
get_test_configuration_insightsRetrieves configuration insight for a specific sprint/release iteration or date range.
analyze_test_case_stabilityAnalyzes stability of test cases identifying flaky tests, consistently failing tests, newly introduced failures, and slow-running tests.
analyze_test_flakinessAnalyze test executions over a lookback period and minimum number of test runs.

Katalon True Platform skills for AI agents​

The MCP server gives your AI agent the tools. The open-source Katalon True Platform skills give it the playbooks: tested, reusable workflows that turn a request such as "cover this requirement" or "ship my Playwright results" into a complete, traceable run on Katalon True Platform.

Supported agents: Claude Code, OpenAI Codex, GitHub Copilot, Cursor, Kiro, Windsurf, Cline, Continue, and other agents that support reusable instruction files.

Included skills​

SkillWhat it doesTry this prompt
katalon-platform-setupInstalls, verifies, and troubleshoots the MCP connection. Confirms project and repository access, and diagnoses authentication errors."Set up Katalon MCP and verify my projects."
katalon-trueplatform-testingRuns the full requirement-to-result workflow: analyze a requirement, design test cases, import them, build a suite, run with AI, and report results."Test requirement CEL-6 end to end on Katalon Platform."
katalon-create-test-casesDesigns ISTQB-aligned manual test cases from a requirement or free-text behavior, checks existing coverage, and imports only what is missing."Create manual tests from requirement CEL-6."
katalon-execute-testCreates manual test runs, starts Run with AI, schedules automated suites, and summarizes pass/fail/blocked outcomes."Run a Katalon suite with AI and summarize results."
katalon-test-case-to-playwright-scriptConverts manual test cases into Playwright TypeScript automation with Page Object Model, keeping Katalon case IDs for traceability."Generate a Playwright script from a Katalon test case."
katalon-playwright-executeRuns Playwright tests with the Katalon reporter configured and verifies the uploaded run in Katalon True Platform."Execute a Playwright suite and upload the report to Katalon Platform."
katalon-upload-reportUploads Katalon Studio/KRE, JUnit XML, and Playwright reports, then verifies the uploaded runs."Upload my JUnit report to Katalon and verify the run."
katalon-release-analyzeAssesses release readiness from coverage, execution health, defect risk, and stability data, with a Ready / Ready with risk / Not ready verdict."Is Sprint 24 ready to ship?"

Install (Claude Code)​

claude plugin marketplace add katalon-labs/true-skills
claude plugin install katalon-true-platform@katalon-true-platform-marketplace

The plugin installs the skills and connects them to the Katalon MCP server. For install steps for the other agents, see the Katalon Labs repository. Start with katalon-platform-setup to connect and verify the MCP, then use the workflow skills.

Usage guidelines​

  • Use MCP tools for Katalon Platform data such as projects, requirements, test cases, suites, runs, results, and defects. Use browser or Playwright tools only for the application under test.
  • Confirm the target project and repository before creating or updating test artifacts. A repository in Katalon True Platform is the Test Project.
  • Understand the boundaries. Requirements are created in Jira or Azure DevOps and then synced to Katalon. Defects must be linked to a failed test result. AI execution can also depend on the application, account, or test environment.
  • Include evidence for failures when available, such as the error message, screenshot, or trace.
  • Protect credentials. Authentication uses browser-based OAuth. Do not paste passwords, API tokens, cookies, JWTs, MFA codes, or OAuth callback URLs into chat, and do not commit them.

Sample workflow: from requirement to test results​

A single prompt such as Test requirement CEL-6 end to end triggers the following flow:

  1. The agent verifies the MCP connection and resolves your project and repository.
  2. It reads requirement CEL-6 from your integrated ALM tool and analyzes the expected behavior.
  3. It designs manual test cases based on the expected behavior.
  4. It checks existing coverage and imports only the missing cases, linking each one back to the requirement.
  5. It creates or reuses a test suite, creates a manual test run, and starts Run with AI.
  6. It monitors the run until every test case completes, then reports results with links: for example, 6 passed, 1 failed, 1 blocked, plus recommended next actions.

To continue into automation, ask the agent to convert the same suite into Playwright scripts and run them. Automated results can be uploaded to Katalon True Platform so they appear next to your manual runs. See Playwright integration for reporter setup details.

What the MCP can and cannot do​

The True Platform MCP Server covers test artifact management, manual and automated execution, results, and quality insights. A few operations are intentionally out of scope:

Not available through MCPWhat to do instead
Create requirementsCreate them in Jira or Azure DevOps, then sync and link them in Katalon.
Inspect the live application under testUse your agent's browser or Playwright tooling to explore the application.
Create a defect without a failed test resultRun the test first; defect creation links to a failed test result ID.

Example use cases​

Once your MCP server connection is active, you can use your LLM to interact directly with Katalon True Platform. Common use cases include:

  • Plan and launch regression runs: ask the assistant to build run configurations, create schedules, and rerun selected executions.
  • Investigate release risk faster: ask the assistant to identify flaky tests, newly introduced failures, slow-running tests, and defect trends for a sprint or release.
  • Turn failures into action: trace a failed result back to its linked requirement, review related test cases, and create a defect in Jira or Azure DevOps from the same conversation.

These workflows help teams move from simple content lookup to AI-assisted test operations, combining project context, traceability, execution control, and quality analysis in one place.

Watch how Claude Desktop connects to the Katalon True Platform MCP Server to analyze project data.

Troubleshooting​

  • Invalid JWT token format error on first connection: this is the authentication challenge before the browser sign-in completes, not a server failure. Finish the browser login and retry.
  • Connection fails with --transport http: use --transport http-first in the mcp-remote arguments.
  • Skills installed but no Katalon tools appear: the MCP server is not connected. Add katalon-prod-mcp manually as shown in Connect to the MCP Server, then restart your AI tool.
  • Agent cannot find your project: ask it to run the setup skill ("Set up Katalon MCP and verify my projects") to confirm project and repository access.

See also​

Was this page helpful?