Skip to main content
Glama

legal_put_shop_withdrawal

Configure legally required WooCommerce withdrawal settings, including labels, emails, links, and period, while leaving unspecified keys unchanged and rejecting invalid values.

Instructions

Change the withdrawal function settings; only the keys given change, an invalid value is a 400 and nothing is written. core_feature switches WooCommerce's own withdrawal feature (409 below WooCommerce 11.1). The two labels are legally prescribed: change them only to the wording the law requires.

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": "legal_put_shop_withdrawal"
  }
}

Input Schema

NameRequiredDescriptionDefault
siteYesSite id (see list_sites)
emailsNoEmails that carry the withdrawal link
footerNoHighlighted link at the end of every page
enabledNocvrt-legal completes WooCommerce's withdrawal function
link_labelNoLabel of the function (prescribed wording)
item_pickerNoItem list for 'specific items only' (order's own customer)
account_menuNoMy Account menu item
core_featureNoWooCommerce's own withdrawal feature on/off
single_emailNoAsk for the email address only once
confirm_labelNoLabel of the confirmation button (prescribed wording)
order_actionsNoWithdrawal action on orders
withdrawal_daysNoWithdrawal period in days (14-365)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv3.14.0

TDQS

A4.1/5.0
Behavior4/5

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

With no annotations the description carries the full burden and does a fair job: it discloses all-or-nothing write behavior on validation failure, a specific failure mode (409 when core_feature is used below WooCommerce 11.1), and a legal caution on the label fields. It does not mention auth requirements, whether concurrent writes conflict, or what the response contains after a successful update.

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 sentences, each doing distinct work: partial-update and validation semantics first, the core_feature caveat second, the legal constraint on labels last. No filler and no repetition of schema content.

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 12-parameter mutation tool with no annotations and no output schema, the description covers the risky parts (atomicity, the 409 condition, the legal constraint on labels). It is slightly thin on post-write behavior and permission requirements, but an agent can call it correctly from what is given.

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

Parameters4/5

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

Schema coverage is 100%, so a 3 is the baseline; the description earns above that by explaining what core_feature actually toggles (WooCommerce's own withdrawal feature, with the 409 version floor) and by framing link_label and confirm_label as legally prescribed wording rather than free text. The other ten parameters are left entirely to the schema.

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?

"Change the withdrawal function settings" gives a specific verb and resource, and the phrase "only the keys given change" immediately establishes patch semantics, which distinguishes it from the read-side sibling legal_get_shop_withdrawal. It stops short of naming any alternative explicitly, so it is clear but not fully sibling-differentiated.

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?

Guidance is concrete: send only the keys you want changed, an invalid value yields a 400 with no write, and the two labels should only be altered to wording the law requires. What is missing is an explicit instruction on the read-before-write flow (using legal_get_shop_withdrawal to inspect current values) or any prerequisite about site permissions.

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