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

ghl-mcp-server-v2

by zackscriven

ghl_product_collection_update

Idempotent

Updates a product collection by its ID to modify details such as name, slug, SEO metadata, and thumbnail image.

Instructions

Update Product Collection Update a specific product collection with Id :collectionId Endpoint: PUT /products/collections/{collectionId} (Version header: v3; source: v3/products-v3.json) Requires a Sub-Account (location) token. OAuth scopes: products/collection.write

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": {
      "collectionId": "<collectionId>",
      "body": "<body>"
    },
    "name": "ghl_product_collection_update"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyYesRequest body (schema carried verbatim from the official OpenAPI spec).
collectionIdYesMongoId of the collection

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv2.1.0
    • changedInput schema / properties / body / properties / seo / allOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "description": {
      -        "description": "The description which would be displayed in preview purposes",
      -        "example": "Collections where all the best products are available",
      -        "type": "string"
      -      },
      -      "title": {
      -        "description": "The title which will be displayed as an SEO format",
      -        "example": "Best Sellers",
      -        "type": "string"
      -      }
      -    },
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "description": {
      +        "description": "The description which would be displayed in preview purposes",
      +        "example": "Collections where all the best products are available",
      +        "type": "string"
      +      },
      +      "title": {
      +        "description": "The title which will be displayed as an SEO format",
      +        "example": "Best Sellers",
      +        "type": "string"
      +      }
      +    },
      +    "title": "CollectionSEODto",
      +    "type": "object"
      +  }
      +]
    • addedInput schema / properties / body / title
      Added value: +"UpdateProductCollectionsDto"
  2. First observedv2.0.0

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, idempotentHint=true, destructiveHint=false and openWorldHint=true, so the safety profile is covered. The description does add value beyond them by disclosing the auth requirement ('Requires a Sub-Account (location) token') and the required OAuth scope 'products/collection.write'. It does not disclose the key mutation semantics an agent needs for a PUT with a required body: whether omitted fields are wiped or preserved.

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?

Front-loaded with the action and target, then the endpoint and auth in short lines. Slightly padded by the spec-source provenance '(Version header: v3; source: v3/products-v3.json)', which is metadata the agent rarely needs to act on.

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, so return values need not be explained, and auth plus scope are covered. However, for a mutation against a nested DTO body, the description omits the one thing that most affects correct invocation: whether this replaces the whole collection or merges into it, and what happens to unset fields.

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%, so both collectionId and the nested body fields are already documented in the schema; the baseline of 3 applies. The description confirms collectionId is the path identifier ('with Id :collectionId') but adds nothing about the body's required altId/altType or the seo/name/slug/image fields.

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 specific verb and resource ('Update a specific product collection with Id :collectionId') plus the underlying endpoint PUT /products/collections/{collectionId}. That is clearly distinct from ghl_product_collection_create/get/list/delete in the sibling set, though the description never explicitly names any sibling as a contrast.

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 only implied: an agent can infer it needs an existing collectionId and a sub-account token. There is no explicit when-to-use versus when-not, and no guidance on partial vs full replacement or on ghl_product_collection_create as the alternative when the collection does not exist yet.

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