Getting Started with iOS Physical Device

Getting Started with iOS Physical device

We support iOS running on MacOS through this MCP. This means that you can control a simulated iOS device, by prompting the agent to do actions on your behalf, like chatting on WhatsApp.

Prerequisites

Before the MCP server can control the iOS, we need to have WebDriverAgent running on the device. Also, go-ios is required to be installed, tunneling and port-forwarding.

1. Install go-ios on your host.

   npm install -g go-ios
   

2. Verify that you can see the device by running ios list. (see Troubleshooting)

3. Start tunnel with ios tunnel start --userspace

4. Start port forwarding with ios forward 8100 8100

5. Launch WebDriverAgent. Here's what needs to be done:

   # close WebDriverAgent if you haven't done so already
   git clone --depth 1 https://github.com/appium/WebDriverAgent.git
   cd WebDriverAgent
   
   # Run `ios list` to get your UDID for the physical device. 
   # Start WDA as an XCUITest, replace '000000000000000000000000' with your udid.
   xcodebuild -project WebDriverAgent.xcodeproj -scheme WebDriverAgentRunner -destination 'platform=iOS,id=000000000000000000000000' test

6. Open WebDriverAgent.xcodeproj file with Xcode, and replace the package name with a unique one. You need to have an Apple developer account (You can enroll for free as an individual. Read more here..

7. Now try the prompt list devices. You should receive a message saying you have iPhone with that udid is available for you.

Troubleshooting

1. I can't see my device with ios list

• Make sure developer mode is enabled on the device, that the device is connected via usb, and that pairing was successful. You can run ios pair to re-pair the device.

FAQ

1. When is Linux going to be supported?

• Very soon. It's a matter of documentation really. Once you get WebDriverAgent running on the device, then it should work for you already.

2. Why do I need to run the tunnel and forwarding myself?

• Yes, it's annoying at the moment. This is on the roadmap, the mcp will run these in background for you.