Skip to main content
Glama
YNAB MCP Server

YNAB MCP Server

by rgarcia

Getpayeebyid

getPayeeById

Fetch a single YNAB payee by plan ID and payee ID to inspect payee details for budgeting and transaction review.

Instructions

Returns a single 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": "getPayeeById"
  }
}

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_idYesThe id of the payee

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.5/5.0
Behavior2/5

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

With no annotations supplied, the description carries the full burden of behavioral disclosure and delivers almost nothing. It does not say whether the call errors when the payee is deleted or not found, whether it is a safe read, or what happens if plan_id is "last-used"/"default" and no default exists. Only the word "Returns" implies a read, which is thin for a zero-annotation tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The single short sentence is front-loaded and contains no filler, but its brevity reflects under-specification rather than disciplined economy. There is no wasted wording, yet one more clause about lookup failure or return content would have earned its place.

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

Completeness2/5

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

For a lookup tool with no annotations and no output schema, the description should indicate what a payee record contains or at least how it behaves on a miss. Neither is present, so the agent knows the shape of the request but not the shape or failure modes of the response.

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 both plan_id and payee_id documented in the schema including the "last-used" and "default" sentinels and a doc link. The description adds no meaning beyond that, so the baseline of 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

"Returns a single payee" states a verb (returns) and a resource (payee) with singular scope, which loosely separates it from list tools like getPayeeLocations. However, it does not distinguish it from other single-payee-adjacent siblings such as getTransactionsByPayee or getPayeeLocationsByPayee, and the title merely restates the name. The purpose is inferable but minimally specified.

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 when-to-use guidance, no mention of prerequisites such as needing a valid plan_id, and no routing to alternatives for listing or fetching related payee data. The agent must infer usage entirely from the name and schema.

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