Skip to main content
Glama

remove_invoice_payment

DestructiveIdempotent

Remove an incorrectly recorded manual invoice payment by payment ID.

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

Input Schema

NameRequiredDescriptionDefault
paymentIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.9/5.0
Behavior3/5

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

Annotations already declare destructiveHint=true, idempotentHint=true, and readOnlyHint=false, so the safety profile is mostly covered. The description adds useful scope by specifying 'manual' payments, but it does not disclose side effects such as whether the invoice balance is restored or what happens if the ID is not found.

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 definition is a single, front-loaded sentence with no wasted wording. It states the action, resource, qualifier, and parameter in one efficient phrase.

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?

For a simple one-parameter mutation, the description plus annotations cover the essential selection criteria. However, for a destructive financial operation, it could better explain irreversibility and downstream effects such as invoice balance updates or error behavior when the payment ID is invalid.

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?

The only parameter is paymentId, and the schema already supplies its UUID format and pattern. The description adds that removal is 'by payment ID,' but it does not explain how to obtain the ID or whether it must refer specifically to a manual payment, leaving limited compensation for the 0% schema description coverage.

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?

The description uses a specific verb and resource: 'Remove... invoice payment,' and narrows scope with 'manual' and 'incorrectly recorded.' This clearly distinguishes it from sibling tools like record_invoice_payment, list_invoice_payments, and remove_appointment_payment.

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 clear usage condition by saying the payment was 'incorrectly recorded,' which tells an agent when removal is appropriate. It does not name exclusions or alternatives, such as using list_invoice_payments to locate the correct ID or avoiding use for non-manual payments.

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