Katalon built-in MCP servers

Last updated: August 2026

This document provides descriptions on Katalon's built-in MCP servers.

Katalon MCP Server

The Katalon MCP Server connects AI assistants to the official Katalon documentation. It can search documentation across Katalon products and fetch documentation pages as Markdown.

Katalon AI Assistant includes this server by default. You can also connect to the public Katalon documentation MCP endpoint from an MCP-compatible client.

Field	Value
Server URL	https://mcp.katalon.com/mcp
Transport type	HTTP
Authentication	Not required

For MCP clients that support remote HTTP servers, add the Katalon documentation MCP server with the following configuration:

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

Tool	Description
fetch	Fetch and retrieve the complete Katalon documentation page content in markdown format.
search	A search tool for general, cross-product queries where the specific product context is unknown or irrelevant for Katalon documentation.
search_katalon_documentation_with_filter	The primary and most accurate search tool for Katalon documentation, about products, features, configuration, and troubleshooting. Use this tool by default for finding information about specific products (Studio, True Platform, Test Execution - Cloud), features, troubleshooting, or integrations.

Usage Tips

• Ask a question like "What's new in Katalon Studio 11.1.0?" to quickly get the information you need. Katalon AI Assistant will search Katalon documentation with product-level filtering (Studio, True Platform, Test Execution - Cloud, etc.) and returns relevant document sections.

Katalon Studio MCP Server

This server has the following tools, grouped by features:

note

Starting from Katalon Studio 11.2.0, several Katalon Studio MCP tools are consolidated into broader write*, readFile, and listEntityFiles tools. If you use saved prompts that reference deprecated tools, update them to use the replacement tools listed in Deprecated tools.

Read and list tools

These three tools answer different questions. Use listEntityFiles when you know part of a name, searchProject when you know part of what is inside a file, and readFile once you have the path you want. A typical request runs them in that order: find it, then read it.

Tool	Description	Example Prompt
listEntityFiles	Lists the entities in the currently open Katalon Studio project, matching on file and entity names. Each entry includes a fileId and a relativePath; test cases and test suites also include the path of their Groovy script. You can narrow the list by entity type, folder, and name at the same time, and results are returned in pages. Ask for a specific name whenever you can — on a large project an unfiltered list is truncated, and the response says so.	List all reports for the test suite TS_RegressionTest. List the test objects under Object Repository/Login whose name contains "button".
readFile	Reads a whole text file from the open project. Accepts either the entity ID as shown in the Tests Explorer, or a path relative to the project. A full path also works when it points inside the open project. A test case and a test suite are each stored as two files: the metadata file holds variables, tags, and data bindings, and the Groovy file holds the steps or the SetUp/TearDown hooks. Reading either one tells you where the other is. Asking for a test case by its entity ID returns the script. Binary files cannot be read. Excel test data keeps its rows in a binary workbook, so the .dat descriptor is readable but the rows are not.	Read the report at Reports/20260327_103426/healthcare-tests - TS_RegressionTest/20260327_103426/ Read the test case Test Cases/Login/TC_Login_Valid.
searchProject (11.5.0+)	Searches file contents across the open project. Unlike listEntityFiles, which searches file names, use this tool to find where something is defined or used and count its references. Search is case-insensitive and supports * and ? wildcards or regular expressions. Each match includes its path, line number, and whether it is a declaration or usage. Credentials and masked variable values are hidden.	Search the project for calls to saveBudget(). Which test cases use the custom keyword openAlert? Where is performanceOpenBrowser defined?

note

A few files are invisible to search because Katalon Studio does not manage them as project resources: .csv, .txt, .log, .xlsx, .xls, and .png. The Search dialog cannot see them either. The Libs folder is also excluded because its contents are generated. Every search result states what was searched, so a result with no matches means "not found in this scope" rather than "does not exist".

Execution tools

note

• Execution tools are not available in MCP server standalone mode.

Tool	Description	Example Prompt
executeTest	Executes a Katalon test case, test suite, or test suite collection in the currently open project. Returns a testExecutionId immediately and does not wait for completion.	Execute test suite Test Suites/Regression/TS_Login on WEB_UI using CHROME.
getAvailableMobileDevices	Lists locally connected Android devices, iOS devices, and iOS simulators available for mobile test execution.	List all available Android devices for mobile test execution.
getAvailableTestCloudEnvironments	Lists environments and devices available in Katalon TestCloud for local Katalon Studio execution.	Show available desktop TestCloud environments for local execution.
getTestExecutionResults	Returns the execution results for a completed test execution, including child results for suites, optional failure details, and the uploaded Katalon True Platform execution result when available.	Get the execution results and uploaded True Platform result for test execution ID 12345.
getTestExecutionStatus	Returns the current status of one or all test executions tracked in this session, including executions triggered by executeTest and those started manually via the Studio Run button.	Check the current status of test execution ID 12345.
stopTestExecution	Stops a running test execution in the current Studio session. Because Studio runs one execution at a time, this stops all active executions.	Stop the running test execution with ID 12345.

Test Case tools

Tool	Description	Example Prompt
writeTestCase	Creates a new test case or updates an existing one in the current Katalon Studio project.	Create or update test case Test Cases/Login/example_test_case with a script that verifies the login page loads correctly.

Test Suite tools

Tool	Description	Example Prompt
writeTestSuite	Creates a new test suite or updates an existing one in the current Katalon Studio project.	Create or update test suite Test Suites/Regression/example_test_suite to include Test Cases/Login/example_test_case.
writeDynamicTestSuite	Creates a new dynamic test suite or updates an existing one in the current Katalon Studio project.	Create or update a dynamic test suite that includes all test cases tagged regression.

Test Suite Collection tools

Tool	Description	Example Prompt
writeTestSuiteCollection	Creates a new test suite collection or updates an existing one in the current Katalon Studio project.	Create or update test suite collection Test Suites/Collections/regression_test_collection to include Test Suites/Regression/example_test_suite.

Test Object tools

note

WebService tools currently do not support displaying HTTP body type responses.

Tool	Description	Example Prompt
writeWebTestObject	Creates a new Web test object or updates an existing one in the Object Repository.	Create or update a web test object Object Repository/Page_CURA/btn_MakeAppointment using XPath /html/body/header/div/a.
writeMobileTestObject	Creates a new Mobile test object or updates an existing one in the Object Repository.	Create or update a mobile test object Object Repository/Mobile/Login/btn_Login using resource-id com.demo.app:id/btnLogin.
writeWindowsTestObject	Creates a new Windows test object or updates an existing one in the Object Repository.	Create or update a Windows test object Object Repository/Desktop/btn_Submit using AutomationId SubmitButton.
writeRestWebServiceTestObject	Creates a new REST Web Service test object or updates an existing one in the Object Repository.	Create or update a REST API test object Object Repository/API/GetUserDetails with GET method for endpoint /api/users/1.
writeSoapWebServiceTestObject	Creates a new SOAP Web Service test object or updates an existing one in the Object Repository.	Create or update a SOAP web service test object Object Repository/API/GetCustomerInfo using WSDL URL https://example.com/customer.wsdl.

tip

When creating or updating test objects, include both a locator strategy and its full path, for example: xpath: /html/body/header/div/a.

Failure Analysis tools

Tool	Description	Example Prompt
analyzeTestFailure	Troubleshoot failed test executions and test report failures by analyzing the execution snapshot and logs. The report path can be given relative to the project or as a full path, so you can analyze an earlier run found with listEntityFiles, not only the run that just finished. The execution snapshot taken when a test fails is consumed by the first analysis. Analyzing the same failure again reports that the snapshot is gone; rerun the test to produce a new one.	Analyze this failed result.

tip

If a test fails, click Troubleshoot with AI to use this tool to analyze the failure's execution context. See more details at AI Failure Troubleshoot.

Custom Keyword tools

Tool	Description	Example Prompt
writeCustomKeyword	Creates a new custom keyword class or updates an existing one in the current Katalon Studio project.	Create or update custom keyword class Keywords/example/UserActions.groovy with method def verifyLogin().
getCustomKeywordMethods	Retrieves custom keyword method signatures from the current project, filtered by name and returned in pages. Use this tool to discover exact method signatures before referencing them via CustomKeywords in a test script. It returns signatures only — never the body of a method, and never the places a keyword is called. To find where a keyword is defined or called, use searchProject.	Get all custom keyword method signatures in this project.

BDD (Behavior-driven development) testing tools

Tool	Description	Example Prompt
writeBddFeatureFile	Creates a new BDD feature file or updates an existing one in the current Katalon Studio project.	Create or update feature file Include/features/Login.feature with a valid login scenario.

Test Data tools

Tool	Description	Example Prompt
writeInternalTestData	Creates a new internal test data entity or updates an existing one in the current Katalon Studio project.	Create or update internal test data Data Files/UserCredentials with username and password columns.

WebUI tools

Tool	Description	Example Prompt
getAvailableExecutionSessions	Retrieves all browser sessions currently running and available for Web UI testing. Useful when a previous test left a browser session open via no closeBrowser() call.	List all running browser sessions that Katalon AI Assistant can use.
webUINavigate	Opens a browser and navigates to the specified URL, or navigates an existing session to a new URL.	Open a Chrome browser and navigate to https://katalon-demo-cura.herokuapp.com/.
webUITakePageSource	Retrieves the HTML source of the current page. Requires an active browser session.	Get the HTML source code of the current page.
webUITakeAccessibilityTreeSnapshot	Retrieves the accessibility tree snapshot of the current page. Requires an active browser session. Not supported on Safari.	Capture an accessibility tree snapshot of the current page.
webUISetText	Enters text into an input element on the current page. Clears existing content before typing.	On the current page, enter demo into the Username input field.
webUIClick	Clicks an element on the current page.	Click the Login button on the current page.
webUICaptureWebTestObject	Captures a web element and saves it to the Object Repository. Supports advanced web elements, including Shadow DOM, iframes, and Flutter Web elements.	Capture the Make Appointment button on https://katalon-demo-cura.herokuapp.com/ as a test object.
webUITakeScreenshot	Captures a full-page or viewport screenshot, displays it in tool output, and saves it to the project Screenshots folder.	Navigate to https://docs.katalon.com and take a full-page screenshot.

To see how these tools work together, refer to the following sample use case, which demonstrates generating a test case and its associated test objects, then executing them. See: WebUI tools sample video.

Known limitations when working with Safari browser

• Cannot run multiple concurrent browser sessions.
• webUITakeAccessibilityTreeSnapshot tool is not operational.

Deprecated tools

Starting from Katalon Studio 11.2.0, the following Katalon Studio MCP tools are deprecated.

Deprecated tool	Replaced by
createTestCase, updateTestCase	writeTestCase
getTestCaseScript	readFile
updateTestCaseScript	writeTestCase
getTestCases	listEntityFiles
createTestSuite, updateTestSuite	writeTestSuite
createDynamicTestSuite, updateDynamicTestSuite	writeDynamicTestSuite
createTestSuiteCollection, updateTestSuiteCollection	writeTestSuiteCollection
getTestSuite	readFile
createWebTestObject, updateWebTestObject	writeWebTestObject
createMobileTestObject, updateMobileTestObject	writeMobileTestObject
createWindowsTestObject, updateWindowsTestObject	writeWindowsTestObject
createRestWebServiceTestObject, updateRestWebServiceTestObject	writeRestWebServiceTestObject
createSoapWebServiceTestObject, updateSoapWebServiceTestObject	writeSoapWebServiceTestObject
getTestObjects, getTestObject	listEntityFiles and readFile
createCustomKeyword, updateCustomKeyword	writeCustomKeyword
getCustomKeyword	readFile
getCustomKeywords	getCustomKeywordMethods. This replacement returns method signatures instead of a class list.
createBddFeatureFile, updateBddFeatureFile	writeBddFeatureFile
createInternalTestData, updateInternalTestData	writeInternalTestData
getTestDataList	listEntityFiles
getInternalTestDataDetails	readFile

Katalon True Platform MCP Server

For more details on configuration and True Platform MCP tool list, refer to True Platform MCP Server.

note

• Katalon AI Assistant uses the authentication information from the Katalon Studio login to smoothly integrate with True Platform MCP Server.
• True Platform MCP Server currently doesn't support integration for Katalon Studio accounts using offline license.
• For better results, specify the project ID in your prompts if you think Katalon AI Assistant will use True Platform MCP Servers.

Known limitations

Katalon MCP servers have the following limitations:

• webUICaptureWebTestObject tool:
  • The tool is not supported on Safari.
  • On dynamic pages, generated locators may use absolute attribute values, which can cause test failures when page content changes.
  • Some AI models (GPT-4.1, GPT-4.1-mini, GPT-5.1) may skip calling prerequisite context tools (webUITakePageSource, webUITakeAccessibilityTreeSnapshot) before invoking webUICaptureWebTestObject, which can reduce locator accuracy.
• webUITakeScreenshot tool:
  • If a screenshot is saved with a filename that already exists in the Screenshots folder, the existing file will be overwritten without warning.
  • Animated elements on the page may not be captured correctly in the screenshot.
• searchProject tool:
  • The label that marks a match as a declaration or a usage is a best guess. It is dependable when you search for a method name or an entity name, and unreliable when you search for a class or type name, because every name on a declaration line looks alike. The matching line is always returned, so you can check it.
  • A line in a .feature file is never marked as a declaration. The step's implementation is Groovy code elsewhere in the project.