Skip to main content
Glama
Sign In
shopify-mcp

shopify-mcp

by miller-joe
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

get_draft_order

Fetch a draft order's full details: status, customer, line items (quantity, title, price), invoice URL, and resulting order if completed. Inspect before update or completion.

Instructions

Fetch a single draft order with full details: status, customer, line items (with quantity, title, and unit price), invoice URL, and the resulting real order if it's already been completed. Use to inspect a draft before calling update_draft_order or complete_draft_order. Returns a friendly text summary.

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": {
      "id": "<id>"
    },
    "name": "get_draft_order"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesDraft order GID, e.g. 'gid://shopify/DraftOrder/12345'. Get one from list_draft_orders.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.1.1
    • changedInput schema / properties / id / description
      Previous value: -"Draft order GID, e.g. gid://shopify/DraftOrder/12345"New value: +"Draft order GID, e.g. 'gid://shopify/DraftOrder/12345'. Get one from list_draft_orders."
  2. First observedv0.1.0

TDQS

A4.4/5.0
Behavior4/5

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

No annotations provided, so description carries full burden. Describes read-only behavior and details of return value. Lacks information on error handling or permissions, but for a fetch tool this is adequate.

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?

Three sentences, no filler. Front-loaded with purpose and return details. Every sentence contributes meaning.

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?

Simple tool with one param. Description covers what, when, and return format. Missing error conditions, but overall sufficient for agent use.

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

Parameters4/5

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

Schema has 100% coverage with id description. Description adds value by suggesting source of ID ('Get one from list_draft_orders'), aiding parameter generation beyond schema.

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?

Description clearly states verb 'Fetch' and resource 'single draft order', lists specific details returned, and differentiates from siblings like update_draft_order and complete_draft_order.

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?

Explicitly recommends using before update_draft_order or complete_draft_order, providing clear context. Does not mention alternatives like list_draft_orders, but the guidance is sufficient for agent decision.

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

Deploy Server

Other Tools