UNPKG

xc-mcp

Version:

MCP server that wraps Xcode command-line tools for iOS/macOS development workflows

43 lines 3.19 kB
/** * Shutdown iOS simulator devices with intelligent device management * * **What it does:** * Gracefully shuts down one or more iOS simulator devices. Supports shutting down specific devices, * all currently booted devices, or all devices at once with smart targeting options. * * **Why you'd use it:** * - Smart device targeting with "booted" and "all" options vs complex CLI syntax * - Better error handling with clear feedback when devices cannot be shut down * - State tracking updates internal device state for better recommendations * - Batch operations efficiently handle multiple device shutdowns * * **Parameters:** * - `deviceId` (string): Device UDID, "booted" for all booted devices, or "all" for all devices * * **Returns:** * Shutdown status with device information, duration, and next step guidance * * **Example:** * ```typescript * // Shutdown specific device * await simctlShutdownTool({ deviceId: 'ABC-123-DEF' }) * * // Shutdown all booted devices * await simctlShutdownTool({ deviceId: 'booted' }) * ``` * * **Full documentation:** See simctl/shutdown.md for detailed parameters and usage patterns * * @param args Shutdown configuration (requires deviceId) * @returns Tool result with shutdown status and guidance * @throws McpError for invalid device ID or shutdown failure */ export declare function simctlShutdownTool(args: any): Promise<{ content: { type: "text"; text: string; }[]; isError: boolean; }>; export declare const SIMCTL_SHUTDOWN_DOCS = "\n# simctl-shutdown\n\nShutdown iOS simulator devices with intelligent device management.\n\n## Overview\n\nGracefully shuts down one or more iOS simulator devices. Supports shutting down specific devices, all currently booted devices, or all devices at once with smart targeting options. Better error handling with clear feedback when devices cannot be shut down.\n\n## Parameters\n\n### Required\n- **deviceId** (string): Device UDID, \"booted\" for all booted devices, or \"all\" for all devices\n\n## Returns\n\nShutdown status with device information, duration, success indicator, command output, and next step guidance. Handles common scenarios like device already shutdown gracefully.\n\n## Examples\n\n### Shutdown specific device\n```typescript\nawait simctlShutdownTool({ deviceId: 'ABC-123-DEF' });\n```\n\n### Shutdown all booted devices\n```typescript\nawait simctlShutdownTool({ deviceId: 'booted' });\n```\n\n### Shutdown all devices\n```typescript\nawait simctlShutdownTool({ deviceId: 'all' });\n```\n\n## Related Tools\n\n- simctl-boot: Boot device after shutdown\n- simctl-list: Find device UDID to shutdown\n- simctl-delete: Delete device after shutdown (required for deletion)\n\n## Notes\n\n- Smart device targeting: \"booted\", \"all\", or specific UDID\n- Graceful shutdown operation\n- Handles \"already shutdown\" scenario without error\n- State tracking updates internal device state for better recommendations\n- Batch operations efficiently handle multiple device shutdowns\n- Required before device deletion (safety check)\n- Use \"booted\" to quickly shutdown all running simulators\n"; //# sourceMappingURL=shutdown.d.ts.map