Skip to main content
Glama

Get Checkpoint

get_checkpoint
Read-only

Read a checkpoint packet — the durable approval unit a held compose pauses at (wait_job reports awaiting_input with {checkpointId, stage, version}). Carries the stage artifact, presigned storyboard stills (REVIEW THE EVIDENCE, not raw JSON), critic verdicts, the money triple {thisStepUsd, jobSpendSoFarUsd, estimatedJourneyTotalUsd} to relay to your human, and the recorded decision once resolved. When the Brief's gates set reviewMode:'hosted' the packet also carries reviewUrl — a browser review page where your human decides directly (relay THAT link instead of raw stills; you learn the decision via checkpoint webhooks / wait_job). Answer an awaiting packet with resume(checkpointId, ...).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
checkpointIdYescheckpointId (path).

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNo
kindNo
quoteNo
stageNo
statusNo
briefIdNo
versionNo
artifactNoThe stage artifact under review: the locked ComposePlan at content; the composition wire shape at layout/motion; the judged composition snapshot on kind:'score'.
decisionNoThe recorded decision {decision, comments?, globalNote?, decidedAt} once resolved.
createdAtNo
projectIdNo
reviewUrlNoHosted review-page URL (present when reviewMode is 'hosted') — a human decides from this link, no account or agent session; the recorded decision rides the SAME resume rail, and the agent learns of it via checkpoint webhooks / wait_job.
stillUrlsNoPresigned storyboard/eval stills — the packet's visual evidence (may be GC'd by the retention sweep after the job goes terminal; the decision record is immortal).
updatedAtNo
reviewModeNoHow this packet is decided (from the Brief's gates). 'hosted' = the review PAGE captures the decision; absent/'agent' = the decision flows back through the driving agent.
composeJobIdNo
revisionCycleNoRevise cycles this gate has consumed. The brief quote states the included count (revisionCyclesIncluded); beyond it, resume(revise) is refused with a typed error.
criticVerdictsNoPer-criterion scores + critique from the design loop / judge, incl. lock_violation entries.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already establish readOnlyHint=true and openWorldHint=false, and the description adds substantial context beyond that: the contents of the packet (stage artifact, presigned stills, critic verdicts, money triple, reviewUrl) and the instruction to relay evidence rather than raw JSON. It stops short of describing pagination, expiry, or error behavior for an unresolvable checkpointId.

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 core definition and organised around what the packet contains and how to act on it. It is dense but a single long paragraph; the trailing webhook/wait_job clause restates how the decision is learned and could be trimmed.

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?

An output schema exists so return values need not be explained, yet the description's account of packet contents is what drives the agent's downstream behaviour (relaying the money triple and reviewUrl). Combined with the resume hand-off, the definition is complete enough to invoke and act on correctly.

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

Parameters4/5

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

Schema coverage is 100% and there is only one parameter whose schema description ('checkpointId (path).') is thin. The description compensates by explaining where checkpointId originates — the wait_job awaiting_input payload — which is meaning the schema itself does not carry.

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 ('Read a checkpoint packet') and defines what a checkpoint is — 'the durable approval unit a held compose pauses at' — which separates it cleanly from list_checkpoints and wait_job in the sibling set.

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?

Explicitly names the trigger condition ('when wait_job reports awaiting_input with {checkpointId, stage, version}') and the follow-up action ('Answer an awaiting packet with resume(checkpointId, ...)'). It also distinguishes hosted vs non-hosted review flows, leaving no ambiguity about when to call this versus its alternatives.

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.