Skip to main content
Glama
YNAB MCP Server

YNAB MCP Server

by rgarcia

Getmonthcategorybyid

getMonthCategoryById

Retrieve category details for a specific YNAB plan month, including assigned, activity, and available amounts, to review monthly budget allocations.

Instructions

Returns a single category for a specific plan month. Amounts (assigned, activity, available, etc.) are specific to the current plan month (UTC).

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>",
      "category_id": "<category_id>"
    },
    "name": "getMonthCategoryById"
  }
}

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).
category_idYesThe id of the category

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.6/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the full behavioral burden. It does add useful context beyond the schema: amounts are computed relative to the plan month in UTC, which tells the agent results are month-dependent. It omits read-only/safety framing, auth requirements, and error behavior.

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, zero filler, with the core purpose front-loaded and the month-scoping caveat second. Every sentence earns its place.

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 no output schema, the description compensates by hinting at the returned shape (a category with assigned, activity, available amounts) and their month sensitivity. For a simple three-parameter read tool this is nearly complete, though the relationship to getCategoryById remains unaddressed.

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%, including the 'current' sentinel for month and 'last-used'/'default' for plan_id, so the baseline of 3 applies. The description clarifies that returned amounts are tied to the month parameter, but adds no 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.

Purpose4/5

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

States a specific verb and resource ('Returns a single category') scoped to a plan month, which distinguishes it functionally from a plain category lookup. However, it never names the obvious sibling getCategoryById, so the month-scoped vs. global distinction is left for the agent to infer.

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

Usage Guidelines3/5

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

Usage is only implied by 'for a specific plan month'; there is no explicit when-to-use statement, no mention of when the plain getCategoryById is preferable, and no prerequisites or failure conditions. The agent can guess the right context but is not guided.

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