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

ghl-mcp-server-v2

by zackscriven

ghl_object_update_record

Idempotent

Update a custom object record by ID for a given location and schema key, sending field values in the request body. Use it to change existing record properties through the GoHighLevel API.

Instructions

SPEC GAP: UpdateCustomObjectRecordDto is an empty object schema in v3/objects-v3.json — verified against the raw spec, not an extraction bug. The body property will accept arbitrary JSON; GHL's convention (per external docs linked from this op, not confirmed in this corpus) is a properties object keyed by the object's field keys. Update Record Update a Custom Object Record by Id. Supported Objects are business and custom objects. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0/87cpx-376296 Endpoint: PUT /objects/{schemaKey}/records/{id} (Version header: v3; source: v3/objects-v3.json)

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": {
      "schemaKey": "<schemaKey>",
      "id": "<id>",
      "locationId": "<locationId>",
      "body": "<body>"
    },
    "name": "ghl_object_update_record"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesid of the record to be updated. Available on the Record details page under the 3 dots or in the url
bodyYesRequest body (schema carried verbatim from the official OpenAPI spec).
schemaKeyYesThe key of the Custom Object / Standard Object Schema. For custom objects, the key must include the “custom_objects.” prefix, while standard objects use their respective object keys. This information is available on the Custom Objects Details page under Settings.
locationIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.1.0
    • addedInput schema / properties / body / title
      Added value: +"UpdateCustomObjectRecordDto"
  2. 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 readOnlyHint=false, destructiveHint=false, idempotentHint=true, so the safety profile is covered. The description adds genuinely non-obvious behavioral context: the exact endpoint and v3 version header, and the critical fact that the body schema is empty so arbitrary JSON is accepted. It stops short of saying how unspecified fields are treated on a partial update.

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 most important fact, the empty body schema, is front-loaded, but the surrounding meta-commentary ("verified against the raw spec, not an extraction bug", "not confirmed in this corpus") consumes space without helping the agent act, and the endpoint line duplicates the name and URL that follow.

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 hollow body schema and no output schema, the description does address the single biggest gap (payload shape) and is honest about the spec defect. It still leaves open whether the update is a merge or replace of unspecified fields, which fields are writable, and what a successful response contains.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 75% schema coverage and an empty nested body object, the description carries the weight where the schema cannot: it explains that the payload is arbitrary JSON and that GHL's convention is a `properties` object keyed by field keys. That is real meaning beyond the schema, though it is hedged as unconfirmed, which limits its reliability.

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 Custom Object Record by Id") and scopes it to business and custom objects, which separates it from ghl_object_create_record and ghl_object_get_record_by_id. It never explicitly names a sibling or a disambiguation rule, so it stops short of a 5.

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 by the verb and by the body-format hint, but there is no when-to-use/when-not guidance, no prerequisite (auth, permissions), and no statement of what to do if the record does not exist. An agent must infer the call conditions from the name.

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