Skip to main content
Glama
YNAB MCP Server

YNAB MCP Server

by rgarcia

Getpayeelocationsbypayee

getPayeeLocationsByPayee

Retrieve all locations for a specified payee by providing plan and payee IDs.

Instructions

Returns all payee locations for a specified payee

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>",
      "payee_id": "<payee_id>"
    },
    "name": "getPayeeLocationsByPayee"
  }
}

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).
payee_idYesid of payee

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.9/5.0
Behavior2/5

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

No annotations are supplied, so the description carries the full disclosure burden, yet it only implies read-only behavior via "Returns." It says nothing about authentication requirements, pagination or result limits, empty-result behavior, or what a payee location object contains — all relevant for a 2-required-parameter lookup with no output schema.

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?

A single sentence with no filler, front-loading the verb and resource. It is appropriately sized but so terse that there is no room for the routing or behavioral context an agent would benefit from.

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

Completeness3/5

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

For a simple two-parameter read tool with full schema coverage and no output schema, the core purpose is adequately conveyed. The definition still lacks disambiguation from closely named siblings and any statement of read-only/safety behavior, which are the remaining gaps.

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 plan_id's schema description already explains the "last-used" and "default" sentinels in detail. The description adds nothing beyond reiterating that a payee is specified, so the baseline 3 applies.

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 pairs a specific verb ("Returns") with a specific resource ("all payee locations") and states the scoping key ("for a specified payee"). It does not, however, distinguish itself from the sibling getPayeeLocations (all locations across payees) or getPayeeLocationById, which an agent must infer from the names alone.

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 guidance on when to choose this tool over getPayeeLocations or getPayeeLocationById, and no prerequisites or exclusions are stated. The agent must derive the selection rule entirely from the tool name.

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