Skip to content

Commit 9b78f34

Browse files
committed
Update docs
1 parent d50a0be commit 9b78f34

4 files changed

Lines changed: 90 additions & 90 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -261,7 +261,7 @@ xcodebuildmcp mcp
261261
xcodebuildmcp tools
262262

263263
# Build for simulator
264-
xcodebuildmcp simulator build-sim --scheme MyApp --project-path ./MyApp.xcodeproj
264+
xcodebuildmcp simulator build --scheme MyApp --project-path ./MyApp.xcodeproj
265265
```
266266

267267
The CLI uses a per-workspace daemon for stateful operations (log capture, debugging, etc.) that auto-starts when needed. See [docs/CLI.md](docs/CLI.md) for full documentation.

docs/CLI.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -32,20 +32,20 @@ xcodebuildmcp <workflow> <tool> --help
3232
Each tool supports `--help` for detailed options:
3333

3434
```bash
35-
xcodebuildmcp simulator build-sim --help
35+
xcodebuildmcp simulator build --help
3636
```
3737

3838
Common patterns:
3939

4040
```bash
4141
# Pass options as flags
42-
xcodebuildmcp simulator build-sim --scheme MyApp --project-path ./MyApp.xcodeproj
42+
xcodebuildmcp simulator build --scheme MyApp --project-path ./MyApp.xcodeproj
4343

4444
# Pass complex options as JSON
45-
xcodebuildmcp simulator build-sim --json '{"scheme": "MyApp", "projectPath": "./MyApp.xcodeproj"}'
45+
xcodebuildmcp simulator build --json '{"scheme": "MyApp", "projectPath": "./MyApp.xcodeproj"}'
4646

4747
# Control output format
48-
xcodebuildmcp simulator list-sims --output json
48+
xcodebuildmcp simulator list --output json
4949
```
5050

5151
## Examples
@@ -54,46 +54,46 @@ xcodebuildmcp simulator list-sims --output json
5454

5555
```bash
5656
# Discover projects
57-
xcodebuildmcp simulator discover-projs
57+
xcodebuildmcp simulator discover-projects
5858

5959
# List schemes
6060
xcodebuildmcp simulator list-schemes --project-path ./MyApp.xcodeproj
6161

6262
# Build
63-
xcodebuildmcp simulator build-sim --scheme MyApp --project-path ./MyApp.xcodeproj
63+
xcodebuildmcp simulator build --scheme MyApp --project-path ./MyApp.xcodeproj
6464

6565
# Boot simulator
66-
xcodebuildmcp simulator boot-sim --simulator-name "iPhone 17 Pro"
66+
xcodebuildmcp simulator boot --simulator-name "iPhone 17 Pro"
6767

6868
# Install and launch
69-
xcodebuildmcp simulator install-app-sim --simulator-id <UDID> --app-path ./build/MyApp.app
69+
xcodebuildmcp simulator install --simulator-id <UDID> --app-path ./build/MyApp.app
7070

71-
xcodebuildmcp simulator launch-app-sim --simulator-id <UDID> --bundle-id com.example.MyApp
71+
xcodebuildmcp simulator launch-app --simulator-id <UDID> --bundle-id com.example.MyApp
7272

7373
# Or... build and run in a single command
74-
xcodebuildmcp simulator build-run-sim --scheme MyApp --project-path ./MyApp.xcodeproj
74+
xcodebuildmcp simulator build-and-run --scheme MyApp --project-path ./MyApp.xcodeproj
7575
```
7676

7777
### Log Capture Workflow
7878

7979
```bash
8080
# Start log capture
81-
xcodebuildmcp logging start-sim-log-cap --simulator-id <UDID> --bundle-id com.example.MyApp
81+
xcodebuildmcp logging start-simulator-log-capture --simulator-id <UDID> --bundle-id com.example.MyApp
8282

8383
> Log capture started successfully. Session ID: 51e2142a-1a99-442a-af01-0586540043df.
8484

8585
# Stop and retrieve logs
86-
xcodebuildmcp logging stop-sim-log-cap --session-id <SESSION_ID>
86+
xcodebuildmcp logging stop-simulator-log-capture --session-id <SESSION_ID>
8787
```
8888

8989
### Testing
9090

9191
```bash
9292
# Run all tests
93-
xcodebuildmcp simulator test-sim --scheme MyAppTests --project-path ./MyApp.xcodeproj
93+
xcodebuildmcp simulator test --scheme MyAppTests --project-path ./MyApp.xcodeproj
9494

9595
# Run with specific simulator
96-
xcodebuildmcp simulator test-sim --scheme MyAppTests --simulator-name "iPhone 17 Pro"
96+
xcodebuildmcp simulator test --scheme MyAppTests --simulator-name "iPhone 17 Pro"
9797
```
9898

9999
For a full list of workflows and tools, see [TOOLS-CLI.md](TOOLS-CLI.md).
@@ -208,16 +208,16 @@ Total: 2 (1 running, 1 stale)
208208
209209
### Stateless Tools (run in-process)
210210
Most tools run directly without the daemon:
211-
- `build-sim`, `test-sim`, `clean`
212-
- `list-sims`, `list-schemes`, `discover-projs`
213-
- `boot-sim`, `install-app-sim`, `launch-app-sim` etc.
211+
- `build`, `test`, `clean`
212+
- `list`, `list-schemes`, `discover-projects`
213+
- `boot`, `install`, `launch-app` etc.
214214
215215
### Stateful Tools (require daemon)
216216
Some tools maintain state and route through the daemon:
217-
- Log capture: `start-sim-log-cap`, `stop-sim-log-cap`
218-
- Video recording: `record-sim-video`
219-
- Debugging: `debug-attach-sim`, `debug-continue`, etc.
220-
- Background processes: `swift-package-run`, `swift-package-stop`
217+
- Log capture: `start-simulator-log-capture`, `stop-simulator-log-capture`
218+
- Video recording: `record-video`
219+
- Debugging: `attach`, `continue`, etc.
220+
- Background processes: `run`, `stop`
221221
222222
When you invoke a stateful tool, the daemon auto-starts if needed.
223223

docs/TOOLS-CLI.md

Lines changed: 67 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -16,88 +16,88 @@ XcodeBuildMCP provides 71 canonical tools organized into 13 workflow groups.
1616
### iOS Device Development (`device`)
1717
**Purpose**: Complete iOS development workflow for physical devices (iPhone, iPad, Apple Watch, Apple TV, Apple Vision Pro). (14 tools)
1818

19-
- `build-device` - Build for device.
19+
- `build` - Build for device.
2020
- `clean` - Clean build products.
21-
- `discover-projs` - Scans a directory (defaults to workspace root) to find Xcode project (.xcodeproj) and workspace (.xcworkspace) files.
21+
- `discover-projects` - Scans a directory (defaults to workspace root) to find Xcode project (.xcodeproj) and workspace (.xcworkspace) files.
2222
- `get-app-bundle-id` - Extract bundle id from .app.
23-
- `get-device-app-path` - Get device built app path.
24-
- `install-app-device` - Install app on device.
25-
- `launch-app-device` - Launch app on device.
26-
- `list-devices` - List connected devices.
23+
- `get-app-path` - Get device built app path.
24+
- `install` - Install app on device.
25+
- `launch` - Launch app on device.
26+
- `list` - List connected devices.
2727
- `list-schemes` - List Xcode schemes.
2828
- `show-build-settings` - Show build settings.
29-
- `start-device-log-cap` - Start device log capture.
30-
- `stop-app-device` - Stop device app.
31-
- `stop-device-log-cap` - Stop device app and return logs.
32-
- `test-device` - Test on device.
29+
- `start-device-log-capture` - Start device log capture.
30+
- `stop` - Stop device app.
31+
- `stop-device-log-capture` - Stop device app and return logs.
32+
- `test` - Test on device.
3333

3434

3535

3636
### iOS Simulator Development (`simulator`)
3737
**Purpose**: Complete iOS development workflow for both .xcodeproj and .xcworkspace files targeting simulators. (21 tools)
3838

39-
- `boot-sim` - Defined in Simulator Management workflow.
40-
- `build-run-sim` - Build and run iOS sim.
41-
- `build-sim` - Build for iOS sim.
39+
- `boot` - Defined in Simulator Management workflow.
40+
- `build` - Build for iOS sim.
41+
- `build-and-run` - Build and run iOS sim.
4242
- `clean` - Defined in iOS Device Development workflow.
43-
- `discover-projs` - Defined in iOS Device Development workflow.
43+
- `discover-projects` - Defined in iOS Device Development workflow.
4444
- `get-app-bundle-id` - Defined in iOS Device Development workflow.
45-
- `get-sim-app-path` - Get sim built app path.
46-
- `install-app-sim` - Install app on sim.
47-
- `launch-app-logs-sim` - Launch sim app with logs.
48-
- `launch-app-sim` - Launch app on simulator.
45+
- `get-app-path` - Get sim built app path.
46+
- `install` - Install app on sim.
47+
- `launch-app` - Launch app on simulator.
48+
- `launch-app-with-logs` - Launch sim app with logs.
49+
- `list` - Defined in Simulator Management workflow.
4950
- `list-schemes` - Defined in iOS Device Development workflow.
50-
- `list-sims` - Defined in Simulator Management workflow.
51-
- `open-sim` - Defined in Simulator Management workflow.
52-
- `record-sim-video` - Record sim video.
51+
- `open` - Defined in Simulator Management workflow.
52+
- `record-video` - Record sim video.
5353
- `screenshot` - Capture screenshot.
5454
- `show-build-settings` - Defined in iOS Device Development workflow.
5555
- `snapshot-ui` - Print view hierarchy with precise view coordinates (x, y, width, height) for visible elements.
56-
- `start-sim-log-cap` - Defined in Log Capture workflow.
57-
- `stop-app-sim` - Stop sim app.
58-
- `stop-sim-log-cap` - Defined in Log Capture workflow.
59-
- `test-sim` - Test on iOS sim.
56+
- `start-simulator-log-capture` - Defined in Log Capture workflow.
57+
- `stop` - Stop sim app.
58+
- `stop-simulator-log-capture` - Defined in Log Capture workflow.
59+
- `test` - Test on iOS sim.
6060

6161

6262

6363
### LLDB Debugging (`debugging`)
6464
**Purpose**: Attach LLDB debugger to simulator apps, set breakpoints, inspect variables and call stacks. (8 tools)
6565

66-
- `debug-attach-sim` - Attach LLDB to sim app.
67-
- `debug-breakpoint-add` - Add breakpoint.
68-
- `debug-breakpoint-remove` - Remove breakpoint.
69-
- `debug-continue` - Continue debug session.
70-
- `debug-detach` - Detach debugger.
71-
- `debug-lldb-command` - Run LLDB command.
72-
- `debug-stack` - Get backtrace.
73-
- `debug-variables` - Get frame variables.
66+
- `add-breakpoint` - Add breakpoint.
67+
- `attach` - Attach LLDB to sim app.
68+
- `continue` - Continue debug session.
69+
- `detach` - Detach debugger.
70+
- `lldb-command` - Run LLDB command.
71+
- `remove-breakpoint` - Remove breakpoint.
72+
- `stack` - Get backtrace.
73+
- `variables` - Get frame variables.
7474

7575

7676

7777
### Log Capture (`logging`)
7878
**Purpose**: Capture and retrieve logs from simulator and device apps. (4 tools)
7979

80-
- `start-device-log-cap` - Defined in iOS Device Development workflow.
81-
- `start-sim-log-cap` - Start sim log capture.
82-
- `stop-device-log-cap` - Defined in iOS Device Development workflow.
83-
- `stop-sim-log-cap` - Stop sim app and return logs.
80+
- `start-device-log-capture` - Defined in iOS Device Development workflow.
81+
- `start-simulator-log-capture` - Start sim log capture.
82+
- `stop-device-log-capture` - Defined in iOS Device Development workflow.
83+
- `stop-simulator-log-capture` - Stop sim app and return logs.
8484

8585

8686

8787
### macOS Development (`macos`)
8888
**Purpose**: Complete macOS development workflow for both .xcodeproj and .xcworkspace files. Build, test, deploy, and manage macOS applications. (11 tools)
8989

90-
- `build-macos` - Build macOS app.
91-
- `build-run-macos` - Build and run macOS app.
90+
- `build` - Build macOS app.
91+
- `build-and-run` - Build and run macOS app.
9292
- `clean` - Defined in iOS Device Development workflow.
93-
- `discover-projs` - Defined in iOS Device Development workflow.
94-
- `get-mac-app-path` - Get macOS built app path.
95-
- `get-mac-bundle-id` - Extract bundle id from macOS .app.
96-
- `launch-mac-app` - Launch macOS app.
93+
- `discover-projects` - Defined in iOS Device Development workflow.
94+
- `get-app-path` - Get macOS built app path.
95+
- `get-macos-bundle-id` - Extract bundle id from macOS .app.
96+
- `launch` - Launch macOS app.
9797
- `list-schemes` - Defined in iOS Device Development workflow.
9898
- `show-build-settings` - Defined in iOS Device Development workflow.
99-
- `stop-mac-app` - Stop macOS app.
100-
- `test-macos` - Test macOS target.
99+
- `stop` - Stop macOS app.
100+
- `test` - Test macOS target.
101101

102102

103103

@@ -111,9 +111,9 @@ XcodeBuildMCP provides 71 canonical tools organized into 13 workflow groups.
111111
### Project Discovery (`project-discovery`)
112112
**Purpose**: Discover and examine Xcode projects, workspaces, and Swift packages. Analyze project structure, schemes, build settings, and bundle information. (5 tools)
113113

114-
- `discover-projs` - Defined in iOS Device Development workflow.
114+
- `discover-projects` - Defined in iOS Device Development workflow.
115115
- `get-app-bundle-id` - Defined in iOS Device Development workflow.
116-
- `get-mac-bundle-id` - Defined in macOS Development workflow.
116+
- `get-macos-bundle-id` - Defined in macOS Development workflow.
117117
- `list-schemes` - Defined in iOS Device Development workflow.
118118
- `show-build-settings` - Defined in iOS Device Development workflow.
119119

@@ -122,34 +122,34 @@ XcodeBuildMCP provides 71 canonical tools organized into 13 workflow groups.
122122
### Project Scaffolding (`project-scaffolding`)
123123
**Purpose**: Scaffold new iOS and macOS projects from templates. (2 tools)
124124

125-
- `scaffold-ios-project` - Scaffold iOS project.
126-
- `scaffold-macos-project` - Scaffold macOS project.
125+
- `scaffold-ios` - Scaffold iOS project.
126+
- `scaffold-macos` - Scaffold macOS project.
127127

128128

129129

130130
### Simulator Management (`simulator-management`)
131131
**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. (8 tools)
132132

133-
- `boot-sim` - Boot iOS simulator.
134-
- `erase-sims` - Erase simulator.
135-
- `list-sims` - List iOS simulators.
136-
- `open-sim` - Open Simulator app.
137-
- `reset-sim-location` - Reset sim location.
138-
- `set-sim-appearance` - Set sim appearance.
139-
- `set-sim-location` - Set sim location.
140-
- `sim-statusbar` - Set sim status bar network.
133+
- `boot` - Boot iOS simulator.
134+
- `erase` - Erase simulator.
135+
- `list` - List iOS simulators.
136+
- `open` - Open Simulator app.
137+
- `reset-location` - Reset sim location.
138+
- `set-appearance` - Set sim appearance.
139+
- `set-location` - Set sim location.
140+
- `statusbar` - Set sim status bar network.
141141

142142

143143

144144
### Swift Package Development (`swift-package`)
145145
**Purpose**: Build, test, run and manage Swift Package Manager projects. (6 tools)
146146

147-
- `swift-package-build` - swift package target build.
148-
- `swift-package-clean` - swift package clean.
149-
- `swift-package-list` - List SwiftPM processes.
150-
- `swift-package-run` - swift package target run.
151-
- `swift-package-stop` - Stop SwiftPM run.
152-
- `swift-package-test` - Run swift package target tests.
147+
- `build` - swift package target build.
148+
- `clean` - swift package clean.
149+
- `list` - List SwiftPM processes.
150+
- `run` - swift package target run.
151+
- `stop` - Stop SwiftPM run.
152+
- `test` - Run swift package target tests.
153153

154154

155155

@@ -173,9 +173,9 @@ XcodeBuildMCP provides 71 canonical tools organized into 13 workflow groups.
173173
### Xcode IDE Integration (`xcode-ide`)
174174
**Purpose**: Bridge tools for connecting to Xcode's built-in MCP server (mcpbridge) to access IDE-specific functionality. (3 tools)
175175

176-
- `xcode-tools-bridge-disconnect` - Disconnect bridge and unregister proxied `xcode_tools_*` tools.
177-
- `xcode-tools-bridge-status` - Show xcrun mcpbridge availability and proxy tool sync status.
178-
- `xcode-tools-bridge-sync` - One-shot connect + tools/list sync (manual retry; avoids background prompt spam).
176+
- `bridge-disconnect` - Disconnect bridge and unregister proxied `xcode_tools_*` tools.
177+
- `bridge-status` - Show xcrun mcpbridge availability and proxy tool sync status.
178+
- `bridge-sync` - One-shot connect + tools/list sync (manual retry; avoids background prompt spam).
179179

180180

181181

@@ -187,4 +187,4 @@ XcodeBuildMCP provides 71 canonical tools organized into 13 workflow groups.
187187

188188
---
189189

190-
*This documentation is automatically generated by `scripts/update-tools-docs.ts` from the tools manifest. Last updated: 2026-02-06T11:40:14.287Z UTC*
190+
*This documentation is automatically generated by `scripts/update-tools-docs.ts` from the tools manifest. Last updated: 2026-02-07T22:29:44.282Z UTC*

docs/TOOLS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,4 +202,4 @@ This document lists MCP tool names as exposed to MCP clients. XcodeBuildMCP prov
202202

203203
---
204204

205-
*This documentation is automatically generated by `scripts/update-tools-docs.ts` from the tools manifest. Last updated: 2026-02-06T11:40:14.287Z UTC*
205+
*This documentation is automatically generated by `scripts/update-tools-docs.ts` from the tools manifest. Last updated: 2026-02-07T22:29:44.282Z UTC*

0 commit comments

Comments
 (0)