Skip to main content

Katalon True Platform MCP Server

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

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.

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 (for example, Claude, GitHub Copilot, or ChatGPT with MCP support) to work directly with Katalon True Platform objects 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​

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 connect your AI tool with Katalon True Platform, point it to the Katalon True Platform MCP endpoint:

  • Use https://<your-sub-domain>.katalon.io/mcp in any AI tool that supports configuring a remote MCP server natively. 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.
{
"mcpServers": {
"katalon-prod-mcp": {
"command": "npx",
"args": [
"mcp-remote",
"https://<your-sub-domain>.katalon.io/mcp",
"--transport",
"http"
]
}
}
}

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.
  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 TestCloud API with optional RSQL filter and pagination.
list_test_cloud_agentsList available TestCloud agents scoped to the current account and project.
list_test_cloud_appsList uploaded TestCloud apps with optional RSQL filters and pagination.
manage_test_cloud_dynamic_appManage TestCloud dynamic apps.
delete_test_cloud_appDelete one or multiple apps from TestCloud.
get_upload_test_cloud_app_urlReturns a temporary upload URL so you can upload an app file to TestCloud via curl, then register it for use.
create_test_cloud_appCreate a TestCloud app from an uploaded app file.
list_test_cloud_tunnelsList active TestCloud tunnels.
prepare_test_cloud_tunnel_startGather download URLs, API keys, and commands to guide users through the TestCloud tunnel setup experience.
build_private_local_testing_configBuild a private local testing configuration payload.
stop_test_cloud_tunnelStop an active TestCloud 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.

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.

Was this page helpful?