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

ghl-mcp-server-v2

by zackscriven

ghl_product_update

Idempotent

Update a product's details by its unique ID, including name, description, pricing, variants, media, and SEO fields, to keep catalog information current.

Instructions

Update Product by ID The "Update Product by ID" API allows modifying information for a specific product using its unique identifier. Use this endpoint to update details for a single product based on the provided product ID. Endpoint: PUT /products/{productId} (Version header: v3; source: v3/products-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: products.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": {
      "productId": "<productId>",
      "body": "<body>"
    },
    "name": "ghl_product_update"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyYesRequest body (schema carried verbatim from the official OpenAPI spec).
productIdYesID or the slug of the product that needs to be returned

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changedv2.1.0
    • changedInput schema / properties / body / properties / label / allOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "endDate": {
      -        "description": "Start date in YYYY-MM-DDTHH:mm:ssZ format",
      -        "example": "2024-06-30T05:43:39.000Z",
      -        "type": "string"
      -      },
      -      "startDate": {
      -        "description": "Start date in YYYY-MM-DDTHH:mm:ssZ format",
      -        "example": "2024-06-26T05:43:35.000Z",
      -        "type": "string"
      -      },
      -      "title": {
      -        "description": "The content for the product label.",
      -        "example": "Featured",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "title"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "endDate": {
      +        "description": "Start date in YYYY-MM-DDTHH:mm:ssZ format",
      +        "example": "2024-06-30T05:43:39.000Z",
      +        "type": "string"
      +      },
      +      "startDate": {
      +        "description": "Start date in YYYY-MM-DDTHH:mm:ssZ format",
      +        "example": "2024-06-26T05:43:35.000Z",
      +        "type": "string"
      +      },
      +      "title": {
      +        "description": "The content for the product label.",
      +        "example": "Featured",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "title"
      +    ],
      +    "title": "ProductLabelDto",
      +    "type": "object"
      +  }
      +]
    • addedInput schema / properties / body / properties / medias / items / title
      Added value: +"ProductMediaDto"
    • changedInput schema / properties / body / properties / seo / allOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "description": {
      -        "description": "SEO description",
      -        "example": "This is the best product you can buy online with amazing features and great value",
      -        "type": "string"
      -      },
      -      "title": {
      -        "description": "SEO title",
      -        "example": "Best Product - Buy Now",
      -        "type": "string"
      -      }
      -    },
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "description": {
      +        "description": "SEO description",
      +        "example": "This is the best product you can buy online with amazing features and great value",
      +        "type": "string"
      +      },
      +      "title": {
      +        "description": "SEO title",
      +        "example": "Best Product - Buy Now",
      +        "type": "string"
      +      }
      +    },
      +    "title": "ProductSEODto",
      +    "type": "object"
      +  }
      +]
    • addedInput schema / properties / body / properties / variants / items / properties / options / items / title
      Added value: +"ProductVariantOptionDto"
    • addedInput schema / properties / body / properties / variants / items / title
      Added value: +"ProductVariantDto"
    • addedInput schema / properties / body / title
      Added value: +"UpdateProductDto"
  2. First observedv2.0.0

TDQS

A3.5/5.0
Behavior4/5

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

The annotations already cover safety traits (readOnly=false, idempotent=true, destructive=false, openWorld=true). The description adds meaningful operational context beyond those annotations: it specifies the PUT endpoint, requires an Agency or Sub-Account token, and lists the products.write OAuth scope. It does not discuss partial-update versus replacement semantics, but the auth and scope details are valuable additions.

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 description is reasonably front-loaded, but it repeats the tool title twice and spends multiple sentences restating the same single-product update idea. The endpoint, token, and OAuth scope details earn their place; the duplicated framing does not.

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?

For a mutation tool with a complex nested body and no output schema, the description covers authentication, scope, and endpoint. However, it omits important update semantics — notably whether this is a full replacement or a partial update, and how required body fields like name, locationId, and productType behave — leaving the agent to infer those from the schema.

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 parameter documentation is already handled by the schema. The description only refers to "a unique identifier" for productId and adds no extra detail about the body fields or their required semantics beyond what the schema provides.

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 states a specific verb and resource — updating a single product by its ID — and clarifies the scope as "a specific product" and "a single product." This implicitly distinguishes it from bulk-update siblings, but it does not explicitly name or contrast with alternatives such as ghl_product_bulk_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?

It says to use this endpoint to update details for a single product based on the provided product ID, which gives clear usage context. However, it does not state when not to use it, nor does it mention bulk-update alternatives or prerequisites beyond the token requirement.

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