Skip to main content
Glama

sync_collection

Sync a collection to a sales channel (creates/updates the channel-side category and places all products in it that are already synced there). integration_uuid selects which channel; not all channels support collections (e.g. TikTok Shop), which returns a clear "collections_unsupported" error.

[#7f246a]

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
workspaceNo
store_uuidYes
collection_uuidYes
integration_uuidYesThe sales-channel integration to sync this collection to (required by the platform).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior4/5

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

Annotations only declare openWorldHint, so the description must carry the mutation story and it does: it discloses the create/update side effect on the channel-side category, the product-placement behavior, and a named error condition. It omits permissions, idempotency, and what happens when products are later removed from the collection.

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?

The two-sentence body is dense and front-loaded with the operation and its channel effect, which is good. However, the trailing artifact '[#7f246a]' is pure noise, and the parenthetical pushes the core effect ahead of the selection rule.

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 a mutation tool with only an openWorldHint annotation, no output schema, and low schema description coverage, the description covers side effects and one failure mode but leaves required identifiers (store_uuid, collection_uuid), auth requirements, and return behavior unexplained.

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

Parameters2/5

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

Schema coverage is only 25%, so the description must compensate, and it does not: store_uuid and collection_uuid are undocumented in both places, and the only parameter it discusses (integration_uuid) is already described in the schema. It adds no new parameter meaning beyond the schema's own text.

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 gives a specific verb+resource ('Sync a collection') plus the target ('to a sales channel') and spells out the channel-side effect (creates/updates the channel-side category and places synced products in it). That clearly separates it from sync_to_channel/sync_to_fulfillment by object, though it never names those siblings explicitly.

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?

It states the selection rule for the channel (integration_uuid) and gives a real when-not case: channels that don't support collections, e.g. TikTok Shop, return 'collections_unsupported'. There is still no routing pointer to a fallback tool for unsupported channels, 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.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources