Skip to main content
Glama
Sign In
mcp-server-woocommerce

mcp-server-woocommerce

by AmitGurbani
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

get_top_sellers

Read-only

Identify your best-selling products by quantity sold, with filtering by preset periods or custom date ranges to track sales trends.

Instructions

Get top-selling products ranked by quantity sold. Filterable by period or date range.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_top_sellers"
  }
}

Input Schema

NameRequiredDescriptionDefault
fieldsNoComma-separated fields to return (default: title,product_id,quantity)
periodNoPredefined period
date_maxNoEnd date (YYYY-MM-DD)
date_minNoStart date (YYYY-MM-DD)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.2.0

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, so the safety profile is established. The description adds that results are ranked by quantity sold and filterable, but does not disclose return format or pagination. It adds some context but not rich behavioral details.

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?

The description is two concise sentences, front-loaded with the primary purpose and followed by filtering options. No wasted words.

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 simple read-only list tool with well-documented schema parameters, the description sufficiently explains what it does and its filtering capabilities. The absence of output schema is acceptable as the tool's return is implied by the resource type.

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 four parameters are documented. The description mentions 'period or date range' which maps to the period/date_min/date_max parameters, but does not add extra meaning beyond what the schema already provides.

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 tool's function: retrieving top-selling products ranked by quantity sold. This distinguishes it from siblings like list_products or get_sales_report by specifying the ranking criterion and the focus on top sellers.

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 clear context (filterable by period or date range) but does not explicitly mention alternatives or when not to use it. It implies usage for sales analysis but lacks explicit exclusions.

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