Skip to main content
Glama

Create checkpoint

checkpoint_create

Create labeled checkpoints to mark progress in a workspace by recording metadata for an existing snapshot.

Instructions

Record a named checkpoint for an existing snapshot id. This creates metadata only; restore is not implemented and snapshot existence is not validated yet.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
workspaceIdYes
snapshotIdYes
labelYes
taskIdNo
reasonNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
checkpointIdYes
workspaceIdYes
taskIdNo
snapshotIdYes
labelYes
reasonNo
createdAtYes
Behavior4/5

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

The description adds valuable behavioral context beyond annotations: 'metadata only', 'restore is not implemented', and 'snapshot existence is not validated yet'. These disclose significant behavioral traits not captured in annotations (readOnlyHint=false, destructiveHint=false), helping the agent understand side effects and constraints.

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 a single sentence that efficiently conveys the core purpose and key limitations. It is front-loaded with the main action. Could be slightly more structured, but overall concise and readable.

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?

Given the tool has 5 parameters (3 required) and an existing output schema, the description adequately covers purpose and behavioral constraints. However, it lacks context on prerequisites (e.g., workspace existence), error conditions, and how this checkpoint interacts with other tools (e.g., if future restore will use it).

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

Parameters2/5

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

With 0% schema description coverage, the description partially explains 'snapshotId' (existing snapshot id) and 'label' (named checkpoint), but omits workspaceId, taskId, and reason entirely. Two out of five parameters receive semantic context, which is insufficient for a schema-poor tool.

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 ('Record a named checkpoint'), the resource ('for an existing snapshot id'), and adds clarifying details that it is metadata-only and lacks restore/validation. This distinguishes it from sibling tools like snapshot_create (which creates snapshots) and task_* (task operations).

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 explicit guidance on when to use this tool versus alternatives. The description lists limitations (no restore, no validation) but does not specify typical usage contexts or when to prefer other tools like snapshot_create or task_*.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/majiayu000/workspaceguard-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server