Skip to main content
Glama
YNAB MCP Server

YNAB MCP Server

by oliverames

Get Month

get_month
Read-onlyIdempotent

Retrieve monthly budget totals and category details including budgets, activity, balances, and goals in dollars to review spending and plan.

Instructions

Get month totals and category budgets, activity, balances and goals (dollars). For negative balances use get_overspent_categories.

Input Schema

NameRequiredDescriptionDefault
monthYesYYYY-MM-DD, first of month
budgetIdNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv6.1.0
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • removedInput schema / properties / budgetId / description
      Removed value: -"Budget ID (uses default if not provided)"
    • changedInput schema / properties / month / description
      Previous value: -"Month in YYYY-MM-DD format (first of month)"New value: +"YYYY-MM-DD, first of month"
    • changedOutput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. Changed1 schema field changedv5.4.0
    • removedOutput schema / properties / result / description
      Removed value: -"Structured result returned by Get Month."
  3. Addedv5.2.0
  4. Removedv5.1.1
  5. First observedv2.0.0

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so the safety profile is covered. The description adds a useful signal by labeling amounts as dollars, but says nothing about budget scoping behavior or whether a missing month/budget falls back to a default.

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?

Two short sentences with no filler, and the core payload is front-loaded in the first sentence. Nothing to trim.

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 an output schema present, return values needn't be explained, and the description adequately lists what the response contains plus units. The only real gap is the undocumented budgetId parameter, which the description never clarifies.

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

Parameters2/5

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

Schema coverage is only 50%: 'month' is documented in the schema (YYYY-MM-DD, first of month) but 'budgetId' has no description anywhere. The description adds no parameter meaning at all, so it fails to compensate for the undocumented optional parameter.

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 names a specific verb and resource ('Get month totals') and enumerates the payload concisely: category budgets, activity, balances, goals. This distinguishes it from list_months and get_month_category well enough, though it doesn't explicitly contrast with get_income_expense_summary or get_month_category.

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 gives an explicit routing rule for one edge case ('For negative balances use get_overspent_categories'), which is exactly the kind of sibling disambiguation an agent needs. It stops short of stating when to prefer this over get_month_category or get_income_expense_summary for overlapping data.

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