Checkout Page

update_field

Destructive

Update one custom field on a checkout page, form, or event: label, element, type, options, required, hidden, default value, visibility rules and more. Only supplied properties change; options are replaced wholesale. Get field IDs from get_checkout_page, get_form, or get_event. Mutating.

Input Schema

TableJSON Schema

Name	Required	Description
`type`	No	Used to store field data in a predictable manner. Please note that you must use Customer Name and Shipping Address if you wish to use any of the shipping address data types. Do not set `type` when `element` is one of: `checkbox`, `quantity`, `tax-id`, `po-number`, `multiple-choice`, `multi-select`, `date-time`, `date`, `time`, `textarea`.
`label`	No	Form label for the input element.
`order`	No	Display order of this field. When omitted, order is determined by the position of the field in the array.
`hidden`	No	Whether this field is hidden from customers at checkout.
`layout`	No	How a multi-select field is drawn at checkout: `dropdown` (the default) or `list`, a list of checkboxes. Ignored on other elements.
`pageId`	Yes	The ID of the page the field belongs to.
`collect`	No	Whether to collect only a billing address or both billing and shipping. Applies to `address` elements. Defaults to `billing`.
`element`	No	Input control used to render this field in checkout. Defaults to `text`.
`fieldId`	Yes	The ID of the field. Field IDs are listed under `fields` in the page detail response from get_checkout_page, get_form, or get_event.
`options`	No	Selectable options for `select`, `multi-select` and `multiple-choice` elements. Replaced wholesale: every option gets a new ID, so re-point any other field whose showHideLogic references one of these options afterwards. Options on a `multi-select` need different values (an option without a value uses its label), and options on a `multiple-choice` need different labels.
`maxValue`	No	Maximum allowed value settings for this field.
`minValue`	No	Minimum allowed value settings for this field.
`pageType`	Yes	The kind of page the field belongs to: `checkout`, `form`, or `event`. Use the type of the tool you fetched the page with (get_checkout_page, get_form, get_event).
`required`	No	Whether this field must be completed before checkout can continue.
`reference`	No	External reference ID for integration purposes. Generated from the field type or label when omitted.
`description`	No	Optional helper text shown below the field label.
`placeholder`	No	Specifies a short hint that describes the expected value of an input element
`defaultValue`	No	Default value settings for the field.
`showHideLogic`	No	Conditional visibility rules for this field. `element.elementId` must be the ID of another field on the same page, and `value` an option ID on that field (or `TRUE`/`FALSE` for a checkbox). Read the IDs from the page detail response; create-time keys are rejected here.
`defaultCountry`	No	ISO 3166-1 alpha-2 country code used as the default for `address` elements. Defaults to `US`.
`collectShippingPhone`	No	Whether to collect a phone number alongside the shipping address. Applies to `address` elements when `collect` is `billing_and_shipping`. Defaults to `false`.
`showSelectedDialCode`	No	Whether to display the selected international dial code in phone inputs.
`limitAllowedCountries`	No	Country restriction settings for country-based fields.
`limitBillingCountries`	No	Restrict the billing country list. Applies to `address` elements.
`limitShippingCountries`	No	Restrict the shipping country list. Applies to `address` elements when `collect` is `billing_and_shipping`.

Output Schema

TableJSON Schema

Name	Required	Description	Default
`data`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

First observedOct 15, 2026

TDQS

A4.2/5.0

Behavior4/5

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

Annotations already declare destructiveHint=true and openWorldHint=true, so the safety profile is covered; the description adds real context beyond them by disclosing that options are replaced wholesale (a destructive side effect) and that unsupplied properties are left untouched. It stops short of noting auth requirements or failure modes.

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?

Front-loaded with verb and resource, followed by the update semantics, the ID-sourcing prerequisite, and a one-word mutation flag. Every sentence carries information and nothing is padding.

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?

For a 25-parameter mutation tool, the description plus the 100%-covered schema and existing output schema cover what an agent needs to invoke it. Gaps are minor: no mention of permission requirements or what happens when a referenced field/option ID is invalid.

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%, with per-parameter descriptions covering the tricky cases (element/type interaction, showHideLogic value resolution, wholesale option replacement). The description's list of updatable properties is a useful summary but adds little the schema does not already document, so the baseline 3 applies.

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?

Specific verb 'Update' on a specific resource 'one custom field' scoped to checkout pages, forms, and events, with an enumeration of the updatable properties. It clearly distinguishes itself from siblings like create_field and delete_field without the agent needing to open any schema.

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?

States the prerequisite for obtaining field IDs (get_checkout_page, get_form, get_event) and clarifies PATCH semantics ('Only supplied properties change'). It does not explicitly route the agent away from update_checkout_page or update_form, but the 'one custom field' scoping makes the boundary evident.

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

All Checkout Page tools Inspect

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

Need Help?