Skip to main content
Glama

Beancount.io

List Ledger Files & Directories

listLedgerFiles
Read-onlyIdempotent

List files and directories in the ledger repo, one directory level at a time, directories first.

Input Schema

NameRequiredDescriptionDefault
ledgerNoTarget ledger as owner/name. Required for an unpinned credential; defaults to the credential's ledger restriction.
dir_pathNoDirectory path to list. Omit for root; '.' is also accepted.

Output Schema

NameRequiredDescriptionDefault
okYes
errorNo
resultNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already cover safety (readOnly, idempotent, non-destructive, closed-world), and the description adds genuinely new behavioral facts: the listing is non-recursive and results are ordered directories-first. Neither trait is derivable from the annotations or schema, and both affect how an agent must loop through the tree. No pagination or empty-directory behavior is described.

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?

A single tightly packed sentence with zero filler, front-loading the core action and appending the two constraints that matter most (depth and ordering).

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?

For a read-only, zero-required-parameter listing tool with a full output schema and rich annotations, the description supplies the key missing context (non-recursive depth, sort order). Minor gaps — behavior on a nonexistent path, large-directory handling — are not covered but are not essential to calling it correctly.

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

Parameters3/5

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

Schema description coverage is 100%, so both parameters (ledger, dir_path) are already documented including the root/'.' convention. The description contributes only the implied notion that dir_path selects a single level; baseline 3 applies.

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 concrete verb and resource ('List files and directories in the ledger repo') plus scope ('one directory level at a time') and ordering ('directories first'). The listing-versus-reading distinction from siblings like readLedgerFiles is implied by 'List' but 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 Guidelines3/5

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

'One directory level at a time' implies an iterative navigation workflow, which is useful guidance for traversal, but there is no explicit statement of when to use this versus readLedgerFiles or how to recurse into a listing. Usage is inferable rather than stated.

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.