xc-mcp/dist/tools/simctl/health-check.d.ts

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

/**
 * Comprehensive iOS simulator environment health check
 *
 * **What it does:**
 * Performs a complete diagnostic check of your iOS development environment, validating
 * Xcode tools, simulators, runtimes, and disk space. Returns actionable recommendations
 * for any issues found.
 *
 * **Why you'd use it:**
 * - Troubleshooting validates entire toolchain when operations fail unexpectedly
 * - Actionable guidance provides specific steps to fix each identified issue
 * - Comprehensive diagnostics check 6 critical areas in seconds
 * - CI/CD validation ensures environment health before running test suites
 *
 * **Parameters:**
 * None - performs complete environment check automatically
 *
 * **Returns:**
 * Health report with pass/fail status for each check and specific guidance for failures
 *
 * **Example:**
 * ```typescript
 * // Run complete health check
 * await simctlHealthCheckTool()
 * ```
 *
 * **Full documentation:** See simctl/health-check.md for diagnostic details
 *
 * @returns Tool result with comprehensive health status and guidance
 */
export declare function simctlHealthCheckTool(): Promise<{
    content: {
        type: "text";
        text: string;
    }[];
    isError: boolean;
}>;
export declare const SIMCTL_HEALTH_CHECK_DOCS = "\n# simctl-health-check\n\nComprehensive iOS simulator environment health check.\n\n## Overview\n\nPerforms a complete diagnostic check of your iOS development environment, validating Xcode tools, simulators, runtimes, and disk space. Returns actionable recommendations for any issues found. Checks 6 critical areas in seconds: Xcode Command Line Tools, simctl availability, available simulators, booted simulators, available runtimes, and disk space.\n\n## Parameters\n\nNone - performs complete environment check automatically.\n\n## Returns\n\nHealth report with pass/fail status for each check, specific guidance for failures, summary of passed/failed checks, and overall healthy status indicator.\n\n## Examples\n\n### Run complete health check\n```typescript\nawait simctlHealthCheckTool();\n```\n\n### Check before CI/CD pipeline\n```typescript\n// Validate environment before running test suite\nconst health = await simctlHealthCheckTool();\nif (!health.healthy) {\n  console.error('Environment issues detected');\n}\n```\n\n## Related Tools\n\n- simctl-list: See available simulators after health check passes\n- simctl-create: Create simulators if none found\n- simctl-suggest: Get intelligent simulator recommendations\n\n## Notes\n\n- Checks 6 critical areas: Xcode tools, simctl, simulators, booted devices, runtimes, disk space\n- Provides specific solutions for each failed check\n- Validates entire toolchain in seconds\n- Warns if disk usage over 80% (simulators require significant space)\n- Perfect for troubleshooting when operations fail unexpectedly\n- Use before CI/CD pipeline execution to ensure environment health\n";
export declare const SIMCTL_HEALTH_CHECK_DOCS_MINI = "Check simulator environment health. Use rtfm({ toolName: \"simctl-health-check\" }) for docs.";
//# sourceMappingURL=health-check.d.ts.map