Skip to main content
Glama

create_payee

Create a Payee (merchant/counterparty) for the user. Use when the user wants to register a new merchant before linking transactions. Can also set the categorization mode, the default tags and the default location. Returns the created Payee. Requires finance:write scope.

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

Input Schema

NameRequiredDescriptionDefault
nameYesDisplay name for the Payee, max 200 chars.
defaultTagIdsNoTag ids (from get_tags) added to new transactions of this payee. Use apply_payee_tags_to_transactions (automations toolset) to tag the existing transactions.
defaultLocationNoDefault location { latitude, longitude } stamped on new transactions of this payee.
defaultCategoryIdNoOptional category id automatically applied to future transactions linked to this Payee.
categorizationModeNoHow the default category is used on new transactions: enforce (always set it, the default), hint (suggest it) or off (ignore it).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changed
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / categorizationMode
      Added value: +{
      +  "description": "How the default category is used on new transactions: enforce (always set it, the default), hint (suggest it) or off (ignore it).",
      +  "enum": [
      +    "enforce",
      +    "hint",
      +    "off"
      +  ],
      +  "type": "string"
      +}
    • addedInput schema / properties / defaultLocation
      Added value: +{
      +  "anyOf": [
      +    {
      +      "properties": {
      +        "latitude": {
      +          "maximum": 90,
      +          "minimum": -90,
      +          "type": "number"
      +        },
      +        "longitude": {
      +          "maximum": 180,
      +          "minimum": -180,
      +          "type": "number"
      +        }
      +      },
      +      "required": [
      +        "latitude",
      +        "longitude"
      +      ],
      +      "type": "object"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "Default location { latitude, longitude } stamped on new transactions of this payee."
      +}
    • addedInput schema / properties / defaultTagIds
      Added value: +{
      +  "description": "Tag ids (from get_tags) added to new transactions of this payee. Use apply_payee_tags_to_transactions (automations toolset) to tag the existing transactions.",
      +  "items": {
      +    "format": "uuid",
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
  2. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations only declare readOnlyHint=false, so the description carries most of the burden and does reasonably well: it states that a finance:write scope is required and that the created Payee is returned (there is no output schema). It also discloses downstream effects—default tags/location/category apply to *future* transactions—and points to apply_payee_tags_to_transactions for existing ones. It does not warn about duplicate-name behavior or uniqueness constraints.

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?

Three tight sentences: purpose first, usage trigger second, optional capabilities and return value last. No filler or restatement, and each sentence contributes new information.

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 mostly-simple create tool with 5 well-documented parameters, the description covers the missing structured pieces: the write scope requirement and the return value (no output schema exists). What remains absent—duplicate handling and error behavior—is nice-to-have rather than essential to invoke it correctly.

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%, including the categorizationMode enum semantics, so the schema already does the heavy lifting. The description only summarizes that the optional parameters exist ('categorization mode, default tags and default location') without adding format or constraint detail beyond the schema.

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 pairs a specific verb with a specific resource and even glosses the domain term ("Payee (merchant/counterparty)"), so an agent knows exactly what is being created. It does not explicitly contrast itself with update_payee or merge_payees, but the create-vs-modify distinction is implicit in 'register a new merchant'.

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?

It gives a concrete trigger condition: 'Use when the user wants to register a new merchant before linking transactions.' That clearly places it in a workflow, but there is no explicit when-not guidance (e.g. if the payee already exists, use get_payees/merge_payees instead).

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.