Skip to main content
Glama

create_checkout

Generate a hosted checkout or payment link for a live vendor, returning a payable short link to accept payments, sell products or subscriptions, or send a pay link.

Instructions

Create a hosted checkout / payment link to charge a customer for a live vendor, and return a payable shortLink. The vendor must already be live (go_live). Use after go_live to accept a payment, sell a product or subscription, or send someone a pay link.

Input Schema

NameRequiredDescriptionDefault
envYesEnvironment the vendor lives in
amountYesAmount in major units, e.g. 50 = £50.00
currencyNoDefault GBP
vendorIdYes
referenceNoYour order/invoice reference
access_tokenNoThe vendor's paas.build access token for this env (returned by go_live). Send it: it will soon be required.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.3.0
    • addedInput schema / properties / access_token
      Added value: +{
      +  "description": "The vendor's paas.build access token for this env (returned by go_live). Send it: it will soon be required.",
      +  "type": "string"
      +}
  2. First observedv1.0.0

TDQS

A3.7/5.0
Behavior3/5

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

No annotations are provided, so the description carries the disclosure burden alone. It does disclose the key output (a payable shortLink) and the go_live prerequisite, but says nothing about link expiry, idempotency, sandbox-vs-production effects, or whether the access_token will be enforced — meaningful gaps for a payment-creating 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?

Two tight sentences, zero filler, with the core action and return value front-loaded before the prerequisite and use cases.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Adequate for a 6-parameter mutation: the go_live prerequisite and the shortLink return are covered and the schema handles most field detail. But with no annotations and no output schema, the missing guidance on choice versus create_subscription_checkout and on link lifetime/enforcement of access_token leaves real holes.

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 83%, so the schema already documents env, amount units, currency default, reference, and the access_token hint. The description adds no parameter-level meaning beyond what those field descriptions already say, so the baseline 3 applies.

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 — 'Create a hosted checkout / payment link to charge a customer' — and even names the return value (payable shortLink). It stops short of distinguishing itself from the sibling create_subscription_checkout, and mentions 'subscription' in its own usage line, which blurs the boundary.

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?

Gives an explicit precondition ('The vendor must already be live (go_live)') and concrete scenarios ('accept a payment, sell a product or subscription, or send someone a pay link'). No exclusion rules — an agent still has to guess when create_subscription_checkout is the better choice.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.