Skip to main content
Glama
camerone05

shopify-admin-mcp-server

by camerone05

Get Variant Location Fulfilment State

shopify_get_variant_locations
Read-onlyIdempotent

Look up a variant by SKU or GID to see which locations stock and fulfil it, with quantities and inventory item ID. Run before updating variant locations.

Instructions

Look up a variant by SKU (or variant GID) and see exactly which locations stock and fulfil it.

Returns:

  • active_locations: locations that CAN stock & fulfil this variant, with available/on_hand/committed/incoming quantities, plus can_deactivate and any deactivation_blocked_reason

  • inactive_locations: locations that CANNOT — activate one with shopify_set_variant_locations

  • inventory_item_id: needed by shopify_adjust_inventory / shopify_set_inventory

Call this before shopify_set_variant_locations to see the current state.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
skuNoExact variant SKU e.g. 'TSHIRT-BLK-M'
variantIdNoVariant GID — use instead of sku when the SKU is ambiguous or blank

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv4.0.1

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint/idempotentHint/destructiveHint=false, so safety is covered. The description adds real value by enumerating the return structure (active vs inactive locations, per-location quantities, can_deactivate, deactivation_blocked_reason) and showing the mutation path via the sibling tool.

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?

Front-loaded purpose sentence followed by a bulleted breakdown of the return shape and the sequencing instruction. Every line earns its place with no filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

No output schema exists, so the description carries the burden of describing returns—and it does so thoroughly (active/inactive buckets, quantity fields, inventory_item_id). Combined with the sequencing guidance, an agent has everything needed to call it correctly.

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 both parameters (sku, variantId) are already documented in the schema, including the ambiguity/blank guidance that the description only echoes as '(or variant GID)'. Baseline 3 is appropriate; the description adds no syntax detail beyond the 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?

States a specific verb (look up) and resource (variant by SKU/GID) and the exact dimension it reveals (which locations stock and fulfil it). This clearly distinguishes it from siblings like shopify_get_locations and shopify_get_inventory_levels.

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

Usage Guidelines5/5

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

Explicitly states 'Call this before shopify_set_variant_locations to see the current state,' and names shopify_set_variant_locations as the way to activate an inactive location. It also names the downstream consumers (shopify_adjust_inventory / shopify_set_inventory) of inventory_item_id, giving the agent clear routing.

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