ynab-mcp

get_plan_settings

Retrieve date and currency format settings for a YNAB plan by providing its plan ID.

Instructions

Get settings for a plan (date format and currency format).

Args: plan_id: The plan ID (use list_plans to find available IDs) exclude_fields: Optional list of field names to exclude from the response. If omitted, the model's default exclude list is used (see FIELDS.md). Pass [] to return all fields. Pass a custom list to override the default.

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

Input Schema

Name	Required	Description	Default
`plan_id`	Yes
`exclude_fields`	No

Output Schema

Name	Required	Description	Default
`result`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.1.0Oct 7, 2026

TDQS

A4.5/5.0

Behavior4/5

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

With no annotations, description carries full burden. It discloses the default exclusion behavior of exclude_fields and how to override it (pass [] for all, custom list). This is key behavioral detail beyond a simple getter. No mention of auth or rate limits, but the tool is read-only by nature.

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?

Description is brief but includes an 'Args' section that is slightly verbose. However, the detail is necessary given the complexity of exclude_fields. It remains front-loaded with the purpose statement. Good structure.

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?

Given the output schema exists, return values need no explanation. Both parameters are fully explained. The description points to FIELDS.md for further details, which is acceptable. No gaps remain for correct invocation.

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?

Schema coverage is 0%, so description must compensate fully. It does: explains plan_id as requiring a specific ID from list_plans, and provides a thorough explanation of exclude_fields including default, override, and custom list. Adds significant value 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?

Description clearly states it retrieves settings (date format, currency format) for a plan. Distinguishes from sibling get_plan (which would fetch broader plan details) and list_plans (which lists plans). Verb 'Get' is specific.

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 guidance for plan_id parameter ('use list_plans to find available IDs') and detailed behavior for exclude_fields. Lacks explicit 'when to use' vs alternatives, but the tool's purpose is straightforward and the parameter advice sufficiently guides correct invocation.

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

Deploy Server