Skip to main content
Glama
hs737

MCP Server for YNAB

by hs737

Category groups — Summary by month

category_groups_summary_by_month
Read-only

Retrieve monthly totals of budgeted, activity, and balance by category group to check budget health at group level.

Instructions

[READ] Per-group, per-month totals of budgeted, activity and balance. Most 'is this budget healthy' questions live at group level, and a group view is small enough to read whole where a category view is not. from_month and to_month: 'YYYY-MM', an ISO date, or 'current'. to_month defaults to the current month. Hidden categories are included by default here, because excluding them would silently drop the credit-card payment group; pass include_hidden=false to leave them out. Amounts are in milliunits (1000 = $1.00). Costs one YNAB request per month in the range (limit 36 months); check overview_request_budget before a long range.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
plan_idNo
to_monthNo
from_monthYes
include_hiddenNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.0

TDQS

A4.9/5.0
Behavior5/5

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

Annotations already declare readOnly/non-destructive, but the description adds substantial non-obvious context: hidden categories are included by default and why (dropping the credit-card payment group), milliunits convention, and the cost model (one request per month, 36-month cap). This is behavior an agent cannot get from the schema or annotations.

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?

Front-loads a [READ] tag and the core purpose, then layers format, defaults, cost. Every sentence earns its place with no filler; density is high but not padded.

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?

An output schema exists so return values needn't be described; given the tool's complexity, the description covers inputs, defaults, units, cost limits and sibling relationship. Nothing essential to a correct call 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?

With 0% schema description coverage the description must carry parameters, and it does for three of four: from_month/to_month accept 'YYYY-MM', ISO date, or 'current', to_month defaults to current month, and include_hidden defaults true with a rationale. Only plan_id is left unexplained.

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?

State a precise verb+resource: per-group, per-month totals of budgeted, activity and balance. It explicitly contrasts with a category-level view ('a group view is small enough to read whole where a category view is not'), so an agent can distinguish it from sibling aggregation tools.

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?

Names the question class it serves ('is this budget healthy' at group level), states the default for to_month, and warns to check overview_request_budget before a long range. It routes the agent toward the right scenario and away from costly misuse.

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