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

ghl-mcp-server-v2

by zackscriven

ghl_store_list_shipping_rates

Read-onlyIdempotent

Retrieve shipping rates for a specific store shipping zone, using limit and offset pagination to page through all available rates.

Instructions

List Shipping Rates The "List Shipping Rate" API allows to retrieve a list of shipping rate. Endpoint: GET /store/shipping-zone/{shippingZoneId}/shipping-rate (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
shippingZoneIdYesID of the item that needs to be returned

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, idempotentHint and non-destructive, so the safety profile is covered. The description adds real context beyond that: the required sub-account token type, the API version/source, and that limit/offset are the pagination mechanism for full result sets. It stops short of explaining what a page actually contains or what the default limit=0 implies.

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

Conciseness4/5

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

The purpose and scope are front-loaded in the first line, and the remaining lines (endpoint, auth, pagination) each carry operational value. The one wasted sentence is "The 'List Shipping Rate' API allows to retrieve a list of shipping rate," a near-restatement of the title/name.

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?

There is no output schema, and the description says nothing about the shape of the returned rate objects, so an agent cannot anticipate the response. Auth and pagination are covered, but the unusual limit=0 default and page-size expectations are left ambiguous for a 5-parameter listing tool.

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 shippingZoneId; baseline 3 applies. The description reinforces that limit/offset are pagination controls and that the path is scoped by shippingZoneId, but it adds no syntax or format detail for altId/altType and does not resolve the ambiguous limit default of 0.

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 rate") and scopes it via the endpoint path to a shipping zone, so an agent knows exactly what is returned. It does not distinguish itself from close siblings such as ghl_store_get_available_shipping_rates or ghl_store_get_shipping_rate, which is the only thing keeping it from a 5.

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?

Usage is implied by the endpoint shape (list rates under a given shippingZoneId) and a prerequisite is stated ("Requires a Sub-Account (location) token"). However, there is no explicit statement of when to prefer this over ghl_store_get_shipping_rate or ghl_store_get_available_shipping_rates, and no exclusions are given.

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