agent-device

Official

Overview Schema Source Related Servers Discussions Admin

record

Initiate or terminate screen capture on app sessions or devices, or create a contact-sheet PNG from an existing capture.

Instructions

Start or stop a screen recording for the active app session or, where supported, the selected device, or build a contact-sheet PNG from a recording already exported. Long Android recordings can return multiple video artifacts; HarmonyOS supports whole-screen recording on physical devices. Times out after 90s.

Input Schema

TableJSON Schema

Name	Required	Description
`fps`	No
`path`	No
`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.
`action`	Yes
`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.
`quality`	No
`session`	No	Agent-device session name.
`noRecord`	No	Do not record this action.
`platform`	No	Platform selector used to resolve a device.
`hideTouches`	No
`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.
`recordingScope`	No
`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
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedv0.21.2Sep 16, 2026

changedOutput schema / oneOf

Previous value: -[
-  {
-    "properties": {
-      "activeSessionApp": {
-        "additionalProperties": true,
-        "type": "object"
-      },
-      "outPath": {
-        "type": "string"
-      },
-      "recordOnlySession": {
-        "type": "boolean"
-      },
-      "recording": {
-        "const": "started",
-        "type": "string"
-      },
-      "recordingBackend": {
-        "type": "string"
-      },
-      "recordingScope": {
-        "type": "string"
-      },
-      "sessionStateDir": {
-        "type": "string"
-      },
-      "showTouches": {
-        "type": "boolean"
-      }
-    },
-    "required": [
-      "recording",
-      "outPath",
-      "sessionStateDir",
-      "showTouches"
-    ],
-    "type": "object"
-  },
-  {
-    "properties": {
-      "activeSessionApp": {
-        "additionalProperties": true,
-        "type": "object"
-      },
-      "artifacts": {
-        "items": {
-          "properties": {
-            "artifactType": {
-              "type": "string"
-            },
-            "field": {
-              "type": "string"
-            },
-            "fileName": {
-              "type": "string"
-            },
-            "localPath": {
-              "type": "string"
-            },
-            "path": {
-              "type": "string"
-            }
-          },
-          "required": [
-            "field"
-          ],
-          "type": "object"
-        },
-        "type": "array"
-      },
-      "chunks": {
-        "items": {
-          "additionalProperties": true,
-          "type": "object"
-        },
-        "type": "array"
-      },
-      "durationMs": {
-        "type": "number"
-      },
-      "outPath": {
-        "type": "string"
-      },
-      "overlayWarning": {
-        "type": "string"
-      },
-      "recordOnlySession": {
-        "type": "boolean"
-      },
-      "recording": {
-        "const": "stopped",
-        "type": "string"
-      },
-      "recordingBackend": {
-        "type": "string"
-      },
-      "recordingScope": {
-        "type": "string"
-      },
-      "showTouches": {
-        "type": "boolean"
-      },
-      "telemetryPath": {
-        "type": "string"
-      },
-      "warning": {
-        "type": "string"
-      }
-    },
-    "required": [
-      "recording",
-      "outPath",
-      "artifacts",
-      "durationMs",
-      "showTouches"
-    ],
-    "type": "object"
-  }
-]New value: +[
+  {
+    "properties": {
+      "activeSessionApp": {
+        "additionalProperties": true,
+        "type": "object"
+      },
+      "outPath": {
+        "type": "string"
+      },
+      "recordOnlySession": {
+        "type": "boolean"
+      },
+      "recording": {
+        "const": "started",
+        "type": "string"
+      },
+      "recordingBackend": {
+        "type": "string"
+      },
+      "recordingScope": {
+        "type": "string"
+      },
+      "sessionStateDir": {
+        "type": "string"
+      },
+      "showTouches": {
+        "type": "boolean"
+      }
+    },
+    "required": [
+      "recording",
+      "outPath",
+      "sessionStateDir",
+      "showTouches"
+    ],
+    "type": "object"
+  },
+  {
+    "properties": {
+      "activeSessionApp": {
+        "additionalProperties": true,
+        "type": "object"
+      },
+      "artifacts": {
+        "items": {
+          "properties": {
+            "artifactType": {
+              "type": "string"
+            },
+            "field": {
+              "type": "string"
+            },
+            "fileName": {
+              "type": "string"
+            },
+            "localPath": {
+              "type": "string"
+            },
+            "path": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "field"
+          ],
+          "type": "object"
+        },
+        "type": "array"
+      },
+      "capturedDurationMs": {
+        "type": "number"
+      },
+      "chunks": {
+        "items": {
+          "additionalProperties": true,
+          "type": "object"
+        },
+        "type": "array"
+      },
+      "durationMs": {
+        "type": "number"
+      },
+      "nativePathDisposition": {
+        "description": "What became of the artifact path the recorder writes to: retirable while it still owes a removal, retired once that removal was verified. ADR 0024 reserves pending.",
+        "enum": [
+          "pending",
+          "retirable",
+          "retired"
+        ],
+        "type": "string"
+      },
+      "outPath": {
+        "type": "string"
+      },
+      "overlayWarning": {
+        "type": "string"
+      },
+      "recordOnlySession": {
+        "type": "boolean"
+      },
+      "recorder": {
+        "description": "What the recorder was observed doing when the recording was stopped: confirmed, or lost when the session holding it died. ADR 0024 reserves unconfirmed for the step that gains the probe.",
+        "enum": [
+          "confirmed",
+          "unconfirmed",
+          "lost"
+        ],
+        "type": "string"
+      },
+      "recording": {
+        "const": "stopped",
+        "type": "string"
+      },
+      "recordingBackend": {
+        "type": "string"
+      },
+      "recordingScope": {
+        "type": "string"
+      },
+      "showTouches": {
+        "type": "boolean"
+      },
+      "telemetryPath": {
+        "type": "string"
+      },
+      "warning": {
+        "type": "string"
+      }
+    },
+    "required": [
+      "recording",
+      "outPath",
+      "artifacts",
+      "durationMs",
+      "showTouches"
+    ],
+    "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"
+]

Changed1 schema field changedv0.20.6Aug 7, 2026
- removedInput schema / properties / maxSize
```
Removed value: -{
-  "type": "integer"
-}
```

Changed5 schema fields changedv0.20.2Jul 30, 2026

addedInput schema / properties / noRecord

Added value: +{
+  "description": "Do not record this action.",
+  "type": "boolean"
+}

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 / recordingScope

Added value: +{
+  "enum": [
+    "app",
+    "device",
+    "system"
+  ],
+  "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: +{
+  "oneOf": [
+    {
+      "properties": {
+        "activeSessionApp": {
+          "additionalProperties": true,
+          "type": "object"
+        },
+        "outPath": {
+          "type": "string"
+        },
+        "recordOnlySession": {
+          "type": "boolean"
+        },
+        "recording": {
+          "const": "started",
+          "type": "string"
+        },
+        "recordingBackend": {
+          "type": "string"
+        },
+        "recordingScope": {
+          "type": "string"
+        },
+        "sessionStateDir": {
+          "type": "string"
+        },
+        "showTouches": {
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "recording",
+        "outPath",
+        "sessionStateDir",
+        "showTouches"
+      ],
+      "type": "object"
+    },
+    {
+      "properties": {
+        "activeSessionApp": {
+          "additionalProperties": true,
+          "type": "object"
+        },
+        "artifacts": {
+          "items": {
+            "properties": {
+              "artifactType": {
+                "type": "string"
+              },
+              "field": {
+                "type": "string"
+              },
+              "fileName": {
+                "type": "string"
+              },
+              "localPath": {
+                "type": "string"
+              },
+              "path": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "field"
+            ],
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "chunks": {
+          "items": {
+            "additionalProperties": true,
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "durationMs": {
+          "type": "number"
+        },
+        "outPath": {
+          "type": "string"
+        },
+        "overlayWarning": {
+          "type": "string"
+        },
+        "recordOnlySession": {
+          "type": "boolean"
+        },
+        "recording": {
+          "const": "stopped",
+          "type": "string"
+        },
+        "recordingBackend": {
+          "type": "string"
+        },
+        "recordingScope": {
+          "type": "string"
+        },
+        "showTouches": {
+          "type": "boolean"
+        },
+        "telemetryPath": {
+          "type": "string"
+        },
+        "warning": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "recording",
+        "outPath",
+        "artifacts",
+        "durationMs",
+        "showTouches"
+      ],
+      "type": "object"
+    }
+  ],
+  "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"
+}

Changed4 schema fields changedv0.17.7Jun 23, 2026

addedInput schema / properties / maxSize
```
Added value: +{
+  "type": "integer"
+}
```

changedInput schema / properties / platform / enum

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

addedInput schema / properties / quality / enum
```
Added value: +[
+  "medium",
+  "high"
+]
```

changedInput schema / properties / quality / type

Previous value: -"integer"New value: +"string"

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.6/5.0

Behavior3/5

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

With no annotations, the description must carry the full burden of behavioral disclosure. It discloses a 90-second timeout, potential multiple video artifacts on Android, and HarmonyOS whole-screen recording support. However, it does not mention side effects like file storage, permissions, or what happens to existing recordings. The description provides some useful behavioral context but is not comprehensive, missing aspects like the effect of the 'stop' action or how output artifacts are delivered.

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?

The description is three sentences, concise and front-loaded with the primary purpose. It packs useful details (timeout, artifact behavior) without fluff. Each sentence earns its place, though the structure could be improved by separating the contact-sheet use case into a clearer secondary clause. Overall, it is efficient and well-sized.

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?

The tool has 22 parameters and an output schema, so return values are covered. The description provides essential behavioral context (timeout, multi-artifact, platform support) but does not guide the agent on how to choose between app vs device vs contact-sheet modes, nor does it explain the interplay of parameters like recordingScope or quality. Given the complexity, the description is adequate but leaves several usage details to the schema, making it somewhat incomplete for optimal agent guidance.

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 73%, so most parameters already have descriptions. The tool description adds little parameter-level meaning beyond hinting at device selection ('selected device') and platform-specific recording scope. It does not explain parameters like recordingScope, quality, fps, or hideTouches, but these are partially covered by the schema. Since coverage is high, the baseline is 3, and the description does not significantly elevate it.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose: start/stop a screen recording, and also build a contact-sheet PNG from an exported recording. It specifies the resource (active app session or selected device) and distinguishes from siblings like screenshot or snapshot by focusing on recording and contact-sheet generation. The verb 'Start or stop' and 'build' are specific and actionable, making the tool's role unambiguous.

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 description provides context about when to use the tool (for screen recordings or contact-sheets) but does not explicitly mention alternatives or exclusions. It does not state 'use this instead of screenshot when you need video' or similar. The mention of 'Long Android recordings can return multiple video artifacts' and 'HarmonyOS supports whole-screen recording' hints at platform considerations but does not guide selection among sibling tools. There is no explicit when-not guidance.

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

Deploy Server

record

Instructions

Input Schema

Output Schema

Schema Changelog

TDQS

Other Tools