ynab-mcpb

by dizzlkheinz

Overview Schema Source Related Servers Discussions Admin

TypeScript

Local

ynab_list_months

Read-onlyIdempotent

List summary data for all budget months with pagination, newest first, and page through results using limit and offset.

Instructions

List summary data for all budget months with pagination.

Args:

budget_id (string, optional): Budget UUID. Omit to use the default budget.
limit (int, optional): Max results per page. Default: 50.
offset (int, optional): Zero-based offset for pagination. Default: 0.
response_format (string, optional): "json" or "markdown" (default: "markdown").

Returns: months[], total_count, returned_count, offset, has_more, next_offset, cached, cache_info

Examples:

List recent months: call with no args, months are newest-first
Page 2: set limit=12, offset=12

Errors:

"No default budget set" → run ynab_set_default_budget first

Input Schema

Name	Required	Default
`limit`	No
`offset`	No
`budget_id`	No
`response_format`	No	markdown

Output Schema

Name	Required	Description
`cached`	No	Indicates if data was served from cache
`months`	Yes	List of months
`offset`	Yes	Offset used for this response
`has_more`	Yes	Whether more items exist beyond this page
`usedDelta`	No	Indicates if delta merge optimization was applied for budgets
`cache_info`	No	Human-readable cache status message (e.g., "Cache hit", "Cache miss")
`next_offset`	No	Offset for next page, if has_more is true
`total_count`	Yes	Total number of items available
`returned_count`	Yes	Number of items returned

Schema Changelog

Changes observed during successful MCP inspections.

Changed2 schema fields changedv0.29.1Oct 26, 2026
- removedOutput schema / properties / months / items / properties / age_of_money / anyOf
```
Removed value: -[
-  {
-    "type": "number"
-  },
-  {
-    "type": "null"
-  }
-]
```
- addedOutput schema / properties / months / items / properties / age_of_money / type
```
Added value: +[
+  "number",
+  "null"
+]
```
Addedv0.26.9May 11, 2026

TDQS

A4.6/5.0

Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint, and destructiveHint=false. The description adds useful behavioral context beyond annotations: pagination defaults, response fields, cache-related fields, and the "No default budget set" error path with remediation. It does not discuss rate limits, but it is materially transparent for a read-only list tool.

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 definition is structured and front-loaded: purpose first, then Args, Returns, Examples, and Errors. Every section adds actionable information, and the examples are concise and directly usable.

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

Completeness5/5

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

The tool is a read-only paginated list operation with annotations, an output schema, and zero required parameters. The description still supplies all necessary parameter semantics, pagination guidance, return field awareness, and error remediation, so an agent can call it correctly without opening the schema.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must carry parameter meaning; it does so fully. It documents budget_id as optional with default-budget behavior, limit and offset with defaults, and response_format with allowed values and default.

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 states a specific verb and resource: "List summary data for all budget months with pagination." This clearly distinguishes the tool from single-month siblings like ynab_get_month and from unrelated transaction tools.

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

Usage Guidelines4/5

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

The description gives practical usage context: no-args lists recent months newest-first, and pagination examples show limit/offset usage. It also names ynab_set_default_budget as remediation when no default budget exists. It does not explicitly say when to choose this over ynab_get_month, but the list-vs-single distinction is clear.

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

Deploy Server