Skip to main content
Glama

Checkout.com MCP by usefulapi

Void payment

checkout_void_payment
Destructive

VOIDS (cancels) a payment that has been authorized but not yet captured — this releases the hold on the customer's funds. Checkout.com: POST /payments/{id}/voids.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesPayment id to void, e.g. 'pay_...'. Required.
metadataNoArbitrary key/value metadata to attach to the void.
referenceNoYour reference for the void.
idempotency_keyNoIdempotency key — sent as the Cko-Idempotency-Key header.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true, so the safety profile is covered; the description adds real value by explaining the concrete effect (releases the hold on the customer's funds) and giving the underlying API route. It stops short of stating prerequisites such as required API scope, error cases, or whether a void can be undone.

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?

Two compact sentences with zero filler; the destructive effect and the state precondition are front-loaded before the endpoint reference. Every clause carries information an agent can act on.

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 four-parameter mutation tool with no output schema, the description supplies the essential semantics: what is voided, in which state, and what the side effect is. It omits any hint of the returned void status or idempotency behavior, which would have closed the remaining gaps at no cost.

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%, so id, metadata, reference, and idempotency_key are all documented in the schema already, which sets the baseline at 3. The description adds no parameter-level meaning beyond implying the payment id is the path segment, so it neither helps nor hurts.

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?

States a specific verb (VOIDS/cancels) against a named resource (payment) and adds the qualifying state 'authorized but not yet captured', which is exactly what separates it from capture and refund operations. It does not name a sibling tool explicitly, so an agent must infer the boundary from the state condition rather than being told.

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?

The phrase 'authorized but not yet captured' functions as a clear when-to-use precondition and implies when it should not be used (captured payments need refund instead). However, it never names checkout_refund_payment or checkout_capture_payment as the alternatives for those other states, leaving the routing inference to the agent.

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.