Skip to main content
Glama
YNAB MCP Server

YNAB MCP Server

by oliverames

Get Payee

get_payee
Read-onlyIdempotent

Retrieves a payee's name, transfer account ID, and deleted status by ID; use search_payees to discover payee IDs.

Instructions

Get payee name, transfer_account_id and deleted status by ID. Discover IDs with search_payees.

Input Schema

NameRequiredDescriptionDefault
payeeIdYesPayee ID
budgetIdNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv6.1.0
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • removedInput schema / properties / budgetId / description
      Removed value: -"Budget ID (uses default if not provided)"
    • changedOutput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. Changed1 schema field changedv5.4.0
    • removedOutput schema / properties / result / description
      Removed value: -"Structured result returned by Get Payee."
  3. Addedv5.2.0
  4. Removedv5.1.1
  5. First observedv2.0.0

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description adds mild context by naming the returned fields, but since an output schema exists this is largely duplicative, and it says nothing about missing/deleted payees or cross-budget behavior for the optional budgetId.

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?

Two short sentences with zero filler; the core lookup is front-loaded and the ID-discovery hint follows immediately. Every sentence earns its place.

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?

With annotations covering safety and an output schema covering return shape, the definition gives an agent enough to call the tool correctly for the common case. The sole gap is the undocumented optional budgetId, a minor omission for a simple single-record lookup.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is only 50%: payeeId has a (minimal) description while budgetId is undocumented in both schema and description. The phrase 'by ID' only restates the payeeId parameter, and the purpose of budgetId when omitted or supplied is never explained, so the description fails to compensate for the coverage gap.

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?

States a specific verb and resource ('Get payee ... by ID') and enumerates the returned fields (name, transfer_account_id, deleted status), which is more informative than the bare title. It routes ID discovery to search_payees but does not distinguish itself from sibling list_payees, which also surfaces payees.

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

Usage Guidelines4/5

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

Explicitly points to search_payees as the way to obtain the ID this tool requires, giving clear context for use. It stops short of stating exclusions, such as when to use list_payees instead of fetching individual payees by ID.

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