Quick Start Guide

This guide will walk you through a simple "hello world" task to verify your setup is working correctly. You will boot a simulator, identify its unique ID, and take a screenshot of it.

This entire process can be driven by instructing an AI agent in your MCP client (like Cursor).

Step 1: Start an iOS Simulator

First, you need a running simulator. You can start one from Xcode, or use the command line for convenience.

Open your terminal and run:

# You can replace "iPhone 15" with any available simulator
xcrun simctl boot "iPhone 15"

After a few moments, the iOS Simulator application will launch and boot the specified device.

Step 2: Get the Simulator's UDID

Now that a simulator is running, you can ask your AI assistant to find its Unique Device Identifier (UDID).

Example Prompt:

Get the ID of the currently booted iOS simulator

Your assistant will use the get_booted_sim_id tool. The expected output should be similar to this:

Booted Simulator: "iPhone 15". UUID: "37A360EC-75F9-4AEC-8EFA-10F4A58D8CCA"

This confirms that the MCP server can communicate with the simctl tool and find the running device.

Step 3: Take a Screenshot

Finally, let's take a screenshot to confirm that file system operations and media capture are working. You can specify a file path for the output.

Example Prompt:

Take a screenshot of the simulator and save it to my desktop as 'quickstart_test.png'.

Your assistant will call the screenshot tool. On success, you will see a confirmation message:

Screenshot saved to /Users/your_username/Desktop/quickstart_test.png

Check your Desktop for the quickstart_test.png file. It should contain an image of the current simulator screen.

Congratulations!

You've successfully installed the server and used its core functionality to inspect and capture content from the iOS simulator.

From here, you can explore the Usage Guide for more complex workflows or dive into the full API Reference to see everything the server can do.