Skip to main content
Glama

update_customer

Destructive

Update the editable details of a customer record in your Checkout Page account.

Use list_customers first if you need to discover the customer ID by name or email. If the customer ID does not exist, returns a 404 error: "Customer not found".

Only the fields you supply are changed; omitted fields are left as-is. The address and shipping subdocuments use patch semantics — supply only the sub-fields you want to change. Send null for any optional field (or for a whole subdocument) to clear it. The primary email field cannot be cleared.

This tool modifies live data and notifies external systems. Every successful update sends a customer.updated webhook, carrying the full updated customer profile, to each endpoint the merchant has subscribed to that event.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoCustomer full name. Send `null` to clear.
emailNoPrimary customer email address. Trimmed and lowercased before storage. Cannot be cleared via this endpoint.
phoneNoCustomer phone number. Send `null` to clear.
addressNoBilling address. Patch semantics — only the subfields you supply are changed. Send `null` to clear the whole subdocument.
shippingNoShipping details. Patch semantics — only the fields you supply are changed (including nested `shipping.address` subfields). Send `null` to clear the whole subdocument.
customerIdYesThe ID of the customer to update. Use `list_customers` first if you need to discover the customer ID by name or email.
companyNameNoCustomer company name. Send `null` to clear.
billingEmailNoBilling email address. Can be different from the primary email. Trimmed and lowercased before storage. Send `null` to clear.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Goes well beyond the annotations: it discloses patch semantics, that omitted fields are untouched, that `null` clears optional fields/subdocuments, that `email` cannot be cleared, the exact 404 behavior, and critically that every successful update fires a `customer.updated` webhook to external endpoints. The destructiveHint/openWorldHint annotations are confirmed and enriched with concrete consequences.

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 purpose, then discovery guidance, then semantics, then the bolded side-effect warning — a sensible ordering with no filler sentences. Slight redundancy with the schema's per-field patch/null notes costs it the top mark.

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 values need not be described, and the description covers the remaining unknowns an agent needs: partial-update semantics, clearing behavior, error behavior, and the external webhook side effect. Nothing material is missing for an 8-parameter mutation tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the schema already documents most parameters; the baseline is 3. The description adds cross-field semantics not present in any single schema entry — the global 'only supplied fields change' rule, whole-subdocument patch/clear behavior, and the email-clearing exception — earning a modest bump above baseline.

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 ('Update the editable details of a customer record') with the account scope named. It also routes the agent to the sibling `list_customers` for ID discovery, so it is distinguishable from at least one adjacent tool without opening a 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?

Gives an explicit prerequisite ('Use `list_customers` first if you need to discover the customer ID by name or email'), which is actionable context for a tool requiring a customerId. It does not state when NOT to use this tool (e.g. use get_customer for read-only inspection), so it stops short of full when/when-not guidance.

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