Skip to main content
Glama

Low Stock Report

woo_low_stock_report
Read-only

Get WooCommerce products that are low in stock, out of stock, or on backorder. Checks stock at the variation level for variable products. Only includes published products (drafts are excluded by WooCommerce Analytics).

Input Schema

NameRequiredDescriptionDefault
typeNoFilter: "lowstock" (default) — items at or below the WooCommerce low-stock threshold, "outofstock", or "onbackorder"
site_idNoSite ID to target (optional if you have only one connected site)
per_pageNoNumber to return (max 100)
stock_statusNoDeprecated alias for "type". Use "type" instead. "instock" is mapped to "lowstock".

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • changedInput schema / properties / stock_status / description
      Previous value: -"Filter by stock status (default shows out of stock and low stock)"New value: +"Deprecated alias for \"type\". Use \"type\" instead. \"instock\" is mapped to \"lowstock\"."
    • changedInput schema / properties / stock_status / enum
      Previous value: -[
      -  "outofstock",
      -  "onbackorder",
      -  "instock"
      -]New value: +[
      +  "lowstock",
      +  "outofstock",
      +  "onbackorder",
      +  "instock"
      +]
    • addedInput schema / properties / type
      Added value: +{
      +  "description": "Filter: \"lowstock\" (default) — items at or below the WooCommerce low-stock threshold, \"outofstock\", or \"onbackorder\"",
      +  "enum": [
      +    "lowstock",
      +    "outofstock",
      +    "onbackorder"
      +  ],
      +  "type": "string"
      +}
  2. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnlyHint=true, destructiveHint=false, openWorldHint=true), so the description is free to add result-shaping behavior: variation-level stock evaluation for variable products, and the exclusion of drafts because WooCommerce Analytics only covers published products. That is genuine context beyond the annotations, though pagination/return shape is still unmentioned.

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 tight sentences with no filler: purpose first, then the variation-level nuance, then the published-only caveat. Every sentence earns its place and the most important information is front-loaded.

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?

With no output schema, the description still gives an agent enough to call it correctly and anticipate the result set (stock-status products, variation-aware, published only). It stops short of describing returned fields or ordering, a minor gap for a read-only listing tool.

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 every parameter (type, site_id, per_page, stock_status) is already documented in the schema, including the deprecated stock_status alias and the 100-item cap. The description adds nothing parameter-specific, so baseline 3 applies.

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 and resource ('Get WooCommerce products') plus the exact narrowing condition ('low in stock, out of stock, or on backorder'), which cleanly separates it from generic siblings like woo_list_products or woo_sales_report. An agent can identify the tool's output set without opening the schema.

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 when to reach for it (when you need inventory-at-risk items) and the three status buckets map to the type enum, but it never states when NOT to use it or names an alternative such as woo_list_products for full catalogs. Usage is inferable rather than explicit.

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