agent-device

Official

Overview Schema Source Related Servers Discussions Admin

replay

Run a recorded automation script, including compatible Maestro YAML flows. A script without a terminal close leaves its session active for subsequent automation. Times out after 90s; a caller-supplied budget extends it.

Instructions

Input Schema

Name	Required	Description
`env`	No
`path`	Yes
`udid`	No	Apple device or simulator UDID; the selector that pins one device when several share a name.
`debug`	No	Enable debug diagnostics.
`force`	No
`runId`	No	Lease run identifier.
`device`	No	Device name selector (a UDID belongs in udid, a serial in serial).
`serial`	No	Android, HarmonyOS, or Vega VVD serial selector.
`target`	No	Alias for deviceTarget on commands without a UI target field. Interaction commands reserve target for the UI element.
`tenant`	No	Remote tenant identifier.
`update`	No
`backend`	No
`leaseId`	No	Existing lease identifier.
`maestro`	No
`session`	No	Agent-device session name.
`testIme`	No	Activate the headless Android test IME for the sessions this replay opens (default on for emulators; opt-in on real devices).
`platform`	No	Platform selector used to resolve a device.
`bundleUrl`	No	Bundle URL hint inherited by replay-opened sessions.
`metroHost`	No	Metro/debug host hint inherited by replay-opened sessions.
`metroPort`	No	Metro/debug port hint inherited by replay-opened sessions.
`timeoutMs`	No	Operation wall-clock budget in milliseconds (default 60000). The client allows another 30000 milliseconds for the daemon result.
`resumeFrom`	No
`saveScript`	No
`includeCost`	No	Include per-command agent-cost (cost.wallClockMs, …) in structuredContent. Defaults to off; the default response shape is unchanged.
`keepSession`	No	Leave the session active by suppressing exactly an authored terminal close in native .ad.
`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.
`mcpOutputFormat`	No	MCP text content format. Defaults to optimized agent-friendly text; use json for JSON text. Structured content is always returned separately.
`resumePlanDigest`	No
`androidDeviceAllowlist`	No	Android serial allowlist used for device resolution.

Output Schema

Name	Required	Description
`healed`	Yes
`message`	Yes
`session`	Yes
`replayed`	Yes
`artifactPaths`	Yes
`sessionActive`	Yes	True iff the session is still active — the script had no terminal close.
`snapshotDiagnostics`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedv0.21.29Oct 23, 2026

changedInput schema / properties / timeoutMs / description

Previous value: -"Maximum wall-clock duration for the replay request."New value: +"Operation wall-clock budget in milliseconds (default 60000). The client allows another 30000 milliseconds for the daemon result."

Changed1 schema field changedv0.21.27Oct 12, 2026

addedInput schema / properties / testIme

Added value: +{
+  "description": "Activate the headless Android test IME for the sessions this replay opens (default on for emulators; opt-in on real devices).",
+  "type": "boolean"
+}

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

Changed1 schema field changedv0.20.9Aug 19, 2026

changedInput schema / properties / platform / enum

Previous value: -[
-  "apple",
-  "android",
-  "vega",
-  "linux",
-  "web",
-  "ios",
-  "macos"
-]New value: +[
+  "apple",
+  "android",
+  "harmonyos",
+  "vega",
+  "linux",
+  "web",
+  "ios",
+  "macos"
+]

Changed1 schema field changedv0.20.6Aug 7, 2026

addedInput schema / properties / timeoutMs

Added value: +{
+  "description": "Maximum wall-clock duration for the replay request.",
+  "type": "integer"
+}

Changed1 schema field changedv0.20.4Aug 3, 2026

addedInput schema / properties / keepSession

Added value: +{
+  "description": "Leave the session active by suppressing exactly an authored terminal close in native .ad.",
+  "type": "boolean"
+}

Changed10 schema fields changedv0.20.2Jul 30, 2026

addedInput schema / properties / bundleUrl

Added value: +{
+  "description": "Bundle URL hint inherited by replay-opened sessions.",
+  "type": "string"
+}

addedInput schema / properties / force
```
Added value: +{
+  "type": "boolean"
+}
```

addedInput schema / properties / metroHost

Added value: +{
+  "description": "Metro/debug host hint inherited by replay-opened sessions.",
+  "type": "string"
+}

addedInput schema / properties / metroPort

Added value: +{
+  "description": "Metro/debug port hint inherited by replay-opened sessions.",
+  "type": "integer"
+}

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 / resumeFrom
```
Added value: +{
+  "type": "integer"
+}
```
addedInput schema / properties / resumePlanDigest
```
Added value: +{
+  "type": "string"
+}
```

addedInput schema / properties / saveScript

Added value: +{
+  "oneOf": [
+    {
+      "type": "boolean"
+    },
+    {
+      "type": "string"
+    }
+  ]
+}

changedInput schema / properties / serial / description

Previous value: -"Android serial selector."New value: +"Android device or Vega VVD serial selector."

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "properties": {
+    "artifactPaths": {
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    },
+    "healed": {
+      "type": "number"
+    },
+    "message": {
+      "type": "string"
+    },
+    "replayed": {
+      "type": "number"
+    },
+    "session": {
+      "type": "string"
+    },
+    "sessionActive": {
+      "description": "True iff the session is still active — the script had no terminal close.",
+      "type": "boolean"
+    },
+    "snapshotDiagnostics": {
+      "additionalProperties": true,
+      "type": "object"
+    }
+  },
+  "required": [
+    "replayed",
+    "healed",
+    "session",
+    "sessionActive",
+    "artifactPaths",
+    "message"
+  ],
+  "type": "object"
+}

Changed3 schema fields changedv0.17.11Jul 6, 2026

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

Changed1 schema field changedv0.17.7Jun 23, 2026

changedInput schema / properties / platform / enum

Previous value: -[
-  "ios",
-  "macos",
-  "android",
-  "linux",
-  "apple"
-]New value: +[
+  "ios",
+  "macos",
+  "android",
+  "linux",
+  "web",
+  "apple"
+]

Changed5 schema fields changedv0.17.6Jun 18, 2026

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"
+]

First observedv0.16.9Jun 3, 2026

TDQS

A3.5/5.0

Behavior3/5

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

With no annotations, the description carries the full burden, and it does disclose two meaningful behaviors: a script without a terminal close keeps its session active for later automation, and there is a 90s wall-clock limit extendable by a caller-supplied budget. It does not say what the tool mutates on the device, how failures/partial runs are handled, or what happens when a session name collides.

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?

Two tight sentences with the purpose front-loaded and the two behavioral caveats following. No filler, though the timeout clause sits slightly awkwardly against the schema's own default (60000ms) and could have been folded into the parameter discussion.

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?

For a 30-parameter executor with an output schema available, the description covers purpose, session persistence, and timeouts, which are the highest-risk unknowns. The device/lease/session routing among 30 params is left entirely to the schema, which is acceptable at 70% coverage but leaves a gap for an agent choosing selectors.

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 70% across 30 parameters, so the baseline is 3. The description only touches the timeout budget (timeoutMs, whose 60s + 30s client allowance composes to the stated 90s), saying nothing about the device-selector, lease/session, or Maestro-flag parameters that dominate the schema.

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?

States a specific verb and resource: "Run a recorded automation script, including compatible Maestro YAML flows." That distinguishes it from the recording side (record) and from other executors (batch, test) without naming them explicitly. A concrete format qualifier (Maestro YAML) further narrows scope.

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?

Usage is only implied by "recorded automation script" — an agent can infer you need an existing script path, but the description never says when to prefer replay over record, batch, or test, nor states prerequisites (device lease, script existence, platform support). No explicit exclusions are given.

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

Deploy Server

replay

Instructions

Input Schema

Output Schema

Schema Changelog

TDQS

Other Tools