Skip to main content
Glama

Commit Checkpoint

commit_checkpoint
Idempotent

Commit an approved checkpoint draft after explicit user approval. Use after verifying the draft via checkpoint or review_pending.

Instructions

Use when: Human review tool: commit the exact reviewed draft after explicit user approval of the checkpoint commit. Tool-execution approval or content approval is not commit approval. Bind approvalEvidence to the server draft digest returned by checkpoint or review_pending. Do not use when: a narrower tool better matches the intent, the project scope is unresolved, or the user has declined the action. Requires: authenticated API authority. Effect: canonical mutation. For the same logical mutation retry, reuse the same idempotencyKey. If the payload or user intent changes, use a new key. Replay returns the first canonical result ID and version; the key never bypasses authorization or expected-version checks. Human approval: required before this action or its canonical follow-up. Then: follow typed result state; review pending proposals/drafts before any canonical apply. On failure: login_required → login; project_not_selected → list_projects/select_project; permission_denied → stop; stale_version or conflict → read current state; projection_pending → report canonical success separately and wait.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
reasonYesShort reason describing what the user approved.
confirmedNoMust be true after the user explicitly approves committing this checkpoint.
checkpointIdYesCheckpoint draft id returned by checkpoint or review_pending.
idempotencyKeyYes
contractVersionYes
approvalEvidenceYes
expectedCheckpointDigestYesServer-issued draftDigest from checkpoint or review_pending.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataYes
statusYes
warningsYes
authorityYes
projectIdYes
reviewUrlYes
idempotencyYes
nextActionsYes
reviewRequiredYes
canonicalVersionYes
projectionStatusYes
Behavior5/5

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

Annotations indicate readOnlyHint=false, idempotentHint=true, destructiveHint=false. The description adds crucial context: 'canonical mutation', idempotency behavior ('reuse the same idempotencyKey', 'replay returns the first canonical result ID and version'), and human approval requirement. No contradiction with annotations.

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 structured with clear 'Use when', 'Do not use when', 'Requires', 'Effect', 'Human approval', 'Then', 'On failure' sections. It is front-loaded and every sentence adds value, though slightly lengthy for a simple tool.

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?

Given the tool complexity (7 params, nested objects, output schema exists), the description covers approval flow, idempotency, failure modes, prerequisites, and follow-up actions. It is comprehensive without needing to detail return values since output schema is provided.

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?

With 57% schema coverage, the description adds value by explaining idempotencyKey reuse policy and binding approvalEvidence to server draft digest. While some parameters still lack detailed explanation, the description compensates well for the gap.

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 purpose: 'commit the exact reviewed draft after explicit user approval of the checkpoint commit.' It distinguishes itself from siblings like 'checkpoint' and 'discard_checkpoint' by focusing on the commit action after human review.

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?

The description explicitly says 'Do not use when: a narrower tool better matches the intent, the project scope is unresolved, or the user has declined the action.' It also provides guidance on idempotencyKey reuse and human approval requirements, giving clear when-to-use and when-not-to-use context.

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/my-abyss-project/abyss-mcp'

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