Skip to main content
Glama

woo_helper_get_invoice_order

Retrieve a WooCommerce order's invoice state—status, invoice number, errors, attempts, PDF availability, dry-run preview, and credit notes—to diagnose invoicing.

Instructions

Invoice state of one order: status, invoice number, error, attempts, has_pdf, the dry-run request preview, and credit notes.

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>",
      "order_id": "<order_id>"
    },
    "name": "woo_helper_get_invoice_order"
  }
}

Input Schema

NameRequiredDescriptionDefault
siteYesSite id (see list_sites)
order_idYesWooCommerce order id

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv3.14.0

TDQS

B3.2/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the full burden. It does useful work by disclosing the shape of the returned record, including the dry-run request preview and credit notes, which hints that invoice generation may be previewed and retried (status, error, attempts). It says nothing about permissions, whether external invoicing calls are triggered, or how stale the state can be.

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?

A single front-loaded sentence that states the resource first and then the returned fields, with no filler. The trailing field list is dense but every item is informative for an agent deciding whether this tool answers its question.

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?

With no output schema, the description appropriately enumerates the fields returned, so an agent knows roughly what comes back. However, terms like 'dry-run request preview' and 'credit notes' are left undefined, and nothing indicates failure behavior when no invoice exists yet for the order — a meaningful gap for an invoice-state lookup.

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% for both parameters (site, order_id) and both are required with clear inline descriptions, so the baseline of 3 applies. The description adds no additional meaning about how site selection or order_id resolution works beyond what the schema already states.

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?

The description names a specific resource and scope: the invoice state of a single order, and enumerates the returned facts (status, invoice number, error, attempts, has_pdf, dry-run preview, credit notes). This clearly separates it from sibling list tools such as woo_helper_list_invoice_orders and woo_helper_get_invoices. It stops short of an explicit action verb, but the read intent 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?

There is no stated when-to-use or when-not-to-use guidance, and no sibling is named as an alternative (e.g. woo_get_order for general order data, woo_helper_list_invoice_orders for a batch). The 'one order' phrasing only implicitly implies a single-record lookup, leaving the agent to infer the routing decision.

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