StudioAssist Agent mode
- Katalon Studio Enterprise version 10.3.2 onwards.
- AI features are enabled in your account settings. If they're disabled, you can enable them with a personal key. For details, see StudioAssist Preferences or contact your Account Admin (see Configure AI Services).
Overview​
Starting with Katalon Studio 10.3.2, StudioAssist introduces a new Agent mode alongside its existing Ask mode.
Agent mode is a real-time collaborator. It interprets your natural-language prompts, turns them into multi-step actions, and iterates them until the task is complete.
With Agent mode, you can:
- Automate test case creation and editing: Generate new test cases or update existing ones, reducing manual work and keeping your project consistent.
- Get trusted answers backed by Katalon Docs: Access step-by-step guidance, troubleshooting solutions, release notes, keyword-based references, and best practices drawn directly from official documentation.
- Extend automation beyond Katalon: Connect with third-party MCP servers to streamline workflows, pull external data, or integrate with other systems directly inside Studio.
How Agent mode works​
Agent mode is powered by HTTP-based MCP (Model Context Protocol) servers. These servers connect StudioAssist with the tools it needs to perform tasks. Learn more in Understanding MCP Servers in StudioAssist.
By default, Katalon provides two MCP servers with tools enabled. You can change these settings at any time. See Managing MCP Servers and Tools in StudioAssist.
- Katalon MCP: Connect StudioAssist to Katalon Docs, so your answers are more accurate, up-to-date, and backed by official guides.
- Katalon Studio MCP: Connect StudioAssist directly to your project, allowing it to read, create, and edit test cases automatically.
You can also extend Agent mode with external MCP servers to integrate systems, pull in additional data, or automate workflows in Katalon Studio. Learn how to connect an external MCP server in Adding an external MCP Server.
When to use Agent mode​
Think of Ask Mode as “answer my question” and Agent mode as “help me get this done”. Refer to the table below to see how each mode processes your prompt.
| Prompt | Ask mode | Agent mode |
|---|---|---|
| “Create a new test case” | Suggests code | Looks up best practices in Katalon Docs and automatically creates a new test case in the KS app |
| “Explain this test case” | Explains code | Explains code with references to related Katalon keywords and documentation |
| “How to create a test case?” | Gives basic steps | Guides you with the latest step-by-step instructions |
| “Troubleshoot an error at step 3” | Suggests generic fixes | Analyzes the error, checks docs, and proposes validated solutions |
How to use Agent mode​
Open the StudioAssist chat window​
When you open a project for the first time, the StudioAssist chat window automatically appears on the right side of your workspace.
If it's not visible or closed, click the StudioAssist icon in the main toolbar.
Alternatively, use the following shortcuts for quick access.
- macOS:Â
^ + ⌥ + N - Windows:Â
Ctrl + Alt + N
- The hotkey on Windows generally works well; however, it may not function when you're focused on the Start Page, and other webview-based screens.
Select Agent mode​
Use the chat mode selector to switch from Ask to Agent.
After switching, the chat window updates to show that you are in Agent mode.
- Your last selected mode is remembered.
- The default mode is Ask when you first enable StudioAssist.
- Chat history is preserved when switching modes.
Connect to the MCP servers​
Agent mode connects to MCP servers to process your requests.
When you send a request, the MCP server analyzes your question and uses the proper available tools to complete the task.
Click the tool settings icon to explore the MCP servers and enable/disable which tools to use. Learn more in Manage MCP servers and tools.
Enter your prompt​
- Type a prompt describing the task you want to perform. The more details you provide, the better the outcome will be.
- Or you can prompt with context by linking to an existing test case or attach files. See StudioAssist Ask mode.
You can use the Prompt Library to customize engineering prompts and provide more context for Agent mode. This helps improve the accuracy of StudioAssist responses by tailoring how it generates, explains, or chats about code.
Grant tool permission​
Before running any tool, StudioAssist will ask you to grant permission. Review each tool, the MCP server, and the input details carefully before approving, as they show exactly what Agent mode will perform.
Choose from three approval types:
| Option | How it works | When to use it |
|---|---|---|
| Allow Once | Allow the tool run one time only. | For one-time requests. |
| Allow this Conversation | Allow the tool run without asking each time until you close or clear the conversation. | For ongoing tasks during your current session. |
| Always Allow | Always allow the tool run without asking, even after you close or clear the conversation. You can reset permissions anytime in Reset tool approval. | For tools you find helpful and use regularly. Avoid using this option for tools that can make that can make sensitive-impact (for example, delete) |
If you select Deny, StudioAssist will not complete the requested action. A message will indicate that access was denied, and you can either retry the action or enter a new request.
Monitor while Agent mode is running​
After permissions are granted, StudioAssist starts working on the task.
StudioAssist may call one or multiple tools to complete a task. You might need to grant permissions more than once for a single answer.
During this process, you may encounter:
- Maximum tool calls reached: To control how many times StudioAssist can call tools for each question (default: 5), you can adjust the limit. If the limit is reached before the task is done, StudioAssist will pause and ask whether you want to continue or stop. Learn more in Access settings for agent mode behavior.
View results​
After Agent mode finishes, the result appears in the StudioAssist panel.
If you use Agent mode to create or update a test case, StudioAssist will place it directly under the Test Cases.
Open the test case in the editor to review the steps, make any necessary edits, and then run it.
You can also tick or untick the option to let Agent mode work on the current file.
Troubleshoot connection issues​
Sometimes, Agent mode cannot reach a tool or MCP server (for example, due to a network error or downtime). In this case, StudioAssist shows a connection error message.
What to do:
- Read the error message in the tool call output.
- Double-check if your MCP server is connected by reviewing the MCP error message in the MCP settings. If there’s an error, hover over the warning (!) icon to view details.
- Try again after the connection is back.
Common use cases​
Refer to the following common use cases and example prompts for guidance.
Create a new test case​
Automatically generate a test case and add it to your project.
- Make sure to include your URL, username, and password in the prompt, or define them in the Object Repository using Spy Web or Web Recorder.
- Using an AI-generated test case may result in missing import statements, which can prevent the test case from running. To fix this, press Ctrl + Shift + O (Windows/Linux) or Command + Shift + O (macOS) to add the required import statements automatically.
Create a Katalon Studio test case in this project to perform the following steps, using objects that I already captured:
1. Open a browser to the URL http://demoaut.katalon.com
2. Click the make appointment button
3. Fill in the username 'John Doe'
4. Fill in the password 'ThisIsNotAPassword'
5. Click the login button
6. Close the browser
Edit an existing test case​
Optimize or restructure an existing test case.
Read this test case, add description to each step, and add a description summarize what this test case does.
<Attach or paste your test case>
Learn about a feature by using Katalon Docs tool​
Get the latest explanation of a feature
Search the Katalon documentation and explain what <feature> is and how to use it.
Troubleshoot issues​
Agent mode analyzes the error, checks documentation, and applies fixes.
This test case failed, troubleshoot the error using information from Katalon doc and fix the script.
<paste root cause here>
Known limitations​
- In Agent mode, StudioAssist may not always use a tool correctly; if this happens, try again by clearly mentioning the tool and MCP server names, or adjust the prompt for better results.
- When StudioAssist use MCP tools to update a test case you're currently opening in Studio, the changes may not automatically appear in the UI. To view the updates, right-click the test case and select Refresh, or close and reopen the test case.
Next steps​
Refer to these docs for more details:
- Understanding MCP Servers in StudioAssist: Learn the concept, why it matters, and how it works within StudioAssist Agent mode. See Understanding MCP Servers in StudioAssist.
- Managing MCP Servers and tools in StudioAssist: How to access MCP settings, add, remove, or disable tools. See Managing MCP Servers and Tools in StudioAssist.
- Agent Mode Behavior Settings: Configure max tool calls, allow tool calls, and reset approvals. See Agent Mode Behavior Settings.