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

ghl-mcp-server-v2

by zackscriven

ghl_store_update_shipping_rate

Idempotent

Update a shipping rate within a GoHighLevel store shipping zone, including name, amount, currency, conditions, and carrier fee details using the zone and rate IDs.

Instructions

Update Shipping Rate The "update Shipping Rate" API allows update a shipping rate to the system. Endpoint: PUT /store/shipping-zone/{shippingZoneId}/shipping-rate/{shippingRateId} (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>",
      "shippingRateId": "<shippingRateId>",
      "body": "<body>"
    },
    "name": "ghl_store_update_shipping_rate"
  }
}

Input Schema

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

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv2.1.0
    • addedInput schema / properties / body / properties / shippingCarrierServices / items / title
      Added value: +"ShippingCarrierServiceDto"
    • addedInput schema / properties / body / title
      Added value: +"UpdateShippingRateDto"
  2. First observedv2.0.0

TDQS

B3.1/5.0
Behavior3/5

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

Annotations already declare readOnly=false, idempotent=true, destructive=false, openWorld=true, establishing the safety profile. The description adds useful context—the HTTP verb/endpoint and the location-token requirement—but does not clarify whether the body is a partial or full replacement, which is the key behavioral unknown for an update.

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?

Endpoint and auth info are front-loadable and useful, but the opening restates the title verbatim ('Update Shipping Rate' / 'the "update Shipping Rate" API') and contains grammatical noise ('allows update a shipping rate to the system') that carries no 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 mutation tool with a nested body and no output schema, the description covers the endpoint and auth requirement but omits the critical update semantics (partial vs. full replacement of body fields) and any return expectations. Annotations carry the safety profile, so this is only adequate.

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 path params (shippingZoneId, shippingRateId) and body fields are already documented in the schema. The description adds nothing about parameter meaning or format beyond restating the endpoint path, so this lands at the schema-reliant baseline.

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 ('update a shipping rate') and even names the exact PUT endpoint with zone and rate path params. It does not, however, distinguish this from siblings like ghl_store_create_shipping_rate or ghl_store_update_shipping_zone, so the agent must infer it modifies an existing rate only.

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 guidance on when to use this versus create or zone-update siblings, and no when-not conditions. The only actionable prerequisite is 'Requires a Sub-Account (location) token,' which is a requirement rather than usage routing.

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