Skip to main content
Glama

List Shopify inventory

list_shopify_inventory
Read-onlyIdempotent

List product variant inventory levels from the connected Shopify store — SKU, quantity, and which product each variant belongs to. Optional query (Shopify search syntax) filters by product/variant. Use to check current stock levels before restocking or listing decisions.

Routing: Shopify inventory: variant stock levels (SKU/quantity) from the live store

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoHow many variants to return (default 20, max 50)
queryNoOptional Shopify variant/product search, e.g. "sku:ABC-1" or "product_title:shampoo"
companyIdYesFreedomOS company id to act within (you must be a member). Required for company-scoped tools.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.9/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 that it reads from the 'live store' and returns variant-level data, which is useful but not extensive. It doesn't disclose pagination behavior beyond the limit parameter, but the annotation coverage lowers the burden.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is concise, with the primary purpose front-loaded. The routing line at the end is slightly redundant but does not detract. It avoids verbosity and is easy to scan.

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?

For a list tool, the description covers the return content, the optional query, and the limit parameter (via schema). There is no output schema, but the description states what is returned. It is complete enough for an agent to understand what it will get.

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 all three parameters (limit, query, companyId) are already documented with descriptions and examples. The description mentions the query filter but doesn't add significant meaning beyond the schema. Baseline 3 is appropriate when the schema carries the semantic load.

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 clearly states the verb 'List' and the resource 'product variant inventory levels', specifying the returned fields (SKU, quantity, product). It distinguishes from sibling tools like list_shopify_products (which list products, not inventory) and adjust_shopify_inventory (which modifies stock). The purpose is unambiguous.

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?

The description provides a clear use case: 'Use to check current stock levels before restocking or listing decisions.' It also mentions the routing for Shopify inventory. However, it does not explicitly exclude alternatives or state when not to use this tool, though the context makes it clear this is for reading inventory.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources