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

ghl-mcp-server-v2

by zackscriven

ghl_store_get_shipping_zone

Read-onlyIdempotent

Retrieves a specific shipping zone by ID for a GoHighLevel sub-account location, optionally including its shipping rates for order fulfillment and rate checks.

Instructions

Get Shipping Zone The "List Shipping Zone" API allows to retrieve a paginated list of shipping zone. Endpoint: GET /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>",
      "altId": "<altId>",
      "altType": "<altType>"
    },
    "name": "ghl_store_get_shipping_zone"
  }
}

Input Schema

NameRequiredDescriptionDefault
altIdYesLocation Id or Agency Id
altTypeYes
shippingZoneIdYesID of the item that needs to be returned
withShippingRateNoInclude shipping rates array

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

C2.7/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so the safety profile is covered. The description adds genuinely useful context beyond that—required sub-account/location token and API version header v3—but omits return shape and the optional withShippingRate behavior.

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?

Short and reasonably front-loaded, but the 'List Shipping Zone ... paginated list' sentence is actively misleading filler that would have been better replaced with a note on the withShippingRate flag. The endpoint/source metadata line is padding for an agent.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

A read-by-ID tool with no output schema should describe what is returned (zone plus optional rates array). Instead the description mischaracterizes the response as a paginated list and never explains the withShippingRate toggle, leaving the most decision-relevant behavior undocumented.

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 75% and schema descriptions exist for altId, altType and withShippingRate. The description only implicitly references shippingZoneId through the path template and adds nothing about the remaining three parameters, so it is at the baseline for a well-covered schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The lead line and endpoint path ('GET /store/shipping-zone/{shippingZoneId}') indicate a single-zone fetch, but the body then says the 'List Shipping Zone' API returns a 'paginated list of shipping zone', which blurs the distinction from the sibling ghl_store_list_shipping_zones. The core verb+resource is present, yet the describing sentence undercuts it.

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?

No guidance on when to use this versus ghl_store_list_shipping_zones or the update/delete siblings. The only usable condition is an auth prerequisite ('Requires a Sub-Account (location) token'), which is a prerequisite rather than usage selection guidance.

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