Skip to main content
Glama

Beancount.io

Rename Ledger File

renameLedgerFile
Idempotent

Move oldPath to newPath preserving content in one atomic commit. Refuses when oldPath is still included unless updateIncludes rewrites those lines in the same commit. Pinned credentials can omit ledger. dry_run previews without committing.

Input Schema

NameRequiredDescriptionDefault
dryRunNoAlias of dry_run, as REST and GraphQL spell it.
ledgerNoTarget ledger as owner/name. Required for an unpinned credential; defaults to the credential's ledger restriction.
dry_runNoRun every check and return the preview without committing
messageNo
newPathYes
oldPathYes
descriptionNoAlias of message, as the MCP file tools spell it.
updateIncludesNo

Output Schema

NameRequiredDescriptionDefault
okYes
errorNo
resultNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changed
    • addedInput schema / properties / description
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "Alias of message, as the MCP file tools spell it."
      +}
    • addedInput schema / properties / dryRun
      Added value: +{
      +  "description": "Alias of dry_run, as REST and GraphQL spell it.",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / dry_run
      Added value: +{
      +  "description": "Run every check and return the preview without committing",
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / result / properties / dry_run
      Added value: +{
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / result / properties / message
      Added value: +{
      +  "type": "string"
      +}
    • addedOutput schema / properties / result / properties / preview
      Added value: +{
      +  "description": "Per-file rewritten include lines; populated on dry runs only.",
      +  "items": {
      +    "additionalProperties": false,
      +    "properties": {
      +      "path": {
      +        "type": "string"
      +      },
      +      "text": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "path",
      +      "text"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • changedOutput schema / properties / result / required
      Previous value: -[
      -  "summary",
      -  "oldPath",
      -  "newPath",
      -  "updatedIncludes",
      -  "wrote",
      -  "entryHashes",
      -  "validation"
      -]New value: +[
      +  "summary",
      +  "message",
      +  "oldPath",
      +  "newPath",
      +  "updatedIncludes",
      +  "preview",
      +  "dry_run",
      +  "wrote",
      +  "entryHashes",
      +  "validation"
      +]
  2. First observed

TDQS

A4.3/5.0
Behavior5/5

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

Adds substantial behavior beyond the annotations: atomicity of the commit, the refusal condition tied to include directives, the coupling with updateIncludes, the credential-pinned ledger omission rule, and the dry_run preview path. This is exactly the kind of operational context an agent needs before a mutation.

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?

Four short sentences, front-loaded with the core action, followed by refusal semantics, credential nuance, and preview mode. No filler or repetition.

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?

With 8 parameters, 50% schema coverage, and an output schema present, the description covers the behaviorally significant facts an agent needs. The only gap is the alias duplication (dryRun/dry_run, message/description), which could cause confusion but is at least documented in the schema.

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 only 50%, but the description carries the important semantics: updateIncludes exists to rewrite include lines in the same commit, ledger can be omitted for pinned credentials, and dry_run previews. It does not address the message/description and dryRun/dry_run alias pairs, which the schema alone documents.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb (move/rename) and resource (oldPath → newPath) with the key constraint that content is preserved in one atomic commit. This clearly separates it from deleteLedgerFiles or updateLedgerFiles, though no sibling is named explicitly.

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

Usage Guidelines4/5

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

Gives concrete conditional guidance: it refuses when oldPath is still `include`d unless updateIncludes rewrites those lines, and dry_run previews without committing. No explicit alternative-tool routing, but the preconditions are clear enough to select it confidently.

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.