YNAB MCP Server

List Payees

list_payees

Read-onlyIdempotent

List all payees with IDs and transfer account markers. Use transfer_account_id as payeeId when creating transfers to avoid inventing transfer names.

Instructions

List all payees with IDs and transfer_account_id (non-null marks a transfer payee — use it as payeeId when creating transfers instead of inventing a 'Transfer : ...' name). Read-only. For name-based lookup prefer search_payees; payee lists on mature budgets can be long.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`budgetId`	No	Budget ID (uses default if not provided)
`lastKnowledgeOfServer`	No	Delta request server knowledge. When provided, returns { payees, server_knowledge }.

Output Schema

TableJSON Schema

Name	Required	Description	Default
`result`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedv5.4.0Sep 15, 2026
- removedOutput schema / properties / result / description
```
Removed value: -"Structured result returned by List Payees."
```

Changed1 schema field changedv5.1.1Jul 21, 2026

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "additionalProperties": false,
+  "properties": {
+    "result": {
+      "description": "Structured result returned by List Payees."
+    }
+  },
+  "required": [
+    "result"
+  ],
+  "type": "object"
+}

First observedv2.0.0May 28, 2026

TDQS

A4.7/5.0

Behavior5/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so safety is covered. The description adds significant behavior beyond that: the meaning of non-null transfer_account_id, the recommendation to use it as payeeId instead of inventing names, and the warning about list size. These are critical operational details not present in structured data and are highly relevant to correct invocation.

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?

Three tight sentences: the first states the core function and key output field, the second adds the transfer payee nuance, the third routes to the alternative and warns about volume. No filler, no repetition; every sentence earns its place.

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?

Given the tool's simplicity, full schema coverage, present output schema, and comprehensive annotations, the description provides all essential context. It covers the key output semantics (transfer payee), the performance characteristic, and the alternative tool. Nothing an agent needs to correctly select and call this tool is missing.

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 parameters (budgetId, lastKnowledgeOfServer) are fully documented in the schema. The description does not add any new parameter-level meaning beyond what the schema provides, so the baseline 3 applies.

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?

States a specific verb and resource ('List all payees with IDs and transfer_account_id'), distinguishes from siblings like search_payees and get_payee, and clarifies the critical transfer payee field. An agent can immediately understand what this tool does and how it differs from related tools.

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

Usage Guidelines5/5

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

Explicitly directs users to search_payees for name-based lookup and warns about long lists on mature budgets. It also instructs how to use transfer_account_id as payeeId for transfers, which tells the agent when to use this output. This is direct, actionable guidance on when to choose this tool versus alternatives.

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