Skip to main content
Glama
maxiomus

MCP Shopify Admin Server

by maxiomus

Preview Product Publish

product_publish_preview
Read-onlyIdempotent

Preview which products will change publication state and on which channels before executing a bulk publication plan, preventing unintended updates.

Instructions

Preview which products will change publication state, and on which channels.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
operation_idYesOperation ID from product_publish_plan
response_formatNoResponse formatjson
Behavior3/5

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

Annotations already indicate readOnlyHint, idempotentHint, and destructiveHint, covering the safety profile. The description adds context about what the preview displays (products and channels), but does not disclose additional behavioral traits beyond what annotations provide. It is consistent with the annotations, so no contradiction.

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, concise sentence that is front-loaded with the primary purpose. It contains no redundant information and every word contributes to understanding the tool's function.

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?

Given the simple schema and absence of an output schema, the description sufficiently explains the tool's purpose and the nature of its output (which products and channels). It could be more explicit about the requirement for an operation_id from a prior plan, but that is already captured in the schema.

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?

The input schema provides full descriptions for both parameters (operation_id and response_format), achieving 100% coverage. The description adds no extra parameter information, so the baseline 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 resource ('products'), explicitly stating the output scope ('which products will change publication state, and on which channels'). This clearly distinguishes the tool from its plan and execute siblings.

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

Usage Guidelines3/5

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

The description implies it is a preview step for a publish operation, but it does not explicitly state when to use it relative to product_publish_plan or product_publish_execute. The operation_id parameter referencing product_publish_plan in the schema hints at the workflow, but the description itself lacks explicit guidance or alternatives.

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