Skip to main content
Glama
YNAB MCP Server

YNAB MCP Server

by rgarcia

Gettransactionsbypayee

getTransactionsByPayee

Retrieve all non-pending transactions for a specific payee in a YNAB plan, using date and type filters to limit results to the records you need.

Instructions

Returns all transactions for a specified payee, excluding any pending transactions

IMPORTANT: this can return thousands of transactions and overflow your context. Always pass since_date (and until_date when you know it) covering only the dates you need, such as the last 7 to 30 days. Without since_date, YNAB returns a full year. Pass type="unapproved" or type="uncategorized" when you only need those transactions.

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": "getTransactionsByPayee"
  }
}

Input Schema

NameRequiredDescriptionDefault
typeNoIf specified, only transactions of the specified type will be included. "uncategorized" and "unapproved" are currently supported.
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
since_dateNoIf specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g. 2016-12-30). Defaults to one year ago when not specified.
until_dateNoIf specified, only transactions on or before this date will be included. The date should be ISO formatted (e.g. 2016-12-30).
last_knowledge_of_serverNoThe starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.2.0
    • changedInput schema / properties / since_date / description
      Previous value: -"If specified, only transactions on or after this date will be included.  The date should be ISO formatted (e.g. 2016-12-30)."New value: +"If specified, only transactions on or after this date will be included.  The date should be ISO formatted (e.g. 2016-12-30). Defaults to one year ago when not specified."
    • addedInput schema / properties / until_date
      Added value: +{
      +  "description": "If specified, only transactions on or before this date will be included.  The date should be ISO formatted (e.g. 2016-12-30).",
      +  "format": "date",
      +  "type": "string"
      +}
  2. First observedv0.1.0

TDQS

A4.4/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does well: it discloses the pending-transaction exclusion, the context-overflow risk from thousands of results, and the default one-year window when since_date is omitted. It omits auth/permission requirements and whether results are paginated, but the high-risk behaviors are disclosed.

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 sentences of purpose and scope, then a clearly marked IMPORTANT block with the actionable constraints. Front-loaded, no filler, and the highest-risk warning is emphasized rather than buried.

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 six-parameter read tool with no output schema and no annotations, the critical calling pitfalls (context overflow, default date window) are fully covered. The gap is last_knowledge_of_server, whose incremental-change semantics are never mentioned, and there is no hint of return shape.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline would be 3, but the description adds real meaning beyond the schema by explaining the consequence of omitting since_date ('YNAB returns a full year') and by naming the concrete type enum values in context. It leaves last_knowledge_of_server — the non-obvious incremental-sync parameter — entirely unexplained.

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 ('Returns all transactions for a specified payee') plus a scope qualifier ('excluding any pending transactions'). That scope qualifier implicitly separates it from getTransactionsByAccount, getTransactionsByCategory, and getTransactionsByMonth, which are the siblings an agent would otherwise confuse it with.

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?

Gives concrete conditional guidance: always pass since_date (7-30 day window), add until_date when known, and use type="unapproved"/"uncategorized" when only those are needed. It never explicitly names a sibling tool as the alternative, so it stops short of full routing guidance, but the when-to-use conditions are clear.

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