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: docs/TOOLS.md
+33-27Lines changed: 33 additions & 27 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 61 tools organized into 12 workflow groups for comprehensive Apple development workflows.
3
+
XcodeBuildMCP provides 64 tools organized into 13 workflow groups for comprehensive Apple development workflows.
4
4
5
5
## Workflow Groups
6
6
@@ -11,52 +11,52 @@ XcodeBuildMCP provides 61 tools organized into 12 workflow groups for comprehens
11
11
### iOS Device Development (`device`)
12
12
**Purpose**: Complete iOS development workflow for both .xcodeproj and .xcworkspace files targeting physical devices (iPhone, iPad, Apple Watch, Apple TV, Apple Vision Pro). Build, test, deploy, and debug apps on real hardware. (7 tools)
13
13
14
-
-`build_device` - Builds an app from a project or workspace for a physical Apple device. Provide exactly one of projectPath or workspacePath. Example: build_device({ projectPath: '/path/to/MyProject.xcodeproj', scheme: 'MyScheme' })
15
-
-`get_device_app_path` - Gets the app bundle path for a physical device application (iOS, watchOS, tvOS, visionOS) using either a project or workspace. Provide exactly one of projectPath or workspacePath. Example: get_device_app_path({ projectPath: '/path/to/project.xcodeproj', scheme: 'MyScheme' })
16
-
-`install_app_device` - Installs an app on a physical Apple device (iPhone, iPad, Apple Watch, Apple TV, Apple Vision Pro). Requires deviceId and appPath.
17
-
-`launch_app_device` - Launches an app on a physical Apple device (iPhone, iPad, Apple Watch, Apple TV, Apple Vision Pro). Requires deviceId and bundleId.
14
+
-`build_device` - Builds an app for a connected device.
15
+
-`get_device_app_path` - Retrieves the built app path for a connected device.
16
+
-`install_app_device` - Installs an app on a connected device.
17
+
-`launch_app_device` - Launches an app on a connected device.
18
18
-`list_devices` - Lists connected physical Apple devices (iPhone, iPad, Apple Watch, Apple TV, Apple Vision Pro) with their UUIDs, names, and connection status. Use this to discover physical devices for testing.
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
-
-`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.
19
+
-`stop_app_device` - Stops a running app on a connected device.
20
+
-`test_device` - Runs tests on a physical Apple device.
21
21
### iOS Simulator Development (`simulator`)
22
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
-
-`boot_sim` - Boots an iOS simulator. After booting, use open_sim() to make the simulator visible.
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.
26
-
-`build_sim` - Builds an app from a project or workspace for a specific simulator by UUID or name. Provide exactly one of projectPath or workspacePath, and exactly one of simulatorId or simulatorName.
27
-
-`get_sim_app_path` - Gets the app bundle path for a simulator by UUID or name using either a project or workspace file.
24
+
-`boot_sim` - Boots an iOS simulator.
25
+
-`build_run_sim` - Builds and runs an app on an iOS simulator.
26
+
-`build_sim` - Builds an app for an iOS simulator.
27
+
-`get_sim_app_path` - Retrieves the built app path for an iOS simulator.
28
28
-`install_app_sim` - Installs an app in an iOS simulator.
29
29
-`launch_app_logs_sim` - Launches an app in an iOS simulator and captures its logs.
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' })
30
+
-`launch_app_sim` - Launches an app in an iOS simulator.
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.
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" })
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).
33
+
-`record_sim_video` - Starts or stops video capture for an iOS simulator.
34
+
-`stop_app_sim` - Stops an app running in an iOS simulator.
35
+
-`test_sim` - Runs tests on an iOS simulator.
36
36
### Log Capture & Management (`logging`)
37
37
**Purpose**: Log capture and management tools for iOS simulators and physical devices. Start, stop, and analyze application and system logs during development and testing. (4 tools)
38
38
39
-
-`start_device_log_cap` - Starts capturing logs from a specified Apple device (iPhone, iPad, Apple Watch, Apple TV, Apple Vision Pro) by launching the app with console output. Returns a session ID.
39
+
-`start_device_log_cap` - Starts log capture on a connected device.
40
40
-`start_sim_log_cap` - Starts capturing logs from a specified simulator. Returns a session ID. By default, captures only structured logs.
41
41
-`stop_device_log_cap` - Stops an active Apple device log capture session and returns the captured logs.
42
42
-`stop_sim_log_cap` - Stops an active simulator log capture session and returns the captured logs.
43
43
### macOS Development (`macos`)
44
44
**Purpose**: Complete macOS development workflow for both .xcodeproj and .xcworkspace files. Build, test, deploy, and manage macOS applications. (6 tools)
45
45
46
-
-`build_macos` - Builds a macOS app using xcodebuild from a project or workspace. Provide exactly one of projectPath or workspacePath. Example: build_macos({ projectPath: '/path/to/MyProject.xcodeproj', scheme: 'MyScheme' })
47
-
-`build_run_macos` - Builds and runs a macOS app from a project or workspace in one step. Provide exactly one of projectPath or workspacePath. Example: build_run_macos({ projectPath: '/path/to/MyProject.xcodeproj', scheme: 'MyScheme' })
48
-
-`get_mac_app_path` - Gets the app bundle path for a macOS application using either a project or workspace. Provide exactly one of projectPath or workspacePath. Example: get_mac_app_path({ projectPath: '/path/to/project.xcodeproj', scheme: 'MyScheme' })
46
+
-`build_macos` - Builds a macOS app.
47
+
-`build_run_macos` - Builds and runs a macOS app.
48
+
-`get_mac_app_path` - Retrieves the built macOS app bundle path.
49
49
-`launch_mac_app` - Launches a macOS application. Note: In some environments, this tool may be prefixed as mcp0_launch_macos_app.
50
50
-`stop_mac_app` - Stops a running macOS application. Can stop by app name or process ID.
51
-
-`test_macos` - Runs tests for a macOS project or workspace using xcodebuild test and parses xcresult output. Provide exactly one of projectPath or workspacePath.
51
+
-`test_macos` - Runs tests for a macOS target.
52
52
### Project Discovery (`project-discovery`)
53
53
**Purpose**: Discover and examine Xcode projects, workspaces, and Swift packages. Analyze project structure, schemes, build settings, and bundle information. (5 tools)
54
54
55
55
-`discover_projs` - Scans a directory (defaults to workspace root) to find Xcode project (.xcodeproj) and workspace (.xcworkspace) files.
56
56
-`get_app_bundle_id` - Extracts the bundle identifier from an app bundle (.app) for any Apple platform (iOS, iPadOS, watchOS, tvOS, visionOS).
57
57
-`get_mac_bundle_id` - Extracts the bundle identifier from a macOS app bundle (.app). Note: In some environments, this tool may be prefixed as mcp0_get_macos_bundle_id.
58
-
-`list_schemes` - Lists available schemes for either a project or a workspace. Provide exactly one of projectPath or workspacePath. Example: list_schemes({ projectPath: '/path/to/MyProject.xcodeproj' })
59
-
-`show_build_settings` - Shows build settings from either a project or workspace using xcodebuild. Provide exactly one of projectPath or workspacePath, plus scheme. Example: show_build_settings({ projectPath: '/path/to/MyProject.xcodeproj', scheme: 'MyScheme' })
58
+
-`list_schemes` - Lists schemes for a project or workspace.
**Purpose**: Tools for creating new iOS and macOS projects from templates. Bootstrap new applications with best practices, standard configurations, and modern project structures. (2 tools)
62
62
@@ -65,11 +65,17 @@ XcodeBuildMCP provides 61 tools organized into 12 workflow groups for comprehens
65
65
### Project Utilities (`utilities`)
66
66
**Purpose**: Essential project maintenance utilities for cleaning and managing existing projects. Provides clean operations for both .xcodeproj and .xcworkspace files. (1 tools)
67
67
68
-
-`clean` - Cleans build products for either a project or a workspace using xcodebuild. Provide exactly one of projectPath or workspacePath. Platform defaults to iOS if not specified. Example: clean({ projectPath: '/path/to/MyProject.xcodeproj', scheme: 'MyScheme', platform: 'iOS' })
68
+
-`clean` - Cleans build products with xcodebuild.
69
+
### session-management (`session-management`)
70
+
**Purpose**: Manage session defaults for projectPath/workspacePath, scheme, configuration, simulatorName/simulatorId, deviceId, useLatestOS and arch. These defaults are required by many tools and must be set before attempting to call tools that would depend on these values. (3 tools)
71
+
72
+
-`session_clear_defaults` - Clear selected or all session defaults.
73
+
-`session_set_defaults` - Set the session defaults needed by many tools. Most tools require one or more session defaults to be set before they can be used. Agents should set the relevant defaults at the beginning of a session.
74
+
-`session_show_defaults` - Show current session defaults.
69
75
### Simulator Management (`simulator-management`)
70
76
**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)
71
77
72
-
-`erase_sims` - Erases simulator content and settings for a specific simulator. Requires simulatorUdid. Optional: shutdownFirst to shut down before erasing.
78
+
-`erase_sims` - Erases a simulator by UDID.
73
79
-`reset_sim_location` - Resets the simulator's location to default.
74
80
-`set_sim_appearance` - Sets the appearance mode (dark/light) of an iOS simulator.
75
81
-`set_sim_location` - Sets a custom GPS location for the simulator.
@@ -104,9 +110,9 @@ XcodeBuildMCP provides 61 tools organized into 12 workflow groups for comprehens
0 commit comments