Skip to main content
Glama

get_ios_dev_app_path_ws

Retrieve the app bundle path for iOS physical device applications by specifying workspace path and scheme. This tool helps developers locate compiled app files for testing and deployment.

Instructions

Gets the app bundle path for an iOS physical device application using a workspace. IMPORTANT: Requires workspacePath and scheme. Example: get_ios_dev_app_path_ws({ workspacePath: '/path/to/workspace', scheme: 'MyScheme' })

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
workspacePathYesPath to the .xcworkspace file (Required)
schemeYesThe scheme to use (Required)
configurationNoBuild configuration (Debug, Release, etc.)

Implementation Reference

  • Core handler logic shared across app path tools. Executes xcodebuild -showBuildSettings for iOS device (generic/platform=iOS), extracts and returns the built app bundle path.
    async function _handleGetAppPathLogic(params: {
      workspacePath?: string;
      projectPath?: string;
      scheme: string;
      configuration: string;
      platform: XcodePlatform;
      simulatorName?: string;
      simulatorId?: string;
      useLatestOS: boolean;
      arch?: string;
    }): Promise<ToolResponse> {
      log('info', `Getting app path for scheme ${params.scheme} on platform ${params.platform}`);
    
      try {
        // Create the command array for xcodebuild with -showBuildSettings option
        const command = ['xcodebuild', '-showBuildSettings'];
    
        // 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 and configuration
        command.push('-scheme', params.scheme);
        command.push('-configuration', params.configuration);
    
        // Handle destination based on platform
        const isSimulatorPlatform = [
          XcodePlatform.iOSSimulator,
          XcodePlatform.watchOSSimulator,
          XcodePlatform.tvOSSimulator,
          XcodePlatform.visionOSSimulator,
        ].includes(params.platform);
    
        let destinationString = '';
    
        if (isSimulatorPlatform) {
          if (params.simulatorId) {
            destinationString = `platform=${params.platform},id=${params.simulatorId}`;
          } else if (params.simulatorName) {
            destinationString = `platform=${params.platform},name=${params.simulatorName}${params.useLatestOS ? ',OS=latest' : ''}`;
          } else {
            return createTextResponse(
              `For ${params.platform} platform, either simulatorId or simulatorName must be provided`,
              true,
            );
          }
        } else if (params.platform === XcodePlatform.macOS) {
          destinationString = constructDestinationString(
            params.platform,
            undefined,
            undefined,
            false,
            params.arch,
          );
        } else if (params.platform === XcodePlatform.iOS) {
          destinationString = 'generic/platform=iOS';
        } else if (params.platform === XcodePlatform.watchOS) {
          destinationString = 'generic/platform=watchOS';
        } else if (params.platform === XcodePlatform.tvOS) {
          destinationString = 'generic/platform=tvOS';
        } else if (params.platform === XcodePlatform.visionOS) {
          destinationString = 'generic/platform=visionOS';
        } else {
          return createTextResponse(`Unsupported platform: ${params.platform}`, true);
        }
    
        command.push('-destination', destinationString);
    
        // Execute the command directly
        const result = await executeCommand(command, 'Get App Path');
    
        if (!result.success) {
          return createTextResponse(`Failed to get app path: ${result.error}`, true);
        }
    
        if (!result.output) {
          return createTextResponse('Failed to extract build settings output from the result.', true);
        }
    
        const buildSettingsOutput = result.output;
        const builtProductsDirMatch = buildSettingsOutput.match(/BUILT_PRODUCTS_DIR = (.+)$/m);
        const fullProductNameMatch = buildSettingsOutput.match(/FULL_PRODUCT_NAME = (.+)$/m);
    
        if (!builtProductsDirMatch || !fullProductNameMatch) {
          return createTextResponse(
            'Failed to extract app path from build settings. Make sure the app has been built first.',
            true,
          );
        }
    
        const builtProductsDir = builtProductsDirMatch[1].trim();
        const fullProductName = fullProductNameMatch[1].trim();
        const appPath = `${builtProductsDir}/${fullProductName}`;
    
        let nextStepsText = '';
        if (params.platform === XcodePlatform.macOS) {
          nextStepsText = `Next Steps:
    1. Get bundle ID: get_macos_bundle_id({ appPath: "${appPath}" })
    2. Launch the app: launch_macos_app({ appPath: "${appPath}" })`;
        } else if (params.platform === XcodePlatform.iOSSimulator) {
          nextStepsText = `Next Steps:
    1. Get bundle ID: get_ios_bundle_id({ appPath: "${appPath}" })
    2. Boot simulator: boot_simulator({ simulatorUuid: "SIMULATOR_UUID" })
    3. Install app: install_app_in_simulator({ simulatorUuid: "SIMULATOR_UUID", appPath: "${appPath}" })
    4. Launch app: launch_app_in_simulator({ simulatorUuid: "SIMULATOR_UUID", bundleId: "BUNDLE_ID" })`;
        } else if (params.platform === XcodePlatform.iOS) {
          nextStepsText = `Next Steps:
    1. Get bundle ID: get_ios_bundle_id({ appPath: "${appPath}" })
    2. Use Xcode to install the app on your connected iOS device`;
        }
    
        return {
          content: [
            {
              type: 'text',
              text: `✅ App path retrieved successfully: ${appPath}`,
            },
            {
              type: 'text',
              text: nextStepsText,
            },
          ],
        };
      } catch (error) {
        const errorMessage = error instanceof Error ? error.message : String(error);
        log('error', `Error retrieving app path: ${errorMessage}`);
        return createTextResponse(`Error retrieving app path: ${errorMessage}`, true);
      }
    }
  • Specific tool handler for get_ios_dev_app_path_ws: validates workspacePath and scheme, calls shared _handleGetAppPathLogic with iOS device platform.
    async (params: Params) => {
      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 _handleGetAppPathLogic({
        ...params,
        configuration: params.configuration ?? 'Debug',
        platform: XcodePlatform.iOS,
        useLatestOS: true,
      });
    },
  • Registers the get_ios_dev_app_path_ws MCP tool with server, defining name, description, input schema, and handler.
    export function registerGetiOSDeviceAppPathWorkspaceTool(server: McpServer): void {
      type Params = BaseWorkspaceParams & { configuration?: string };
      registerTool<Params>(
        server,
        'get_ios_dev_app_path_ws',
        "Gets the app bundle path for an iOS physical device application using a workspace. IMPORTANT: Requires workspacePath and scheme. Example: get_ios_dev_app_path_ws({ workspacePath: '/path/to/workspace', scheme: 'MyScheme' })",
        {
          workspacePath: workspacePathSchema,
          scheme: schemeSchema,
          configuration: configurationSchema,
        },
        async (params: Params) => {
          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 _handleGetAppPathLogic({
            ...params,
            configuration: params.configuration ?? 'Debug',
            platform: XcodePlatform.iOS,
            useLatestOS: true,
          });
        },
      );
    }
  • Input parameter schema for the tool: workspacePath (string, required), scheme (string, required), configuration (string, optional). Schemas imported from ./common.ts
    {
      workspacePath: workspacePathSchema,
      scheme: schemeSchema,
      configuration: configurationSchema,
    },
  • Top-level tool registration configuration: enables the iOS device app path workspace tool via environment variable and tool groups.
      register: registerGetiOSDeviceAppPathWorkspaceTool,
      groups: [ToolGroup.IOS_DEVICE_WORKFLOW, ToolGroup.APP_DEPLOYMENT, ToolGroup.PROJECT_DISCOVERY],
      envVar: 'XCODEBUILDMCP_TOOL_GET_IOS_DEVICE_APP_PATH_WORKSPACE',
    },
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden. It mentions 'IMPORTANT: Requires workspacePath and scheme' and gives an example, but lacks details on behavioral traits like error handling, output format, dependencies, or side effects. For a tool with no annotations, this is insufficient.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is appropriately sized with two sentences: one stating the purpose and one providing important usage notes with an example. It is front-loaded with the core functionality, though the example could be slightly more concise.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given no annotations and no output schema, the description is incomplete. It lacks information on what the tool returns (e.g., the path format), error conditions, or any behavioral context needed for effective use. For a tool in this context, more detail is required.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema fully documents all parameters. The description adds minimal value by emphasizing the required parameters in the example, but does not provide additional meaning beyond what the schema already states. Baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose with a specific verb ('Gets') and resource ('app bundle path for an iOS physical device application'), and distinguishes it from siblings by specifying 'using a workspace' (vs. 'proj' in sibling get_ios_dev_app_path_proj). It precisely identifies what the tool does.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides clear context for when to use this tool (for iOS physical device apps with a workspace) and implicitly distinguishes it from project-based alternatives (e.g., get_ios_dev_app_path_proj). However, it does not explicitly state when not to use it or name alternatives, keeping it at a 4.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/SampsonKY/XcodeBuildMCP'

If you have feedback or need assistance with the MCP directory API, please join our Discord server