Skip to main content
Glama
Sign In
mcp-ynab

mcp-ynab

by alexfu
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

getPayeeLocationsByPayee

Retrieve all payee locations for a specific payee to track transaction sources. Supply plan ID and payee ID to get the complete list of associated locations.

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

Output Schema

NameRequiredDescriptionDefault
dataYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

With no annotations, the description must carry behavioral disclosure itself; 'Returns' does signal a read-style operation and the 'all...for a specified payee' scoping is clear. It does not mention plan_id behavior, pagination, auth, or empty-result behavior, but for a simple lookup this is a minimally viable disclosure.

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?

A single, front-loaded sentence with no filler. It communicates the exact result set in the fewest words.

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?

For a simple read endpoint the description plus fully documented required parameters and an output schema is largely sufficient to call the tool correctly. The main missing piece is explicit sibling differentiation, but the tool name and 'for a specified payee' make the selection reasonably clear.

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 the parameters are already fully documented; the description adds only the implicit mapping of 'specified payee' to payee_id. This meets the baseline but does not enrich the schema's parameter meaning.

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 uses a clear verb and resource ('Returns all payee locations') and scopes it to a specified payee, so the tool's function is immediately understandable. It does not explicitly contrast with siblings such as getPayeeLocations or getPayeeLocationById, so it stops short of full differentiation.

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?

No guidance is given about when to choose this tool over getPayeeLocations or getPayeeLocationById, and no exclusions or prerequisites are mentioned. The agent must infer from the name that payee_id is the filter.

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

Deploy Server

Other Tools