Skip to main content
Glama

flow.record_checkpoint

Record a runtime screen checkpoint from an Appium session, saving the current UI state and optional next action to document test progress and enable evidence-based verification.

Instructions

[workspace write][risk:write] Record a runtime screen checkpoint from Appium source/session and optional action needed to reach the next checkpoint.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYes
orderNo
prefixNo
sourceNo
testNameYes
serverUrlNo
sessionIdNo
sourcePathNo
actionToNextNo
checkpointIdNo
screenshotPathNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0-alpha.14

TDQS

C2.4/5.0
Behavior2/5

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

The inline '[workspace write][risk:write]' prefix is useful and the description indicates it records from an Appium source/session. However, with no formal annotations, the description does not disclose what files or state are persisted, whether an active Appium session is required, or how the optional actionToNext is stored and later used.

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 one front-loaded sentence and wastes no words. The 'source/session' phrasing is slightly ambiguous but the length and structure are appropriate for the high-level idea.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness1/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

A tool with 11 parameters, no parameter descriptions, no annotations, and no output schema needs a much richer description. This one provides only the high-level action and leaves the agent unable to determine how to construct a valid invocation beyond guessing the required names.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% and all 11 parameters are undocumented. The description vaguely maps to source/sessionId and actionToNext but does not explain required params testName/name or the meaning of order, prefix, serverUrl, sourcePath, checkpointId, and screenshotPath.

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 names a specific verb ('Record') and resource ('runtime screen checkpoint from Appium source/session') and adds the optional action-to-next concept. It is clearly a checkpoint-recording tool rather than a replay or verification tool, though it does not explicitly name the sibling it complements.

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

Usage Guidelines2/5

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

No when-to-use or when-not-to-use guidance is given. There is no mention of flow.replay_to_checkpoint, flow.record_test_run, or verify.assert_* as alternatives, so the agent must infer placement in a workflow from the tool name and context.

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