MCP Shopify Admin Server

Preview Order Cancellation

order_cancel_preview

Read-onlyIdempotent

Preview a planned order cancellation to see its impact before executing. Review expected changes to avoid mistakes.

Instructions

Preview a planned order cancellation. Shows what will happen.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "operation_id": "<operation_id>"
    },
    "name": "order_cancel_preview"
  }
}

Input Schema

Name	Required	Description	Default
`operation_id`	Yes	Operation ID from order_cancel_plan
`response_format`	No	Response format	json

Schema Changelog

Changes observed during successful MCP inspections.

First observedv1.0.0Aug 8, 2026

TDQS

A3.7/5.0

Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, covering the safety profile. The description adds 'Shows what will happen,' which clarifies it is a simulation, but this is not a significant behavioral disclosure beyond what annotations already imply.

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 two concise sentences, front-loaded with the purpose, and every word earns its place. No unnecessary detail or padding.

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?

The tool is simple, with annotations covering safety and schema covering parameters. However, the description does not detail what 'Shows what will happen' actually includes, and there is no output schema. It is adequate but lacks richer context about the returned information.

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%, so parameters are well-documented in the schema. The description itself adds no parameter-specific meaning, and the baseline 3 is appropriate since the schema does the heavy lifting.

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 the specific verb 'Preview' with the resource 'planned order cancellation' and states the outcome ('Shows what will happen'). This clearly distinguishes it from sibling tools like order_cancel_plan and order_cancel_execute.

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 usage after planning ('planned order cancellation') but does not explicitly mention when to use it vs alternatives or provide exclusions. It gives enough context to suggest it is a pre-execution step, but lacks direct guidance.

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

Deploy Server