Skip to main content
Glama

View checkout

get_checkout
Read-only

Read checkout by checkout_id. Returns persisted order status, payment_status, payment_method, items, customer, total_zar and currency. Initial order status is started, not pending. This tool does not return a previously generated payment_url: retain the complete_checkout response in caller context.

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

Input Schema

NameRequiredDescriptionDefault
checkout_idYes

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

A3.8/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnly, non-destructive, closed-world), and the description adds genuine context beyond them: the exact persisted fields returned, the fact that initial order status is "started" rather than "pending", and the important limitation that payment_url is not retrievable here. That last caveat is exactly the kind of behavioral detail an agent cannot get from structured fields.

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 short sentences, front-loaded with the action, then return shape, then the two gotchas an agent is most likely to get wrong. Every sentence carries information that is not trivially inferable, and nothing is padded.

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 single-parameter read with an output schema and full annotations, the definition covers the notable traps (status default of "started", missing payment_url) that would otherwise cause misbehavior. The only shortfall is the absence of any guidance on when this read is preferable to sibling reads such as get_order.

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?

Only one parameter exists and schema description coverage is 0%, so the description must carry the burden; it merely repeats the name ("by checkout_id") without stating format, source, or whether it is an opaque ID versus a reference. Minimal but adequate for a single-key lookup.

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 and resource ("Read checkout by checkout_id") and immediately scopes the payload with an enumerated field list, so the agent knows exactly what this returns. It also implicitly separates itself from complete_checkout by noting it does not return payment_url, though it never explicitly contrasts with other read siblings like get_order or get_cart.

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

Usage Guidelines3/5

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

Usage is only implied: the note about retaining the complete_checkout response hints that this tool is for re-reading an existing checkout rather than completing one, but there is no explicit when-to-use or when-not-to-use statement. No prerequisites or state conditions (e.g., whether it works after cancellation) are given.

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