Skip to main content
Glama

list_order_bumps

Read-only

List the order bumps on a checkout page or event (shown as add-ons on events) in display order, with how each is offered and any reason it cannot be offered right now. Read-only.

Input Schema

NameRequiredDescriptionDefault
pageIdYesThe ID of the checkout page or event. Use the type you fetched it with (get_checkout_page or get_event).
pageTypeYesThe kind of page the order bump is on: `checkout` for a checkout page, `event` for an event (where order bumps are shown as add-ons).

Output Schema

NameRequiredDescriptionDefault
dataYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • removedOutput schema / $defs / OrderBump / properties / showHideLogic / properties / priceId
      Removed value: -{
      -  "type": [
      -    "string",
      -    "null"
      -  ]
      -}
    • addedOutput schema / $defs / OrderBump / properties / showHideLogic / properties / priceIds
      Added value: +{
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • changedOutput schema / $defs / OrderBump / properties / showHideLogic / required
      Previous value: -[
      -  "enabled",
      -  "subject",
      -  "comparison",
      -  "priceId",
      -  "ticketTypeIds",
      -  "orderBumpProductIds"
      -]New value: +[
      +  "enabled",
      +  "subject",
      +  "comparison",
      +  "priceIds",
      +  "ticketTypeIds",
      +  "orderBumpProductIds"
      +]
  2. Added

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, openWorldHint=false, and destructiveHint=false, and the description is consistent with that by stating "Read-only." It adds useful behavioral detail by saying results include display order, how each bump is offered, and any reason it cannot be offered right now.

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?

The description is two short sentences with no wasted wording. The core listing behavior and scope are front-loaded, followed by the concise "Read-only" safety cue.

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?

Given the rich annotations, 100% schema description coverage, and presence of an output schema, the description supplies enough context for an agent to call this tool correctly. It covers purpose, scope, ordering behavior, and the read-only nature without needing to explain return fields already covered by the output schema.

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 100%, so both pageId and pageType are already well documented in the schema. The description reinforces that the listing applies to a checkout page or event and that events show order bumps as add-ons, but it does not add format or constraint details beyond 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?

The description uses a specific verb and resource ("List the order bumps"), scopes it to a checkout page or event, and adds that results are in display order. It clearly distinguishes this read operation from sibling mutation tools such as create_order_bump, update_order_bump, and reorder_order_bumps.

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?

The description makes the context clear (listing order bumps on a checkout page or event) and notes that it is read-only. However, it does not explicitly state when to use this versus get_checkout_page, get_event, or reorder_order_bumps, leaving usage to be inferred.

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