prepare_ios_simulator

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

Annotations only mark this as not read-only, so the description carries the burden. It adds valuable behavioral context: WDA is cached, launched on a free per-simulator port, and can be skipped via an environment variable pointing to an already-extracted app. It doesn't describe failure modes or cleanup, but the main side effects are visible.

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

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

Three sentences carry all necessary information, with the core action front-loaded and optional usage details following. It is appropriately concise, though the second and third sentences are dense and mix integration guidance with environment configuration.

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

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

With no output schema, the description still explains the full setup flow: boot, WDA download/cache/launch, reuse via capabilities, and the skip-download path via environment variable. It implies the returned WDA URL without explicitly stating it, leaving a minor gap for an agent that needs to rely solely on this text.

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

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

Schema description coverage is 100%, so the baseline is 3. The description references skipWda and the environment variable override, which supplements the schema slightly, but it does not add significant new meaning to the parameters beyond what the property descriptions already provide.

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

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

The description states a specific verb+resource: boot an iOS/tvOS simulator, download/cache WebDriverAgent, and launch it on a per-simulator port. This clearly distinguishes it from the sibling appium_prepare_ios_real_device by targeting simulators and explicitly mentions Apple TV support.

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

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

It provides concrete usage direction: pass capabilitiesHint (appium:webDriverAgentUrl) to appium_session_management to reuse WDA, and use skipWda=true when only booting is needed. It stops short of explicitly stating when not to use this tool or comparing it to the real-device sibling, so it isn't a perfect 5.

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