Skip to main content
Glama

Inspect, press, or dismiss the device keyboard

keyboard
Destructive

Read the on-screen input state, dismiss it, or send Return to the focused field so agents can verify and complete form entries.

Instructions

status (alias get) reads the keyboard state; a visible keyboard reports returnKey and its label. Unreadable Apple keyboard state reports OBSERVATION_UNAVAILABLE. Enter (alias return) sends Return to the focused input; it may submit, move focus, or insert a newline, and unconfirmed delivery reports keyboard_return_unavailable with dispatched: unknown (Return may have landed). On the native iOS runner, dismiss is a no-op when the keyboard is hidden; a visible keyboard returns keyboard_dismiss_unavailable with dispatched: no. When Return would submit or finish the edit (search, go, done, send), that refusal names keyboard enter. Press the visible Hide Keyboard key or an app control that ends editing, or gesture pan down from the scrollable content with interactive dismissal, and verify with status. Android dismiss sends platform dismissal. 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": "keyboard"
  }
}

Input Schema

NameRequiredDescriptionDefault
udidNoApple device or simulator UDID.
actionNo
deviceNoDevice name; ids go in udid or serial.
serialNoAndroid, HarmonyOS, or Vega VVD serial.
sessionNoSession name.
noRecordNoDo not record this action.
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: -{
      -  "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"
      -}New value: +null
  3. 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."
  4. 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"
      -}
  5. 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"
      +]
  6. 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."
  7. 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"
      +}
  8. 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"
      +]
  9. 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"
      +]
  10. First observedv0.16.9

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already flag the write/destructive profile, and the description goes well beyond them: the 90s timeout, the failure sentinels (OBSERVATION_UNAVAILABLE, keyboard_dismiss_unavailable, keyboard_return_unavailable), the dispatched: unknown/no semantics, and the native-iOS no-op case. The one gap is that it never explains why Return is destructive beyond a brief 'may submit'.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Almost every sentence carries real information, but the paragraph is a dense run-on that mixes three actions, two platforms, and several error codes without breaks or headers. Front-loading works for status and enter, but the dismiss/alternatives guidance is buried at the end.

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?

For an 8-parameter mutation tool with no output schema, it covers the important runtime facts: timeout, failure modes, platform divergence, and remediation paths. It does not say which device-identifier parameters are required for which platform, leaving that to the schema.

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 88%, so the schema already documents udid, platform, serial, session, and the rest. The description contributes only the action-value aliases (get, return) and the platform-specific behavior of dismiss on iOS versus Android, which is modest added meaning. Baseline 3 is appropriate.

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 opening clause enumerates the actual operations behind the generic name 'keyboard': status/get reads state, enter/return sends Return, dismiss closes it. That is a specific verb+resource statement an agent can act on. It does not cleanly separate itself from the sibling 'get' tool, which the 'status (alias get)' phrasing arguably muddies.

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

Usage Guidelines4/5

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

It gives real when-to guidance inside the dismiss paragraph: use the visible Hide Keyboard key, an app control that ends editing, or a pan-down gesture, then confirm with status. It also routes the agent to 'keyboard enter' when a dismissal refusal actually means the Return would submit. It stops short of stating when to prefer press/gesture/keyboard outright.

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