Skip to main content
Glama

Frontman for WordPress

wc_get_stock_report

Read-onlyIdempotent

Retrieves WooCommerce stock reports. Mirrors woocommerce-mcp-server method get_stock_report using local WordPress authentication; no WooCommerce REST API keys are required.

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_id": "<site_id>"
    },
    "name": "wc_get_stock_report"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageNoPage number. Default 1.
filtersNoWooCommerce REST API report filters to pass through.
perPageNoNumber of results per page. Default 10, max 100.
site_idYesThe connected site's id returned by list_sites. Call list_sites first; do not use a URL or WordPress post ID.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive, and closed-world, so the safety profile is covered. The description adds genuinely useful context that no REST API keys are needed because it uses local WordPress authentication. However, it says nothing about what the report contains (stock levels, low/out-of-stock status) or how pagination behaves across pages.

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 compact sentences: purpose first, then authentication context. No padding, though the mention of mirroring an internal server method is closer to implementation trivia than agent-usable 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?

For a read-only report tool with four parameters and no output schema, the description should indicate what the report returns and what filter keys are valid. The auth note is helpful, but an agent still cannot predict the response shape or how to filter meaningfully.

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 page, perPage, site_id, and filters are already documented in structured data. The description adds no further meaning, and notably does not clarify what the open-ended pass-through 'filters' object accepts, leaving that opaque.

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 and resource ('Retrieves WooCommerce stock reports'), which is clear and distinct from other wc_get_*_report siblings by resource name. It does not explicitly contrast itself with those siblings, but the resource 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 Guidelines2/5

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

The description offers no when-to-use guidance, no prerequisites, and no mention of alternatives such as the products or sales reports. The only procedural hint (call list_sites first) lives in the schema, not the description.

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.