Skip to main content
Glama

Retract a Ledger entry

ledger_entries_retract
Destructive

Takes an entry out of the curated ledger — THE remedy when you recorded something wrong (a decision that wasn't made, a duplicate, a fact the user corrects). Reversible from Ledger and fully audited, so it is safe to offer as soon as the user says 'that's not right'. Not for overturning a settled claim the team once believed — a human supersedes that. Fails with conflict if already retracted. Ids come from ledger_entries_list. May return needs_confirmation.

Input Schema

NameRequiredDescriptionDefault
entryIdYesThe entry to retract.
workspaceNoWorkspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalIdNoApproval id from a prior needs_confirmation envelope.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior3/5

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

Annotations already declare destructiveHint=true, readOnlyHint=false, and openWorldHint=false, so the description carries a lower burden. It still adds real value: reversibility, full audit trail, a conflict failure on double-retract, and a possible `needs_confirmation` return. However it does not disclose the permission model or what 'reversible from Ledger' technically requires, so it is additive but not exhaustive.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Five tight sentences, front-loaded with the primary use case before the exclusion, failure mode, id source, and return shape. Each sentence carries distinct information with no filler.

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?

No output schema exists, so the description compensates by flagging the `needs_confirmation` envelope, which is exactly the return behavior an agent needs. Combined with the conflict-on-retract failure mode and id sourcing, nothing required to call this tool correctly is missing.

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%, so the baseline is 3, but the description adds genuine meaning: it tells the agent where entryId comes from (ledger_entries_list) and links the `needs_confirmation` return to the approvalId parameter in the schema. That cross-reference is beyond what either the schema or annotations state.

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 and resource ('takes an entry out of the curated ledger') and immediately scopes it against siblings like ledger_entries_settle and ledger_entries_update by naming the exact error scenario it fixes. An agent can distinguish retract from settle/update 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?

Explicit when-to-use ('THE remedy when you recorded something wrong') with concrete examples, explicit when-not ('Not for overturning a settled claim the team once believed — a human supersedes that'), an urgency cue ('safe to offer as soon as the user says that's not right'), and the id source (ledger_entries_list). Every routing question is answered.

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.

Resources