Skip to main content
Glama
calebl

YNAB MCP Server

by calebl
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

List Payees

ynab_list_payees
Read-only

List all payees in a YNAB plan to find payee IDs needed for creating transactions.

Instructions

Lists all payees in a plan. Useful for finding payee IDs when creating transactions.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
planIdNoThe plan ID (optional, defaults to YNAB_PLAN_ID; budgetId is a deprecated alias)
budgetIdNoDeprecated alias of planId (still accepted)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv0.3.0
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / properties / budgetId / anyOf
      Added value: +[
+  {
+    "description": "Deprecated alias of planId (still accepted)",
+    "type": "string"
+  },
+  {
+    "type": "null"
+  }
+]
    • changedInput schema / properties / budgetId / description
      Previous value: -"The ID of the budget (optional, defaults to YNAB_BUDGET_ID environment variable)"New value: +"Deprecated alias of planId (still accepted)"
    • removedInput schema / properties / budgetId / type
      Removed value: -"string"
    • addedInput schema / properties / planId
      Added value: +{
+  "anyOf": [
+    {
+      "description": "The plan ID (optional, defaults to YNAB_PLAN_ID; budgetId is a deprecated alias)",
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "description": "The plan ID (optional, defaults to YNAB_PLAN_ID; budgetId is a deprecated alias)"
+}
  2. Addedv1.0.0

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, covering safety. The description adds that it lists 'all' payees, which is a useful scope note, but it doesn't disclose any behavioral quirks like pagination or performance. The bar is lower due to annotations, so a 3 is appropriate.

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 concise sentences with no filler. The core action is front-loaded, and the usage hint is placed second. Every word 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?

For a simple read-only list tool with optional parameters and no output schema, the description adequately covers purpose and usage. It implicitly conveys that payee IDs are returned ('useful for finding payee IDs'), but it could be more explicit about the exact return shape. Still, it's largely 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?

The schema has 100% description coverage for both parameters (planId and budgetId), and the description adds no additional parameter details. With high schema coverage, the baseline is 3, and no extra value is provided beyond the schema.

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 clearly states the tool lists all payees in a plan, which is a specific verb and resource. It also explicitly mentions its utility for finding payee IDs when creating transactions, distinguishing it from sibling tools like ynab_list_accounts or ynab_list_categories.

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?

The description provides a concrete usage context: find payee IDs for creating transactions. While it doesn't explicitly mention alternatives or when not to use it, the purpose is clear enough and the sibling set is large but the tool's specific role is obvious.

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

Deploy Server

Other Tools