Skip to main content
Glama
justmytwospence

ynab-mcp

Get Budget Settings

get_budget_settings
Read-only

Retrieve date and currency format settings for a YNAB budget to ensure consistent financial data display and reporting.

Instructions

[1 API call] Get a budget's date and currency format settings

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
budget_idNoBudget ID or 'last-used'last-used

Implementation Reference

  • The 'get_budget_settings' tool implementation, including registration, input schema, and handler logic.
    server.registerTool("get_budget_settings", {
      title: "Get Budget Settings",
      description: "[1 API call] Get a budget's date and currency format settings",
      inputSchema: {
        budget_id: z.string().default("last-used").describe("Budget ID or 'last-used'"),
      },
      annotations: { readOnlyHint: true },
    }, async ({ budget_id }) => {
      try {
        const response = await getClient().plans.getPlanSettingsById(budget_id);
        const s = response.data.settings;
        const lines = [
          `Date Format: ${s.date_format?.format}`,
          `Currency Format:`,
          `  ISO Code: ${s.currency_format?.iso_code}`,
          `  Symbol: ${s.currency_format?.currency_symbol}`,
          `  Decimal Digits: ${s.currency_format?.decimal_digits}`,
          `  Symbol First: ${s.currency_format?.symbol_first}`,
          `  Display Symbol: ${s.currency_format?.display_symbol}`,
        ];
        return textResult(lines.join("\n"));
      } catch (e: any) {
        return errorResult(e.message);
      }
    });
Behavior3/5

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

The description adds value by specifying '[1 API call]', which indicates a single request without pagination or batching, and clarifies the scope ('date and currency format settings'). The annotations already declare readOnlyHint=true, so the agent knows it's safe, but the description provides additional behavioral context without contradicting annotations.

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?

The description is a single, efficient sentence that front-loads key information (API call count and resource). There is no wasted text, making it highly concise and well-structured for quick understanding.

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

Completeness3/5

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

Given the tool's simplicity (1 parameter, read-only, no output schema), the description is adequate but minimal. It covers the basic purpose and behavior but lacks details on output format or error handling, which could be useful for an agent despite the annotations providing safety context.

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 input schema has 100% description coverage, with the 'budget_id' parameter well-documented. The description does not add any parameter-specific information beyond what the schema provides, such as examples or constraints, so it meets the baseline for high schema coverage.

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?

The description clearly states the action ('Get') and the resource ('a budget's date and currency format settings'), making the purpose specific. However, it does not explicitly distinguish this tool from sibling tools like 'get_budget' or 'list_budgets', which might retrieve different budget-related data, so it lacks sibling differentiation.

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?

The description provides no guidance on when to use this tool versus alternatives. It does not mention sibling tools like 'get_budget' or 'list_budgets', nor does it specify any prerequisites or exclusions for usage, leaving the agent without context for selection.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/justmytwospence/ynab-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server