Skip to main content
Glama
YNAB MCP Server

YNAB MCP Server

by rgarcia

Getplanmonth

getPlanMonth

Retrieve a single month from a YNAB plan to review budget details. Specify the plan ID and month in ISO format, or use 'current' for the present calendar month.

Instructions

Returns a single plan month

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "plan_id": "<plan_id>",
      "month": "<month>"
    },
    "name": "getPlanMonth"
  }
}

Input Schema

NameRequiredDescriptionDefault
monthYesThe plan month in ISO format (e.g. 2016-12-01) ("current" can also be used to specify the current calendar month (UTC))
plan_idYesThe id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.5/5.0
Behavior2/5

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

No annotations exist, so the description carries the full behavioral burden, and "Returns" only weakly implies a read-only, non-destructive call. It doesn't state whether future months can 404, whether this requires auth, or how errors surface for an invalid month.

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

Conciseness3/5

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

A single front-loaded sentence with zero filler, but it is under-specified rather than efficient. Every word earns its place, yet there are too few words for the job.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

There is no output schema and no annotations, so the description is the only place to learn what a "plan month" response looks like and how it relates to the list sibling. It leaves both unaddressed for a tool whose payload shape is non-obvious.

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 coverage is 100%, including the special "current" value for month and "last-used"/"default" sentinels for plan_id, so the parameters are already well documented. The description adds no meaning beyond the schema, which is the baseline 3 case.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

"Returns a single plan month" names a verb and resource and, via the singular "month," implicitly contrasts with the sibling getPlanMonths. But it is close to a restatement of the tool name and says nothing about what a plan month contains, so an agent gets only the bare minimum.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No when-to-use guidance is given, and the obvious alternative (getPlanMonths for listing) is never mentioned. The agent must infer from the name alone that this fetches one month rather than many.

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