You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-1Lines changed: 4 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -86,6 +86,7 @@ The XcodeBuildMCP server provides the following tool capabilities:
86
86
-**Log Capture**: Capture run-time logs from a simulator
87
87
-**UI Automation**: Interact with simulator UI elements
88
88
-**Screenshot**: Capture screenshots from a simulator
89
+
-**Video Capture**: Start/stop simulator video capture to MP4 (AXe v1.1.0+)
89
90
90
91
### Device management
91
92
-**Device Discovery**: List connected physical Apple devices over USB or Wi-Fi
@@ -117,7 +118,9 @@ For clients that support MCP resources XcodeBuildMCP provides efficient URI-base
117
118
- Xcode 16.x or later
118
119
- Node 18.x or later
119
120
120
-
### Configure your MCP client
121
+
> Video capture requires the bundled AXe binary (v1.1.0+). Run `npm run bundle:axe` once locally before using `record_sim_video`. This is not required for unit tests.
Copy file name to clipboardExpand all lines: docs/TOOLS.md
+6-5Lines changed: 6 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# XcodeBuildMCP Tools Reference
2
2
3
-
XcodeBuildMCP provides 60 tools organized into 12 workflow groups for comprehensive Apple development workflows.
3
+
XcodeBuildMCP provides 61 tools organized into 12 workflow groups for comprehensive Apple development workflows.
4
4
5
5
## Workflow Groups
6
6
@@ -19,7 +19,7 @@ XcodeBuildMCP provides 60 tools organized into 12 workflow groups for comprehens
19
19
-`stop_app_device` - Stops an app running on a physical Apple device (iPhone, iPad, Apple Watch, Apple TV, Apple Vision Pro). Requires deviceId and processId.
20
20
-`test_device` - Runs tests for an Apple project or workspace on a physical device (iPhone, iPad, Apple Watch, Apple TV, Apple Vision Pro) using xcodebuild test and parses xcresult output. Provide exactly one of projectPath or workspacePath.
21
21
### iOS Simulator Development (`simulator`)
22
-
**Purpose**: Complete iOS development workflow for both .xcodeproj and .xcworkspace files targeting simulators. Build, test, deploy, and interact with iOS apps on simulators. (11 tools)
22
+
**Purpose**: Complete iOS development workflow for both .xcodeproj and .xcworkspace files targeting simulators. Build, test, deploy, and interact with iOS apps on simulators. (12 tools)
23
23
24
24
-`boot_sim` - Boots an iOS simulator. After booting, use open_sim() to make the simulator visible.
25
25
-`build_run_sim` - Builds and runs an app from a project or workspace on a specific simulator by UUID or name. Provide exactly one of projectPath or workspacePath, and exactly one of simulatorId or simulatorName.
@@ -30,6 +30,7 @@ XcodeBuildMCP provides 60 tools organized into 12 workflow groups for comprehens
30
30
-`launch_app_sim` - Launches an app in an iOS simulator by UUID or name. If simulator window isn't visible, use open_sim() first. or launch_app_sim({ simulatorName: 'iPhone 16', bundleId: 'com.example.MyApp' })
31
31
-`list_sims` - Lists available iOS simulators with their UUIDs.
32
32
-`open_sim` - Opens the iOS Simulator app.
33
+
-`record_sim_video` - Starts or stops video capture for an iOS simulator using AXe. Provide exactly one of start=true or stop=true. On stop, outputFile is required. fps defaults to 30.
33
34
-`stop_app_sim` - Stops an app running in an iOS simulator by UUID or name. or stop_app_sim({ simulatorName: "iPhone 16", bundleId: "com.example.MyApp" })
34
35
-`test_sim` - Runs tests on a simulator by UUID or name using xcodebuild test and parses xcresult output. Works with both Xcode projects (.xcodeproj) and workspaces (.xcworkspace).
35
36
### Log Capture & Management (`logging`)
@@ -68,7 +69,7 @@ XcodeBuildMCP provides 60 tools organized into 12 workflow groups for comprehens
68
69
### Simulator Management (`simulator-management`)
69
70
**Purpose**: Tools for managing simulators from booting, opening simulators, listing simulators, stopping simulators, erasing simulator content and settings, and setting simulator environment options like location, network, statusbar and appearance. (5 tools)
70
71
71
-
-`erase_sims` - Erases simulator content and settings. Provide exactly one of: simulatorUuid or all=true. Optional: shutdownFirst to shut down before erasing.
72
+
-`erase_sims` - Erases simulator content and settings. Provide exactly one of: simulatorUdid or all=true. Optional: shutdownFirst to shut down before erasing.
72
73
-`reset_sim_location` - Resets the simulator's location to default.
73
74
-`set_sim_appearance` - Sets the appearance mode (dark/light) of an iOS simulator.
74
75
-`set_sim_location` - Sets a custom GPS location for the simulator.
@@ -103,9 +104,9 @@ XcodeBuildMCP provides 60 tools organized into 12 workflow groups for comprehens
0 commit comments