Skip to main content
Glama
mathbeal

avenir-mcp

Category balances for a month

get_category_balances
Read-onlyIdempotent

Retrieve budgeted, spent, and available amounts per category for a month to see where money went and what's left.

Instructions

Budgeted, spent (activity) and available (balance) per category for a month.

Amounts in currency units; activity is negative for spending. Hidden and internal categories are left out, and so are categories with nothing budgeted, spent or available unless include_empty is true. Use get_budget_vs_actual for the share of each budget consumed.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
monthNo'YYYY-MM-01' or 'current'.current
plan_idYesYNAB plan id or 'last-used'.
include_emptyNoAlso list categories with no amount at all.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/openWorld, but the description adds real behavioral context beyond them: amounts are in currency units, activity is negative for spending, and hidden/internal or empty categories are silently excluded unless include_empty is set. That sign convention and default-filter disclosure materially affect how an agent interprets results.

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 resource and its three metrics, then filtering rules, then the sibling hand-off. No filler and nothing repeated from the schema.

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?

With an output schema present and rich annotations, the description does not need to explain return shape; it still covers units, sign convention, default exclusions and the alternative tool. Nothing needed to invoke or interpret it correctly is missing.

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 the schema already documents month, plan_id and include_empty, making 3 the baseline. The description reinforces include_empty's effect and the currency/sign semantics of returned amounts but adds no new parameter syntax or format detail beyond the schema.

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 states exactly what is returned (budgeted, spent/activity, available/balance per category) and scopes it to a month. It also names the sibling get_budget_vs_actual and the distinction that selects it, so an agent can tell the two apart without opening either schema.

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?

It explicitly routes the agent elsewhere ('Use get_budget_vs_actual for the share of each budget consumed') and discloses the default filtering behavior (hidden/internal categories and zero-amount categories omitted unless include_empty). It stops short of stating when this tool is the right first choice versus other summary tools like get_monthly_summary or get_spending_trends.

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