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

ghl-mcp-server-v2

by zackscriven

ghl_product_inventory_update

Bulk update available quantities and out-of-stock purchase settings for multiple inventory items in GoHighLevel using price IDs and location details.

Instructions

Update Inventory The Update Inventory API allows the user to bulk update the inventory for multiple items. Use this endpoint to update the available quantity and out-of-stock purchase settings for multiple items in the inventory. Endpoint: POST /products/inventory (Version header: v3; source: v3/products-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: products/prices.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": {
      "body": "<body>"
    },
    "name": "ghl_product_inventory_update"
  }
}

Input Schema

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

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv2.1.0
    • addedInput schema / properties / body / properties / items / items / title
      Added value: +"UpdateInventoryItemDto"
    • addedInput schema / properties / body / title
      Added value: +"UpdateInventoryDto"
  2. First observedv2.0.0

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false and openWorldHint=true, so the mutation profile is known. The description adds genuinely useful context beyond that: bulk semantics, required Agency/Sub-Account token, OAuth scope products/prices.write, and the concrete endpoint path and API version.

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 bulk-update purpose is front-loaded and the auth/endpoint metadata is compact. The opening sentence 'Update Inventory The Update Inventory API allows the user to bulk update...' is slightly redundant with the title, but the overall length is justified by the operational details.

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 single-parameter tool wrapping a nested DTO, the description supplies the auth requirements, scope, and endpoint that an agent needs to invoke correctly, and no output schema means return values need not be explained. It lacks any note on partial-failure or bulk-error behavior, which keeps it short of a 5.

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% and every nested field (altId, altType, priceId, availableQuantity, allowOutOfStockPurchases) is documented inline. The description's mention of quantity and out-of-stock settings merely restates schema content, adding no syntax, limits, or format details beyond it.

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 ('bulk update the inventory for multiple items') and names the fields affected (available quantity, out-of-stock purchase settings). It does not explicitly differentiate itself from the sibling ghl_product_inventory_list, but the bulk-update scope 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?

'Use this endpoint to update the available quantity and out-of-stock purchase settings' implies the usage context, but there is no explicit when-not-to-use guidance or reference to alternatives such as ghl_product_inventory_list or ghl_product_price_update.

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