xc-mcp/dist/tools/cache/get-config.d.ts

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

import type { ToolResult } from '../../types/xcode.js';
/**
 * Get current cache retention configuration settings
 *
 * **What it does:**
 * Retrieves the current cache retention policies for simulator, project, and response caches.
 * Shows both millisecond values and human-readable durations. Essential for understanding your
 * current cache configuration before making adjustments or troubleshooting performance.
 *
 * **Why you'd use it:**
 * - Verify cache retention settings before tuning for specific workflows
 * - Understand current configuration when troubleshooting stale data issues
 * - Document cache settings for team collaboration or CI/CD configuration
 * - Compare settings across different environments (development vs production)
 *
 * **Parameters:**
 * - cacheType (string, optional): Which cache config to retrieve - "simulator", "project",
 *   "response", or "all". Defaults to "all"
 *
 * **Returns:**
 * JSON object containing cache retention settings with both raw milliseconds and human-readable
 * durations (e.g., "1h 30m")
 *
 * **Example:**
 * ```typescript
 * // Get all cache configurations
 * await getCacheConfigTool({});
 *
 * // Get only simulator cache config
 * await getCacheConfigTool({cacheType: "simulator"});
 *
 * // Returns:
 * // {
 * //   "cacheConfiguration": {
 * //     "simulator": {
 * //       "maxAgeMs": 3600000,
 * //       "maxAgeHuman": "1h 0m"
 * //     },
 * //     "project": {
 * //       "maxAgeMs": 3600000,
 * //       "maxAgeHuman": "1h 0m"
 * //     },
 * //     "response": {
 * //       "maxAgeMs": 1800000,
 * //       "maxAgeHuman": "30m",
 * //       "note": "Response cache duration is currently fixed"
 * //     }
 * //   }
 * // }
 * ```
 *
 * **Full documentation:** See cache/get-config.md for detailed parameters and examples
 *
 * @param args Tool arguments with optional cacheType filter
 * @returns Tool result with cache configuration details
 */
export declare function getCacheConfigTool(args: any): Promise<ToolResult>;
export declare const CACHE_GET_CONFIG_DOCS = "\n# cache-get-config\n\n\uD83D\uDD0D **Get current cache retention configuration settings** - View cache policies.\n\nRetrieves the current cache retention policies for simulator, project, and response caches. Shows both millisecond values and human-readable durations. Essential for understanding your current cache configuration before making adjustments or troubleshooting performance.\n\n## Advantages\n\n\u2022 Verify cache retention settings before tuning for specific workflows\n\u2022 Understand current configuration when troubleshooting stale data issues\n\u2022 Document cache settings for team collaboration or CI/CD configuration\n\u2022 Compare settings across different environments (development vs production)\n\n## Parameters\n\n### Required\n- (None)\n\n### Optional\n- cacheType (string): Which cache config to retrieve - \"simulator\", \"project\", \"response\", or \"all\". Defaults to \"all\"\n\n## Returns\n\n- Tool execution results with current cache configuration\n- Retention times in both milliseconds and human-readable format\n- Fixed response cache duration (30 minutes)\n\n## Related Tools\n\n- cache-set-config: Configure cache retention times\n- cache-get-stats: Monitor cache performance\n- cache-clear: Clear cached data\n\n## Notes\n\n- Tool is auto-registered with MCP server\n- Shows default configurations before any customization\n- Response cache duration is fixed at 30 minutes\n- Use to verify config changes after using cache-set-config\n";
//# sourceMappingURL=get-config.d.ts.map