Skip to main content
Glama

Update checkout details

update_checkout
Destructive

Update customer details or payment_method only before payment-link generation. Paid, cancelled and payment-in-progress checkouts are rejected. Concurrent state changes are detected; retrieve the latest status before retrying.

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": "update_checkout"
  }
}

Input Schema

NameRequiredDescriptionDefault
customerNo
checkout_idYes
payment_methodNo

Output Schema

NameRequiredDescriptionDefault
ap2No
itemsNo
statusYes
messageNo
currencyYes
customerNo
next_stepNo
total_zarYes
item_countNo
checkout_idYes
payment_urlNo
payment_methodNo
provider_referenceNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already flag this as non-read-only and destructive, so the description earns credit for adding real behavior: state-based rejection rules and optimistic-concurrency detection with retry guidance. It still doesn't say whether unspecified customer fields are preserved or overwritten, nor what permissions are needed, which matters for a destructive mutation.

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?

Three tight sentences with no filler: capability first, then the blocking states, then the concurrency caveat. Each sentence carries distinct information an agent needs before calling.

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?

An output schema exists, so return values needn't be explained, and the description covers the critical state preconditions and retry behavior. The remaining gap is update semantics for a nested object (merge vs replace) and failure modes beyond the listed checkout states.

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 0% and only the nested customer fields carry inline descriptions, so the description must compensate. It does name two of the three parameters (customer details, payment_method) but says nothing about checkout_id, which is the sole required parameter, or about how the nested customer object is merged.

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?

The description states a specific verb+resource (update checkout) and narrows the mutable surface to 'customer details or payment_method', so the agent knows exactly what this tool changes. It stops short of explicitly contrasting with siblings like update_cart or cancel_checkout, which keeps it at a 4 rather than a 5.

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 timing precondition ('only before payment-link generation') and explicit when-not conditions (paid, cancelled, payment-in-progress checkouts are rejected). The retry path is hinted at via 'retrieve the latest status', which points toward get_checkout, but no sibling is named outright.

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