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

ghl-mcp-server-v2

by zackscriven

ghl_custom_field_update

Idempotent

Update a custom field by ID—name, description, options, placeholder, form visibility, and file-upload limits. Include locationId and showInForms in every request.

Instructions

Per spec (UpdateCustomFieldsDTO), locationId and showInForms are both required on every update call, even ones that only change name/description/options — this is a genuine spec requirement, not an extraction artifact. Update Custom Field By Id

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

Input Schema

NameRequiredDescriptionDefault
idYes
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 / options / items / title
      Added value: +"OptionDTO"
    • addedInput schema / properties / body / title
      Added value: +"UpdateCustomFieldsDTO"
  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, openWorldHint=true. The description adds real context beyond them: the surprising requirement that locationId and showInForms must be sent on every call, the OAuth scope (locations/customFields.write) needed, and the object-type support limitation. It does not say what the response contains, but the behavioral profile is well covered.

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 first sentence is valuable and front-loaded, but it is followed by a duplicated title, an empty HTML div wrapper and a three-line repeated heading before reaching the useful scope note and endpoint. The endpoint/scope metadata is well placed at the end, but a third of the text is redundant boilerplate.

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 an idempotent mutation with nested body objects and no output schema, the description supplies endpoint, auth scope, required-on-every-call fields and object-type limits — enough to call it safely. It omits what is returned after the update and how it relates to the near-duplicate location-scoped sibling, which keeps it at merely adequate.

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 only 50% schema description coverage, the description compensates by explaining the non-obvious requiredness rule for locationId and showInForms on partial updates — information the schema cannot convey and that would otherwise cause a validation error. It does not add anything about the `id` path parameter, which is left undocumented in both places.

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+resource ('Update Custom Field By Id') and gives the concrete endpoint (PUT /custom-fields/{id}), so an agent knows exactly what is being mutated. It stops short of 5 because it never distinguishes this tool from the very similar siblings ghl_custom_field_create or ghl_location_update_custom_field, which an agent could easily confuse.

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?

There is one genuine usage constraint — 'Only supports Custom Objects and Company (Business) today' — which tells the agent when the call will fail. Beyond that there is no guidance on when to reach for this instead of the location-scoped custom field update sibling, so applicability is only implied.

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