Skip to main content
Glama
YNAB MCP Server

YNAB MCP Server

by rgarcia

Getcategorybyid

getCategoryById

Retrieves one YNAB category's details and current-month assigned, activity, and available amounts using a plan ID and category ID.

Instructions

Returns a single category. 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>",
      "category_id": "<category_id>"
    },
    "name": "getCategoryById"
  }
}

Input Schema

NameRequiredDescriptionDefault
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

B3.4/5.0
Behavior3/5

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

With no annotations, the description carries the full burden. It usefully discloses that assigned, activity, and available amounts are tied to the current plan month (UTC), which is non-obvious and valuable, but it says nothing about permissions, error behavior when a category or plan does not exist, or the shape of the returned object.

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 zero waste, and the core return behavior is front-loaded before the month-scoping caveat. 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?

For a simple two-parameter getter with full schema coverage and no output schema, the description is largely sufficient and adds the important month-scoping caveat. The main remaining gap is that it does not help an agent distinguish this tool from getMonthCategoryById when both could appear to return a category.

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%, so both plan_id and category_id are already documented, including the special "last-used" and "default" values for plan_id. The description adds no parameter-level meaning beyond the schema, making the baseline 3 appropriate.

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?

"Returns a single category" states a specific verb and resource, and the parenthetical about plan-month amounts clarifies what the returned figures mean. It does not explicitly distinguish this from the close sibling getMonthCategoryById, so the agent must infer the difference from the name alone.

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?

The description offers no when-to-use guidance and names no alternatives, despite siblings like getCategories (list) and getMonthCategoryById (month-specific category) being obvious alternatives. The month-scoping sentence is a behavioral note, not a routing rule.

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