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
search_katalon_knowledge_base	Search Katalon's official documentation using semantic search to retrieve relevant text chunks about Katalon products, features, configurations, and troubleshooting.
read_katalon_documentation	Fetch and convert a Katalon documentation page to HTML format with configurable image processing.

Usage Tips

• Ask a question like "What's new in 10.4.0?" to quickly get the information you need.
• To get the full content of the documentation page, follow up with "Get me the full release notes".

Katalon Studio MCP Server

This server has the following tools, grouped by features:

Group	Description
Test Case tools	Get test cases by ID, create/update test case and scripts
Custom Keyword tools	Read/update custom keyword classes
Test Object tools	Read test object details by ID
Test Suite tools	Read, create/update test suite with metadata and test case list
BDD (Behavior-driven development) tools	Create/update feature files in Gherkin format
Test Data tools	List entities, create internal test data

Below are details of the tools inside each group:

Test Case tools

Tool	Description	Example Prompt
getTestCases	Get a list of all test case IDs in the current project	Show me all the test cases in this project.”
createTestCase	Create a new test case under your specified folder with your provided details	Create a new test case called ‘example_test_case’ with the description ‘Verify login page loads correctly.’”
updateTestCase	Update test case with name, description, tags and comments you provide	Update the 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	Show me the Groovy script for the ‘example_test_case.’”
updateTestCaseScript	Update the Groovy script content for an existing test case	Replace the script in ‘example_test_case’ with 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	Show me all the custom keywords in this project.
getCustomKeyword	Get a custom keyword class file with the name you provide and return its content	Show me the Groovy code for the custom keyword 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 a new custom keyword class called ‘example_keyword_class’ with the 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.	Rename the custom keyword class ‘example_keyword_class’ to ‘example_user_actions’ and add a new method called def verifyLogin().

Test Object tools

Tool	Description	Example Prompt
getTestObjects	Get a list of all test object IDs from the current project	Show me all the test objects in this project.

Test Suite tools

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

BDD (Behavior-driven development) tools

Tool	Description	Example Prompt
createBddFeatureFile	Create a new BDD feature file with Gherkin content in the current Katalon Studio project	Create a new feature file called ‘example_feature_file’ with 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	Rename ‘example_feature_file’ to ‘example_login_feature’ and 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	Show me all the test data files in this project.
createInternalTestData	Create a new internal test data entity with specified data in the current Katalon Studio project	Create a new test data file called ‘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.