xc-mcp
Version:
MCP server that wraps Xcode command-line tools for iOS/macOS development workflows
61 lines • 4.04 kB
TypeScript
import type { ToolResult } from '../../types/xcode.js';
/**
* Get comprehensive persistence system status with storage metrics and recommendations
*
* **What it does:**
* Provides detailed information about the persistence system's current state. Shows whether
* persistence is enabled, cache directory location, disk usage statistics, file counts, last save
* timestamps, and intelligent recommendations based on storage health. Essential for monitoring
* and troubleshooting persistent storage.
*
* **Why you'd use it:**
* - Monitor disk space usage and cache file growth over time
* - Verify persistence is working correctly (check last save timestamps)
* - Troubleshoot persistence issues (check writability, file counts)
* - Get actionable recommendations for cache maintenance and optimization
*
* **Parameters:**
* - includeStorageInfo (boolean, optional): Whether to include detailed disk usage and file
* information. Defaults to true. Set to false for lightweight status check.
*
* **Returns:**
* JSON object containing:
* - enabled: Whether persistence is currently active
* - schemaVersion: Cache data format version
* - cacheDirectory: Storage location (if enabled)
* - storage: Disk usage, file count, last save time, writability (if includeStorageInfo is true)
* - recommendations: Actionable suggestions based on storage state
* - features: Available persistence features (if disabled)
*
* **Example:**
* ```typescript
* // Get full status with storage details
* await persistenceStatusTool({includeStorageInfo: true});
*
* // Get lightweight status without disk scanning
* await persistenceStatusTool({includeStorageInfo: false});
*
* // Returns (when enabled):
* // {
* // "enabled": true,
* // "cacheDirectory": "/Users/dev/.xc-mcp/cache",
* // "storage": {
* // "diskUsage": "2.4 MB",
* // "fileCount": 12,
* // "lastSave": "2025-01-23T10:15:30.000Z",
* // "isWritable": true
* // },
* // "recommendations": [
* // "📝 Cache is healthy and actively used"
* // ]
* // }
* ```
*
* **Full documentation:** See persistence/status.md for detailed parameters and examples
*
* @param args Tool arguments with optional includeStorageInfo flag
* @returns Tool result with comprehensive persistence status
*/
export declare function persistenceStatusTool(args: any): Promise<ToolResult>;
export declare const PERSISTENCE_STATUS_DOCS = "\n# persistence-status\n\n\uD83D\uDCCA **Get comprehensive persistence system status with storage metrics and recommendations** - Monitor persistence.\n\nProvides detailed information about the persistence system's current state. Shows whether persistence is enabled, cache directory location, disk usage statistics, file counts, last save timestamps, and intelligent recommendations based on storage health. Essential for monitoring and troubleshooting persistent storage.\n\n## Advantages\n\n\u2022 Monitor disk space usage and cache file growth over time\n\u2022 Verify persistence is working correctly (check last save timestamps)\n\u2022 Troubleshoot persistence issues (check writability, file counts)\n\u2022 Get actionable recommendations for cache maintenance and optimization\n\n## Parameters\n\n### Required\n- (None)\n\n### Optional\n- includeStorageInfo (boolean): Whether to include detailed disk usage and file information. Defaults to true\n\n## Returns\n\n- Tool execution results with comprehensive persistence status\n- Enabled/disabled state and schema version\n- Cache directory location (if enabled)\n- Storage usage, file count, last save time, writability\n- Actionable recommendations based on storage state\n\n## Related Tools\n\n- persistence-enable: Turn on persistence\n- persistence-disable: Turn off persistence\n\n## Notes\n\n- Tool is auto-registered with MCP server\n- Provides intelligent recommendations for health\n- Set includeStorageInfo: false for lightweight check\n- Use regularly to monitor cache growth and health\n";
//# sourceMappingURL=status.d.ts.map