Skip to main content
Glama

Show the foreground app and activity

appstate

Reveals the foreground app or activity on Android, HarmonyOS, iOS, and macOS devices, so agents can confirm which app is currently active before acting.

Instructions

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

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "appstate"
  }
}

Input Schema

NameRequiredDescriptionDefault
udidNoApple device or simulator UDID.
deviceNoDevice name; ids go in udid or serial.
serialNoAndroid, HarmonyOS, or Vega VVD serial.
sessionNoSession name.
platformNoDevice platform.
deviceTargetNoDevice form factor.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv0.21.38
    • removedInput schema / properties / debug
      Removed value: -{
      -  "description": "Enable debug diagnostics.",
      -  "type": "boolean"
      -}
    • removedInput schema / properties / includeCost
      Removed value: -{
      -  "description": "Add agent cost (cost.wallClockMs, …) to the result, returned as JSON text.",
      -  "type": "boolean"
      -}
    • removedInput schema / properties / mcpOutputFormat
      Removed value: -{
      -  "description": "Result text: compact optimized (default) or the full result as JSON (larger).",
      -  "enum": [
      -    "optimized",
      -    "json"
      -  ],
      -  "type": "string"
      -}
    • removedInput schema / properties / responseLevel
      Removed value: -{
      -  "description": "Result detail: digest (smallest) or full (largest), as JSON; default is compact text.",
      -  "enum": [
      -    "digest",
      -    "default",
      -    "full"
      -  ],
      -  "type": "string"
      -}
    • removedInput schema / properties / target
      Removed value: -{
      -  "description": "Alias for deviceTarget.",
      -  "enum": [
      -    "mobile",
      -    "tv",
      -    "desktop"
      -  ],
      -  "type": "string"
      -}
  2. Changed15 schema fields changedv0.21.37
    • removedInput schema / properties / androidDeviceAllowlist
      Removed value: -{
      -  "description": "Android serial allowlist used for device resolution.",
      -  "type": "string"
      -}
    • changedInput schema / properties / device / description
      Previous value: -"Device name selector (a UDID belongs in udid, a serial in serial)."New value: +"Device name; ids go in udid or serial."
    • changedInput schema / properties / deviceTarget / description
      Previous value: -"Device target form. Maps to the CLI --target flag."New value: +"Device form factor."
    • changedInput schema / properties / includeCost / description
      Previous value: -"Include per-command agent-cost (cost.wallClockMs, …) in structuredContent. Defaults to off; the default response shape is unchanged."New value: +"Add agent cost (cost.wallClockMs, …) to the result, returned as JSON text."
    • removedInput schema / properties / leaseId
      Removed value: -{
      -  "description": "Existing lease identifier.",
      -  "type": "string"
      -}
    • changedInput schema / properties / mcpOutputFormat / description
      Previous value: -"MCP text content format. Defaults to optimized agent-friendly text; use json for JSON text. Structured content is always returned separately."New value: +"Result text: compact optimized (default) or the full result as JSON (larger)."
    • changedInput schema / properties / platform / description
      Previous value: -"Platform selector used to resolve a device."New value: +"Device platform."
    • changedInput schema / properties / responseLevel / description
      Previous value: -"Response verbosity: token-cheap digest / default (today) / full. Defaults to default; the default response shape is unchanged."New value: +"Result detail: digest (smallest) or full (largest), as JSON; default is compact text."
    • removedInput schema / properties / runId
      Removed value: -{
      -  "description": "Lease run identifier.",
      -  "type": "string"
      -}
    • changedInput schema / properties / serial / description
      Previous value: -"Android, HarmonyOS, or Vega VVD serial selector."New value: +"Android, HarmonyOS, or Vega VVD serial."
    • changedInput schema / properties / session / description
      Previous value: -"Agent-device session name."New value: +"Session name."
    • changedInput schema / properties / target / description
      Previous value: -"Alias for deviceTarget on commands without a UI target field. Interaction commands reserve target for the UI element."New value: +"Alias for deviceTarget."
    • removedInput schema / properties / tenant
      Removed value: -{
      -  "description": "Remote tenant identifier.",
      -  "type": "string"
      -}
    • changedInput schema / properties / udid / description
      Previous value: -"Apple device or simulator UDID; the selector that pins one device when several share a name."New value: +"Apple device or simulator UDID."
    • changedOutput schema / (root)
      Previous 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": {
      -          "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"
      -    }
      -  ],
      -  "type": "object"
      -}New value: +null
  3. Changed1 schema field changedv0.21.27
    • 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"
      +  }
      +]
  4. Changed1 schema field changedv0.21.15
    • 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"
      +  }
      +]
  5. 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."
  6. 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"
      -}
  7. 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"
      +]
  8. Changed2 schema fields changedv0.20.2
    • 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."
  9. Changed4 schema fields changedv0.17.11
    • 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"
      +}
  10. 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"
      +]
  11. 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"
      +]
  12. First observedv0.16.9

TDQS

A3.6/5.0
Behavior4/5

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

Beyond the annotations, the description contributes two genuinely useful behavioral facts: platform-specific fidelity (Android/HarmonyOS query live, iOS/macOS only answer per session) and a 90-second timeout. Those are the kind of operational details an agent cannot get from the schema. The only tension is that a 'Show' operation is annotated readOnlyHint=false, which the text does not explain, though that may reflect device/session interaction rather than a real contradiction.

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 tight sentences with the capability statement front-loaded and the operational caveats immediately after. The parenthetical 'iOS and macOS answer per session' is compact but slightly cryptic, which keeps it from a 5.

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?

For a zero-required-parameter query tool with a fully documented schema, the essentials are covered. But there is no output schema, and the description never indicates what 'showing' returns (app name, bundle identifier, activity string?), leaving the agent to guess at the response shape.

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% across all six device-targeting parameters, so the schema already carries parameter meaning and the description is not obligated to restate it. However, the description never mentions targeting at all, so it adds nothing on top of the schema. Baseline 3 applies.

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?

Names a specific verb and resource ('Show foreground app/activity') so an agent knows exactly what the call reports. It also scopes applicability by platform (Android and HarmonyOS live; iOS/macOS per session). It does not distinguish itself from siblings such as app-switcher or apps, which keeps it below a 5.

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?

Usage is implied rather than stated: an agent can infer it should call this when it needs to know what is currently on screen. There is no explicit when-not-to-use or alternative named, even though app-switcher and apps exist and could plausibly serve overlapping needs.

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