sl-test

Instructions

Implementation Reference

• src/tools/build_ios_simulator.ts:42-70 (handler)

  Core internal handler that executes the xcodebuild build command for iOS simulator targeting, shared across similar tools.

  async function _handleIOSSimulatorBuildLogic(params: {
    workspacePath?: string;
    projectPath?: string;
    scheme: string;
    configuration: string;
    simulatorName?: string;
    simulatorId?: string;
    useLatestOS: boolean;
    derivedDataPath?: string;
    extraArgs?: string[];
    preferXcodebuild?: boolean;
  }): Promise<ToolResponse> {
    log('info', `Starting iOS Simulator build for scheme ${params.scheme} (internal)`);
  
    return executeXcodeBuildCommand(
      {
        ...params,
      },
      {
        platform: XcodePlatform.iOSSimulator,
        simulatorName: params.simulatorName,
        simulatorId: params.simulatorId,
        useLatestOS: params.useLatestOS,
        logPrefix: 'iOS Simulator Build',
      },
      params.preferXcodebuild,
      'build',
    );
  }

• src/tools/build_ios_simulator.ts:511-557 (registration)

  Registers the 'build_ios_sim_id_proj' tool with name, description, input schema, validation, and delegation to core handler.

  export function registerIOSSimulatorBuildByIdProjectTool(server: McpServer): void {
    type Params = {
      projectPath: string;
      scheme: string;
      simulatorId: string;
      configuration?: string;
      derivedDataPath?: string;
      extraArgs?: string[];
      useLatestOS?: boolean;
      preferXcodebuild?: boolean;
    };
  
    registerTool<Params>(
      server,
      'build_ios_sim_id_proj',
      "Builds an iOS app from a project file for a specific simulator by UUID. IMPORTANT: Requires projectPath, scheme, and simulatorId. Example: build_ios_sim_id_proj({ projectPath: '/path/to/MyProject.xcodeproj', scheme: 'MyScheme', simulatorId: 'SIMULATOR_UUID' })",
      {
        projectPath: projectPathSchema,
        scheme: schemeSchema,
        simulatorId: simulatorIdSchema,
        configuration: configurationSchema,
        derivedDataPath: derivedDataPathSchema,
        extraArgs: extraArgsSchema,
        useLatestOS: useLatestOSSchema,
        preferXcodebuild: preferXcodebuildSchema,
      },
      async (params: Params) => {
        // Validate required parameters
        const projectValidation = validateRequiredParam('projectPath', params.projectPath);
        if (!projectValidation.isValid) return projectValidation.errorResponse!;
  
        const schemeValidation = validateRequiredParam('scheme', params.scheme);
        if (!schemeValidation.isValid) return schemeValidation.errorResponse!;
  
        const simulatorIdValidation = validateRequiredParam('simulatorId', params.simulatorId);
        if (!simulatorIdValidation.isValid) return simulatorIdValidation.errorResponse!;
  
        // Provide defaults
        return _handleIOSSimulatorBuildLogic({
          ...params,
          configuration: params.configuration ?? 'Debug',
          useLatestOS: params.useLatestOS ?? true, // May be ignored by xcodebuild
          preferXcodebuild: params.preferXcodebuild ?? false,
        });
      },
    );
  }

• src/tools/common.ts:22-62 (schema)

  Zod schemas for common parameters used in the tool's input schema, including projectPath, scheme, simulatorId, etc.

  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)');
  export const configurationSchema = z
    .string()
    .optional()
    .describe('Build configuration (Debug, Release, etc.)');
  export const derivedDataPathSchema = z
    .string()
    .optional()
    .describe('Path where build products and other derived data will go');
  export const extraArgsSchema = z
    .array(z.string())
    .optional()
    .describe('Additional xcodebuild arguments');
  export const simulatorNameSchema = z
    .string()
    .describe("Name of the simulator to use (e.g., 'iPhone 16') (Required)");
  export const simulatorIdSchema = z
    .string()
    .describe('UUID of the simulator to use (obtained from listSimulators) (Required)');
  export const useLatestOSSchema = z
    .boolean()
    .optional()
    .describe('Whether to use the latest OS version for the named simulator');
  export const appPathSchema = z
    .string()
    .describe('Path to the .app bundle (full path to the .app directory)');
  export const bundleIdSchema = z
    .string()
    .describe("Bundle identifier of the app (e.g., 'com.example.MyApp')");
  export const launchArgsSchema = z
    .array(z.string())
    .optional()
    .describe('Additional arguments to pass to the app');
  export const preferXcodebuildSchema = z
    .boolean()
    .optional()
    .describe(
      'If true, prefers xcodebuild over the experimental incremental build system, useful for when incremental build system fails.',
    );

• src/utils/register-tools.ts:231-235 (registration)

  Central registration entry that invokes registerIOSSimulatorBuildByIdProjectTool during server initialization if enabled.

  {
    register: registerIOSSimulatorBuildByIdProjectTool,
    groups: [ToolGroup.IOS_SIMULATOR_WORKFLOW],
    envVar: 'XCODEBUILDMCP_TOOL_IOS_SIMULATOR_BUILD_BY_ID_PROJECT',
  },