Katalon built-in MCP servers

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

Katalon MCP Server

This server specializes in finding/returning Katalon's document.

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, TestOps, TestCloud), features, troubleshooting, or integrations.

Usage Tips

• Ask a question like "What's new in Katalon Studio 10.4.2?" to quickly get the information you need. StudioAssist will use search_katalon_documentation_with_filter to search Katalon documentation with product-level filtering (Studio, TestOps, TestCloud, etc.) and returns relevant document sections.

• If you want a full document page returned, follow up with “Retrieve full documentation”. StudioAssist will use fetch to return the full document in Markdown format, including code blocks, tables, and images.

• If your question isn't product-specific, like “Does Katalon have MCP servers?”, StudioAssist will use search to locate and return the answer.

Katalon Studio MCP Server

This server has the following tools, grouped by features:

Test Case tools

Tool	Description	Example Prompt
getTestCases	Get a list of all test case IDs in the current project	Get all test cases in this project.
createTestCase	Create a new test case under your specified folder with your provided details	Create new test case ‘example_test_case’ with description ‘Verify login page loads correctly.’
updateTestCase	Update test case with name, description, tags and comments you provide	Update test case ‘example_test_case’ — change the description to ‘Include password recovery step’ and add the tag ‘UI.’
getTestCaseScript	Get the Groovy script content and other metadata for a specific test case	Get test case script for the ‘example_test_case.’
updateTestCaseScript	Update the Groovy script content for an existing test case	Update test case script: add this step to ‘example_test_case’: WebUI.verifyElementPresent(findTestObject('Login/Button_Login'), 10).

Custom Keyword tools

Tool	Description	Example Prompt
getCustomKeywords	Get a list of all custom keywords in the current project	Get custom keywords in this project.
getCustomKeyword	Get a custom keyword class file with the name you provide and return its content	Get custom keyword content for class ‘example_keyword_class.’
createCustomKeyword	Create a new custom keyword class with content you specify. The keyword will be saved in the Keywords source folder.	Create custom keyword ‘example_keyword_class’ with method def printMessage(){ println("Hello from custom keyword!") }.
updateCustomKeyword	Update an existing custom keyword class file. Can update the content and optionally rename/move the keyword to a different package/class name.	Update custom keyword ‘example_keyword_class’: change name to ‘example_user_actions’, add new method def verifyLogin().

Test Object tools

Limitations

• When configured with Bedrock-based models, StudioAssist cannot create or update test objects, as AWS Bedrock providers don't support create/update test object tools.
• Gemini provider may not reliably execute create/update test object actions. To avoid this issue:
  • Attach to your prompt a custom instruction file that describes the test object you want to create along with real examples from your project.
  • Use another AI model. See all of our supported AI models at AI service configuration.
• For WebService tools, we currently don't support displaying HTTP body type responses.

Tools	Description	Example Prompt
getTestObjects	Get a list of all test object IDs from the current project	Get all test objects in this project.
getTestObject	Retrieves detailed information about a test object from the Object Repository based on its ID in the current Katalon Studio project.	Get test object details for "make appointment button".
createWebTestObject	Creates a new web test object in the Object Repository with a suggested locator strategy based on locator information.	Create a web test object "make appointment button" on this page CURA Healthcare Service using full XPath /html/body/header/div/a.
createMobileTestObject	Creates a new mobile test object in the Object Repository with a suggested locator strategy based on locator information.	Create a mobile test object "login button" in the Android app using resource-id com.demo.app:id/btnLogin.
createWindowsTestObject	Creates a new Windows test object in the Object Repository with a suggested locator strategy based on locator information.	Create a Windows test object "Submit button" using AutomationId SubmitButton.
createRestWebServiceTestObject	Creates a new REST Web Service test object in the Object Repository with a suggested locator strategy based on locator information.	Create a REST API test object "Get user details" with GET method for the endpoint /api/users/1.
createSoapWebServiceTestObject	Creates a new SOAP Web Service test object in the Object Repository with a suggested locator strategy based on locator information.	Create a SOAP web service test object "GetCustomerInfo" using WSDL URL <https://example.com/customer.wsdl.>
updateWebTestObject	Updates an existing web test object in the Object Repository based on its ID in the current Katalon Studio project.	Update "make appointment button" to use CSS selector #btn-make-appointment.
updateMobileTestObject	Updates an existing mobile test object in the Object Repository based on its ID in the current Katalon Studio project.	Update object "login button" to use XPath //android.widget.Button[@text='Login'].
updateWindowsTestObject	Updates an existing Windows test object in the Object Repository based on its ID in the current Katalon Studio project.	Update object "Submit button" to use Name locator "Submit".
updateRestWebServiceTestObject	Updates an existing REST Web Service test object in the Object Repository based on its ID in the current Katalon Studio project.	Update object "Get user details" to use endpoint /api/users/{id} with path parameter id.
updateSoapWebServiceTestObject	Updates an existing SOAP Web Service test object in the Object Repository based on its ID in the current Katalon Studio project.	Update object "GetCustomerInfo" to use the latest WSDL URL provided by the service team.

tip

• For a more stable workflow, use getTestObjects to retrieve all test objects in your project before using other Test Object tools.
• When creating or updating Test Objects, include both a locator strategy and its full path (e.g. xpath: /html/body/header/div/a) in your prompt. E.g. Create a web test object "make appointment button" on this page CURA Healthcare Service using full XPath /html/body/header/div/a.
• (Optional) Connect to Selenium MCP server allows StudioAssist to understand web project contexts better and generate Test Objects with higher precision. E.g. Create a new web test object named "make appointment button" on this page CURA Healthcare Service.

Test Suite tools

Tool	Description	Example Prompt
getTestSuite	Get details of a specific test suite in the current Katalon Studio project	Get test suite ‘example_test_suite.’
createTestSuite	Create a new test suite with metadata and test cases in the current Katalon Studio project	Create test suite ‘example_test_suite’ that includes: ‘example_test_case_1’, ‘example_login_case_1.’
updateTestSuite	Update an existing test suite with new metadata and test cases in the current Katalon Studio project	Update test suite ‘example_checkout_case_1’: add ‘example_test_suite_1.’ to end of test suite.
createDynamicTestSuite	Create a new dynamic test suite with metadata and filtering configuration in the current Katalon Studio project	Create dynamic test suite ‘example_dynamic_test_suite_1’: include all test cases tagged ‘regression.’
updateDynamicTestSuite	Update an existing dynamic test suite with new metadata and filtering configuration in the current Katalon Studio project	Update dynamic test suite ‘example_dynamic_test_suite’: only include test cases tagged ‘critical.’

Test Suite Collection tools

Tool	Description	Example Prompt
createTestSuiteCollection	Creates a new test suite collection with metadata and test suites in the current Katalon Studio project	Create test suite collection with all test suites in this project.
updateTestSuiteCollection	Update an existing test suite collection with new metadata and test suites in the current Katalon Studio project	update test suite collection regression_test_collection to include example_test_suite_1

BDD (Behavior-driven development) testing tools

Tool	Description	Example Prompt
createBddFeatureFile	Create a new BDD feature file with Gherkin content in the current Katalon Studio project	Create Bdd feature file ‘example_feature_file’: add the following Gherkin content: Feature: Login Scenario: Valid login Given user is on the login page When user enters valid credentials Then the homepage is displayed.
updateBddFeatureFile	Update an existing BDD feature file’s content, name, and/or location in the current Katalon Studio project	Update BDD feature file: update name ‘example_feature_file’ to ‘example_login_feature’, add a new scenario for invalid login.

Test Data tools

Tool	Description	Example Prompt
getTestDataList	Get a list of all test data entities available in the current Katalon Studio project	Get test data list of all test data files in this project.
createInternalTestData	Create a new internal test data entity with specified data in the current Katalon Studio project	Create internal test data ‘example_test_data’ using the table ‘sample_data_for_test_case.’

Katalon TestOps MCP Server

Starting version 10.4.0, Katalon Studio supports TestOps MCP Server, supporting users on TestOps (not including TestOps Legacy). See TestOps MCP Server for more details on configurations and tool list.

note

• StudioAssist uses the authentication information from the Katalon Studio login to smoothly integrate with TestOps MCP Server.
• TestOps 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 StudioAssist will use TestOps MCP Servers.