Skip to main content
Glama
appium

MCP Appium

Official
by appium
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

appium_screen_recording

Start or stop screen recording for mobile app tests. Start begins capturing, stop retrieves and saves the video as MP4 on iOS or Android.

Instructions

Start or stop screen recording. action=start begins recording; action=stop stops and saves to MP4.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
actionYesstart begins recording; stop ends, retrieves, and saves it.
bitRateNoAndroid only. Video bit rate in bits per second.
videoFpsNoiOS only. Frames per second. Default: 10.
bugReportNoAndroid only. Display timestamp overlay. Requires API level 27+.
sessionIdNoSession ID; defaults to the active session.
timeLimitNoRecorder limit in seconds; it does not retrieve/save automatically, so call stop. iOS default 180/max 4200; Android default 180/max 1800.
videoSizeNoAndroid only. Frame size in WIDTHxHEIGHT format (e.g. 1280x720).
videoTypeNoiOS only. Video codec to use (e.g. libx264).
videoScaleNoiOS only. Width:height, each 1–16384 (e.g. 1280:720); one may be -1 or -2 to preserve aspect ratio.
pixelFormatNoiOS only. Output pixel format (e.g. yuv420p).
forceRestartNoRestart and discard any active recording; default false.
videoQualityNoiOS only. Video quality preset. Default: medium.
hardwareAccelerationNoiOS only. FFMPEG hardware acceleration backend.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 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."
    • removedInput schema / properties / videoFilters
      Removed value: -{
-  "description": "iOS only. FFMPEG video filters. Takes precedence over videoScale.",
-  "type": "string"
-}
    • changedInput schema / properties / videoScale / description
      Previous value: -"iOS only. Scaling value (e.g. 1280:720)."New value: +"iOS only. Width:height, each 1–16384 (e.g. 1280:720); one may be -1 or -2 to preserve aspect ratio."
    • addedInput schema / properties / videoScale / pattern
      Added value: +"^(?:[1-9]\\d{0,4}|-[12]):(?:[1-9]\\d{0,4}|-[12])(?![\\s\\S])"
  2. First observedv1.92.11

TDQS

A3.7/5.0
Behavior3/5

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

The description adds the useful behavioral fact that stopping the recording saves it as an MP4, which goes beyond the readOnlyHint=false annotation. However, it does not disclose stateful concerns like the need to pair start with stop, what happens if a recording is already active, or where the file is saved.

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 two short sentences with no filler. It front-loads the core purpose and then gives the action-level mechanics, making it easy to scan and process.

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 description is adequate for a basic understanding, and the schema supplies rich parameter detail. However, for a 13-parameter tool with no output schema, it leaves lifecycle behavior, return values, and platform considerations implicit, so an agent gets only partial context.

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 13 parameters. The description mostly restates the action parameter's meaning ('action=start begins recording; action=stop stops and saves to MP4') without adding extra semantics for the platform-specific parameters.

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 states a specific verb and resource: start or stop screen recording. It also gives the concrete outcome for stop ('saves to MP4'), which clearly distinguishes this video-capture tool from sibling tools like appium_screenshot.

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?

The action values make the basic usage clear, but there is no explicit guidance about when to choose this tool over alternatives, nor any documented prerequisites such as an active session or a started recording. Usage is implied rather than stated.

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