Skip to main content
Glama

Update a collection

update_collection
Destructive

Update a shop collection’s name, description, or product list by ID, so you can revise existing collection details and assigned products.

Instructions

Rate limit: 100 requests / 10 seconds per shop. See Rate limiting.

Updates collection name, description, and/or product list

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNo
accountNoExact private shop profile label; not a provider identity or authorization proof.
confirmNoExplicit approval for this exact provider effect or local private-file operation.
payloadNoComplete current native JSON body; cannot mix with native body flags or payload_file.
offerIdsNoList of product IDs to set in the collection
descriptionNo
payload_fileNoAbsolute regular non-symlink native JSON body file, at most1MiB. Cannot mix with payload or body flags.
collection_idYesNative collectionId

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare destructiveHint=true, idempotentHint=false, openWorldHint=true, so the risk profile is partly covered. The description adds a genuinely useful non-annotation detail: 100 requests / 10 seconds per shop. However, it never explains the destructive semantics implied by offerIds (replacing the collection's product list) nor mentions the required confirm/account fields for this mutation.

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?

Two compact sentences with no filler; the rate-limit note is a single pointer to documentation rather than an essay. Slight deduction because the operational note is placed ahead of the actual statement of purpose, so the substance is not fully front-loaded.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For an 8-parameter, nested-object, non-idempotent mutation with no output schema, the description covers rate limiting but omits how the mutually exclusive payload, payload_file, and flat body flags interact, and says nothing about the confirm requirement. Adequate but with clear gaps an agent would need to resolve from the schema alone.

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 75%, so structured fields already document most parameters, and 75% is high enough that the baseline is 3. The description maps cleanly onto name/description/offerIds but adds no format or behavioral detail beyond what the schema states, and is silent on the payload-vs-flat-field alternatives.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names a specific verb (Updates) and resource (collection) and enumerates the mutable fields: name, description, product list. That is clear enough for an agent to know what the tool does, but it does not distinguish itself from close siblings like update_collection_products or update_collection_availability, which overlap with the 'product list' wording.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no guidance on when to use this tool versus update_collection_products, update_collection_availability, or create_collection, and no stated prerequisites. The only contextual information is a rate-limit pointer, which is operational rather than selection guidance.

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

Deploy Server

Other Tools