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

ghl-mcp-server-v2

by zackscriven

ghl_product_list

Read-onlyIdempotent

List and filter products for a location, with pagination, search, sorting, and optional store or collection filters, to retrieve the product data you need.

Instructions

Lists products for a location. (Generated tool name was originally 'ghl_product_list_invoices' — an evident copy-paste artifact unrelated to this operation; corrected here.) List Products The "List Products" API allows to retrieve a paginated list of products. Customize your results by filtering products based on name or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve product information. Endpoint: GET /products/ (Version header: v3; source: v3/products-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: products.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": {
      "locationId": "<locationId>"
    },
    "name": "ghl_product_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoThe maximum number of items to be included in a single page of results
expandNoName of an entity whose data has to be fetched along with product. Possible entities are tax, stripe and paypal. If not mentioned, only ID will be returned in case of taxes
offsetNoThe starting index of the page, indicating the position from which the results should be retrieved.
searchNoThe name of the product for searching.
storeIdNofetch and project products based on the storeId
sortOrderNoThe order of sort which should be applied for the date
locationIdYesLocationId is the id of the sub-account
productIdsNoList of product ids to be fetched.
collectionIdsNoFilter by product category Ids. Supports comma separated values
collectionSlugNoThe slug value of the collection by which the collection would be searched
includedInStoreNoSeparate products by which are included in the store and which are not
availableInStoreNoIf the product is included in the online store

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 cover the safety profile (readOnly, idempotent, non-destructive, open-world), so the bar is lower. The description still adds real value beyond them: token/authorization requirements, the products.readonly OAuth scope, and the pagination contract (limit/offset) for retrieving full 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 purpose is front-loaded, but the second sentence is pure noise — a note about the generated tool name originally being 'ghl_product_list_invoices' actively distracts and references a sibling-like name. The boilerplate "provides a straightforward way to explore and retrieve product information" and the source/manifest metadata earn little.

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 annotations, a 100%-covered 12-param schema, and no output schema, the description covers what the schema cannot: auth requirement, OAuth scope, and paging instructions. What's missing is only marginal (e.g. whether an empty result set vs. error is returned), so this is close to complete.

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% across 12 parameters, so the schema already documents limit, offset, search, storeId, productIds, collectionIds, expand, etc. The description only reiterates limit/offset as pagination params, adding framing but no new semantics. Baseline 3 applies.

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 opening sentence states a specific verb and resource ("Lists products for a location"), which cleanly distinguishes it from mutation siblings such as ghl_product_create/update/delete and from ghl_product_get. It does not explicitly call out those siblings, but the verb+resource pairing is unambiguous.

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 rather than stated: the description notes you can filter by name or paginate, and that an Agency or Sub-Account token is required. There is no explicit when-to-use/when-not guidance and no pointer to alternatives (e.g. ghl_product_get for a single product), leaving the agent to infer 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