Skip to main content
Glama

keyboard

Inspect Android soft-input visibility and type, or dismiss the on-screen input by tapping its hide key; reports when no dismiss key exists. Verifies closure and times out after 90 seconds.

Instructions

Inspect Android keyboard visibility/type or press/dismiss the device keyboard. To hide the keyboard, use keyboard dismiss. It taps the keyboard dismiss/hide key when one is exposed, verifies the keyboard closed, and reports UNSUPPORTED_OPERATION when no dismiss key exists — background taps are never attempted. Times out after 90s.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
udidNoApple device or simulator UDID; the selector that pins one device when several share a name.
debugNoEnable debug diagnostics.
runIdNoLease run identifier.
actionNo
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.
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.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
typeNo
actionYes
messageNo
visibleNo
attemptsNo
platformYes
dismissedNo
inputTypeNo
inputOwnerNo
wasVisibleNo
focusedPackageNo
focusedResourceIdNo
inputMethodPackageNo

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. Changed2 schema fields changedv0.20.9
    • changedInput schema / properties / action / enum
      Previous value: -[
      -  "status",
      -  "dismiss"
      -]New value: +[
      +  "status",
      +  "dismiss",
      +  "enter",
      +  "return"
      +]
    • 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. 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: +{
      +  "properties": {
      +    "action": {
      +      "enum": [
      +        "status",
      +        "dismiss",
      +        "enter"
      +      ],
      +      "type": "string"
      +    },
      +    "attempts": {
      +      "type": "number"
      +    },
      +    "dismissed": {
      +      "type": "boolean"
      +    },
      +    "focusedPackage": {
      +      "type": "string"
      +    },
      +    "focusedResourceId": {
      +      "type": "string"
      +    },
      +    "inputMethodPackage": {
      +      "type": "string"
      +    },
      +    "inputOwner": {
      +      "enum": [
      +        "app",
      +        "ime",
      +        "unknown"
      +      ],
      +      "type": "string"
      +    },
      +    "inputType": {
      +      "type": "string"
      +    },
      +    "message": {
      +      "type": "string"
      +    },
      +    "platform": {
      +      "enum": [
      +        "android",
      +        "ios"
      +      ],
      +      "type": "string"
      +    },
      +    "type": {
      +      "enum": [
      +        "text",
      +        "number",
      +        "email",
      +        "phone",
      +        "password",
      +        "datetime",
      +        "unknown"
      +      ],
      +      "type": "string"
      +    },
      +    "visible": {
      +      "type": "boolean"
      +    },
      +    "wasVisible": {
      +      "type": "boolean"
      +    }
      +  },
      +  "required": [
      +    "platform",
      +    "action"
      +  ],
      +  "type": "object"
      +}
  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

A3.6/5.0
Behavior4/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 key behaviors for dismiss: taps the dismiss key, verifies closure, reports UNSUPPORTED_OPERATION when no dismiss key exists, never attempts background taps, and times out after 90s. This is strong for one action, but other actions (status, enter, return) are not behaviorally disclosed, so it's not complete.

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 a compact three-sentence block that front-loads the purpose and then details the dismiss behavior. There is no fluff, and every sentence contributes something. The structure is logical: purpose, usage hint, behavioral specifics.

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 output schema exists, so return values are presumably covered. However, the tool has 17 parameters and 6 enums, and the description only explains the dismiss action in detail. It doesn't cover the status, enter, or return actions, nor does it mention platform nuances (e.g., whether it works on iOS despite saying Android). This leaves gaps for an agent to call it correctly across all actions.

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 coverage is 94%, so the schema already documents most parameters. The description adds value by explaining the 'dismiss' action's semantics (taps dismiss key, verifies, etc.), which the schema's enum values don't describe. However, it doesn't clarify the meaning of 'status', 'enter', or 'return', so it only partially compensates for the undocumented enum semantics.

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 clear verb-resource relationship: inspect or press/dismiss the keyboard. It is specific about the Android platform and distinguishes itself from generic tools like 'type' or 'click'. However, it doesn't fully disambiguate between the 'status' and 'enter' actions, so it's not perfect.

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?

It explicitly says 'To hide the keyboard, use keyboard dismiss', giving a concrete when-to-use for one action. But it doesn't provide guidance for when to use 'status', 'enter', or 'return', nor does it contrast with alternative tools like 'type' or 'keyboard' siblings. This is partial guidance at best.

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