Skip to main content
Glama
oliverames

YNAB MCP Server

by oliverames

Get Payee

get_payee
Read-onlyIdempotent

Fetch a payee's details by ID to confirm it exists or resolve its transfer account. Read-only lookup returns name, transfer account, and deletion flag.

Instructions

Get one payee by ID (name, transfer_account_id, deleted flag). Read-only. Mostly useful to confirm a payee still exists or resolve its transfer account; for discovery use search_payees.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
payeeIdYesPayee ID
budgetIdNoBudget ID (uses default if not provided)

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv5.4.0
    • removedOutput schema / properties / result / description
      Removed value: -"Structured result returned by Get Payee."
  2. Addedv5.2.0
  3. Removedv5.1.1
  4. First observedv2.0.0

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered. The description adds useful behavioral context beyond annotations by specifying the returned fields and the practical purpose, though it does not discuss not-found behavior or auth requirements.

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?

The description is two compact sentences, front-loading the operation and scope before naming the alternative. Every sentence contributes either capability, intent, or routing guidance, with no filler.

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?

For a simple read-only get-by-ID tool, the description covers purpose, use case, alternative selection, returned fields, and read-only nature. The presence of an output schema means return-value details need not be repeated, and annotations cover side-effect safety, making the description 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 'Payee ID' and 'Budget ID (uses default if not provided)' already documenting both parameters. The tool description adds no further parameter-level detail, so the schema carries the burden and a baseline score of 3 is appropriate.

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 ('Get one payee by ID') and names the key returned fields: name, transfer_account_id, deleted flag. It also distinguishes itself from the discovery-oriented sibling by pointing to search_payees, preventing confusion with list_payees or get_payee_location.

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?

Explicitly describes when to use the tool: to confirm a payee still exists or resolve its transfer account. It also names the alternative, search_payees, for discovery use cases, giving the agent clear routing guidance.

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