Skip to main content
Glama

Checkout Page

by com.checkoutpage
OverviewDiscussionsAdmin

upload_file

Upload a file into your Checkout Page account from a public URL.

Use this tool when you need a Checkout Page file ID to reference elsewhere in the API. The tool fetches the source file from url, uploads it to Checkout Page, and returns the stored file record.

Purpose matters:

  • purpose: "image" uploads a public image asset. Use this for page galleries, product galleries, ticket visuals, logos, hero images, and other media shown on the page.

  • purpose: "file" uploads a private downloadable asset. Use this for digital downloads attached to checkout pages, files restricted to certain product variants, and files delivered after a form submission.

How uploaded files are typically used:

  • Page gallery images on checkout pages, events or forms.

  • Product gallery images and variant-specific images

  • Ticket types where an image is needed

  • Downloadable files attached to products or checkout pages after purchase or forms after submission.

Input notes:

  • url MUST be a public URL. The MCP server will make a http request to directly download the resource.

  • filename is optional and overrides the stored filename.

  • Images uploaded as purpose: "image" must still be a supported image type upstream.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlYesPublic URL of the file to fetch and upload into Checkout Page. The MCP tool downloads the file from this URL, then sends it to the Upload File API.
purposeNoUse `image` for public display assets such as page galleries, product galleries, ticket visuals, or similar media. Use `file` for private downloadable assets such as PDFs, digital downloads, or post-submission form downloads.image
filenameNoOptional filename override. If omitted, the tool derives a name from the source URL when possible.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Adds useful behavior beyond annotations: the MCP server makes an HTTP request to download the resource from the public URL, filename can override the stored name, and image uploads must be supported upstream. Annotations already cover safety (readOnlyHint=false, destructiveHint=false, openWorldHint=true), but the description omits auth, rate-limit, or idempotency details.

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

Conciseness3/5

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

Front-loads the core action well, but the 'Purpose matters' section, the 'How uploaded files are typically used' list, and the 'Input notes' repeat much of the schema and each other. Sections like the typical-usage list add bulk without much new selection value.

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 presence of an output schema and annotations, the description is complete enough: it covers the source URL requirement, purpose semantics, filename override, and typical usage. Return values and safety profile are handled by structured fields, so no critical information 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%, so the schema already documents url, purpose, and filename. The description reinforces the public URL requirement and purpose values but does not add parameter semantics beyond what the schema provides.

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: 'Upload a file into your Checkout Page account from a public URL.' It also clarifies the outcome ('returns the stored file record') and when a Checkout Page file ID is needed, making it easy to distinguish from the create_* and update_* siblings.

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?

Clearly says when to use it: 'Use this tool when you need a Checkout Page file ID to reference elsewhere in the API.' It also explains the two purpose modes and their use cases, but it does not name alternative tools or explicit when-not conditions, so it falls short of a 5.

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

All Checkout Page toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources