Note
With the release of MagicPod version 1.69.0, the MCP server has been redesigned. As a result, existing users of the previous MCP server must update their configuration. Please follow the setup instructions below to migrate to the new MCP server.
Table of contents
Overview
MagicPod MCP Server is a module that enables AI agents (Cline, Cursor, Claude, etc.) to operate various MagicPod functions. By implementing this, you can automate MagicPod operations by giving instructions to AI agents in natural language.
Some of the main operations currently available through the MagicPod MCP server include:
- Creating, editing, viewing, and running test cases
- Creating, editing, and viewing shared steps
- Retrieving test run results
- Retrieving UI information and validating locators
- Searching MagicPod Help Center articles
When creating or editing test cases, you can also have the AI read files such as Excel spreadsheets and give it instructions based on their contents. This enables workflows such as:
- Have the AI read test procedures created in Excel or a similar tool and create the necessary test cases.
- Have the AI read specifications for a new feature and update the affected test cases.
- Analyze the cause of a test failure and update the test case as necessary.
For specific examples of what you can do with the MagicPod MCP server, see also Prompt Examples.
The full list of available operations (tools) is provided below.
| Tool | Description |
capture_ui |
Capture the current UI of the device |
create_shared_step |
Create a shared step from a consecutive range of steps in the current test case |
delete_ui |
Delete unused UIs on the project's default branch |
edit_data_pattern |
Edit the data patterns (values used for data-driven testing) of the current test case |
edit_shared_step_parameter |
Add or remove parameters for the current shared step |
edit_shared_step_steps |
Edit test steps in a shared step |
edit_steps |
Edit test steps in the current test case |
edit_ui_elements |
Edit the properties (name and locator) of UI elements on a saved UI |
execute_batch_run |
Start a new batch run, or retry one |
execute_partial_steps |
Run part of a test by specifying the start and end steps |
find_help_center_article |
Search and view MagicPod Help Center articles |
get_command_definition |
Retrieve detailed definitions of one or more MagicPod commands |
get_health_score |
Retrieve the health score of a project |
get_shared_step |
Retrieve details of a single shared step, including its steps in a human-readable format |
get_shared_step_internal_steps |
Retrieve test steps in a shared step definition |
get_test_case_detail |
Retrieve details of a single test case, including its steps in a human-readable format |
get_test_run |
Retrieve information and artifacts for a single test run |
inspect_locators |
Suggest stable locators for a screen or validate existing locators |
inspect_ui |
Retrieve and search previously captured UIs (screens) |
list_batch_run_test_runs |
List all test runs in a batch run, grouped by test pattern |
list_batch_runs |
List batch runs in a project, newest first |
list_fixture_images |
List a project's fixture images |
list_organizations |
List organizations you can access |
list_projects |
List projects you can access within an organization |
list_shared_steps |
List shared steps and shared step folders in a project |
list_test_cases |
List test cases and test case folders in a project |
list_test_runs |
List test runs for a test case in descending run number order (newest first) |
list_test_settings |
List test settings in a project, with their test settings patterns |
manage_device |
Start or stop a device for the specified session |
manage_shared_steps |
Manage shared steps and their folders: create, rename, delete, or reorder folders; move shared steps; edit a shared step's name or description; move a shared step to the trash |
manage_test_cases |
Create a test case; change a test case's name, description, or start mode (launch mode); create, rename, or delete a test case folder |
read_shared_step |
Load the steps and parameter definitions of the current shared step |
read_test_case |
Load data for the current test case |
reorder_test_case |
Change the order of test cases and folders: move one item, or reorder the whole tree at once |
search_shared_steps |
Search shared steps by name, description, or folder name using a keyword or regular expression |
start_session |
Start a MagicPod session for the specified test case |
start_shared_step_session |
Start a MagicPod session for editing the specified shared step |
upload_fixture_image |
Upload an image as a MagicPod fixture |
Future expansion plans: We plan to expand functionality in the future, including enhanced automatic repair. Reference: Press Release(Japanese)
Setup Instructions
You can set it up using either OAuth authentication or an API token.
For detailed setup instructions for each AI service, please see this article.
Q&A
Q. Can I use the MagicPod MCP server for tests running on a local PC environment?
Yes. The MagicPod MCP server can be used for tests running in both cloud and local PC environments.
Q. Are MagicPod AI credits consumed when creating or editing test cases using the MagicPod MCP server?
No. MagicPod AI credits are not consumed when creating or editing test cases using the MagicPod MCP server.
AI processing uses the AI tokens provided by the AI agent connected to the MagicPod MCP server. For information about usage limits and pricing, please check the AI agent you are using and your subscription plan.
Q. Which MagicPod plans support the MagicPod MCP server?
The MagicPod MCP server is available on all MagicPod plans.
Q. I cannot use a newly added tool.
After the MagicPod MCP server is updated, the AI agent may still retain information from before the update.
If you cannot use a newly added tool, restart your AI agent, such as Claude Desktop, create a new session, and try again.
Also, under Configuring Tool Permissions, make sure that the relevant tool is enabled.
Security
- Your information will not be used for machine learning.
- Even if you specify an API token in the MCP server's config file, it is designed not to pass this information to AI agents.
- We plan to expand functionality in the future while maintaining a security-conscious configuration.