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

ghl-mcp-server-v2

by zackscriven

ghl_product_inventory_list

Read-onlyIdempotent

Retrieve a paginated list of inventory items with search and pagination parameters to fetch details for multiple products in a location.

Instructions

List Inventory The "List Inventory API allows the user to retrieve a paginated list of inventory items. Use this endpoint to fetch details for multiple items in the inventory based on the provided query parameters. Endpoint: GET /products/inventory (Version header: v3; source: v3/products-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: products/prices.readonly Pagination params: limit, offset — pass them to page through full result sets.

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": {
      "altId": "<altId>",
      "altType": "<altType>"
    },
    "name": "ghl_product_inventory_list"
  }
}

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.
searchNoSearch string for Variant Search
altTypeYes

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 readOnly, idempotent, non-destructive, open-world. The description adds real context beyond them: the auth requirement (Agency or Sub-Account token), the OAuth scope products/prices.readonly, the version header, and pagination 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?

Auth, scope, endpoint and pagination metadata are front-loaded well, but the opening restates the title ('List Inventory') and the sentence about fetching multiple items based on query parameters is filler that earns no place.

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?

For a read-only, annotated list tool with no output schema, the description covers auth, scope, endpoint and paging, which is most of what an agent needs. The return payload shape and default page size behavior are not described, a minor gap.

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 limit/offset/search/altId are already documented in the schema. The description echoes limit and offset and adds the useful instruction to page through full result sets, but says nothing about search or altType semantics.

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 clear verb+resource: retrieve a paginated list of inventory items via GET /products/inventory. It distinguishes inventory from the neighboring product tools (ghl_product_list, ghl_product_get) by naming inventory items, but never explicitly contrasts with ghl_product_inventory_update.

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?

Says to use it to fetch details for multiple items, which implies list-style usage, but gives no when-not guidance and never names alternatives such as ghl_product_list or ghl_product_inventory_update. The required Agency/Sub-Account token is a prerequisite, not 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