Skip to main content
Glama

list_schems_ws

Lists available schemes within an Xcode workspace by providing the workspace path, enabling developers to identify and manage project configurations.

Instructions

Lists available schemes in the workspace. IMPORTANT: Requires workspacePath. Example: list_schems_ws({ workspacePath: '/path/to/MyProject.xcworkspace' })

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
workspacePathYesPath to the .xcworkspace file (Required)

Implementation Reference

  • The core handler function that executes the tool logic: runs `xcodebuild -list -workspace`, parses the schemes section from output, lists them, and provides suggested next tool calls.
    async function _handleListSchemesLogic(params: {
      workspacePath?: string;
      projectPath?: string;
    }): Promise<ToolResponse> {
      log('info', 'Listing schemes');
    
      try {
        // For listing schemes, we can't use executeXcodeBuild directly since it's not a standard action
        // We need to create a custom command with -list flag
        const command = ['xcodebuild', '-list'];
    
        if (params.workspacePath) {
          command.push('-workspace', params.workspacePath);
        } else if (params.projectPath) {
          command.push('-project', params.projectPath);
        } // No else needed, one path is guaranteed by callers
    
        const result = await executeCommand(command, 'List Schemes');
    
        if (!result.success) {
          return createTextResponse(`Failed to list schemes: ${result.error}`, true);
        }
    
        // Extract schemes from the output
        const schemesMatch = result.output.match(/Schemes:([\s\S]*?)(?=\n\n|$)/);
    
        if (!schemesMatch) {
          return createTextResponse('No schemes found in the output', true);
        }
    
        const schemeLines = schemesMatch[1].trim().split('\n');
        const schemes = schemeLines.map((line) => line.trim()).filter((line) => line);
    
        // Prepare next steps with the first scheme if available
        let nextStepsText = '';
        if (schemes.length > 0) {
          const firstScheme = schemes[0];
          const projectOrWorkspace = params.workspacePath ? 'workspace' : 'project';
          const path = params.workspacePath || params.projectPath;
    
          nextStepsText = `Next Steps:
    1. Build the app: ${projectOrWorkspace === 'workspace' ? 'macos_build_workspace' : 'macos_build_project'}({ ${projectOrWorkspace}Path: "${path}", scheme: "${firstScheme}" })
       or for iOS: ${projectOrWorkspace === 'workspace' ? 'ios_simulator_build_by_name_workspace' : 'ios_simulator_build_by_name_project'}({ ${projectOrWorkspace}Path: "${path}", scheme: "${firstScheme}", simulatorName: "iPhone 16" })
    2. Show build settings: ${projectOrWorkspace === 'workspace' ? 'show_build_set_ws' : 'show_build_set_proj'}({ ${projectOrWorkspace}Path: "${path}", scheme: "${firstScheme}" })`;
        }
    
        return {
          content: [
            {
              type: 'text',
              text: `✅ Available schemes:`,
            },
            {
              type: 'text',
              text: schemes.join('\n'),
            },
            {
              type: 'text',
              text: nextStepsText,
            },
          ],
        };
      } catch (error) {
        const errorMessage = error instanceof Error ? error.message : String(error);
        log('error', `Error listing schemes: ${errorMessage}`);
        return createTextResponse(`Error listing schemes: ${errorMessage}`, true);
      }
    }
  • Registers the 'list_schems_ws' tool with the MCP server using registerTool, including name, description, input schema, and thin handler that validates and delegates to core logic.
    export function registerListSchemesWorkspaceTool(server: McpServer): void {
      registerTool<BaseWorkspaceParams>(
        server,
        'list_schems_ws',
        "Lists available schemes in the workspace. IMPORTANT: Requires workspacePath. Example: list_schems_ws({ workspacePath: '/path/to/MyProject.xcworkspace' })",
        {
          workspacePath: workspacePathSchema,
        },
        async (params: BaseWorkspaceParams) => {
          // Validate required parameters
          const workspaceValidation = validateRequiredParam('workspacePath', params.workspacePath);
          if (!workspaceValidation.isValid) return workspaceValidation.errorResponse!;
    
          return _handleListSchemesLogic(params);
        },
      );
    }
  • Zod schema definition for the required 'workspacePath' input parameter used by the tool.
    export const workspacePathSchema = z.string().describe('Path to the .xcworkspace file (Required)');
  • Top-level registration entry that conditionally registers the tool via registerListSchemesWorkspaceTool based on environment variable.
    register: registerListSchemesWorkspaceTool,
    groups: [ToolGroup.PROJECT_DISCOVERY],
    envVar: 'XCODEBUILDMCP_TOOL_LIST_SCHEMES_WORKSPACE',
  • Shared utility function used to register all tools with the MCP server, wrapping the custom handler to match MCP SDK signature.
    export function registerTool<T extends object>(
      server: McpServer,
      name: string,
      description: string,
      schema: Record<string, z.ZodType>,
      handler: (params: T) => Promise<ToolResponse>,
    ): void {
      // Create a wrapper handler that matches the signature expected by server.tool
      const wrappedHandler = (
        args: Record<string, unknown>,
        _extra: unknown,
      ): Promise<ToolResponse> => {
        // Assert the type *before* calling the original handler
        // This confines the type assertion to one place
        const typedParams = args as T;
        return handler(typedParams);
      };
    
      server.tool(name, description, schema, wrappedHandler);
    }
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 of behavioral disclosure. It mentions that the tool 'Lists available schemes' and requires workspacePath, but doesn't describe other behaviors such as output format, potential errors, or whether it's read-only or has side effects. For a tool with no annotations, this leaves significant gaps in understanding its behavior.

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 concise and front-loaded, starting with the core purpose in the first sentence. The second sentence adds necessary context and an example without redundancy. However, the example could be slightly more informative (e.g., clarifying path format), and there's minor room for improvement in efficiency.

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

Completeness3/5

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

Given the tool's low complexity (1 parameter, no output schema, no annotations), the description is somewhat complete but lacks depth. It covers the basic purpose and parameter requirement, but without annotations or output schema, it should ideally explain more about the return values or behavioral traits to fully guide an AI agent, leaving it as minimally adequate.

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?

The schema description coverage is 100%, with the parameter 'workspacePath' fully documented in the schema as 'Path to the .xcworkspace file (Required)'. The description adds minimal value beyond this by emphasizing 'IMPORTANT: Requires workspacePath' and providing an example, but doesn't offer additional semantics like format details or constraints. Baseline 3 is appropriate given high schema coverage.

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

Purpose4/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: 'Lists available schemes in the workspace.' It specifies the verb ('Lists') and resource ('schemes in the workspace'), making the action clear. However, it doesn't explicitly distinguish this tool from its sibling 'list_schems_proj', which likely lists schemes in a project rather than workspace, so it misses full sibling differentiation.

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

Usage Guidelines3/5

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

The description implies usage context by specifying that it requires a workspacePath and provides an example, which suggests when to use this tool (for workspaces). However, it doesn't explicitly state when not to use it or mention alternatives like 'list_schems_proj' for projects, leaving some ambiguity in sibling tool selection.

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