agent-device

Official

by callstack

Overview Schema Source Related Servers Discussions Admin

TypeScript

Remote

batch

Execute multiple commands in one daemon request. Times out after 90s.

Instructions

Execute multiple commands in one daemon request. Times out after 90s.

Input Schema

Name	Required	Description
`out`	No	Optional output path for command artifacts.
`udid`	No	Apple device or simulator UDID; the selector that pins one device when several share a name.
`debug`	No	Enable debug diagnostics.
`runId`	No	Lease run identifier.
`steps`	Yes	Structured batch steps. Each step uses a command name and the same input object as that command tool.
`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.
`leaseId`	No	Existing lease identifier.
`onError`	No	Batch failure policy.
`session`	No	Agent-device session name.
`maxSteps`	No	Maximum number of steps accepted for this batch.
`platform`	No	Platform selector used to resolve a device.
`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.
`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.

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedv0.21.29Oct 23, 2026

changedInput schema / properties / steps / items / properties / command / enum

Previous value: -[
-  "devices",
-  "capabilities",
-  "doctor",
-  "apps",
-  "boot",
-  "shutdown",
-  "appstate",
-  "perf",
-  "logs",
-  "network",
-  "audio",
-  "test",
-  "clipboard",
-  "keyboard",
-  "install",
-  "reinstall",
-  "push",
-  "trigger-app-event",
-  "open",
-  "close",
-  "snapshot",
-  "diff",
-  "wait",
-  "alert",
-  "settings",
-  "react-native",
-  "record",
-  "trace",
-  "find",
-  "click",
-  "fill",
-  "longpress",
-  "hover",
-  "press",
-  "type",
-  "get",
-  "is",
-  "back",
-  "gesture",
-  "home",
-  "tv-remote",
-  "orientation",
-  "fold",
-  "scroll",
-  "swipe",
-  "focus",
-  "screenshot",
-  "app-switcher",
-  "action-button",
-  "install-from-source"
-]New value: +[
+  "devices",
+  "capabilities",
+  "doctor",
+  "apps",
+  "boot",
+  "shutdown",
+  "appstate",
+  "perf",
+  "logs",
+  "network",
+  "audio",
+  "test",
+  "clipboard",
+  "keyboard",
+  "install",
+  "reinstall",
+  "uninstall",
+  "push",
+  "trigger-app-event",
+  "open",
+  "close",
+  "snapshot",
+  "diff",
+  "wait",
+  "alert",
+  "settings",
+  "react-native",
+  "record",
+  "trace",
+  "find",
+  "click",
+  "fill",
+  "longpress",
+  "hover",
+  "press",
+  "type",
+  "get",
+  "is",
+  "back",
+  "gesture",
+  "home",
+  "tv-remote",
+  "orientation",
+  "fold",
+  "telephony",
+  "scroll",
+  "swipe",
+  "focus",
+  "screenshot",
+  "app-switcher",
+  "action-button",
+  "hardware-button",
+  "install-from-source"
+]

Changed1 schema field changedv0.21.12Sep 23, 2026

changedInput schema / properties / steps / items / properties / command / enum

Previous value: -[
-  "devices",
-  "capabilities",
-  "doctor",
-  "apps",
-  "boot",
-  "shutdown",
-  "appstate",
-  "perf",
-  "logs",
-  "network",
-  "audio",
-  "test",
-  "clipboard",
-  "keyboard",
-  "install",
-  "reinstall",
-  "push",
-  "trigger-app-event",
-  "open",
-  "close",
-  "snapshot",
-  "diff",
-  "wait",
-  "alert",
-  "settings",
-  "react-native",
-  "record",
-  "trace",
-  "find",
-  "click",
-  "fill",
-  "longpress",
-  "hover",
-  "press",
-  "type",
-  "get",
-  "is",
-  "back",
-  "gesture",
-  "home",
-  "tv-remote",
-  "orientation",
-  "scroll",
-  "swipe",
-  "focus",
-  "screenshot",
-  "app-switcher",
-  "install-from-source"
-]New value: +[
+  "devices",
+  "capabilities",
+  "doctor",
+  "apps",
+  "boot",
+  "shutdown",
+  "appstate",
+  "perf",
+  "logs",
+  "network",
+  "audio",
+  "test",
+  "clipboard",
+  "keyboard",
+  "install",
+  "reinstall",
+  "push",
+  "trigger-app-event",
+  "open",
+  "close",
+  "snapshot",
+  "diff",
+  "wait",
+  "alert",
+  "settings",
+  "react-native",
+  "record",
+  "trace",
+  "find",
+  "click",
+  "fill",
+  "longpress",
+  "hover",
+  "press",
+  "type",
+  "get",
+  "is",
+  "back",
+  "gesture",
+  "home",
+  "tv-remote",
+  "orientation",
+  "fold",
+  "scroll",
+  "swipe",
+  "focus",
+  "screenshot",
+  "app-switcher",
+  "action-button",
+  "install-from-source"
+]

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

addedInput schema / properties / steps / items / properties / input / commandInputFor
```
Added value: +"command"
```

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

Changed2 schema fields 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"
+]

changedInput schema / properties / steps / items / properties / command / enum

Previous value: -[
-  "devices",
-  "capabilities",
-  "doctor",
-  "apps",
-  "boot",
-  "shutdown",
-  "appstate",
-  "perf",
-  "logs",
-  "network",
-  "audio",
-  "test",
-  "clipboard",
-  "keyboard",
-  "install",
-  "reinstall",
-  "push",
-  "trigger-app-event",
-  "open",
-  "close",
-  "snapshot",
-  "diff",
-  "wait",
-  "alert",
-  "settings",
-  "react-native",
-  "record",
-  "trace",
-  "find",
-  "click",
-  "fill",
-  "longpress",
-  "press",
-  "type",
-  "get",
-  "is",
-  "back",
-  "gesture",
-  "home",
-  "tv-remote",
-  "orientation",
-  "scroll",
-  "swipe",
-  "focus",
-  "screenshot",
-  "app-switcher",
-  "install-from-source"
-]New value: +[
+  "devices",
+  "capabilities",
+  "doctor",
+  "apps",
+  "boot",
+  "shutdown",
+  "appstate",
+  "perf",
+  "logs",
+  "network",
+  "audio",
+  "test",
+  "clipboard",
+  "keyboard",
+  "install",
+  "reinstall",
+  "push",
+  "trigger-app-event",
+  "open",
+  "close",
+  "snapshot",
+  "diff",
+  "wait",
+  "alert",
+  "settings",
+  "react-native",
+  "record",
+  "trace",
+  "find",
+  "click",
+  "fill",
+  "longpress",
+  "hover",
+  "press",
+  "type",
+  "get",
+  "is",
+  "back",
+  "gesture",
+  "home",
+  "tv-remote",
+  "orientation",
+  "scroll",
+  "swipe",
+  "focus",
+  "screenshot",
+  "app-switcher",
+  "install-from-source"
+]

Changed3 schema fields changedv0.20.2Jul 30, 2026

changedInput schema / properties / platform / enum

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

changedInput schema / properties / serial / description

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

changedInput schema / properties / steps / items / properties / command / enum

Previous value: -[
-  "devices",
-  "doctor",
-  "apps",
-  "boot",
-  "shutdown",
-  "appstate",
-  "perf",
-  "logs",
-  "network",
-  "audio",
-  "test",
-  "clipboard",
-  "keyboard",
-  "install",
-  "reinstall",
-  "push",
-  "trigger-app-event",
-  "open",
-  "close",
-  "snapshot",
-  "diff",
-  "wait",
-  "alert",
-  "settings",
-  "react-native",
-  "record",
-  "trace",
-  "find",
-  "click",
-  "fill",
-  "longpress",
-  "press",
-  "type",
-  "get",
-  "is",
-  "back",
-  "gesture",
-  "home",
-  "rotate",
-  "scroll",
-  "swipe",
-  "focus",
-  "screenshot",
-  "app-switcher",
-  "install-from-source"
-]New value: +[
+  "devices",
+  "capabilities",
+  "doctor",
+  "apps",
+  "boot",
+  "shutdown",
+  "appstate",
+  "perf",
+  "logs",
+  "network",
+  "audio",
+  "test",
+  "clipboard",
+  "keyboard",
+  "install",
+  "reinstall",
+  "push",
+  "trigger-app-event",
+  "open",
+  "close",
+  "snapshot",
+  "diff",
+  "wait",
+  "alert",
+  "settings",
+  "react-native",
+  "record",
+  "trace",
+  "find",
+  "click",
+  "fill",
+  "longpress",
+  "press",
+  "type",
+  "get",
+  "is",
+  "back",
+  "gesture",
+  "home",
+  "tv-remote",
+  "orientation",
+  "scroll",
+  "swipe",
+  "focus",
+  "screenshot",
+  "app-switcher",
+  "install-from-source"
+]

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

changedInput schema / properties / steps / items / properties / command / enum

Previous value: -[
-  "devices",
-  "boot",
-  "shutdown",
-  "apps",
-  "open",
-  "close",
-  "install",
-  "reinstall",
-  "install-from-source",
-  "push",
-  "trigger-app-event",
-  "snapshot",
-  "screenshot",
-  "diff",
-  "wait",
-  "alert",
-  "settings",
-  "click",
-  "press",
-  "longpress",
-  "swipe",
-  "focus",
-  "type",
-  "fill",
-  "scroll",
-  "get",
-  "gesture",
-  "is",
-  "find",
-  "perf",
-  "logs",
-  "network",
-  "record",
-  "trace",
-  "test",
-  "appstate",
-  "back",
-  "home",
-  "rotate",
-  "app-switcher",
-  "keyboard",
-  "clipboard",
-  "react-native"
-]New value: +[
+  "devices",
+  "doctor",
+  "apps",
+  "boot",
+  "shutdown",
+  "appstate",
+  "perf",
+  "logs",
+  "network",
+  "audio",
+  "test",
+  "clipboard",
+  "keyboard",
+  "install",
+  "reinstall",
+  "push",
+  "trigger-app-event",
+  "open",
+  "close",
+  "snapshot",
+  "diff",
+  "wait",
+  "alert",
+  "settings",
+  "react-native",
+  "record",
+  "trace",
+  "find",
+  "click",
+  "fill",
+  "longpress",
+  "press",
+  "type",
+  "get",
+  "is",
+  "back",
+  "gesture",
+  "home",
+  "rotate",
+  "scroll",
+  "swipe",
+  "focus",
+  "screenshot",
+  "app-switcher",
+  "install-from-source"
+]

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

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

changedInput schema / properties / steps / items / properties / command / enum

Previous value: -[
-  "devices",
-  "boot",
-  "apps",
-  "open",
-  "close",
-  "install",
-  "reinstall",
-  "install-from-source",
-  "push",
-  "trigger-app-event",
-  "snapshot",
-  "screenshot",
-  "diff",
-  "wait",
-  "alert",
-  "settings",
-  "click",
-  "press",
-  "longpress",
-  "swipe",
-  "focus",
-  "type",
-  "fill",
-  "scroll",
-  "get",
-  "gesture",
-  "is",
-  "find",
-  "perf",
-  "logs",
-  "network",
-  "record",
-  "trace",
-  "test",
-  "appstate",
-  "back",
-  "home",
-  "rotate",
-  "app-switcher",
-  "keyboard",
-  "clipboard",
-  "react-native"
-]New value: +[
+  "devices",
+  "boot",
+  "shutdown",
+  "apps",
+  "open",
+  "close",
+  "install",
+  "reinstall",
+  "install-from-source",
+  "push",
+  "trigger-app-event",
+  "snapshot",
+  "screenshot",
+  "diff",
+  "wait",
+  "alert",
+  "settings",
+  "click",
+  "press",
+  "longpress",
+  "swipe",
+  "focus",
+  "type",
+  "fill",
+  "scroll",
+  "get",
+  "gesture",
+  "is",
+  "find",
+  "perf",
+  "logs",
+  "network",
+  "record",
+  "trace",
+  "test",
+  "appstate",
+  "back",
+  "home",
+  "rotate",
+  "app-switcher",
+  "keyboard",
+  "clipboard",
+  "react-native"
+]

First observedv0.16.9Jun 3, 2026

TDQS

B3.3/5.0

Behavior2/5

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

No annotations are provided, so the description carries the full behavioral burden. It discloses only the single-request execution model and 90s timeout, omitting execution ordering, failure semantics, side-effect risks of nested commands, and response behavior.

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?

Two short, front-loaded sentences with no repetition or filler. The timeout note is useful and every sentence earns its place.

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?

This is a complex batch tool with many parameters, a large nested command enum, and no output schema. The rich schema covers parameter details adequately, but the description leaves important batch execution and response semantics unexplained.

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 description coverage is 100%, so the schema already documents all 19 parameters. The description adds no parameter-level meaning beyond the general idea of running multiple commands.

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: executing multiple commands in one daemon request. This distinguishes the batch tool from individual command siblings, though it does not explicitly name those alternatives.

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?

The batching use case is implied by 'multiple commands in one daemon request,' but there is no explicit guidance on when to use this instead of separate command calls, nor any exclusions or prerequisites.

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

Deploy Server

batch

Instructions

Input Schema

Schema Changelog

TDQS

Other Tools