Skip to main content
Glama

ynab_get_payee

Read-onlyIdempotent

Retrieve details of a specific payee from your YNAB budget, including name, transfer account, and deletion status. Choose JSON or markdown output.

Instructions

Get details for a specific payee.

Args:

  • budget_id (string, optional): Budget UUID. Omit to use the default budget.

  • payee_id (string, required): Payee UUID.

  • response_format (string, optional): "json" or "markdown" (default: "markdown").

Returns: payee (id, name, transfer_account_id, deleted), cached, cache_info

Errors:

  • "No default budget set" → run ynab_set_default_budget first

  • "Payee not found" → invalid payee_id

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
budget_idNo
payee_idYes
response_formatNomarkdown

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
cachedNoIndicates if data was served from cache
cache_infoNoHuman-readable cache status message (e.g., "Cache hit", "Cache miss")
usedDeltaNoIndicates if delta merge optimization was applied for budgets
payeeYesPayee details
Behavior4/5

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

Annotations already declare readOnlyHint, destructiveHint, and idempotentHint. Description adds value by detailing the return structure (id, name, transfer_account_id, deleted, cached, cache_info) and error conditions. No contradictions.

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?

Structured into clear sections (Args, Returns, Errors) with no unnecessary words. Front-loaded with purpose, then concise parameter and error details. Every sentence is informative.

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 retrieval tool, the description covers all necessary aspects: parameter behavior, return format, caching info, and error handling. The presence of an output schema (not shown) further supplements completeness.

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

Parameters5/5

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

With 0% schema description coverage, the description fully compensates by explaining each parameter: budget_id (optional, omit for default), payee_id (required), response_format (json/markdown, default markdown). Adds meaning beyond schema types.

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?

The description states 'Get details for a specific payee', which is a clear verb+resource combination. It naturally distinguishes from sibling 'ynab_list_payees' which retrieves all payees, not a single one.

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?

Provides explicit error guidance ('No default budget set' → run ynab_set_default_budget first) and clarifies optional parameter usage. Does not explicitly state when to use this tool instead of alternatives, but the error handling and parameter hints imply proper usage.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/dizzlkheinz/ynab-mcpb'

If you have feedback or need assistance with the MCP directory API, please join our Discord server