Skip to main content
Glama

Capture or diff the accessibility tree

snapshot

Capture the accessibility tree or diff it against the session baseline to detect UI changes. Returns element refs for semantic interactions, with an option to list only actionable elements.

Instructions

Capture the accessibility tree or compare it with the previous session baseline. The result includes refs for semantic interactions; the diff option reports UI changes. interactiveOnly lists only elements you can act on. After an action with settle, take a snapshot only when its diff lacks the next target or did not settle. Times out after 90s; a caller-supplied budget extends it.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "snapshot"
  }
}

Input Schema

NameRequiredDescriptionDefault
rawNo
udidNoApple device or simulator UDID.
depthNo
scopeNo
deviceNoDevice name; ids go in udid or serial.
recordNoForce-record this out-of-band observation into a repair-armed heal (mutually exclusive with noRecord). Authored replay steps are recorded automatically and never need this.
serialNoAndroid, HarmonyOS, or Vega VVD serial.
sessionNoSession name.
noRecordNoDo not record this action.
platformNoDevice platform.
forceFullNo
timeoutMsNoMaximum wall-clock time for the snapshot command.
observeOnlyNoiOS only. Refuse instead of activating or repairing the session app. Reports XCUIApplication state, which does not prove screen ownership (#2696).
deviceTargetNoDevice form factor.
customActionsNoList the custom actions an element merged away, such as a card's reply control. Not invocable: reach the control via its detail screen, a labeled element elsewhere, or its rect. iOS simulator only; costs one accessibility round trip per merged element.
interactiveOnlyNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changedv0.21.38
    • changedInput schema / properties / customActions / description
      Previous value: -"Name the affordances an element merged away (iOS UIAccessibilityCustomAction, React Native accessibilityActions) — a card whose reply/options controls are not separate elements still lists them here. The names are for PLANNING, not invocation: there is no API to trigger them, so reach the affordance through the element detail screen, through the same control exposed as a labeled element elsewhere, or by coordinates from its rect. iOS simulator only; costs one accessibility round trip per merged element."New value: +"List the custom actions an element merged away, such as a card's reply control. Not invocable: reach the control via its detail screen, a labeled element elsewhere, or its rect. iOS simulator only; costs one accessibility round trip per merged element."
    • removedInput schema / properties / debug
      Removed value: -{
      -  "description": "Enable debug diagnostics.",
      -  "type": "boolean"
      -}
    • removedInput schema / properties / includeCost
      Removed value: -{
      -  "description": "Add agent cost (cost.wallClockMs, …) to the result, returned as JSON text.",
      -  "type": "boolean"
      -}
    • removedInput schema / properties / mcpOutputFormat
      Removed value: -{
      -  "description": "Result text: compact optimized (default) or the full result as JSON (larger).",
      -  "enum": [
      -    "optimized",
      -    "json"
      -  ],
      -  "type": "string"
      -}
    • removedInput schema / properties / responseLevel
      Removed value: -{
      -  "description": "Result detail: digest (smallest) or full (largest), as JSON; default is compact text.",
      -  "enum": [
      -    "digest",
      -    "default",
      -    "full"
      -  ],
      -  "type": "string"
      -}
    • removedInput schema / properties / target
      Removed value: -{
      -  "description": "Alias for deviceTarget.",
      -  "enum": [
      -    "mobile",
      -    "tv",
      -    "desktop"
      -  ],
      -  "type": "string"
      -}
  2. Changed14 schema fields changedv0.21.37
    • removedInput schema / properties / androidDeviceAllowlist
      Removed value: -{
      -  "description": "Android serial allowlist used for device resolution.",
      -  "type": "string"
      -}
    • changedInput schema / properties / device / description
      Previous value: -"Device name selector (a UDID belongs in udid, a serial in serial)."New value: +"Device name; ids go in udid or serial."
    • changedInput schema / properties / deviceTarget / description
      Previous value: -"Device target form. Maps to the CLI --target flag."New value: +"Device form factor."
    • changedInput schema / properties / includeCost / description
      Previous value: -"Include per-command agent-cost (cost.wallClockMs, …) in structuredContent. Defaults to off; the default response shape is unchanged."New value: +"Add agent cost (cost.wallClockMs, …) to the result, returned as JSON text."
    • removedInput schema / properties / leaseId
      Removed value: -{
      -  "description": "Existing lease identifier.",
      -  "type": "string"
      -}
    • changedInput schema / properties / mcpOutputFormat / description
      Previous value: -"MCP text content format. Defaults to optimized agent-friendly text; use json for JSON text. Structured content is always returned separately."New value: +"Result text: compact optimized (default) or the full result as JSON (larger)."
    • changedInput schema / properties / platform / description
      Previous value: -"Platform selector used to resolve a device."New value: +"Device platform."
    • changedInput schema / properties / responseLevel / description
      Previous value: -"Response verbosity: token-cheap digest / default (today) / full. Defaults to default; the default response shape is unchanged."New value: +"Result detail: digest (smallest) or full (largest), as JSON; default is compact text."
    • removedInput schema / properties / runId
      Removed value: -{
      -  "description": "Lease run identifier.",
      -  "type": "string"
      -}
    • changedInput schema / properties / serial / description
      Previous value: -"Android, HarmonyOS, or Vega VVD serial selector."New value: +"Android, HarmonyOS, or Vega VVD serial."
    • changedInput schema / properties / session / description
      Previous value: -"Agent-device session name."New value: +"Session name."
    • changedInput schema / properties / target / description
      Previous value: -"Alias for deviceTarget on commands without a UI target field. Interaction commands reserve target for the UI element."New value: +"Alias for deviceTarget."
    • removedInput schema / properties / tenant
      Removed value: -{
      -  "description": "Remote tenant identifier.",
      -  "type": "string"
      -}
    • changedInput schema / properties / udid / description
      Previous value: -"Apple device or simulator UDID; the selector that pins one device when several share a name."New value: +"Apple device or simulator UDID."
  3. Changed1 schema field changedv0.21.27
    • addedInput schema / properties / observeOnly
      Added value: +{
      +  "description": "iOS only. Refuse instead of activating or repairing the session app. Reports XCUIApplication state, which does not prove screen ownership (#2696).",
      +  "type": "boolean"
      +}
  4. Changed3 schema fields changedv0.21.0
    • changedInput schema / properties / device / description
      Previous value: -"Device name selector."New value: +"Device name selector (a UDID belongs in udid, a serial in serial)."
    • changedInput schema / properties / serial / description
      Previous value: -"Android device or Vega VVD serial selector."New value: +"Android, HarmonyOS, or Vega VVD serial selector."
    • changedInput schema / properties / udid / description
      Previous value: -"iOS device UDID selector."New value: +"Apple device or simulator UDID; the selector that pins one device when several share a name."
  5. Changed8 schema fields changedv0.20.10
    • removedInput schema / properties / cwd
      Removed value: -{
      -  "description": "Working directory for command execution.",
      -  "type": "string"
      -}
    • removedInput schema / properties / daemonAuthToken
      Removed value: -{
      -  "description": "Remote daemon auth token.",
      -  "type": "string"
      -}
    • removedInput schema / properties / daemonBaseUrl
      Removed value: -{
      -  "description": "Remote daemon base URL.",
      -  "type": "string"
      -}
    • removedInput schema / properties / iosSimulatorDeviceSet
      Removed value: -{
      -  "description": "iOS simulator device-set path used for device resolution.",
      -  "type": "string"
      -}
    • removedInput schema / properties / iosXctestDerivedDataPath
      Removed value: -{
      -  "description": "Derived data path for external iOS XCTest runner execution.",
      -  "type": "string"
      -}
    • removedInput schema / properties / iosXctestEnvDir
      Removed value: -{
      -  "description": "Writable directory for iOS XCTest runner env overlays.",
      -  "type": "string"
      -}
    • removedInput schema / properties / iosXctestrunFile
      Removed value: -{
      -  "description": "Externally built iOS XCTest runner .xctestrun artifact path.",
      -  "type": "string"
      -}
    • removedInput schema / properties / stateDir
      Removed value: -{
      -  "description": "Agent-device state directory.",
      -  "type": "string"
      -}
  6. Changed1 schema field changedv0.20.9
    • changedInput schema / properties / platform / enum
      Previous value: -[
      -  "apple",
      -  "android",
      -  "vega",
      -  "linux",
      -  "web",
      -  "ios",
      -  "macos"
      -]New value: +[
      +  "apple",
      +  "android",
      +  "harmonyos",
      +  "vega",
      +  "linux",
      +  "web",
      +  "ios",
      +  "macos"
      +]
  7. Changed1 schema field changedv0.20.6
    • addedInput schema / properties / customActions
      Added value: +{
      +  "description": "Name the affordances an element merged away (iOS UIAccessibilityCustomAction, React Native accessibilityActions) — a card whose reply/options controls are not separate elements still lists them here. The names are for PLANNING, not invocation: there is no API to trigger them, so reach the affordance through the element detail screen, through the same control exposed as a labeled element elsewhere, or by coordinates from its rect. iOS simulator only; costs one accessibility round trip per merged element.",
      +  "type": "boolean"
      +}
  8. Changed4 schema fields changedv0.20.2
    • addedInput schema / properties / noRecord
      Added value: +{
      +  "description": "Do not record this action.",
      +  "type": "boolean"
      +}
    • changedInput schema / properties / platform / enum
      Previous value: -[
      -  "apple",
      -  "android",
      -  "linux",
      -  "web",
      -  "ios",
      -  "macos"
      -]New value: +[
      +  "apple",
      +  "android",
      +  "vega",
      +  "linux",
      +  "web",
      +  "ios",
      +  "macos"
      +]
    • addedInput schema / properties / record
      Added value: +{
      +  "description": "Force-record this out-of-band observation into a repair-armed heal (mutually exclusive with noRecord). Authored replay steps are recorded automatically and never need this.",
      +  "type": "boolean"
      +}
    • changedInput schema / properties / serial / description
      Previous value: -"Android serial selector."New value: +"Android device or Vega VVD serial selector."
  9. Changed3 schema fields changedv0.17.11
    • addedInput schema / properties / includeCost
      Added value: +{
      +  "description": "Include per-command agent-cost (cost.wallClockMs, …) in structuredContent. Defaults to off; the default response shape is unchanged.",
      +  "type": "boolean"
      +}
    • changedInput schema / properties / platform / enum
      Previous value: -[
      -  "ios",
      -  "macos",
      -  "android",
      -  "linux",
      -  "web",
      -  "apple"
      -]New value: +[
      +  "apple",
      +  "android",
      +  "linux",
      +  "web",
      +  "ios",
      +  "macos"
      +]
    • addedInput schema / properties / responseLevel
      Added value: +{
      +  "description": "Response verbosity: token-cheap digest / default (today) / full. Defaults to default; the default response shape is unchanged.",
      +  "enum": [
      +    "digest",
      +    "default",
      +    "full"
      +  ],
      +  "type": "string"
      +}
  10. Changed1 schema field changedv0.17.7
    • changedInput schema / properties / platform / enum
      Previous value: -[
      -  "ios",
      -  "macos",
      -  "android",
      -  "linux",
      -  "apple"
      -]New value: +[
      +  "ios",
      +  "macos",
      +  "android",
      +  "linux",
      +  "web",
      +  "apple"
      +]
  11. Changed6 schema fields changedv0.17.6
    • removedInput schema / properties / compact
      Removed value: -{
      -  "type": "boolean"
      -}
    • addedInput schema / properties / iosXctestDerivedDataPath
      Added value: +{
      +  "description": "Derived data path for external iOS XCTest runner execution.",
      +  "type": "string"
      +}
    • addedInput schema / properties / iosXctestEnvDir
      Added value: +{
      +  "description": "Writable directory for iOS XCTest runner env overlays.",
      +  "type": "string"
      +}
    • addedInput schema / properties / iosXctestrunFile
      Added value: +{
      +  "description": "Externally built iOS XCTest runner .xctestrun artifact path.",
      +  "type": "string"
      +}
    • addedInput schema / properties / mcpOutputFormat
      Added value: +{
      +  "description": "MCP text content format. Defaults to optimized agent-friendly text; use json for JSON text. Structured content is always returned separately.",
      +  "enum": [
      +    "optimized",
      +    "json"
      +  ],
      +  "type": "string"
      +}
    • changedInput schema / properties / platform / enum
      Previous value: -[
      -  "ios",
      -  "android",
      -  "macos",
      -  "linux",
      -  "apple"
      -]New value: +[
      +  "ios",
      +  "macos",
      +  "android",
      +  "linux",
      +  "apple"
      +]
  12. First observedv0.16.9

TDQS

A3.6/5.0
Behavior3/5

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

Adds real behavioral facts beyond the annotations: a 90s hard timeout, a caller-supplied budget that extends it, and the shape of the result (refs plus reported UI changes). However, annotations declare readOnlyHint=false, and the description never explains why a 'capture/compare' operation is not read-only — the schema's observeOnly note about 'activating or repairing the session app' and record's heal-recording side effect are the likely causes, and neither is surfaced. An agent could call this believing it is a pure observation.

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?

Six short sentences, front-loaded with the capture-vs-compare statement, and every sentence carries a distinct fact (result shape, diff mode, interactiveOnly, re-snapshot rule, timeout). The fragment style ('interactiveOnly lists only elements you can act on.') is slightly clipped but readable. No filler.

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?

For a 16-parameter, zero-required tool with no output schema and minimal annotations, the description covers the important workflow rule and the return shape well. It leaves gaps that matter at this complexity: the unexplained non-read-only behavior, the unlocalized 'diff option', and most parameters undocumented in a description that only names two of them.

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 coverage is 69%, so the baseline is 3. The description does add meaning for the undocumented interactiveOnly flag ('lists only elements you can act on') and ties timeoutMs to the 90s default with budget extension. But raw, depth, scope, forceFull and others get nothing, and 'the diff option' refers to no parameter in the schema, which is actively confusing for a 16-parameter tool.

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?

Names a specific verb and resource: 'Capture the accessibility tree or compare it with the previous session baseline,' and adds that results carry refs for semantic interactions. That is concrete and actionable. It falls short of 5 because a sibling named 'diff' exists and the description never explains whether the tool's 'diff option' is that sibling or a mode of this tool, so the boundary between the two remains ambiguous.

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?

Gives genuinely conditional usage advice: 'take a snapshot only when its diff lacks the next target or did not settle,' which tells the agent when to re-snapshot after a settle action rather than spamming calls. It also scopes interactiveOnly to actionable elements. It does not cover when to prefer the separate 'diff' sibling over this tool's comparison mode, so the alternative-selection guidance is incomplete.

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