agent-device

Official

Overview Schema Source Related Servers Discussions Admin

hover

Move the pointer over a UI target by ref, selector, or coordinates without pressing to reveal hidden controls such as row toolbars or menus; web only.

Instructions

Move the pointer over a UI target by snapshot ref, selector, or coordinates without pressing, to reveal hover-gated UI such as row toolbars or menus. Web only; touch platforms have no hover state. Use settle to observe what the hover revealed without a follow-up snapshot. Times out after 90s; a caller-supplied budget extends it.

Input Schema

Name	Required	Description
`raw`	No	Use raw snapshot data during selector resolution.
`udid`	No	Apple device or simulator UDID; the selector that pins one device when several share a name.
`debug`	No	Enable debug diagnostics.
`depth`	No	Snapshot traversal depth.
`runId`	No	Lease run identifier.
`scope`	No	Snapshot scope selector used before resolution.
`device`	No	Device name selector (a UDID belongs in udid, a serial in serial).
`serial`	No	Android, HarmonyOS, or Vega VVD serial selector.
`settle`	No	After the action, wait for the UI to go quiet and return the settled diff vs the pre-action tree in the same response. Best-effort; never fails the action.
`target`	Yes	UI target. This is separate from deviceTarget, which selects the device form.
`tenant`	No	Remote tenant identifier.
`leaseId`	No	Existing lease identifier.
`session`	No	Agent-device session name.
`noRecord`	No	Do not record this action.
`platform`	No	Platform selector used to resolve a device.
`timeoutMs`	No	Settle: wait deadline in milliseconds (default 10000).
`includeCost`	No	Include per-command agent-cost (cost.wallClockMs, …) in structuredContent. Defaults to off; the default response shape is unchanged.
`deviceTarget`	No	Device target form. Maps to the CLI --target flag.
`responseLevel`	No	Response verbosity: token-cheap digest / default (today) / full. Defaults to default; the default response shape is unchanged.
`settleQuietMs`	No	Settle: quiet window in milliseconds (default 500; 300 when the settled tree comes from the iOS simulator snapshot bridge). On iOS, a broad screen replacement such as a modal dismissal is confirmed for at least 1500ms whatever window is asked for, within the timeoutMs settle deadline; a replacement from a screen the pre-action capture read as presenting nothing, such as a tab switch, gets no 1500ms confirmation and keeps the asked window.
`mcpOutputFormat`	No	MCP text content format. Defaults to optimized agent-friendly text; use json for JSON text. Structured content is always returned separately.
`androidDeviceAllowlist`	No	Android serial allowlist used for device resolution.

Output Schema

Name	Required	Description
`x`	No	Resolved interaction x coordinate when available.
`y`	No	Resolved interaction y coordinate when available.
`ref`	No	Snapshot ref without the @ prefix when the target was an @ref.
`cost`	No
`hint`	No
`settle`	No
`gesture`	No
`message`	No
`warning`	No
`evidence`	No
`refLabel`	No
`selector`	No	Selector expression when the target was a selector.
`resolution`	No	Pre-action disclosure of how the acting path resolved its target. Absent when resolutionDisclosure is inapplicable for the path.
`targetKind`	Yes	Resolved interaction target kind.
`selectorChain`	No
`referenceWidth`	No	Reference frame width for visualizing the interaction point.
`targetHittable`	No
`referenceHeight`	No	Reference frame height for visualizing the interaction point.
`maestroFallbackReason`	No
`maestroNonHittableCoordinateFallbackUsed`	No	Whether the direct iOS Maestro coordinate fallback was actually used.
`maestroNonHittableCoordinateFallbackAllowed`	No	Whether the direct iOS Maestro coordinate fallback was allowed for this selector.

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedv0.21.28Oct 15, 2026

changedInput schema / properties / settleQuietMs / description

Previous value: -"Settle: quiet window in milliseconds (default 500)."New value: +"Settle: quiet window in milliseconds (default 500; 300 when the settled tree comes from the iOS simulator snapshot bridge). On iOS, a broad screen replacement such as a modal dismissal is confirmed for at least 1500ms whatever window is asked for, within the timeoutMs settle deadline; a replacement from a screen the pre-action capture read as presenting nothing, such as a tab switch, gets no 1500ms confirmation and keeps the asked window."

Changed3 schema fields changedv0.21.2Sep 16, 2026

changedOutput schema / properties / evidence / properties / changedFromBefore / description

Previous value: -"Whether the post-action digest differs from the pre-action capture digest. false is evidence, not failure."New value: +"Whether the post-action digest differs from the pre-action capture digest. false is evidence, not failure. With surfaceChange present, no digest comparison is made: it reports that surface transition."

addedOutput schema / properties / evidence / properties / surfaceChange

Added value: +{
+  "description": "Present when an in-place system surface (web sign-in or Apple Pay sheet) was presented over the app, or left it.",
+  "properties": {
+    "disclosure": {
+      "description": "Agent-facing sentence explaining the surface transition.",
+      "type": "string"
+    },
+    "from": {
+      "description": "Surface the pre-action baseline described: a host bundle id, or app.",
+      "type": "string"
+    },
+    "to": {
+      "description": "Surface the post-action capture describes: a host bundle id, or app.",
+      "type": "string"
+    }
+  },
+  "required": [
+    "from",
+    "to",
+    "disclosure"
+  ],
+  "type": "object"
+}

addedOutput schema / properties / settle / properties / surfaceChange

Added value: +{
+  "description": "Present when an in-place system surface (web sign-in or Apple Pay sheet) was presented over the app, or left it.",
+  "properties": {
+    "disclosure": {
+      "description": "Agent-facing sentence explaining the surface transition.",
+      "type": "string"
+    },
+    "from": {
+      "description": "Surface the pre-action baseline described: a host bundle id, or app.",
+      "type": "string"
+    },
+    "to": {
+      "description": "Surface the post-action capture describes: a host bundle id, or app.",
+      "type": "string"
+    }
+  },
+  "required": [
+    "from",
+    "to",
+    "disclosure"
+  ],
+  "type": "object"
+}

Changed3 schema fields changedv0.21.0Sep 9, 2026

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."

Changed8 schema fields changedv0.20.10Aug 26, 2026

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"
-}

Addedv0.20.9Aug 19, 2026

TDQS

A4.4/5.0

Behavior4/5

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

With no annotations, the description carries the burden and discloses key traits: it does not press (pure read-side hover), it is web-only, it has a 90s timeout, and a caller-supplied budget can extend it. It omits whether the action is recorded or what happens on non-hover-gated targets, but the timeout and platform constraints are substantive.

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?

Four compact sentences, each carrying distinct information (action, target modes, platform constraint, settle tip, timeout). The core action and target modes are front-loaded before qualifications.

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

Completeness4/5

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

Output schema exists, so return-value explanation is unnecessary. Given 22 parameters, the description sensibly does not attempt to cover them all and focuses on the ones that matter (target, settle, timeout). Minor gap: no mention of device/session selection context or recording behavior, but nothing an agent needs to call it correctly is missing.

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

Parameters4/5

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

Schema coverage is 100%, so baseline is 3, but the description adds meaning the schema does not: it frames the three target kinds as interchangeable recognition modes and explains that settle lets you capture what hover revealed without a follow-up snapshot, which clarifies that parameter's purpose. Timeout/budget semantics are also explained.

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?

States a precise verb ('Move the pointer over') and resource, enumerates the three targeting modes (snapshot ref, selector, coordinates), and gives the intent ('reveal hover-gated UI such as row toolbars or menus'). It is clearly distinguishable from siblings like click, press, and longpress.

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?

Explicitly scopes the tool to 'Web only' and explains why: 'touch platforms have no hover state', which is a genuine when-not-to-use rule. It also advises using settle to observe the revealed UI. It stops short of naming alternative tools for non-hover scenarios, so it is strong but not fully routed.

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

Deploy Server