agent-device

Official

by callstack

Overview Schema Source Related Servers Discussions Admin

TypeScript

Remote

test

Run replay scripts as a serial test suite, streaming progress without a fixed client timeout.

Instructions

Run one or more replay scripts as a serial test suite Streams progress; no fixed client timeout.

Input Schema

TableJSON Schema

Name	Required	Description
`env`	No
`udid`	No	Apple device or simulator UDID; the selector that pins one device when several share a name.
`debug`	No	Enable debug diagnostics.
`paths`	Yes
`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
`retries`	No
`session`	No	Agent-device session name.
`failFast`	No
`platform`	No	Platform selector used to resolve a device.
`shardAll`	No
`bundleUrl`	No	Bundle URL hint inherited by each test session.
`metroHost`	No	Metro/debug host hint inherited by each test session.
`metroPort`	No	Metro/debug port hint inherited by each test session.
`timeoutMs`	No
`shardSplit`	No
`includeCost`	No	Include per-command agent-cost (cost.wallClockMs, …) in structuredContent. Defaults to off; the default response shape is unchanged.
`recordVideo`	No
`artifactsDir`	No
`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.

Output Schema

TableJSON Schema

Name	Required	Description	Default
`tests`	Yes
`total`	Yes
`failed`	Yes
`notRun`	Yes
`passed`	Yes
`skipped`	Yes
`executed`	Yes
`failures`	Yes
`durationMs`	Yes
`snapshotDiagnostics`	No

Schema Changelog

Changes observed during successful MCP inspections.

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

Changed6 schema fields changedv0.20.2Jul 30, 2026

addedInput schema / properties / bundleUrl

Added value: +{
+  "description": "Bundle URL hint inherited by each test session.",
+  "type": "string"
+}

addedInput schema / properties / metroHost

Added value: +{
+  "description": "Metro/debug host hint inherited by each test session.",
+  "type": "string"
+}

addedInput schema / properties / metroPort

Added value: +{
+  "description": "Metro/debug port hint inherited by each test session.",
+  "type": "integer"
+}

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

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "properties": {
+    "durationMs": {
+      "type": "number"
+    },
+    "executed": {
+      "type": "number"
+    },
+    "failed": {
+      "type": "number"
+    },
+    "failures": {
+      "items": {
+        "additionalProperties": true,
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "notRun": {
+      "type": "number"
+    },
+    "passed": {
+      "type": "number"
+    },
+    "skipped": {
+      "type": "number"
+    },
+    "snapshotDiagnostics": {
+      "additionalProperties": true,
+      "type": "object"
+    },
+    "tests": {
+      "items": {
+        "additionalProperties": true,
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "total": {
+      "type": "number"
+    }
+  },
+  "required": [
+    "total",
+    "executed",
+    "passed",
+    "failed",
+    "skipped",
+    "notRun",
+    "durationMs",
+    "failures",
+    "tests"
+  ],
+  "type": "object"
+}

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

removedInput schema / properties / reportJunit
```
Removed value: -{
-  "type": "string"
-}
```

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

Changed3 schema fields changedv0.17.1Jun 9, 2026
- addedInput schema / properties / recordVideo
```
Added value: +{
+  "type": "boolean"
+}
```
- addedInput schema / properties / shardAll
```
Added value: +{
+  "type": "integer"
+}
```
- addedInput schema / properties / shardSplit
```
Added value: +{
+  "type": "integer"
+}
```
First observedv0.16.9Jun 3, 2026

TDQS

C2.5/5.0

Behavior2/5

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

With no annotations, the description carries the full burden. It discloses 'no fixed client timeout' and mentions streaming progress, but it fails to explain side effects, permissions, failure behavior, or what happens to artifacts. This is minimal disclosure for a test runner.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is concise but awkwardly phrased; 'Streams progress' reads as a fragment and lacks clarity. It front-loads the core action but could be more intelligible and structured.

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

Completeness1/5

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

For a tool with 30 parameters and a complex serial execution model, the description is grossly incomplete. It does not explain the meaning of 'serial test suite', how paths are used, the operational context, or how it differs from replay. The output schema exists, but behavioral and usage context is missing.

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?

The description adds no parameter-specific information beyond what the schema provides. With schema coverage at 60%, many parameters lack descriptions, and the description does not compensate. It only vaguely references 'replay scripts', which aligns with the 'paths' parameter but nothing else.

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?

The description states a specific action ('Run') and resource ('one or more replay scripts') and indicates a serial test suite, which distinguishes it from the 'replay' sibling. However, the phrasing 'Streams progress' is ambiguous and no explicit comparison to alternatives is given.

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?

No guidance is provided on when to use this tool versus alternatives like 'replay'. The phrase 'serial test suite' implies batch usage, but it never explicitly says to use 'replay' for a single script or mentions any prerequisites or exclusions.

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

Deploy Server

test

Instructions

Input Schema

Output Schema

Schema Changelog

TDQS

Other Tools