Skip to main content
Glama

test

Run iOS Xcode workspace or project tests to identify and report errors, enabling developers to validate code functionality within their development environment.

Instructions

Run test for the iOS Xcode workspace/project in the folder

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
folderYesThe full path of the current folder that the iOS Xcode workspace/project sits

Implementation Reference

  • Handler logic specific to the 'test' tool: appends 'test' action to the xcodebuild command.
    if name == "test":
        command.append("test")
  • Registers the 'test' tool in the list_tools function, specifying name, description, and shared input schema.
    Tool(
        name="test",
        description="Run test for the iOS Xcode workspace/project in the folder",
        inputSchema=Folder.model_json_schema(),
    )
  • Pydantic model defining the input parameters (folder path) used by the 'test' tool schema.
    class Folder(BaseModel):
        """Parameters"""
        folder: Annotated[str, Field(description="The full path of the current folder that the iOS Xcode workspace/project sits")]
  • Main handler function for tool execution, dispatches based on tool name ('test' or 'build'), sets up xcodebuild command, runs it, and returns output.
    @server.call_tool()
    async def call_tool(name, arguments: dict) -> list[TextContent]:
        try:
            args = Folder(**arguments)
        except ValueError as e:
            raise McpError(ErrorData(code=INVALID_PARAMS, message=str(e)))
        os.chdir(args.folder)
        xcode_project_path = find_xcode_project()
        project_name = os.path.basename(xcode_project_path)
        project_type = ""
        if xcode_project_path.endswith(".xcworkspace"):
            project_type = "-workspace"
        else:
            project_type = "-project"
    
        scheme = find_scheme(project_type, project_name)
        destination = find_available_simulator()
        command = ["xcodebuild",
                   project_type,
                   project_name,
                   "-scheme",
                   scheme,
                   "-destination",
                   destination]
        if name == "test":
            command.append("test")
    
        result = subprocess.run(command, stdout=subprocess.PIPE, stderr=subprocess.PIPE, check=False).stdout
        
        lines = result.decode("utf-8").splitlines()
        error_lines = [line for line in lines if "error:" or "warning:" in line.lower()]
        error_message = "\n".join(error_lines)
        if not error_message:
            error_message = "Successful"
        return [
            TextContent(type="text", text=f"Command: {' '.join(command)}"),
            TextContent(type="text", text=f"{error_message}")
            ]
Behavior2/5

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

With no annotations provided, the description carries full burden for behavioral disclosure. It states the action is to 'Run test' but doesn't explain what this entails—whether it's a read-only operation, what kind of tests are run, if it modifies files, requires specific permissions, or has side effects like generating reports. This leaves significant gaps in understanding the tool's behavior.

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

Conciseness5/5

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

The description is a single, efficient sentence that directly states the tool's purpose without unnecessary words. It's appropriately sized and front-loaded, making it easy to grasp quickly with zero waste.

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 the complexity of running tests in an iOS Xcode environment, the description is incomplete. With no annotations and no output schema, it fails to cover key aspects like what the tool returns (e.g., test results, logs, or errors), behavioral traits, or usage context relative to the sibling 'build' tool. This leaves the agent with insufficient information for effective tool selection and invocation.

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 description adds minimal parameter semantics beyond the input schema, which has 100% coverage. It implies the 'folder' parameter is where the iOS Xcode workspace/project is located, but doesn't provide additional context like format examples or constraints. Since schema coverage is high, the baseline score of 3 is appropriate as the description doesn't significantly enhance parameter understanding.

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 action ('Run test') and target resource ('iOS Xcode workspace/project'), making the purpose understandable. However, it doesn't differentiate from the sibling 'build' tool, which likely performs a related but different operation in the same context.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus the 'build' sibling tool or other alternatives. It mentions the context ('in the folder') but gives no explicit when/when-not instructions or prerequisites for usage.

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/ShenghaiWang/xcodebuild'

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