Skip to main content
Glama

WooCommerce: Get top sellers

woocommerce_get_top_sellers
Read-only

Retrieve top-selling WooCommerce products by period or date range, using reports or privacy-safe order aggregation, and return aggregate product totals without customer PII.

Instructions

[UNIFIED] Get top selling products report. Uses WooCommerce reports when available and falls back to privacy-safe order aggregation when reports are empty/unavailable. Returns aggregate product totals only, never customer PII.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "site": "<site>"
    },
    "name": "woocommerce_get_top_sellers"
  }
}

Input Schema

NameRequiredDescriptionDefault
siteYes
limitNo
periodNoweek
date_maxNo
date_minNo
statusesNo
fallback_max_pagesNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv3.14.0
  2. Removedv3.13.1
  3. First observedv3.4.0

TDQS

A3.5/5.0
Behavior4/5

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

readOnlyHint=true already tells the agent this is a safe read, yet the description adds meaningful context beyond that: a dual-source strategy with a fallback to order aggregation, and a guarantee that output is aggregate-only and contains no customer PII. It stops short of disclosing latency/cost implications of the fallback or any result-set size behavior tied to limit/pagination.

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 the purpose front-loaded, followed by source strategy and the privacy guarantee. No filler, no restatement of the title, and each sentence contributes distinct information.

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?

The description covers what the tool returns conceptually (aggregate product totals) and its data sourcing, which is valuable since there is no output schema. However, for a 7-parameter tool with zero schema documentation, the complete absence of parameter guidance leaves real gaps an agent must guess at.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% across 7 parameters — limit, period, date_min, date_max, statuses, site, and fallback_max_pages carry no schema text, enums, or formats. The description never mentions any of them; 'fallback' loosely hints at fallback_max_pages, but period defaults, date format, status filtering semantics, and limit behavior are entirely undocumented, so the description fails to compensate for the coverage gap.

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+resource ('Get top selling products report') and scopes it to product-level aggregates, which distinguishes it from the store-wide sibling woocommerce_get_sales_report. It does not explicitly name that sibling as the alternative, so differentiation is implicit rather than spelled out.

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 explains the internal routing (reports when available, order aggregation as fallback) but gives no guidance on when an agent should choose this over woocommerce_get_sales_report, nor any prerequisites for the 'site' argument or expected cost of the fallback path. Usage is implied by the tool name rather than stated.

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

Deploy Server

Other Tools