Skip to main content
Glama

get_checkout_page

Read-only

Retrieve a single checkout page by ID from your Checkout Page account.

Use this tool when you already know the checkout page ID and want to inspect the current configuration.

If the checkout page ID does not exist, returns a 404 error: "Checkout page not found".

Example uses:

  • "Fetch checkout page 6812fe6e9f39b6760576f01c"

  • "Show me the current settings for checkout page X"

  • "Check whether this checkout page is draft, published or archived"

  • "Inspect the product, files, images, or redirect settings on this page"

For create flows, use create_checkout_page. For a direct lookup after creation, pass the returned page id into this tool.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageIdYesThe ID of the checkout page to retrieve. You can get this from `create_checkout_page`, the dashboard, or another Checkout Page API response.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=false, so safety is covered structurally. The description adds real behavioral context beyond that: the exact 404 failure mode and message, and the fact that the returned configuration includes status (draft/published/archived), product, files, images, and redirect settings.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the core action and usage condition in the first two sentences, then alternatives, then examples. The four example utterances are somewhat repetitive but each exercises a distinct intent (fetch, inspect settings, check status, inspect sub-resources), so they earn most of their space.

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?

An output schema exists so return-shape detail is unnecessary, and the description still covers the one thing the schema can't: the 404 error path. Nothing an agent needs to invoke this correctly is missing.

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% and the single pageId parameter is already documented with its 24-char hex pattern and sourcing guidance, so the description's 'by ID' adds little. Baseline 3 is appropriate when the schema does the heavy lifting.

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+resource ('Retrieve a single checkout page by ID') and immediately scopes it to an existing-resource lookup, which cleanly separates it from list_checkout_pages, create_checkout_page, and update_checkout_page in the sibling set.

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?

Explicitly states when to use it ('when you already know the checkout page ID') and routes the agent elsewhere for the adjacent flow ('For create flows, use `create_checkout_page`'). It even covers the chained workflow of passing the id returned by creation into this tool.

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