Skip to main content
Glama
justmytwospence

ynab-mcp

Get Locations for Payee

get_payee_locations_for_payee
Read-only

Retrieve GPS locations for a specific payee in YNAB to track transaction geography and enhance budget accuracy.

Instructions

[1 API call] Get all GPS locations for a specific payee

Input Schema

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

Implementation Reference

  • The tool 'get_payee_locations_for_payee' is registered and implemented in the same block, using 'getClient().payeeLocations.getPayeeLocationsByPayee' to fetch data.
    server.registerTool("get_payee_locations_for_payee", {
      title: "Get Locations for Payee",
      description: "[1 API call] Get all GPS locations for a specific payee",
      inputSchema: {
        budget_id: z.string().default("last-used").describe("Budget ID or 'last-used'"),
        payee_id: z.string().describe("The payee ID"),
      },
      annotations: { readOnlyHint: true },
    }, async ({ budget_id, payee_id }) => {
      try {
        const response = await getClient().payeeLocations.getPayeeLocationsByPayee(budget_id, payee_id);
        const locations = response.data.payee_locations;
        if (locations.length === 0) return textResult("No locations found for this payee.");
        const lines = locations.map((l) =>
          `- (${l.latitude}, ${l.longitude}) [ID: ${l.id}]`
        );
        return textResult(`Locations for payee ${payee_id}:\n${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 annotation 'readOnlyHint: true' already indicates this is a safe read operation. The description adds the constraint '[1 API call]', which hints at rate limit considerations, but doesn't elaborate on pagination, error conditions, or data format. It provides some context beyond annotations but lacks depth.

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 with zero waste. It front-loads key information (API call count and action) and avoids redundancy, making it highly concise and well-structured.

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 (read-only, two parameters, no output schema), the description is adequate but minimal. It covers the basic action and scope but lacks details on output format, error handling, or sibling tool differentiation, leaving some contextual gaps.

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?

With 100% schema description coverage, the input schema fully documents both parameters (budget_id and payee_id). The description mentions 'a specific payee', aligning with payee_id, but adds no extra semantic detail beyond what the schema provides, meeting the baseline for high 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 all GPS locations') and target resource ('for a specific payee'), making the purpose evident. However, it doesn't differentiate from sibling tools like 'get_payee_location' (singular) or 'list_payee_locations', leaving some ambiguity about scope distinctions.

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 like 'get_payee_location' or 'list_payee_locations'. It lacks context about prerequisites (e.g., needing a payee_id) or exclusions, offering minimal usage direction.

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