Skip to main content
Glama
YNAB MCP Server

YNAB MCP Server

by rgarcia

Getplansettingsbyid

getPlanSettingsById

Retrieves settings for a specified YNAB plan by plan ID, accepting 'last-used' or 'default' to target the right budget quickly.

Instructions

Returns settings for a plan

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>"
    },
    "name": "getPlanSettingsById"
  }
}

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).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.3/5.0
Behavior3/5

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

With no annotations supplied, the description carries the burden of behavioral disclosure. 'Returns' clearly signals a read-only, non-destructive operation, which is the primary behavioral fact an agent needs. However, it says nothing about auth requirements, whether plan settings change over time, or what the response contains beyond 'settings' — a notable gap for an unannotated tool.

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

Conciseness4/5

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

A single five-word sentence with zero waste, front-loaded with the verb. It is arguably over-concise given the tool's lack of annotations, but structurally it cannot be faulted for padding.

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?

A simple one-parameter read tool, so the bar is low, but with no annotations and no output schema the description is the only behavioral context available and it provides essentially none. It does not say what 'settings' comprise, whether the call can fail for invalid plan ids, or what an agent gets back — leaving gaps the structured fields do not cover.

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%, and the schema itself documents the special values 'last-used' and 'default' plus a link to the OAuth default-plan docs. The description adds no meaning beyond that. Per the rubric, a schema-complete single parameter yields a baseline of 3.

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: 'Returns settings for a plan.' An agent can distinguish this from other getters (getAccountById, getPlanMonths) because the resource is explicitly 'plan settings'. It lacks any statement of what distinguishes it from the sibling getPlans / getPlanMonth, but the name-resource pairing is clear enough for selection.

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

Usage Guidelines3/5

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

No explicit when-to-use or when-not-to-use guidance, and no alternatives named. Usage is implied by the resource name: fetch configuration for a single plan. An agent can infer it, but nothing steers it away from other plan-related retrieval tools.

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