xc-mcp/dist/tools/xcodebuild/get-details.d.ts

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

/**
 * Retrieve detailed build or test output from cached results (progressive disclosure)
 *
 * **What it does:**
 * Provides on-demand access to full build and test logs that were cached during xcodebuild-build
 * or xcodebuild-test execution. Implements progressive disclosure pattern: initial build/test
 * responses return concise summaries to prevent token overflow, while this tool allows drilling
 * down into full logs, filtered errors, warnings, or metadata when needed for debugging.
 *
 * **Why you'd use it:**
 * - Access full build logs without cluttering initial responses
 * - Filter to just errors or warnings for faster debugging
 * - Retrieve exact command executed and exit code
 * - Inspect build metadata and cache information
 *
 * **Parameters:**
 * - buildId (string, required): Cache ID from xcodebuild-build or xcodebuild-test response
 * - detailType (string, required): Type of details to retrieve
 *   - "full-log": Complete stdout and stderr output
 *   - "errors-only": Lines containing errors or build failures
 *   - "warnings-only": Lines containing warnings
 *   - "summary": Build metadata and configuration used
 *   - "command": Exact xcodebuild command executed
 *   - "metadata": Cache info and output sizes
 * - maxLines (number, optional): Maximum lines to return (default: 100)
 *
 * **Returns:**
 * Structured JSON containing requested details. For logs, includes total line count and
 * truncation status. For errors/warnings, includes count and filtered lines. For summary,
 * includes full metadata about the build or test execution.
 *
 * **Example:**
 * ```typescript
 * // After running a build that returns { buildId: "abc123", ... }
 * const errors = await xcodebuildGetDetailsTool({
 *   buildId: "abc123",
 *   detailType: "errors-only"
 * });
 *
 * // Get full log with custom line limit
 * const fullLog = await xcodebuildGetDetailsTool({
 *   buildId: "abc123",
 *   detailType: "full-log",
 *   maxLines: 500
 * });
 *
 * // Get execution metadata
 * const metadata = await xcodebuildGetDetailsTool({
 *   buildId: "abc123",
 *   detailType: "metadata"
 * });
 * ```
 *
 * **Full documentation:** See xcodebuild/get-details.md for detailed parameters and examples
 *
 * @param args Tool arguments containing buildId, detailType, and optional maxLines
 * @returns Tool result with requested build or test details
 */
export declare function xcodebuildGetDetailsTool(args: any): Promise<{
    content: {
        type: "text";
        text: string;
    }[];
}>;
export declare const XCODEBUILD_GET_DETAILS_DOCS = "\n# xcodebuild-get-details\n\n\uD83D\uDD0D **Retrieve detailed build or test output from cached results** - Progressive disclosure for logs.\n\nProvides on-demand access to full build and test logs that were cached during xcodebuild-build or xcodebuild-test execution. Implements progressive disclosure pattern: initial build/test responses return concise summaries to prevent token overflow, while this tool allows drilling down into full logs, filtered errors, warnings, or metadata when needed for debugging.\n\n## Advantages\n\n\u2022 Access full build logs without cluttering initial responses\n\u2022 Filter to just errors or warnings for faster debugging\n\u2022 Retrieve exact command executed and exit code\n\u2022 Inspect build metadata and cache information\n\n## Parameters\n\n### Required\n- buildId (string): Cache ID from xcodebuild-build or xcodebuild-test response\n- detailType (string): Type of details to retrieve\n  - \"full-log\": Complete stdout and stderr output\n  - \"errors-only\": Lines containing errors or build failures\n  - \"warnings-only\": Lines containing warnings\n  - \"summary\": Build metadata and configuration used\n  - \"command\": Exact xcodebuild command executed\n  - \"metadata\": Cache info and output sizes\n\n### Optional\n- maxLines (number): Maximum lines to return (default: 100)\n\n## Returns\n\n- Tool execution results with requested build or test details\n- Full logs or filtered errors/warnings with line counts\n- Build metadata and execution information\n\n## Related Tools\n\n- xcodebuild-build: Build iOS projects (returns buildId)\n- xcodebuild-test: Run tests (returns testId)\n- simctl-get-details: Get simulator list details\n\n## Notes\n\n- Tool is auto-registered with MCP server\n- Requires valid cache ID from recent build/test\n- Cache IDs expire after 30 minutes\n- Use for debugging build failures and test issues\n";
export declare const XCODEBUILD_GET_DETAILS_DOCS_MINI = "Get build/test logs from cache. Use rtfm({ toolName: \"xcodebuild-get-details\" }) for docs.";
//# sourceMappingURL=get-details.d.ts.map