Skip to main content
Glama
eloircorona

hledger-mcp

Get Budget

get_budget

Retrieve a budget report from your hledger journal, optionally filtered by period. Requires budget directives in the journal.

Instructions

Show budget report. Requires budget directives in the journal. Optionally filter by period.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
periodNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.6/5.0
Behavior3/5

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

With no annotations, the description carries the behavioral disclosure burden. The word 'Show' implies a read-only operation, and the prerequisite about budget directives adds important context about a dependency. It does not mention error behavior, output format details, or side effects, but for a simple read-only report this is a reasonable level of transparency.

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?

The description is two short sentences with no wasted words. The key action is front-loaded, and the prerequisite plus optional filter follow naturally, making it easy to parse and act on.

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?

This is a simple tool with one optional parameter and an output schema, so the description covers the essential usage context: what is shown, a prerequisite, and an optional filter. Minor gaps like period format are not critical for this level of complexity.

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?

The schema only defines 'period' without any parameter description, so the description's phrase 'Optionally filter by period' is valuable: it clarifies that the parameter acts as an optional filter. It does not specify the expected string format or allowed values, leaving some ambiguity for the agent.

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?

The description states the tool's function clearly: 'Show budget report' specifies a distinct action and resource. It is implicitly distinguishable from siblings like get_balance and get_register because it focuses on a budget-specific report, though it does not explicitly name alternatives.

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?

The description provides a useful prerequisite: 'Requires budget directives in the journal,' which helps the agent know when the tool is applicable. However, it does not explicitly explain when to prefer this tool over get_balance, get_register, or add_transaction, nor does it state exclusion conditions.

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

Deploy Server

Other Tools