YNAB MCP Server

Get Payee Locations By Payee

get_payee_locations_by_payee

Read-onlyIdempotent

Retrieve all recorded GPS locations for a payee to confirm which physical merchant an ambiguous payee name refers to.

Instructions

Get all recorded GPS locations for one payee. Read-only. Useful to confirm which physical merchant an ambiguous payee refers to; empty for payees never used in YNAB's mobile app.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`payeeId`	Yes	Payee ID
`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 Get Payee Locations By Payee."
```

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

First observedv2.0.0May 28, 2026

TDQS

A3.7/5.0

Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint, so the description's 'Read-only' is redundant. However, it adds valuable behavioral context by stating that results are empty for payees never used in YNAB's mobile app, which is not covered by annotations.

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 concise and front-loaded with the core action. It contains three sentences, but the 'Read-only' phrase is redundant given the annotations, slightly reducing efficiency. Still, every other part contributes meaning.

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 presence of an output schema and safety annotations, the description covers the essential aspects: purpose, use case, and edge-case behavior (empty result). It does not explain return format, but that is delegated to the output schema, so it is adequately complete.

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%, with both parameters already documented in the input schema. The description does not add any additional parameter-specific semantics, so it stays at the baseline for high coverage.

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 clearly states the verb (Get) and resource (all recorded GPS locations for one payee), making the purpose obvious. It also specifies the scope 'for one payee,' which helps differentiate from list_payee_locations, though it does not explicitly name that sibling tool.

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 a concrete use case ('confirm which physical merchant an ambiguous payee refers to'), which implies when to use it. However, it does not mention when not to use it or point to alternative tools like list_payee_locations or get_payee_location, so guidance is implied rather than explicit.

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