Skip to main content
Glama

get_inventory

Retrieve WooCommerce inventory levels and stock status for products, and filter results for low-stock or out-of-stock items.

Instructions

Retrieve inventory levels and stock status for products in the WooCommerce store. Supports filtering for low-stock and out-of-stock items (deterministic low stock threshold <= 5).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoPage number for pagination.
limitNoMaximum number of inventory items to return (1-100).
low_stock_onlyNoWhen true, only returns products that are out of stock or have stock quantity below or equal to their low stock threshold (default threshold: <= 5).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full behavioral burden. It conveys the read nature of the call and usefully discloses the deterministic low-stock threshold, but omits permissions/auth requirements, pagination behavior beyond what the schema says, and any side effects or rate limits.

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?

Two tight sentences with the core action front-loaded and the filtering capability immediately after. No filler, though the parenthetical threshold repeats schema content.

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 read-only list tool with three fully documented parameters and no output schema, the description is minimally adequate: it explains what is fetched and the filtering option. It lacks detail on the shape/ordering of returned inventory data and does not compensate for the absence of annotations.

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 the schema already documents page, limit, and low_stock_only thoroughly. The description restates the threshold detail ('<= 5') that the low_stock_only schema field already contains, adding no new parameter meaning.

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?

States a specific verb ('Retrieve') and resource ('inventory levels and stock status for products') scoped to the WooCommerce store, which is clearly distinguishable from the order- and product-centric siblings. It does not explicitly name an alternative, but 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 Guidelines3/5

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

The description implies usage by noting support for filtering low-stock and out-of-stock items, which hints at the relevant scenario. However, it never states when to use this tool versus search_products or get_product, nor any prerequisites or exclusions.

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