xc-mcp
Version:
MCP server that wraps Xcode command-line tools for iOS/macOS development workflows
44 lines • 3.23 kB
TypeScript
/**
* Install iOS apps to simulators for testing
*
* **What it does:**
* Installs a built .app bundle to a simulator device, making it available for launching
* and testing. Validates the app bundle format and simulator state before installation.
*
* **Why you'd use it:**
* - Deploy built apps directly from Xcode DerivedData to any simulator
* - Fast installation completes in seconds for quick test iterations
* - Validation checks ensure app bundle and simulator are valid before attempting install
* - Testing workflows integrate app installation into automated test pipelines
*
* **Parameters:**
* - `udid` (string): Simulator UDID (from simctl-list)
* - `appPath` (string): Path to .app bundle (e.g., /path/to/MyApp.app)
*
* **Returns:**
* Installation status with app name, simulator info, and guidance for next steps
*
* **Example:**
* ```typescript
* // Install from Xcode build output
* await simctlInstallTool({
* udid: 'ABC-123-DEF',
* appPath: '/Users/dev/Library/Developer/Xcode/DerivedData/MyApp-xxx/Build/Products/Debug-iphonesimulator/MyApp.app'
* })
* ```
*
* **Full documentation:** See simctl/install.md for app installation patterns
*
* @param args Installation configuration (requires udid and appPath)
* @returns Tool result with installation status and guidance
* @throws McpError for invalid app path, simulator not found, or installation failure
*/
export declare function simctlInstallTool(args: any): Promise<{
content: {
type: "text";
text: string;
}[];
isError: boolean;
}>;
export declare const SIMCTL_INSTALL_DOCS = "\n# simctl-install\n\nInstall iOS apps to simulators for testing.\n\n## Overview\n\nInstalls a built .app bundle to a simulator device, making it available for launching and testing. Validates the app bundle format and simulator state before installation. Fast installation completes in seconds for quick test iterations.\n\n## Parameters\n\n### Required\n- **udid** (string): Simulator UDID (from simctl-list)\n- **appPath** (string): Path to .app bundle (e.g., /path/to/MyApp.app)\n\n## Returns\n\nInstallation status with app name, simulator info (name, state, availability), success indicator, command output, and guidance for next steps (launch, get container, uninstall).\n\n## Examples\n\n### Install from Xcode build output\n```typescript\nawait simctlInstallTool({\n udid: 'ABC-123-DEF',\n appPath: '/Users/dev/Library/Developer/Xcode/DerivedData/MyApp-xxx/Build/Products/Debug-iphonesimulator/MyApp.app'\n});\n```\n\n### Install to specific simulator\n```typescript\nawait simctlInstallTool({\n udid: 'TEST-DEVICE-UDID',\n appPath: '/path/to/MyApp.app'\n});\n```\n\n## Related Tools\n\n- simctl-launch: Launch installed app\n- simctl-uninstall: Remove app from simulator\n- simctl-get-app-container: Get app filesystem container path\n\n## Notes\n\n- App path must point to .app bundle (not .ipa)\n- Fast installation - completes in seconds\n- Validates app bundle format and simulator state\n- Extracts app name from bundle path automatically\n- Deploys built apps directly from Xcode DerivedData\n- Use for quick test iterations and automated test pipelines\n";
//# sourceMappingURL=install.d.ts.map