Skip to main content
Glama
maxiomus

MCP Shopify Admin Server

by maxiomus

Preview Collection Update

collection_update_preview
Read-onlyIdempotent

Preview planned collection updates by comparing current vs new state. Use operation ID from update planning to validate changes before applying.

Instructions

Preview a planned collection update, showing current vs new state.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
operation_idYesOperation ID from collection_update_plan
response_formatNoResponse formatjson
Behavior4/5

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

The description adds behavioral detail beyond annotations by stating it shows 'current vs new state'. Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so no contradiction. It doesn't detail side effects, but the annotations cover the safety profile.

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?

The description is a single, front-loaded sentence that clearly states the action and resource without any filler or redundant information. Every word earns its place.

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 tool without an output schema, the description provides the key behavioral fact (current vs new state) and relies on annotations for safety. The workflow context is partly implied by sibling tool names and the parameter reference to collection_update_plan, making it reasonably complete for a simple preview operation.

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 clear descriptions for both operation_id and response_format, including an enum and default for the latter. The description itself does not add parameter-specific meaning, so the baseline score of 3 is appropriate.

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?

The description uses a specific verb ('Preview') and identifies the resource ('planned collection update'), clearly distinguishing it from the sibling tools collection_update_plan and collection_update_execute. The added phrase 'showing current vs new state' further clarifies the tool's function.

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?

The description implies a clear usage context: use this tool to preview a planned update before execution. It references 'planned collection update' and the operation_id comes from collection_update_plan, but it does not explicitly state alternatives or when-not-to-use. This is sufficient for a straightforward preview tool.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/maxiomus/mcp-shopify-admin'

If you have feedback or need assistance with the MCP directory API, please join our Discord server