agent-device

Official

by callstack

Overview Schema Source Related Servers Discussions Admin

TypeScript

Remote

appstate

Show foreground app/activity (Android and HarmonyOS; iOS and macOS answer per session) Times out after 90s.

Instructions

Show foreground app/activity (Android and HarmonyOS; iOS and macOS answer per session) Times out after 90s.

Input Schema

Name	Required	Description
`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.
`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.
`session`	No	Agent-device session name.
`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.

Output Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedv0.21.27Oct 12, 2026

changedOutput schema / oneOf

Previous value: -[
-  {
-    "properties": {
-      "appBundleId": {
-        "type": "string"
-      },
-      "appName": {
-        "type": "string"
-      },
-      "device_udid": {
-        "description": "iOS only — the session device UDID.",
-        "type": "string"
-      },
-      "ios_simulator_device_set": {
-        "description": "iOS only — the simulator set path, or null when unknown.",
-        "type": [
-          "string",
-          "null"
-        ]
-      },
-      "platform": {
-        "enum": [
-          "ios",
-          "macos"
-        ],
-        "type": "string"
-      },
-      "source": {
-        "description": "runner when a live runner read the session app state; session when the record alone answered.",
-        "enum": [
-          "session",
-          "runner"
-        ],
-        "type": "string"
-      },
-      "state": {
-        "description": "The session app XCUIApplication state as a live runner reads it; absent with source session.",
-        "enum": [
-          "unknown",
-          "notRunning",
-          "runningBackgroundSuspended",
-          "runningBackground",
-          "runningForeground"
-        ],
-        "type": "string"
-      },
-      "surface": {
-        "enum": [
-          "app",
-          "frontmost-app",
-          "desktop",
-          "menubar"
-        ],
-        "type": "string"
-      }
-    },
-    "required": [
-      "platform",
-      "appName",
-      "source",
-      "surface"
-    ],
-    "type": "object"
-  },
-  {
-    "properties": {
-      "activity": {
-        "type": "string"
-      },
-      "package": {
-        "type": "string"
-      },
-      "platform": {
-        "const": "android",
-        "type": "string"
-      }
-    },
-    "required": [
-      "platform",
-      "package",
-      "activity"
-    ],
-    "type": "object"
-  }
-]New value: +[
+  {
+    "properties": {
+      "appBundleId": {
+        "type": "string"
+      },
+      "appName": {
+        "type": "string"
+      },
+      "device_udid": {
+        "description": "iOS only — the session device UDID.",
+        "type": "string"
+      },
+      "ios_simulator_device_set": {
+        "description": "iOS only — the simulator set path, or null when unknown.",
+        "type": [
+          "string",
+          "null"
+        ]
+      },
+      "platform": {
+        "enum": [
+          "ios",
+          "macos"
+        ],
+        "type": "string"
+      },
+      "source": {
+        "description": "runner when a live runner read the session app state; session when the record alone answered.",
+        "enum": [
+          "session",
+          "runner"
+        ],
+        "type": "string"
+      },
+      "state": {
+        "description": "The session app XCUIApplication state as a live runner reads it; absent with source session.",
+        "enum": [
+          "unknown",
+          "notRunning",
+          "runningBackgroundSuspended",
+          "runningBackground",
+          "runningForeground"
+        ],
+        "type": "string"
+      },
+      "surface": {
+        "enum": [
+          "app",
+          "frontmost-app",
+          "desktop",
+          "menubar"
+        ],
+        "type": "string"
+      }
+    },
+    "required": [
+      "platform",
+      "appName",
+      "source",
+      "surface"
+    ],
+    "type": "object"
+  },
+  {
+    "properties": {
+      "activity": {
+        "type": "string"
+      },
+      "package": {
+        "type": "string"
+      },
+      "platform": {
+        "enum": [
+          "android",
+          "harmonyos"
+        ],
+        "type": "string"
+      }
+    },
+    "required": [
+      "platform",
+      "package",
+      "activity"
+    ],
+    "type": "object"
+  }
+]

Changed1 schema field changedv0.21.15Sep 25, 2026

changedOutput schema / oneOf

Previous value: -[
-  {
-    "properties": {
-      "appBundleId": {
-        "type": "string"
-      },
-      "appName": {
-        "type": "string"
-      },
-      "device_udid": {
-        "description": "iOS only — the session device UDID.",
-        "type": "string"
-      },
-      "ios_simulator_device_set": {
-        "description": "iOS only — the simulator set path, or null when unknown.",
-        "type": [
-          "string",
-          "null"
-        ]
-      },
-      "platform": {
-        "enum": [
-          "ios",
-          "macos"
-        ],
-        "type": "string"
-      },
-      "source": {
-        "const": "session",
-        "type": "string"
-      },
-      "surface": {
-        "enum": [
-          "app",
-          "frontmost-app",
-          "desktop",
-          "menubar"
-        ],
-        "type": "string"
-      }
-    },
-    "required": [
-      "platform",
-      "appName",
-      "source",
-      "surface"
-    ],
-    "type": "object"
-  },
-  {
-    "properties": {
-      "activity": {
-        "type": "string"
-      },
-      "package": {
-        "type": "string"
-      },
-      "platform": {
-        "const": "android",
-        "type": "string"
-      }
-    },
-    "required": [
-      "platform",
-      "package",
-      "activity"
-    ],
-    "type": "object"
-  }
-]New value: +[
+  {
+    "properties": {
+      "appBundleId": {
+        "type": "string"
+      },
+      "appName": {
+        "type": "string"
+      },
+      "device_udid": {
+        "description": "iOS only — the session device UDID.",
+        "type": "string"
+      },
+      "ios_simulator_device_set": {
+        "description": "iOS only — the simulator set path, or null when unknown.",
+        "type": [
+          "string",
+          "null"
+        ]
+      },
+      "platform": {
+        "enum": [
+          "ios",
+          "macos"
+        ],
+        "type": "string"
+      },
+      "source": {
+        "description": "runner when a live runner read the session app state; session when the record alone answered.",
+        "enum": [
+          "session",
+          "runner"
+        ],
+        "type": "string"
+      },
+      "state": {
+        "description": "The session app XCUIApplication state as a live runner reads it; absent with source session.",
+        "enum": [
+          "unknown",
+          "notRunning",
+          "runningBackgroundSuspended",
+          "runningBackground",
+          "runningForeground"
+        ],
+        "type": "string"
+      },
+      "surface": {
+        "enum": [
+          "app",
+          "frontmost-app",
+          "desktop",
+          "menubar"
+        ],
+        "type": "string"
+      }
+    },
+    "required": [
+      "platform",
+      "appName",
+      "source",
+      "surface"
+    ],
+    "type": "object"
+  },
+  {
+    "properties": {
+      "activity": {
+        "type": "string"
+      },
+      "package": {
+        "type": "string"
+      },
+      "platform": {
+        "const": "android",
+        "type": "string"
+      }
+    },
+    "required": [
+      "platform",
+      "package",
+      "activity"
+    ],
+    "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"
-}

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

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

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

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "oneOf": [
+    {
+      "properties": {
+        "appBundleId": {
+          "type": "string"
+        },
+        "appName": {
+          "type": "string"
+        },
+        "device_udid": {
+          "description": "iOS only — the session device UDID.",
+          "type": "string"
+        },
+        "ios_simulator_device_set": {
+          "description": "iOS only — the simulator set path, or null when unknown.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "platform": {
+          "enum": [
+            "ios",
+            "macos"
+          ],
+          "type": "string"
+        },
+        "source": {
+          "const": "session",
+          "type": "string"
+        },
+        "surface": {
+          "enum": [
+            "app",
+            "frontmost-app",
+            "desktop",
+            "menubar"
+          ],
+          "type": "string"
+        }
+      },
+      "required": [
+        "platform",
+        "appName",
+        "source",
+        "surface"
+      ],
+      "type": "object"
+    },
+    {
+      "properties": {
+        "activity": {
+          "type": "string"
+        },
+        "package": {
+          "type": "string"
+        },
+        "platform": {
+          "const": "android",
+          "type": "string"
+        }
+      },
+      "required": [
+        "platform",
+        "package",
+        "activity"
+      ],
+      "type": "object"
+    }
+  ],
+  "type": "object"
+}

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

B3.2/5.0

Behavior3/5

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

With no annotations, the description carries full burden but does disclose two useful traits: a 90s timeout and the platform-dependent answer semantics (Android/HarmonyOS direct vs iOS/macOS per session). It does not state read-only safety or what happens on timeout, so the disclosure is partial.

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 compact clauses, front-loaded with the core action and immediately qualified by platform and timeout. Minor flaw: the two sentences run together without punctuation after the closing parenthesis, slightly harming readability.

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?

An output schema exists, so return values need not be explained, and the description covers the key operational caveats (platform scope, 90s timeout). For a zero-required-param query tool this is largely sufficient, with only the read-only/timeout-behavior detail missing.

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 all 15 device-selection and output-shaping parameters are already documented in the schema. The description adds nothing about params, which is acceptable given the schema does the heavy lifting.

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+resource: 'Show foreground app/activity', with platform scope parenthetically qualified (Android/HarmonyOS direct; iOS/macOS per session). It is distinguishable from query siblings like apps/get, though it never names them explicitly.

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 when-to-use guidance and no alternatives named. An agent must infer that this is the read for current foreground state versus siblings such as apps, is, snapshot, or session, which is a plausible confusion in this crowded sibling set.

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

Deploy Server

appstate

Instructions

Input Schema

Output Schema

Schema Changelog

TDQS

Other Tools