Skip to main content
Glama

create_checkout

Destructive

Phase 1 of 2 in the purchase flow. Convert a cart (or inline items + customer) into a checkout. Customer name, email, and phone are required. Returns checkout_id. No payment link is minted yet, call complete_checkout for that. Use update_checkout to correct customer details before finalising.

Input Schema

NameRequiredDescriptionDefault
itemsNo
cart_idNoEither cart_id or items required
customerNo
payment_methodNoDefault 'yoco'

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. Changed3 schema fields changed
    • removedInput schema / properties / customer / description
      Removed value: -"Customer details. Name, email, mobile phone and delivery address are required; city is optional. Placeholder or test details are refused."
    • removedInput schema / properties / items / description
      Removed value: -"Line items to buy. Required if cart_id is not given."
    • addedInput schema / properties / items / items / properties / no_drill
      Added value: +{
      +  "description": "Optional. true for the no-drill option (tension brackets, inside the frame, max 2000mm wide; 1500mm on 25mm venetians). Adds the R65 no-drill kit per blind. Offered on indoor roller blinds, including value rollers, and 25mm aluminium or aluwood venetians. Dedicated no-drill products already include the kit.",
      +  "type": "boolean"
      +}
  2. Changed2 schema fields changed
    • addedInput schema / properties / customer / description
      Added value: +"Customer details. Name, email, mobile phone and delivery address are required; city is optional. Placeholder or test details are refused."
    • addedInput schema / properties / items / description
      Added value: +"Line items to buy. Required if cart_id is not given."
  3. Changed3 schema fields changed
    • removedOutput schema / properties / created_at
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "type": "string"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ]
      -}
    • changedOutput schema / properties / items / anyOf
      Previous value: -[
      -  {
      -    "items": {
      -      "additionalProperties": true,
      -      "properties": {
      -        "colour": {
      -          "type": "string"
      -        },
      -        "finish": {
      -          "anyOf": [
      -            {
      -              "type": "string"
      -            },
      -            {
      -              "type": "null"
      -            }
      -          ]
      -        },
      -        "height": {
      -          "type": "number"
      -        },
      -        "mountType": {
      -          "type": "string"
      -        },
      -        "price": {
      -          "type": "number"
      -        },
      -        "productId": {
      -          "type": "string"
      -        },
      -        "productName": {
      -          "type": "string"
      -        },
      -        "quantity": {
      -          "type": "number"
      -        },
      -        "total": {
      -          "type": "number"
      -        },
      -        "width": {
      -          "type": "number"
      -        }
      -      },
      -      "required": [],
      -      "type": "object"
      -    },
      -    "type": "array"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "items": {
      +      "additionalProperties": true,
      +      "properties": {
      +        "colour": {
      +          "anyOf": [
      +            {
      +              "type": "string"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ]
      +        },
      +        "drop_mm": {
      +          "type": "number"
      +        },
      +        "mount_type": {
      +          "type": "string"
      +        },
      +        "product_name": {
      +          "type": "string"
      +        },
      +        "product_slug": {
      +          "type": "string"
      +        },
      +        "quantity": {
      +          "type": "number"
      +        },
      +        "total_price": {
      +          "type": "number"
      +        },
      +        "unit_price": {
      +          "type": "number"
      +        },
      +        "width_mm": {
      +          "type": "number"
      +        }
      +      },
      +      "required": [],
      +      "type": "object"
      +    },
      +    "type": "array"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • removedOutput schema / properties / payment_status
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "type": "string"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ]
      -}
  4. Changed8 schema fields changed
    • addedInput schema / anyOf
      Added value: +[
      +  {
      +    "required": [
      +      "cart_id"
      +    ]
      +  },
      +  {
      +    "properties": {
      +      "customer": {
      +        "required": [
      +          "name",
      +          "email",
      +          "phone"
      +        ]
      +      }
      +    },
      +    "required": [
      +      "items",
      +      "customer"
      +    ]
      +  }
      +]
    • addedInput schema / properties / customer / properties / email / description
      Added value: +"Real customer email, checked before checkout creation"
    • addedInput schema / properties / customer / properties / name / description
      Added value: +"Real customer name, checked before checkout creation"
    • addedInput schema / properties / customer / properties / phone / description
      Added value: +"South African phone number, checked before checkout creation"
    • removedInput schema / properties / customer / required
      Removed value: -[
      -  "name",
      -  "email",
      -  "phone"
      -]
    • addedInput schema / properties / items / items
      Added value: +{
      +  "properties": {
      +    "colour": {
      +      "description": "Exact available colour; validate with configure_product before adding",
      +      "minLength": 1,
      +      "type": "string"
      +    },
      +    "finish": {
      +      "description": "Optional pricing finish for aluminium Venetians",
      +      "type": "string"
      +    },
      +    "height_mm": {
      +      "description": "Actual ordered drop in millimetres",
      +      "exclusiveMinimum": 0,
      +      "type": "number"
      +    },
      +    "mount_type": {
      +      "description": "Use inside for recess fit or outside for face fix",
      +      "minLength": 1,
      +      "type": "string"
      +    },
      +    "product_id": {
      +      "description": "product_id returned by search_catalog or lookup_catalog",
      +      "type": "string"
      +    },
      +    "product_name": {
      +      "description": "Optional; server resolves the catalogue name",
      +      "type": "string"
      +    },
      +    "quantity": {
      +      "description": "Number of blinds; defaults to 1",
      +      "type": "number"
      +    },
      +    "total_price_zar": {
      +      "description": "Optional, ignored: server recalculates all totals",
      +      "type": "number"
      +    },
      +    "unit_price_zar": {
      +      "description": "Optional, ignored: server recalculates all prices",
      +      "type": "number"
      +    },
      +    "width_mm": {
      +      "description": "Actual ordered width in millimetres",
      +      "exclusiveMinimum": 0,
      +      "type": "number"
      +    }
      +  },
      +  "required": [
      +    "product_id",
      +    "width_mm",
      +    "height_mm",
      +    "colour",
      +    "mount_type"
      +  ],
      +  "type": "object"
      +}
    • addedInput schema / properties / items / minItems
      Added value: +1
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "additionalProperties": true,
      +  "properties": {
      +    "ap2": {
      +      "additionalProperties": true,
      +      "properties": {
      +        "merchant_authorization": {
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "merchant_authorization"
      +      ],
      +      "type": "object"
      +    },
      +    "checkout_id": {
      +      "type": "string"
      +    },
      +    "created_at": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ]
      +    },
      +    "currency": {
      +      "const": "ZAR",
      +      "type": "string"
      +    },
      +    "customer": {
      +      "additionalProperties": true,
      +      "properties": {
      +        "address": {
      +          "anyOf": [
      +            {
      +              "type": "string"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ]
      +        },
      +        "city": {
      +          "anyOf": [
      +            {
      +              "type": "string"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ]
      +        },
      +        "email": {
      +          "type": "string"
      +        },
      +        "name": {
      +          "type": "string"
      +        },
      +        "phone": {
      +          "anyOf": [
      +            {
      +              "type": "string"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ]
      +        }
      +      },
      +      "required": [],
      +      "type": "object"
      +    },
      +    "item_count": {
      +      "type": "number"
      +    },
      +    "items": {
      +      "anyOf": [
      +        {
      +          "items": {
      +            "additionalProperties": true,
      +            "properties": {
      +              "colour": {
      +                "type": "string"
      +              },
      +              "finish": {
      +                "anyOf": [
      +                  {
      +                    "type": "string"
      +                  },
      +                  {
      +                    "type": "null"
      +                  }
      +                ]
      +              },
      +              "height": {
      +                "type": "number"
      +              },
      +              "mountType": {
      +                "type": "string"
      +              },
      +              "price": {
      +                "type": "number"
      +              },
      +              "productId": {
      +                "type": "string"
      +              },
      +              "productName": {
      +                "type": "string"
      +              },
      +              "quantity": {
      +                "type": "number"
      +              },
      +              "total": {
      +                "type": "number"
      +              },
      +              "width": {
      +                "type": "number"
      +              }
      +            },
      +            "required": [],
      +            "type": "object"
      +          },
      +          "type": "array"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ]
      +    },
      +    "message": {
      +      "type": "string"
      +    },
      +    "next_step": {
      +      "type": "string"
      +    },
      +    "payment_method": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ]
      +    },
      +    "payment_status": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ]
      +    },
      +    "payment_url": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ]
      +    },
      +    "provider_reference": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ]
      +    },
      +    "status": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ]
      +    },
      +    "total_zar": {
      +      "type": "number"
      +    }
      +  },
      +  "required": [
      +    "checkout_id",
      +    "status",
      +    "total_zar",
      +    "currency"
      +  ],
      +  "type": "object"
      +}
  5. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Adds real context beyond the annotations: it discloses the return value (checkout_id), that no payment link exists yet, and that customer details are validated before creation. It does not address the destructiveHint=true flag at all — there is no mention of whether a repeat call creates a duplicate checkout, or that an unwanted one can be undone via cancel_checkout.

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?

Four short sentences, front-loaded with the phase position and the core conversion action, then the precondition, then the return value, then the alternatives. No filler and no repetition of schema text.

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 the one-line mention of checkout_id is enough on the return side, and the sibling routing covers the workflow. The only real gap is mutation safety: a newly created checkout's reversibility/cancellation path is never mentioned despite destructiveHint=true.

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?

With 50% schema description coverage, the description does useful work by spelling out the mutually exclusive cart_id vs items+customer paths and the required customer fields. But it says nothing about payment_method (default yoco), the per-item required attributes, or quantity defaults, so half the parameter surface is still carried only by the schema.

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?

States a specific verb and resource ("Convert a cart ... into a checkout") and frames it positionally as "Phase 1 of 2 in the purchase flow". It names the sibling that finishes the job (complete_checkout) and the one that amends it (update_checkout), so the tool is distinguishable without opening a 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?

Explicit routing: use this to create, use complete_checkout to mint the payment link, use update_checkout to fix customer details before finalising. It also states the hard precondition (name, email, phone required) rather than leaving it to inference.

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