Skip to main content
Glama

update_payee

Update a Payee. Leave a field out to keep it. Renaming preserves the previous canonical name as an alias so historical matches still resolve, and refuses a name another payee or alias already uses. Sets the default category and how it is applied (categorizationMode), the default tags and the default location for new transactions, and the logo (a brand domain or a monogram, not both; a logo set here is kept as manual). Returns the 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": {
      "id": "<id>"
    },
    "name": "update_payee"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesPayee id.
nameNoNew display name, 1 to 200 characters.
logoIconNoIcon key shown instead of a brand logo or monogram (e.g. "food-24-regular"), or null to clear. Not together with logoDomain or logoInitials.
logoColorNoMonogram background as #rrggbb, or null for the default tint.
logoDomainNoBrand domain to take the logo from (e.g. "netflix.com", no protocol or slashes), or null to clear. Not together with logoInitials.
logoInitialsNoOne or two characters shown as a monogram instead of a brand logo, or null to clear. Not together with logoDomain.
defaultTagIdsNoThe full set of default tags for new transactions of this payee. It replaces the current set; [] clears it. Use apply_payee_tags_to_transactions (automations toolset) to tag the existing transactions.
defaultLocationNoDefault location { latitude, longitude } stamped on new transactions of this payee, or null to clear.
defaultCategoryIdNoNew default category id, or null to clear.
categorizationModeNoHow the default category is used on new transactions: enforce (always set it), hint (suggest it) or off (ignore it).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed13 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), hint (suggest it) or off (ignore it).",
      +  "enum": [
      +    "enforce",
      +    "hint",
      +    "off"
      +  ],
      +  "type": "string"
      +}
    • changedInput schema / properties / defaultCategoryId / anyOf
      Previous value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "format": "uuid",
      +    "type": "string"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • 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, or null to clear."
      +}
    • addedInput schema / properties / defaultTagIds
      Added value: +{
      +  "description": "The full set of default tags for new transactions of this payee. It replaces the current set; [] clears it. Use apply_payee_tags_to_transactions (automations toolset) to tag the existing transactions.",
      +  "items": {
      +    "format": "uuid",
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • addedInput schema / properties / id / format
      Added value: +"uuid"
    • addedInput schema / properties / logoColor
      Added value: +{
      +  "anyOf": [
      +    {
      +      "pattern": "^#[0-9a-fA-F]{6}$",
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "Monogram background as #rrggbb, or null for the default tint."
      +}
    • addedInput schema / properties / logoDomain
      Added value: +{
      +  "anyOf": [
      +    {
      +      "maxLength": 253,
      +      "pattern": "^[^\\s/]+$",
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "Brand domain to take the logo from (e.g. \"netflix.com\", no protocol or slashes), or null to clear. Not together with logoInitials."
      +}
    • addedInput schema / properties / logoIcon
      Added value: +{
      +  "anyOf": [
      +    {
      +      "maxLength": 64,
      +      "minLength": 1,
      +      "pattern": "^[a-z0-9-]+$",
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "Icon key shown instead of a brand logo or monogram (e.g. \"food-24-regular\"), or null to clear. Not together with logoDomain or logoInitials."
      +}
    • addedInput schema / properties / logoInitials
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "One or two characters shown as a monogram instead of a brand logo, or null to clear. Not together with logoDomain."
      +}
    • changedInput schema / properties / name / description
      Previous value: -"New display name."New value: +"New display name, 1 to 200 characters."
    • addedInput schema / properties / name / maxLength
      Added value: +200
    • addedInput schema / properties / name / minLength
      Added value: +1
  2. First observed

TDQS

A4.2/5.0
Behavior5/5

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

With only readOnlyHint=false in the annotations, the description carries real weight: renaming preserves the old canonical name as an alias so historical matches still resolve, a duplicate name or alias is refused, a logo set here is stored as manual, and the call returns the Payee. Auth scope is also disclosed, which annotations do not cover.

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?

Front-loaded with the verb and the omit-to-keep rule, then semantics, then scope. Three dense sentences with no filler, though the field enumeration in the middle sentence partially restates what the schema already labels.

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 10-parameter mutation with no output schema, it covers mutation semantics, the rename side effect, conflict behavior, auth scope, and the return value. The logo story is slightly incomplete since logoIcon and logoColor are never mentioned in the description, even though the schema documents them.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description adds genuine meaning beyond the schema with the omit-to-keep partial-update contract and the logo mutual-exclusion rule stated in prose. It does omit logoIcon and logoColor from its logo discussion, leaving a small gap.

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?

"Update a Payee" gives a specific verb and resource, and the enumeration of updatable aspects (name, default category, tags, location, logo) makes the scope concrete. It distinguishes itself from create_payee/delete_payee/merge_payees only implicitly through the verb, and never names a sibling directly, so it falls short of a 5.

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?

"Leave a field out to keep it" tells the agent this is a partial update rather than a full replace, and the schema note routes the agent to apply_payee_tags_to_transactions (automations toolset) when existing transactions must be retagged. The finance:write prerequisite is stated, but there is no explicit when-not guidance or direct pointer to create_payee/merge_payees for adjacent intents.

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.