xc-mcp/dist/tools/persistence/disable.d.ts

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

import type { ToolResult } from '../../types/xcode.js';
/**
 * Disable persistent state management and return to in-memory-only caching
 *
 * **What it does:**
 * Safely deactivates file-based persistence and optionally deletes existing cache data files.
 * After disabling, XC-MCP operates with in-memory caching only, losing all learned state on server
 * restart. Useful for privacy requirements, disk space constraints, or troubleshooting cache-related
 * issues.
 *
 * **Why you'd use it:**
 * - Meet privacy requirements that prohibit persistent storage
 * - Free up disk space when storage is limited
 * - Switch to CI/CD mode where persistence isn't beneficial
 * - Troubleshoot issues potentially caused by stale cached data
 *
 * **Parameters:**
 * - clearData (boolean, optional): Whether to delete existing cache files when disabling.
 *   Defaults to false (keeps files but stops writing new data)
 *
 * **Returns:**
 * JSON object containing:
 * - success: Whether persistence was disabled
 * - message: Confirmation message
 * - clearedData: Whether cache files were deleted
 * - previousStorageInfo: Disk usage stats before disabling (if clearData was true)
 * - effect: Description of the operational change
 *
 * **Example:**
 * ```typescript
 * // Disable persistence but keep cache files
 * await persistenceDisableTool({clearData: false});
 *
 * // Disable and delete all cache files
 * await persistenceDisableTool({clearData: true});
 *
 * // Returns:
 * // {
 * //   "success": true,
 * //   "message": "Persistence disabled successfully",
 * //   "clearedData": true,
 * //   "previousStorageInfo": {
 * //     "diskUsage": "2.4 MB",
 * //     "fileCount": 12
 * //   },
 * //   "effect": "XC-MCP will now operate with in-memory caching only"
 * // }
 * ```
 *
 * **Full documentation:** See persistence/disable.md for detailed parameters and examples
 *
 * @param args Tool arguments with optional clearData flag
 * @returns Tool result with persistence deactivation confirmation
 */
export declare function persistenceDisableTool(args: any): Promise<ToolResult>;
export declare const PERSISTENCE_DISABLE_DOCS = "\n# persistence-disable\n\n\uD83D\uDD0C **Disable persistent state management and return to in-memory-only caching** - Turn off persistence.\n\nSafely deactivates file-based persistence and optionally deletes existing cache data files. After disabling, XC-MCP operates with in-memory caching only, losing all learned state on server restart. Useful for privacy requirements, disk space constraints, or troubleshooting cache-related issues.\n\n## Advantages\n\n\u2022 Meet privacy requirements that prohibit persistent storage\n\u2022 Free up disk space when storage is limited\n\u2022 Switch to CI/CD mode where persistence isn't beneficial\n\u2022 Troubleshoot issues potentially caused by stale cached data\n\n## Parameters\n\n### Required\n- (None)\n\n### Optional\n- clearData (boolean): Whether to delete existing cache files when disabling. Defaults to false\n\n## Returns\n\n- Tool execution results with persistence deactivation confirmation\n- Confirmation of whether cache files were cleared\n- Previous storage information (if clearData was true)\n- Operational effect description\n\n## Related Tools\n\n- persistence-enable: Turn on persistence\n- persistence-status: View persistence system status\n\n## Notes\n\n- Tool is auto-registered with MCP server\n- Defaults to keeping cache files (just stopping writes)\n- Set clearData: true to delete all cache files\n- Operation is immediate and irreversible\n";
//# sourceMappingURL=disable.d.ts.map