Skip to main content
Glama

bulk_delete_payees

Destructive

Permanently delete many payees at once. Their transactions stay and lose the payee; their aliases go with them; automations that use a deleted payee are paused. All or nothing: one unknown id refuses the whole call and deletes nothing. Returns { deletedCount, ignoredAddedCount }. Irreversible. Requires finance:delete 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": {
      "ids": "<ids>"
    },
    "name": "bulk_delete_payees"
  }
}

Input Schema

NameRequiredDescriptionDefault
idsYesPayee ids to delete: 1 to 2000, no repeats (from get_payees).
ignoreFutureNotrue to also add every name and alias of the deleted payees to the ignored list, so they are not created again. Default false.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.7/5.0
Behavior5/5

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

Goes well past destructiveHint=true: it discloses that transactions survive and lose their payee, aliases are removed, dependent automations are paused, and the call is all-or-nothing so one unknown id aborts everything. It also states irreversibility and the required auth scope, which annotations cannot express.

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?

Five short, front-loaded sentences, each carrying distinct information: scope, side effects, atomicity, return shape, and irreversibility/scope requirement. No filler or repetition of the schema.

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?

For a destructive bulk mutation with no output schema, the description covers everything an agent needs: prerequisites, side effects on related objects, failure semantics, reversibility, and the response shape. Nothing material is missing.

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 real meaning beyond the schema: the atomic failure mode of ids (one unknown id refuses the whole call) and the return fields deletedCount/ignoredAddedCount, which otherwise have no output schema to document them.

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 and resource with explicit scope: "Permanently delete many payees at once." The bulk framing immediately distinguishes it from the singular delete_payee sibling, and "permanently" sets the operation's stakes.

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?

Gives clear preconditions (needs finance:delete scope, ids must all be known) and a consequence warning, which effectively tells the agent when this call will and won't succeed. It does not explicitly say to use delete_payee for a single payee, so the alternative routing is left implicit.

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.