Skip to main content
Glama

shopify_get_inventory_levels

Read-onlyIdempotent

Retrieve inventory levels by product or inventory item, using inventoryItemId and after to paginate through locations for multi-store management.

Instructions

Get inventory by product or inventory item. Use inventoryItemId and after to page through additional locations.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
afterNo
firstNo
storeYes
productIdNo
inventoryItemIdNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.6.0

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, openWorldHint, idempotentHint, and destructiveHint=false, so the safety profile is covered. The description adds a behavioral detail beyond annotations: results are paginated with a cursor and can span multiple locations. It does not reveal return format, max pages, or any rate-limit implications, but nothing contradicts the annotations.

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?

Two terse sentences: the first states the operation and filter options, the second gives the key pagination behavior. No filler or repetition; information is front-loaded and easy to scan.

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?

For a simple read-only query with annotations and a small schema, the core invocation is described, and the pagination hint is helpful. Still, with no output schema and zero parameter descriptions, an agent is left to infer the meaning of 'first' and store, and what fields the returned inventory levels contain.

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 coverage is 0%, so the description carries the burden. It usefully maps productId to 'by product', inventoryItemId to 'by inventory item', and after to pagination. However, it says nothing about the required store parameter or the first page-size parameter, and it does not explain the Shopify GID format beyond the schema patterns.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses a specific verb ('Get') and identifies the resource ('inventory') with clear filter dimensions: by product or inventory item. It does not explicitly name a sibling tool, but the read-oriented wording differentiates it from write tools like shopify_set_inventory and analysis tools like shopify_low_stock_report.

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 gives a concrete how-to for pagination ('Use inventoryItemId and after to page through additional locations'), which is useful usage guidance. However, it never states when to prefer this tool over alternatives such as shopify_compare_inventory, shopify_store_locations, or shopify_set_inventory, leaving the choice largely implicit.

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