Skip to main content
Glama

Frontman for WordPress

wc_get_order_refund

Read-onlyIdempotent

Gets one WooCommerce order refund. Mirrors woocommerce-mcp-server method get_order_refund 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>",
      "orderId": "<orderId>",
      "refundId": "<refundId>"
    },
    "name": "wc_get_order_refund"
  }
}

Input Schema

NameRequiredDescriptionDefault
orderIdYesThe order ID.
site_idYesThe connected site's id returned by list_sites. Call list_sites first; do not use a URL or WordPress post ID.
refundIdYesThe refund 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 readOnlyHint, idempotentHint, destructiveHint=false, and openWorldHint=false, so the safety profile is fully covered. The description adds genuinely new context about authentication (local WordPress auth, no WooCommerce REST API keys), which is a creditable addition. It says nothing about the response shape or what happens when a refund ID does not exist.

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 short sentences with the operation front-loaded and the auth note second. Minimal waste, though the implementation-mirroring clause ("Mirrors woocommerce-mcp-server method get_order_refund") is mostly provenance detail rather than actionable 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?

This is a simple three-parameter read tool with complete schema coverage and full annotations, so the burden is low. However, with no output schema, the description could say what a refund record contains or how the response is shaped, and it never distinguishes single fetch from the list sibling.

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 coverage is 100% and all three parameters are documented in the schema, including the useful warning not to pass a URL or post ID for site_id. The description itself adds no parameter meaning beyond that, so the baseline of 3 applies.

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?

"Gets one WooCommerce order refund" gives a specific verb and resource and the word "one" signals single-record retrieval. It does not explicitly name wc_get_order_refunds or wc_get_order as the alternatives, so the differentiation from siblings is left implicit.

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 when-to-use or when-not-to-use guidance: nothing says to prefer wc_get_order_refunds for listing or wc_get_order for the parent order. The only hint is the schema note to call list_sites first, which lives in the parameter description rather than the tool 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.