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

ghl-mcp-server-v2

by zackscriven

ghl_store_list_shipping_zones

Read-onlyIdempotent

Retrieves a paginated list of shipping zones for a store location, with an option to include shipping rates. Supports limit and offset to page through full result sets.

Instructions

List Shipping Zones The "List Shipping Zone" API allows to retrieve a list of shipping zone. Endpoint: GET /store/shipping-zone (Version header: v3; source: v3/store-v3.json) Requires a Sub-Account (location) token. Pagination params: limit, offset — pass them to page through full result sets.

Input Schema

NameRequiredDescriptionDefault
altIdYesLocation Id or Agency Id
limitNoThe maximum number of items to be included in a single page of results
offsetNoThe starting index of the page, indicating the position from which the results should be retrieved.
altTypeYes
withShippingRateNoInclude shipping rates array

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered. The description adds genuinely new context: the auth token scope (sub-account/location), the API version header, and pagination behavior for large result sets.

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?

The opening line is front-loaded and useful, but the second sentence ('The "List Shipping Zone" API allows to retrieve a list of shipping zone') merely restates the title, and '(source: v3/store-v3.json)' is internal noise an agent cannot act on.

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?

With no output schema, the description should carry the load, and it does cover auth scope, endpoint, and paging. What remains missing is any hint of the response shape (zone objects, and that withShippingRate toggles an embedded rates array), which is the one parameter left unexplained.

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 80%, so the schema already documents altId, limit, offset, and withShippingRate. The description reinforces the pagination parameters' purpose but adds nothing about withShippingRate or the altId/altType pairing, so it only marginally exceeds the schema 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?

The description uses a specific verb+resource ('retrieve a list of shipping zone') and names the concrete endpoint GET /store/shipping-zone, so the operation is unambiguous. It does not explicitly distinguish itself from siblings like ghl_store_get_shipping_zone or ghl_store_list_shipping_rates, but 'list' versus 'get' is readable from the name.

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?

It states a prerequisite ('Requires a Sub-Account (location) token') and tells the caller to pass limit/offset to page through full result sets, which is real usage guidance. It stops short of naming alternatives (e.g., use ghl_store_get_shipping_zone for a single zone) or stating when not to use it.

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