YNAB MCP Server

List Payee Locations

list_payee_locations

Read-onlyIdempotent

Retrieve all payee locations with GPS coordinates captured by YNAB mobile at transaction time. Read-only; includes only payees with mobile-recorded transactions.

Instructions

List all payee locations (GPS coordinates YNAB's mobile app recorded at transaction time). Read-only. Only payees with mobile-recorded transactions appear; many budgets have none. Use get_payee_locations_by_payee to scope to one payee.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`budgetId`	No	Budget ID (uses default if not provided)

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 Payee Locations."
```

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 Payee Locations."
+    }
+  },
+  "required": [
+    "result"
+  ],
+  "type": "object"
+}

First observedv2.0.0May 28, 2026

TDQS

A4.5/5.0

Behavior4/5

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

Annotations already cover read-only, idempotent, non-destructive, so the bar is lower. The description adds behavioral context beyond annotations by disclosing the filtering rule ('only payees with mobile-recorded transactions appear') and data provenance ('GPS coordinates... recorded at transaction time'). This helps set expectations for empty results and data scope.

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 sentences, each earning its place: purpose, behavioral caveat, and alternative routing. No filler or redundancy. Front-loaded with the key action and context.

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 (one optional param, output schema present, annotations complete), the description covers the essential interpretation, result-sparsity behavior, and sibling differentiation. Nothing needed for correct invocation 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 covers the sole optional parameter budgetId fully with 'Budget ID (uses default if not provided)', so baseline is 3. The description does not elaborate on parameter semantics, but the schema handles it completely; no additional meaning is required.

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 payee locations (GPS coordinates YNAB's mobile app recorded at transaction time).' It clearly distinguishes from sibling get_payee_locations_by_payee by noting the all-scope and by explicitly naming the scoped alternative.

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?

Provides explicit guidance: 'Only payees with mobile-recorded transactions appear; many budgets have none' warns about result sparsity, and 'Use get_payee_locations_by_payee to scope to one payee' tells the agent exactly when to use the sibling instead.

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