Skip to main content
Glama
ghl-mcp-server-v2

ghl-mcp-server-v2

by zackscriven

ghl_store_update_shipping_zone

Idempotent

Update a store shipping zone by ID, including its name, countries, and states, to keep location-specific delivery coverage accurate.

Instructions

Update Shipping Zone The "update Shipping Zone" API allows update a shipping zone to the system. Endpoint: PUT /store/shipping-zone/{shippingZoneId} (Version header: v3; source: v3/store-v3.json) Requires a Sub-Account (location) token.

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": {
      "shippingZoneId": "<shippingZoneId>",
      "body": "<body>"
    },
    "name": "ghl_store_update_shipping_zone"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyYesRequest body (schema carried verbatim from the official OpenAPI spec).
shippingZoneIdYesID of the item that needs to be returned

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv2.1.0
    • addedInput schema / properties / body / properties / countries / items / properties / states / items / title
      Added value: +"ShippingZoneCountryStateDto"
    • addedInput schema / properties / body / properties / countries / items / title
      Added value: +"ShippingZoneCountryDto"
    • addedInput schema / properties / body / title
      Added value: +"UpdateShippingZoneDto"
  2. First observedv2.0.0

TDQS

B3.3/5.0
Behavior3/5

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

Annotations already declare non-readOnly, idempotent, non-destructive and openWorld, so the safety profile is covered. The description adds the auth requirement, the v3 header and the PUT verb, but omits the key behavioral question for a PUT-style body update: whether omitted fields (e.g. countries) are cleared or preserved.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the operation, but the second sentence is redundant boilerplate with awkward grammar ('allows update a shipping zone to the system'). The endpoint/version/auth metadata does earn its place, so the waste is moderate rather than severe.

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 2-parameter mutation with full schema coverage and a rich nested body, the description covers endpoint, version, and auth. It is still thin on update semantics — whether this is a full replace or a partial merge — which is the one thing an agent would most want before writing.

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 baseline is 3. The description contributes nothing about the shippingZoneId or the body fields (name, altId/altType, countries/states) that the schema does not already state.

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+resource (update a shipping zone) and the HTTP operation against /store/shipping-zone/{shippingZoneId}, which distinguishes it from the get/create/delete/list shipping-zone siblings. Slightly degraded by the tautological restatement in sentence two, but the 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 Guidelines3/5

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

No explicit when-to-use vs when-not or alternative routing is given; the agent must infer from the name that this mutates an existing zone rather than creating one. It does add one usable precondition — a Sub-Account (location) token is required — which is more than nothing.

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