Skip to main content
Glama

update_payment_recipient

Idempotent

Rename or archive a saved recipient (free)

Renames a saved Venmo or PayPal recipient, archives it, or both. Provide at least one of display_name or archived.

Archiving hides an entry from the default list while keeping its history, which is the reversible way to retire a recipient. Prefer it over DELETE.

Input Schema

NameRequiredDescriptionDefault
archivedNoMust be a boolean. A wrong type returns a terminal 400 with code `invalid_archived`.
platformYesPayment platform the recipient is saved under.
display_nameNoMust be a string. A wrong type returns a terminal 400 with code `invalid_display_name`.
recipient_idYesThe entry's `recipient_id` from `GET /payment-recipients` (an opaque id, not the phone number or email).

Output Schema

NameRequiredDescriptionDefault
user_idNo
archivedNo
platformNo
display_nameNo
recipient_idNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • removedInput schema / properties / auth_token
      Removed value: -{
      -  "description": "Laso credential. Only if the MCP connection has no Authorization header.",
      -  "type": "string"
      -}
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "archived": {
      +      "type": [
      +        "boolean",
      +        "null"
      +      ]
      +    },
      +    "display_name": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "platform": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "recipient_id": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "user_id": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    }
      +  },
      +  "type": "object"
      +}
  2. Changed1 schema field changed
    • addedInput schema / properties / platform / description
      Added value: +"Payment platform the recipient is saved under."
  3. Changed2 schema fields changed
    • removedInput schema / properties / platform / description
      Removed value: -"Payment platform the recipient is saved under."
    • changedOutput schema / (root)
      Previous value: -{
      -  "properties": {
      -    "archived": {
      -      "type": [
      -        "boolean",
      -        "null"
      -      ]
      -    },
      -    "display_name": {
      -      "type": [
      -        "string",
      -        "null"
      -      ]
      -    },
      -    "platform": {
      -      "type": [
      -        "string",
      -        "null"
      -      ]
      -    },
      -    "recipient_id": {
      -      "type": [
      -        "string",
      -        "null"
      -      ]
      -    },
      -    "user_id": {
      -      "type": [
      -        "string",
      -        "null"
      -      ]
      -    }
      -  },
      -  "type": "object"
      -}New value: +null
  4. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations declare readOnlyHint=false, destructiveHint=false, and idempotentHint=true. The description adds meaningful context beyond annotations by explaining that archiving hides an entry from the default list while preserving history, making it reversible. It clearly communicates the mutation is non-destructive and reversible, aligning with the annotations. No contradiction.

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?

Concise and front-loaded: the first sentence states the purpose and scope, the second explains the constraint, and the third gives the behavioral nuance about archiving. No wasted words; every sentence adds value.

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 an output schema exists, return values are already covered. The description covers the key usage constraint, the behavior of archiving, and differentiates from DELETE. It is complete for an agent to correctly invoke the tool without missing critical information.

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 baseline is 3. The description adds value by stating the 'at least one of display_name or archived' constraint, which is not captured in the schema's required fields. It also explains the semantics of archived (hides from list, keeps history), going beyond the schema's simple type descriptions.

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?

States a specific verb ('rename or archive') and resource ('saved recipient'), explicitly mentions Venmo/PayPal, and distinguishes itself from the DELETE sibling by recommending archiving over deletion. An agent can immediately understand what the tool does and how it differs.

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 a clear usage constraint: must provide at least one of display_name or archived. Explicitly recommends archiving over DELETE for retiring recipients, which is a direct alternative. However, it does not discuss when to use this versus list or other tools, though the context implies it's for existing recipients only.

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.

Resources