Skip to main content
Glama

Get the payment link

complete_checkout
Destructive

Generate a Yoco card or Ozow instant-EFT payment link; this does NOT complete payment. Rejects cancelled checkouts and rechecks stock and totals first. An atomic claim prevents competing gateway calls. Returns payment_url or null plus status and message; cloud callers may be held. Retain a successful URL: repeat calls return payment_pending with no URL. Gateway failures raise an error, send no payment-link email and require team review rather than an automatic retry. Poll get_order with customer_email for payment status.

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": {
      "checkout_id": "<checkout_id>"
    },
    "name": "complete_checkout"
  }
}

Input Schema

NameRequiredDescriptionDefault
checkout_idYes
payment_methodNoOverrides any value set in create_checkout/update_checkout

Output Schema

NameRequiredDescriptionDefault
ap2No
itemsNo
statusYes
messageYes
currencyNo
customerNo
next_stepNo
total_zarNo
item_countNo
checkout_idYes
payment_urlYes
payment_methodNo
provider_referenceNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations only declare readOnlyHint=false, destructiveHint=true and openWorldHint=true; the description adds substantially more: an atomic claim against competing gateway calls, null-vs-URL returns, the payment_pending repeat-call trap, no payment-link email on gateway failure, and the possibility that cloud callers are held. These are exactly the side-effect and failure-mode facts the annotations cannot convey. It stops short of stating permission/auth requirements or whether a generated link can be revoked, so it is not exhaustive.

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?

Six compact sentences, front-loaded with purpose and the non-obvious "does not complete payment" correction, then scoping, then return and failure behavior. Every clause carries operational information; nothing is padding.

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 non-idempotent, destructive-flagged, open-world gateway call, the description covers the safety-relevant surface: claim/race behavior, idempotency-like repeat-call behavior, error semantics, and where to poll next. With an output schema present, it does not need to re-specify return fields, and its brief status/message/payment_url mention is a bonus rather than a gap.

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

Parameters2/5

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

checkout_id is required but has no description in the schema, and the description never explains what it is or where to obtain it; payment_method's override behavior is documented in the schema, not enriched here. At 50% schema coverage the description should compensate for the undocumented required parameter, and it does not.

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?

"Generate a Yoco card or Ozow instant-EFT payment link" names a specific verb and resource, and the immediate "this does NOT complete payment" clause draws the boundary an agent would otherwise blur with checkout/payment-completion siblings. The tool is distinguishable from get_checkout, create_checkout and get_order without opening the schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It states when-not conditions (rejects cancelled checkouts, does not complete payment), what to do instead for status ("Poll get_order with customer_email"), and what not to do on failure (no automatic retry; require team review). The only minor gap is that it does not contrast with create_quote_link, but the routing guidance for the payment flow itself is explicit.

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