Skip to main content
Glama
appium

MCP Appium

Official
by appium
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

appium_driver_settings

Retrieve or modify Appium driver session settings, such as idle timeouts and selector waits, to fine-tune test behavior.

Instructions

Read or update Appium driver session settings (e.g. idle timeouts, selector waits). Use action=get to return JSON settings; action=update merges a map into the session. Works for embedded UiAutomator2/XCUITest sessions and remote WebDriver clients that support Appium settings.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
actionYesget: read current Appium driver session settings (timeouts, selector waits, flags). update: merge a settings map into the session (requires settings).
settingsNoRequired when action is update. Driver-specific keys (e.g. Android UiAutomator2: waitForIdleTimeout, waitForSelectorTimeout, ignoreUnimportantViews; iOS XCUITest has its own set). Use action=get first to inspect current values.
sessionIdNoSession ID; defaults to the active session.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.95.0
    • changedInput schema / properties / sessionId / description
      Previous value: -"Session ID to target. If omitted, uses the active session."New value: +"Session ID; defaults to the active session."
    • changedInput schema / properties / settings / additionalProperties
      Previous value: -falseNew value: +{}
  2. First observedv1.92.11

TDQS

A3.8/5.0
Behavior3/5

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

Annotations provide no real behavioral cover beyond readOnlyHint=false, so the description carries the burden. It usefully reveals that get returns JSON settings and update merges a map into the session, but it does not describe update response behavior, side effects, or failure cases. This is adequate but not rich.

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?

Two sentences with no filler: the first front-loads the tool's purpose and action modes, and the second scopes supported client types. Every sentence earns its place.

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 a moderately simple settings tool, the description covers the main operational distinctions: reading vs. updating, merge semantics, and supported session types. Since there is no output schema, it could have specified what update returns, but the core usage is complete enough for an agent to invoke the tool correctly.

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%, so the schema already documents all parameters. The description adds some useful context by naming typical settings keys and explaining the get/update split, but it does not significantly compensate beyond the schema's own detailed parameter descriptions.

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 uses a specific verb-resource pair ('Read or update Appium driver session settings') with concrete examples like idle timeouts and selector waits. It is clearly distinct from the sibling tools by targeting driver session settings, though it does not explicitly name or differentiate itself from a sibling.

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?

The description gives explicit action-level guidance: use action=get to read settings and action=update to merge a settings map. It also clarifies supported session types (embedded UiAutomator2/XCUITest and remote WebDriver clients), which helps an agent decide when this tool applies.

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