sync_shopify
Trigger a sync of Shopify product and page data to Xyle.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| site_id | Yes | The site ID |
Trigger a sync of Shopify product and page data to Xyle.
| Name | Required | Description | Default |
|---|---|---|---|
| site_id | Yes | The site ID |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already flag this as non-read-only, open-world, idempotent and destructive, but the description adds nothing about behavior: what existing Xyle data may be overwritten, whether the call is synchronous or returns a job handle, and how long a sync takes are all undisclosed. The word 'trigger' hints at an async kickoff, which is the only extra signal.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
One short, front-loaded sentence with no filler. It is appropriately sized, though the terseness is partly what leaves behavioral gaps.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a destructive, open-world mutation with no output schema, the description omits key facts an agent needs: what gets replaced, whether success is terminal or eventual, and any prerequisite connection state. It is not complete enough for a write operation of this risk profile.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
With a single parameter at 100% schema description coverage, the schema already defines site_id. The description adds no further meaning (e.g. which site's Shopify store is targeted), so the baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description gives a specific verb ('Trigger a sync') plus the resource and direction ('Shopify product and page data to Xyle'), which cleanly separates it from read-oriented siblings like get_shopify_products and get_shopify_status. It does not explicitly name an alternative, but the purpose is unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no guidance on when this should be run versus get_shopify_status or get_shopify_products, and no prerequisites stated (e.g. whether the Shopify connection must already exist). The agent must infer the whole usage context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.