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

ghl-mcp-server-v2

by zackscriven

ghl_location_update_custom_field

Idempotent

Update a location's custom field by ID with new name, model, options, or validation rules for URL, date/time, and file fields.

Instructions

Update Custom Field Endpoint: PUT /locations/{locationId}/customFields/{id} (Version header: v3; source: v3/locations-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": {
      "locationId": "<locationId>",
      "id": "<id>",
      "body": "<body>"
    },
    "name": "ghl_location_update_custom_field"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesCustom Field Id
bodyYesRequest body (schema carried verbatim from the official OpenAPI spec).
locationIdYesLocation Id

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changedv2.1.0
    • addedInput schema / properties / body / properties / dateTimeValidation
      Added value: +{
      +  "allOf": [
      +    {
      +      "properties": {
      +        "bufferDays": {
      +          "description": "For future_only: minimum days from today before a date is selectable",
      +          "example": 2,
      +          "type": "number"
      +        },
      +        "daysAllowed": {
      +          "description": "Days of week 0=Sunday..6=Saturday. Works alongside future_only, past_only, or range modes.",
      +          "example": [
      +            1,
      +            2,
      +            3,
      +            4,
      +            5
      +          ],
      +          "items": {
      +            "type": "number"
      +          },
      +          "type": "array"
      +        },
      +        "inputType": {
      +          "description": "For DATE_TIME fields: collect date only, time only, or both (defaults per product if omitted).",
      +          "enum": [
      +            "date_only",
      +            "time_only",
      +            "date_and_time"
      +          ],
      +          "example": "date_and_time",
      +          "type": "string"
      +        },
      +        "mode": {
      +          "description": "any: no restriction. future_only: value must be in future. past_only: value must be in past. range: value within rangeMin-rangeMax.",
      +          "enum": [
      +            "any",
      +            "future_only",
      +            "past_only",
      +            "range"
      +          ],
      +          "example": "any",
      +          "type": "string"
      +        },
      +        "rangeMax": {
      +          "description": "Required when mode is range. ISO date or datetime string",
      +          "example": "2026-12-31",
      +          "type": "string"
      +        },
      +        "rangeMin": {
      +          "description": "Required when mode is range. ISO date or datetime string",
      +          "example": "2026-01-01",
      +          "type": "string"
      +        },
      +        "rollingDays": {
      +          "description": "For future_only: rolling window in days from today (e.g. 30 = next 30 days). Mutually exclusive with bufferDays.",
      +          "example": 30,
      +          "type": "number"
      +        }
      +      },
      +      "title": "DateTimeValidationDto",
      +      "type": "object"
      +    }
      +  ],
      +  "description": "When provided, replaces date/time validation rules (DATE, TIME, DATE_TIME fields only).",
      +  "example": {
      +    "mode": "range",
      +    "rangeMax": "2026-12-31",
      +    "rangeMin": "2026-01-01"
      +  }
      +}
    • addedInput schema / properties / body / properties / optionDisplayType
      Added value: +{
      +  "description": "When provided, updates the option rendering mode (RADIO / CHECKBOX only). One of TEXT_ONLY, TEXT_WITH_ICON, TEXT_WITH_IMAGE.",
      +  "enum": [
      +    "TEXT_ONLY",
      +    "TEXT_WITH_ICON",
      +    "TEXT_WITH_IMAGE"
      +  ],
      +  "example": "TEXT_WITH_IMAGE",
      +  "type": "string"
      +}
    • changedInput schema / properties / body / properties / textBoxListOptions / items / anyOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "label": {
      -        "example": "First",
      -        "type": "string"
      -      },
      -      "prefillValue": {
      -        "example": "",
      -        "type": "string"
      -      }
      -    },
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "label": {
      -        "example": "First",
      -        "type": "string"
      -      },
      -      "prefillValue": {
      -        "example": "",
      -        "type": "string"
      -      }
      -    },
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "label": {
      +        "example": "First",
      +        "type": "string"
      +      },
      +      "prefillValue": {
      +        "example": "",
      +        "type": "string"
      +      }
      +    },
      +    "title": "textBoxListOptionsSchema",
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "label": {
      +        "example": "First",
      +        "type": "string"
      +      },
      +      "prefillValue": {
      +        "example": "",
      +        "type": "string"
      +      }
      +    },
      +    "title": "textBoxListOptionsSchema",
      +    "type": "object"
      +  }
      +]
    • addedInput schema / properties / body / properties / urlValidation
      Added value: +{
      +  "allOf": [
      +    {
      +      "properties": {
      +        "allowedDomains": {
      +          "description": "Domains accepted when mode is allow_only",
      +          "example": [
      +            "example.com"
      +          ],
      +          "items": {
      +            "type": "string"
      +          },
      +          "type": "array"
      +        },
      +        "blockedDomains": {
      +          "description": "Domains rejected when mode is block",
      +          "example": [],
      +          "items": {
      +            "type": "string"
      +          },
      +          "type": "array"
      +        },
      +        "mode": {
      +          "description": "allow_all: any url. allow_only: only allowedDomains. block: anything but blockedDomains.",
      +          "enum": [
      +            "allow_all",
      +            "allow_only",
      +            "block"
      +          ],
      +          "example": "allow_all",
      +          "type": "string"
      +        }
      +      },
      +      "title": "UrlValidationDto",
      +      "type": "object"
      +    }
      +  ],
      +  "description": "When provided, replaces URL validation rules (URL fields only).",
      +  "example": {
      +    "allowedDomains": [
      +      "example.com"
      +    ],
      +    "mode": "allow_only"
      +  }
      +}
    • addedInput schema / properties / body / properties / userFieldConfig
      Added value: +{
      +  "allOf": [
      +    {
      +      "properties": {
      +        "multiSelect": {
      +          "description": "Single or multi-select; cannot change after create",
      +          "example": false,
      +          "type": "boolean"
      +        }
      +      },
      +      "title": "UserFieldConfigDto",
      +      "type": "object"
      +    }
      +  ],
      +  "description": "When provided, updates user field options except multiSelect (immutable after create).",
      +  "example": {
      +    "multiSelect": false
      +  }
      +}
    • addedInput schema / properties / body / title
      Added value: +"UpdateCustomFieldsDTO"
  2. First observedv2.0.0

TDQS

C2.6/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false, idempotentHint=true and openWorldHint=true, and the PUT endpoint is consistent with those. The description adds no behavioral context beyond the API version header: nothing about auth/permission requirements, whether omitted body fields are cleared, or the immutability caveats (e.g. multiSelect cannot change after create).

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?

Two short lines, front-loaded with the action and the endpoint. The source/version metadata is low-value for selection but is compact and not bloated, so little is wasted.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/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 deeply nested body (URL validation, date/time validation, user field config, file options) and no output schema, the description says nothing about partial-update behavior, which body fields apply to which field types, or what is returned. It leans entirely on the schema and annotations, leaving real gaps for correct invocation.

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 the schema already documents locationId, id, and every body field including nested validation objects. The description only repeats the path parameter names via the endpoint string, adding no meaning beyond the schema; baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description restates the title ('Update Custom Field') and then gives the HTTP endpoint PUT /locations/{locationId}/customFields/{id}, which confirms it is a partial/full update of a custom field definition. However, it does not distinguish this from closely named siblings such as ghl_custom_field_update or ghl_location_create_custom_field, so an agent cannot tell why two update tools exist.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no when-to-use / when-not-to-use guidance and no mention of the alternatives (ghl_custom_field_update, ghl_location_update_custom_value). Only the endpoint path implicitly signals this operates on a field definition scoped to a location, which is weak guidance at best.

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