show_build_set_ws
Display build settings from an Xcode workspace by specifying the workspace path and scheme. Use this tool to retrieve project configurations directly from the command line.
Instructions
Shows build settings from a workspace using xcodebuild. IMPORTANT: Requires workspacePath and scheme. Example: show_build_set_ws({ workspacePath: '/path/to/MyProject.xcworkspace', scheme: 'MyScheme' })
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| scheme | Yes | The scheme to use (Required) | |
| workspacePath | Yes | Path to the .xcworkspace file (Required) |
Implementation Reference
- src/tools/build_settings.ts:34-79 (handler)Core execution logic for showing build settings using xcodebuild -showBuildSettings. Handles both workspace and project inputs, executes command, and formats response.async function _handleShowBuildSettingsLogic(params: { workspacePath?: string; projectPath?: string; scheme: string; }): Promise<ToolResponse> { log('info', `Showing build settings for scheme ${params.scheme}`); try { // Create the command array for xcodebuild const command = ['xcodebuild', '-showBuildSettings']; // -showBuildSettings as an option, not an action // Add the workspace or project if (params.workspacePath) { command.push('-workspace', params.workspacePath); } else if (params.projectPath) { command.push('-project', params.projectPath); } // Add the scheme command.push('-scheme', params.scheme); // Execute the command directly const result = await executeCommand(command, 'Show Build Settings'); if (!result.success) { return createTextResponse(`Failed to show build settings: ${result.error}`, true); } return { content: [ { type: 'text', text: `✅ Build settings for scheme ${params.scheme}:`, }, { type: 'text', text: result.output || 'Build settings retrieved successfully.', }, ], }; } catch (error) { const errorMessage = error instanceof Error ? error.message : String(error); log('error', `Error showing build settings: ${errorMessage}`); return createTextResponse(`Error showing build settings: ${errorMessage}`, true); } }
- src/tools/build_settings.ts:158-178 (registration)Specific registration function for the 'show_build_set_ws' tool, defining name, description, input schema, and handler with validation.export function registerShowBuildSettingsWorkspaceTool(server: McpServer): void { registerTool<BaseWorkspaceParams>( server, 'show_build_set_ws', "Shows build settings from a workspace using xcodebuild. IMPORTANT: Requires workspacePath and scheme. Example: show_build_set_ws({ workspacePath: '/path/to/MyProject.xcworkspace', scheme: 'MyScheme' })", { workspacePath: workspacePathSchema, scheme: schemeSchema, }, async (params: BaseWorkspaceParams) => { // Validate required parameters const workspaceValidation = validateRequiredParam('workspacePath', params.workspacePath); if (!workspaceValidation.isValid) return workspaceValidation.errorResponse!; const schemeValidation = validateRequiredParam('scheme', params.scheme); if (!schemeValidation.isValid) return schemeValidation.errorResponse!; return _handleShowBuildSettingsLogic(params); }, ); }
- src/tools/build_settings.ts:163-166 (schema)Input schema definition for the tool using Zod schemas for workspacePath and scheme.{ workspacePath: workspacePathSchema, scheme: schemeSchema, },
- src/utils/register-tools.ts:129-132 (registration)Top-level configuration that enables the registration of show_build_set_ws tool based on environment variable.register: registerShowBuildSettingsWorkspaceTool, groups: [ToolGroup.PROJECT_DISCOVERY], envVar: 'XCODEBUILDMCP_TOOL_SHOW_BUILD_SETTINGS_WORKSPACE', },
- src/tools/common.ts:22-24 (schema)Zod schema definitions for common parameters: workspacePathSchema and schemeSchema used by the tool.export const workspacePathSchema = z.string().describe('Path to the .xcworkspace file (Required)'); export const projectPathSchema = z.string().describe('Path to the .xcodeproj file (Required)'); export const schemeSchema = z.string().describe('The scheme to use (Required)');