Skip to main content
Glama
hs737

MCP Server for YNAB

by hs737

Months — Get

months_get
Read-only

Fetch one month's categories with their budgeted, activity, and balance amounts. Use compact mode for month-over-month reviews, or include hidden categories for credit-card payments.

Instructions

[READ] Get one month's categories with their budgeted, activity, and balance. month: ISO date for the first day of the month ('2024-01-01'), 'YYYY-MM', or 'current'. compact=true returns only id, group, name, budgeted, activity and balance per category — about a quarter of the size, and enough for any month-over-month review. Use the full form only when you need goal fields or notes. include_hidden=true adds hidden categories, which is where YNAB keeps the credit-card payment categories; deleted categories are never returned. To compare several months, use months_range instead (up to 36 months in one call). Amounts are in milliunits (1000 = $1.00).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
monthYes
compactNo
plan_idNo
include_hiddenNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.0

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so safety is covered. The description nonetheless adds real behavioral context beyond the annotations: deleted categories are never returned, hidden categories are where credit-card payment categories live, and amounts are in milliunits (1000 = $1.00). It stops short of describing pagination or error behavior, but adds meaningful value.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loads the core action and payload, then packs format, compaction, hidden-category, and unit notes into tight clauses. Every sentence adds information, though the milliunits and hidden-category asides make it slightly dense for a single-resource getter.

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-value structure needn't be re-explained, yet the description usefully covers units (milliunits) and what fields compact returns. Combined with the format guidance for 'month' and the sibling routing, an agent has everything needed to invoke this correctly.

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?

Schema coverage is 0%, so the description carries the full burden. It fully documents the required 'month' param (three accepted ISO/YYYY-MM/'current' forms), the compact flag's effect and size tradeoff, and include_hidden's semantics. The 'plan_id' parameter is never mentioned, which is the one clear gap for a 4-param tool.

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?

States a specific verb ('Get') and resource ('one month's categories') with the exact payload contents (budgeted, activity, balance). It also names the sibling months_range and the condition that distinguishes them, so an agent can disambiguate without opening schemas.

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?

Explicit when-to-use guidance for each mode: compact=true for month-over-month review, full form only when goal fields or notes are needed, include_hidden=true specifically to surface credit-card payment categories. It also routes multi-month comparison to months_range (up to 36 months), naming the alternative directly.

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