Skip to main content
Glama

Preview Frame

preview_frame
Idempotent

Queue durable still-frame evidence for layout/copy judgment. Returns immediately with {jobId, kind:'preview_frame', status}; then call wait_job(kind="preview_frame", id=jobId) to receive every presigned frame as an image. The immutable snapshot records geometry, layers, warnings, and whether the target was persisted, inline, or session scratch. A still cannot prove motion — use preview_clip or preview_component for animation.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyYes
projectIdYesprojectId (path).

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
kindNoJob family, e.g. `verify` | `preview` | `brand_kit_extract`.
jobIdNoPoll GET /v1/jobs/{jobId} / wait_job until terminal.
jobKeyNoDeterministic identity of the work (content hash of every input the result depends on). Re-enqueueing the same key returns the same job while it runs; a failed key revives as a fresh attempt.
statusNorunning on a fresh/deduped enqueue; succeeded when an identical request already completed. Cancelled is part of the shared status vocabulary; identical cancelled work revives to running.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Beyond annotations (which only say non-destructive, idempotent, non-open-world), the description discloses that the call is asynchronous and returns immediately with a job handle, that the snapshot is immutable, and what the snapshot records (geometry, layers, warnings, persistence source). This is exactly the behavioral context the annotations cannot carry.

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?

Front-loaded with the action, then the return contract, the snapshot semantics, and finally the sibling exclusion. Every sentence is load-bearing, though the snapshot-contents sentence is dense enough that it borders on over-packing for a short description.

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

Completeness5/5

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

Covers the async handoff, the follow-up tool, and the alternative tools, and an output schema exists so return-value detail need not be duplicated here. Nothing an agent needs to invoke this correctly and consume the result is missing.

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?

The description adds no per-parameter guidance — nothing about timestamps batching, scale, image format, or composition selection — so the schema's own rich field descriptions do all the work. The only implied mapping is the 'persisted, inline, or session scratch' phrase touching on composition/session_id semantics. With ~50% declared coverage, this is an unambitious but adequate 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?

States a specific verb+resource ('queue durable still-frame evidence') plus the intent ('for layout/copy judgment'), and explicitly separates itself from preview_clip/preview_component for animation. An agent can route between the three preview tools without opening any schema.

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

Usage Guidelines5/5

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

Gives an explicit when-to-use ('layout/copy judgment'), an explicit when-not ('A still cannot prove motion'), and names the correct alternatives (preview_clip, preview_component). It also tells the agent the required follow-up call (wait_job with kind/id), so the workflow is not left to inference.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.