Skip to main content
Glama

ynab_get_category

Read-onlyIdempotent

Retrieve current month details for any budget category, including budgeted amount, activity, balance, and goal progress. Resolve errors by setting a default budget or providing a valid category ID.

Instructions

Get current month details for a specific budget category.

Args:

  • budget_id (string, optional): Budget UUID. Omit to use the default budget.

  • category_id (string, optional): Category UUID.

  • response_format (string, optional): "json" or "markdown" (default: "markdown").

Returns: category (id, name, budgeted, activity, balance, goal_type, goal_target, goal_percentage_complete), cached, cache_info

Errors:

  • "No default budget set" → run ynab_set_default_budget first

  • "Category not found" → invalid category_id

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
budget_idNo
category_idYes
response_formatNomarkdown

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
cachedNoIndicates if data was served from cache
categoryYesCategory details
usedDeltaNoIndicates if delta merge optimization was applied for budgets
cache_infoNoHuman-readable cache status message (e.g., "Cache hit", "Cache miss")
Behavior4/5

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

Annotations already provide readOnlyHint, idempotentHint, and destructiveHint. The description adds value by disclosing that results are for the 'current month', detailing the return fields (id, name, budgeted, activity, balance, goal_type, etc.), and explaining error conditions. This goes beyond what annotations convey.

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?

The description is well-structured with a clear one-line purpose, bulleted args, a returns line, and error list. It is front-loaded and concise, though the docstring style (Args:, dashes) is slightly verbose for a function description.

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?

Given the tool's simplicity (3 params, no nested objects) and the presence of an output schema (not shown but signaled), the description covers the key aspects: current month scope, return fields, and error handling. It is largely complete, though it could mention that activity is the month-to-date activity.

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 description coverage is 0%, but the description compensates by explaining each parameter: budget_id (UUID, optional to use default), category_id (UUID), response_format (enum default 'markdown'). This adds practical meaning though it could be more precise (e.g., UUID format).

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?

The description clearly states 'Get current month details for a specific budget category' with a specific verb and resource. It distinguishes from siblings like ynab_list_categories (which lists many) and ynab_get_month (which gets a full month) by focusing on a single category's details.

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?

The description provides basic usage hints like omitting budget_id to use default and lists errors that guide troubleshooting (e.g., requiring ynab_set_default_budget first). However, it lacks explicit guidance on when to use this tool instead of alternatives like ynab_list_categories or ynab_get_month, and does not mention prerequisites beyond the default budget.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/dizzlkheinz/ynab-mcpb'

If you have feedback or need assistance with the MCP directory API, please join our Discord server