Skip to main content
Glama
chrisguidry
by chrisguidry

List categories

list_categories
Read-only

Retrieve a YNAB plan's visible categories with this month's budgeted amounts and targets, ordered by category group. Use limit and offset to page through results.

Instructions

List the plan's categories with this month's amounts and targets.

Only returns visible categories. Hidden and deleted categories are excluded. Categories come in the order the plan shows them, group by group.

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum number of categories to return per page (default: 50)
offsetNoNumber of categories to skip for pagination (default: 0)

Output Schema

NameRequiredDescriptionDefault
categoriesYesList of categories
paginationYesPagination information

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.8/5.0
Behavior4/5

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

The description adds useful behavior beyond the read-only annotations: only visible categories are returned, hidden and deleted categories are excluded, and results follow the plan's group-by-group ordering. It does not cover pagination behavior, but the schema already documents limit and offset.

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?

The description is short, front-loaded with the core purpose, and every sentence contributes useful information about scope, filtering, or ordering. There is no wasted text.

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?

The description is largely complete for a simple list tool: it explains what is returned, which categories are excluded, and how results are ordered. With annotations, full parameter schema coverage, and an output schema, the remaining omissions are minor.

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%, so both limit and offset are already well documented in the input schema. The description does not add parameter-specific meaning beyond what the schema provides, which is acceptable at the baseline.

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?

The description states a specific verb and resource: list the plan's categories, including this month's amounts and targets. It is clear what the tool returns, but it does not explicitly distinguish itself from siblings such as list_category_groups or get_month_category.

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 implied by the description: use this to list categories in plan display order. However, there is no explicit guidance on when to use this versus list_category_groups, get_month_category, or other category-related siblings.

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