more edits

Signed-off-by: Matt Bruce <matt.bruce1@toyota.com>
This commit is contained in:
Matt Bruce 2026-02-12 16:50:00 -06:00
parent 3d1e2835b0
commit 370647c882
3 changed files with 37 additions and 1 deletions

View File

@ -34,7 +34,7 @@ This guide covers how to set up MCP (Model Context Protocol) automation for iOS
brew tap getsentry/xcodebuildmcp brew tap getsentry/xcodebuildmcp
brew install xcodebuildmcp brew install xcodebuildmcp
``` ```
2. Ensure `.xcodebuildmcp/config.yaml` is present and configured for your workspace, scheme, and simulator. 2. Ensure `.xcodebuildmcp/config.yaml` is present and configured for your workspace, scheme, and simulator. ([What is config.yaml? See reference and sample.](xcodebuildmcp-config.yaml.md))
3. Add or update `.vscode/mcp.json`: 3. Add or update `.vscode/mcp.json`:
```json ```json
{ {

View File

@ -56,9 +56,11 @@ brew tap getsentry/xcodebuildmcp
brew install xcodebuildmcp brew install xcodebuildmcp
``` ```
### 2. Configure XcodeBuildMCP ### 2. Configure XcodeBuildMCP
- The repo should include `.xcodebuildmcp/config.yaml`. Make sure it points to the correct workspace, scheme, and simulator. - The repo should include `.xcodebuildmcp/config.yaml`. Make sure it points to the correct workspace, scheme, and simulator.
- [What is config.yaml? See reference and sample.](xcodebuildmcp-config.yaml.md)
Example (Toyota): Example (Toyota):

View File

@ -0,0 +1,34 @@
# xcodebuildmcp/config.yaml Reference
This file is required for XcodeBuildMCP to automate builds, tests, and simulator actions. It tells the tool which workspace, scheme, configuration, and simulator to use.
## Example config.yaml
```yaml
schemaVersion: 1
sessionDefaults:
workspacePath: ./OneApp.xcworkspace
scheme: ToyotaOneApp
configuration: Debug
simulatorName: iPhone 17 Pro Max
simulatorId: <SIMULATOR_UDID>
useLatestOS: true
```
## Key Fields
- `workspacePath`: Path to your .xcworkspace or .xcodeproj
- `scheme`: The Xcode scheme to build/test
- `configuration`: Build configuration (Debug, Release, etc.)
- `simulatorName`: Name of the simulator to use
- `simulatorId`: UDID of the simulator (optional; takes precedence over name)
- `useLatestOS`: If true, always use the latest available iOS version
## Where to put it
Place this file at `.xcodebuildmcp/config.yaml` in your repo root.
## Why it matters
This config lets XcodeBuildMCP run builds, tests, and launches without manual setup. It ensures all developers and CI jobs use the same settings.
## Troubleshooting
- If builds fail, check workspacePath and scheme.
- If the simulator isnt found, check simulatorName or simulatorId.
- If you change project structure, update config.yaml accordingly.