Skip to main content
Glama
appium

MCP Appium

Official
by appium

appium_mobile_file

Transfer files to or from mobile devices using Appium extensions. Push uploads base64-encoded content to a device path; pull downloads a remote file and returns its base64 data.

Instructions

Push or pull a file using Appium mobile extensions. action=push uses payloadBase64, action=pull returns contentBase64.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
actionYespush uploads a file to device; pull downloads from device.
sessionIdNoSession ID; defaults to the active session.
remotePathYesPath to the file on the device. Android (UiAutomator2): use an absolute path (e.g. /data/local/tmp/foo.txt or /sdcard/Download/foo.txt). iOS (XCUITest): use the formats described in the Appium XCUITest file transfer guide (e.g. @com.example.app:documents/file.txt or simulator-relative paths).
payloadBase64NoRequired when action=push. Ignored when action=pull.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field 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."
  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 show readOnlyHint=false, indicating mutation, which aligns with the push action. The description adds the action-to-payload mapping (push uses payloadBase64, pull returns contentBase64) but does not disclose side effects like file overwriting or failure conditions. It provides some context but is not comprehensive.

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 a single, front-loaded sentence that states the purpose and the key action-to-payload behavior with zero waste. It is efficient and immediately actionable.

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 tool with four parameters and no output schema, the description covers the core behavior and return format for pull. The schema handles platform-specific paths and parameter requirements, so the description is adequate for correct invocation, though it omits error handling and side-effect details.

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 in detail, including platform-specific remotePath formats. The description only restates the action-payload relationship already present in the schema, adding no extra semantic value beyond the baseline.

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 action ('push or pull a file') and the specific Appium mobile extensions, making it distinct from other appium_* tools like screenshot or clipboard. It names the resource and the operation precisely, avoiding tautology.

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 by the tool's purpose, but the description does not explicitly state when to choose this over alternatives or provide any exclusion criteria. Since it is the only file-transfer tool among siblings, the choice is obvious, yet the guidance is not explicit.

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