Skip to main content
Glama

Replay a recorded session or Maestro flow

replay
Destructive

Run a recorded automation script, including Maestro YAML flows, to replay actions on a device. Keeps the session active for follow-up automation when the script has no terminal close.

Instructions

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.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "path": "<path>"
    },
    "name": "replay"
  }
}

Input Schema

NameRequiredDescriptionDefault
envNo
pathYes
udidNoApple device or simulator UDID.
forceNo
deviceNoDevice name; ids go in udid or serial.
serialNoAndroid, HarmonyOS, or Vega VVD serial.
updateNo
backendNo
maestroNo
sessionNoSession name.
testImeNoActivate the headless Android test IME for the sessions this replay opens (default on for emulators; opt-in on real devices).
platformNoDevice platform.
bundleUrlNoBundle URL hint inherited by replay-opened sessions.
metroHostNoMetro/debug host hint inherited by replay-opened sessions.
metroPortNoMetro/debug port hint inherited by replay-opened sessions.
timeoutMsNoOperation wall-clock budget in milliseconds (default 60000). The client allows another 30000 milliseconds for the daemon result.
resumeFromNo
saveScriptNo
keepSessionNoLeave the session active by suppressing exactly an authored terminal close in native .ad.
deviceTargetNoDevice form factor.
resumePlanDigestNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv0.21.38
    • 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. Changed15 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."
    • changedOutput schema / (root)
      Previous 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"
      -}New value: +null
  3. Changed1 schema field changedv0.21.29
    • 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."
  4. Changed1 schema field changedv0.21.27
    • 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"
      +}
  5. 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."
  6. 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"
      -}
  7. 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"
      +]
  8. Changed1 schema field changedv0.20.6
    • addedInput schema / properties / timeoutMs
      Added value: +{
      +  "description": "Maximum wall-clock duration for the replay request.",
      +  "type": "integer"
      +}
  9. Changed1 schema field changedv0.20.4
    • addedInput schema / properties / keepSession
      Added value: +{
      +  "description": "Leave the session active by suppressing exactly an authored terminal close in native .ad.",
      +  "type": "boolean"
      +}
  10. Changed10 schema fields changedv0.20.2
    • 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"
      +}
  11. 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"
      +}
  12. 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"
      +]
  13. Changed5 schema fields changedv0.17.6
    • 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"
      +]
  14. First observedv0.16.9

TDQS

B3.1/5.0
Behavior4/5

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

Annotations only declare non-read-only and destructive; the description adds genuinely useful behavior beyond them: a script lacking a terminal close leaves its session open for later steps, and the 90s ceiling can be raised by a caller budget (consistent with timeoutMs default 60000 plus the client's 30000 allowance). It does not explain the destructive footprint — that replay can drive UI, close sessions, or alter device state — which is the main remaining gap.

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?

Three short sentences, front-loaded with the core action and with no filler. The final clause about a caller-supplied budget is slightly vague about which parameter supplies it, but nothing is redundant.

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?

For a destructive 21-parameter tool with no output schema and middling schema coverage, three sentences are thin — nothing on what gets mutated, what a successful replay yields, or how the many session/target parameters interact. The details it does give are accurate and helpful, but the definition under-serves the tool's complexity.

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

Parameters2/5

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

With 21 parameters and only 57% schema description coverage, roughly nine parameters (resumeFrom, resumePlanDigest, saveScript, force, update, maestro, backend, env, session) carry no meaning in either place. The description contributes nothing about any parameter, not even the required 'path' or the timeout/keepSession interplay it alludes to.

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') and extends scope to Maestro YAML flows, which an agent would not infer from the name alone. It never distinguishes itself from plausible siblings like 'batch' or 'session', so it stops short of full sibling differentiation.

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?

There is no explicit when-to-use or when-not guidance, no prerequisites (e.g., that a recording or Maestro file must exist at path), and no named alternative for plain one-off automation. The session-persistence note describes an outcome rather than a selection criterion.

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