Skip to main content
Glama
YNAB MCP Server

YNAB MCP Server

by rgarcia

Getpayeelocations

getPayeeLocations

Retrieves all payee locations for a specified YNAB plan, helping you review saved payee location data when managing budgets.

Instructions

Returns all payee locations

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "plan_id": "<plan_id>"
    },
    "name": "getPayeeLocations"
  }
}

Input Schema

NameRequiredDescriptionDefault
plan_idYesThe id of the plan. "last-used" can be used to specify the last used plan and "default" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.6/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full behavioral burden, yet it discloses nothing about read-only semantics, pagination or result size, ordering, or empty-result behavior. For a list endpoint with no annotations and no output schema, this is a substantial gap.

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?

One short, front-loaded sentence with no filler or redundancy. Its brevity is the problem only in the sense that content is missing, which is penalized elsewhere; structurally it is clean.

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

Completeness2/5

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

With no annotations and no output schema, the description is the only place an agent could learn what a payee location actually contains, whether results are paginated, or how large the result set might be. None of that is present, leaving it inadequate for a list-returning endpoint.

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% and the single plan_id parameter is thoroughly documented in the schema, including the "last-used" and "default" sentinels and a link to the OAuth plan docs. The description adds nothing beyond the schema, so baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

"Returns all payee locations" gives a verb (returns) and a resource (payee locations), and the word "all" hints that there is no payee filter, implicitly distinguishing it from getPayeeLocationsByPayee. But beyond that single qualifier it essentially restates the tool name, so the purpose is only minimally specified.

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

Usage Guidelines2/5

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

There is no when-to-use guidance, no mention of prerequisites (e.g. which plan to target), and no explicit routing to getPayeeLocationsByPayee or getPayeeLocationById. The agent must infer the filtering distinction from the sibling names rather than from this definition.

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