clean_ws
Cleans Xcode build products for a specific workspace using xcodebuild. Specify workspace path; scheme and configuration are optional.
Instructions
Cleans build products for a specific workspace using xcodebuild. IMPORTANT: Requires workspacePath. Scheme/Configuration are optional. Example: clean_ws({ workspacePath: '/path/to/MyProject.xcworkspace', scheme: 'MyScheme' })
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| workspacePath | Yes | Path to the .xcworkspace file (Required) | |
| scheme | No | Optional: The scheme to clean | |
| configuration | No | Optional: Build configuration to clean (Debug, Release, etc.) | |
| derivedDataPath | No | Optional: Path where derived data might be located | |
| extraArgs | No | Additional xcodebuild arguments |
Implementation Reference
- src/tools/clean.ts:27-51 (handler)Core handler function that executes the xcodebuild clean command for workspaces or projects.
async function _handleCleanLogic(params: { workspacePath?: string; projectPath?: string; scheme?: string; configuration?: string; derivedDataPath?: string; extraArgs?: string[]; }): Promise<ToolResponse> { log('info', 'Starting xcodebuild clean request (internal)'); // For clean operations, we need to provide a default platform and configuration return executeXcodeBuildCommand( { ...params, scheme: params.scheme || '', // Empty string if not provided configuration: params.configuration || 'Debug', // Default to Debug if not provided }, { platform: XcodePlatform.macOS, // Default to macOS, but this doesn't matter much for clean logPrefix: 'Clean', }, false, 'clean', // Specify 'clean' as the build action ); } - src/tools/clean.ts:60-71 (schema)Zod input schema defining parameters for the clean_ws tool, including required workspacePath.
workspacePath: z.string().describe('Path to the .xcworkspace file (Required)'), scheme: z.string().optional().describe('Optional: The scheme to clean'), configuration: z .string() .optional() .describe('Optional: Build configuration to clean (Debug, Release, etc.)'), derivedDataPath: z .string() .optional() .describe('Optional: Path where derived data might be located'), extraArgs: z.array(z.string()).optional().describe('Additional xcodebuild arguments'), }, - src/tools/clean.ts:57-73 (registration)Direct registration of the 'clean_ws' tool on the MCP server, specifying name, description, input schema, and handler function.
'clean_ws', "Cleans build products for a specific workspace using xcodebuild. IMPORTANT: Requires workspacePath. Scheme/Configuration are optional. Example: clean_ws({ workspacePath: '/path/to/MyProject.xcworkspace', scheme: 'MyScheme' })", { workspacePath: z.string().describe('Path to the .xcworkspace file (Required)'), scheme: z.string().optional().describe('Optional: The scheme to clean'), configuration: z .string() .optional() .describe('Optional: Build configuration to clean (Debug, Release, etc.)'), derivedDataPath: z .string() .optional() .describe('Optional: Path where derived data might be located'), extraArgs: z.array(z.string()).optional().describe('Additional xcodebuild arguments'), }, (params) => _handleCleanLogic(params), ); - src/utils/register-tools.ts:141-147 (registration)Configuration entry in toolRegistrations array that enables registration of the clean_ws tool via registerCleanWorkspaceTool when the corresponding environment variable is set.
register: registerCleanWorkspaceTool, groups: [ ToolGroup.MACOS_WORKFLOW, ToolGroup.IOS_SIMULATOR_WORKFLOW, ToolGroup.IOS_DEVICE_WORKFLOW, ], envVar: 'XCODEBUILDMCP_TOOL_CLEAN_WORKSPACE',