Skip to main content
Glama
callstack

agent-device

Official
by callstack
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

install

Install an app binary from a local path, optionally specifying an app identifier to target a specific app, and use reinstall to replace an existing installation.

Instructions

Install an app binary from a local path. Provide an app identifier with the path when the target needs explicit app selection; use reinstall to replace an already installed app. Times out after 180s.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
appNoOptional app identifier hint.
udidNoApple device or simulator UDID; the selector that pins one device when several share a name.
debugNoEnable debug diagnostics.
runIdNoLease run identifier.
deviceNoDevice name selector (a UDID belongs in udid, a serial in serial).
serialNoAndroid, HarmonyOS, or Vega VVD serial selector.
targetNoAlias for deviceTarget on commands without a UI target field. Interaction commands reserve target for the UI element.
tenantNoRemote tenant identifier.
appPathYesPath to app binary.
leaseIdNoExisting lease identifier.
sessionNoAgent-device session name.
noRecordNoDo not record this action.
platformNoPlatform selector used to resolve a device.
includeCostNoInclude per-command agent-cost (cost.wallClockMs, …) in structuredContent. Defaults to off; the default response shape is unchanged.
deviceTargetNoDevice target form. Maps to the CLI --target flag.
responseLevelNoResponse verbosity: token-cheap digest / default (today) / full. Defaults to default; the default response shape is unchanged.
mcpOutputFormatNoMCP text content format. Defaults to optimized agent-friendly text; use json for JSON text. Structured content is always returned separately.
androidDeviceAllowlistNoAndroid serial allowlist used for device resolution.

Schema Changelog

Changes observed during successful MCP inspections.

  1. 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."
  2. 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"
-}
  3. 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"
+]
  4. Changed3 schema fields changedv0.20.2
    • 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"
+]
    • changedInput schema / properties / serial / description
      Previous value: -"Android serial selector."New value: +"Android device or Vega VVD serial selector."
  5. Changed5 schema fields changedv0.17.11
    • addedInput schema / properties / app / description
      Added value: +"Optional app identifier hint."
    • 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 / required
      Previous value: -[
-  "app",
-  "appPath"
-]New value: +[
+  "appPath"
+]
  6. 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"
+]
  7. 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"
+]
  8. First observedv0.16.9

TDQS

A4.4/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It discloses a 180s timeout, which is a behavioral detail. However, it does not state whether the install overwrites an existing app, what happens on failure, or any required permissions. The mutation nature is implicit, but there's limited additional transparency beyond the timeout.

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?

The description is two sentences with no wasted words. It front-loads the purpose, then provides usage guidance and a timeout note. Every sentence earns its place, making it concise and well-structured.

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?

Given the absence of an output schema and the full schema coverage of parameters, the description covers the core operation, directs to reinstall for replacement, and notes the timeout. It does not specify behavior when the app is already installed, but that is handled by the reinstall reference. The description is sufficiently complete for an install command, though it could mention failure handling or overwrite behavior.

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

Parameters4/5

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

Schema description coverage is 100%, so the baseline is 3. The description adds meaning to two parameters: it clarifies that 'app' is an identifier (via 'Provide an app identifier') and that 'appPath' is a local path (via 'from a local path'). This provides additional context beyond the schema, though it doesn't elaborate on the other 16 parameters. Given the high schema coverage, the description compensates adequately.

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: 'Install an app binary from a local path.' It uses a specific verb ('Install'), resource ('app binary'), and source ('local path'). It differentiates from the sibling 'reinstall' by explicitly stating 'use reinstall to replace an already installed app,' which helps an agent distinguish between the two.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description gives explicit usage guidance: it tells the agent to provide an app identifier when explicit app selection is needed, and directs to 'reinstall' when replacing an already installed app. This clearly indicates when to use this tool versus the alternative. It also mentions the 180s timeout, which is useful context.

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

Deploy Server

Other Tools