Skip to main content
Glama
AIWerk

@aiwerk/mcp-server-ghl

by AIWerk

custom_fields_update_custom_field

Idempotent

Update a GoHighLevel custom field by ID. Modify its name, options, description, placeholder, and form visibility to keep field data accurate.

Instructions

Update Custom Field By Id

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
nameNoField name
optionsNoOptions for the field. Important: Providing options will completely replace the existing options array. You must include all existing options alongside any new options you wish to add. Removal of options is not supported through this update. Applicable only for SINGLE_OPTIONS, MULTIPLE_OPTIONS, RADI
locationIdNoLocation Id Defaults to GHL_LOCATION_ID when omitted.
descriptionNoDescription of the field
placeholderNoPlaceholder text for the field
showInFormsYesWhether the field should be shown in forms
maxFileLimitNoMaximum file limit for uploads. Applicable only for fields with a data type of FILE_UPLOAD.
acceptedFormatsNoAllowed file formats for uploads. Options include: .pdf, .docx, .doc, .jpg, .jpeg, .png, .gif, .csv, .xlsx, .xls, all
Behavior2/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false, and idempotentHint=true. The description adds no behavioral context, such as warning that updating options replaces the existing array (a nuance only present in the schema). It does not contradict annotations but provides zero value beyond them.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness2/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is extremely brief, but it is not good conciseness—it is under-specification. It lacks any structural detail or front-loading of critical information that an agent would need to decide whether to call this tool.

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?

Despite rich annotations and schema, the description is incomplete. For an update operation with 9 parameters, it does not explain the effect of the update (e.g., options replacement), nor any return value or side effects. The schema covers some, but the description fails to synthesize usage context.

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 high (89%), so the schema documents most parameters. The description provides no additional information about parameters, but the baseline of 3 is appropriate because the schema does the heavy lifting.

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

Purpose2/5

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

The description 'Update Custom Field By Id' is essentially a tautology of the tool name and title. It states a verb and resource but adds no specificity about what fields can be updated or how it differs from sibling tools like custom_fields_create_custom_field or custom_fields_get_custom_field_by_id.

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?

No guidance is given on when to use this tool versus alternatives. There is no mention of prerequisites, conditions, or exclusions, leaving the agent to infer usage from the schema.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/AIWerk/mcp-server-ghl'

If you have feedback or need assistance with the MCP directory API, please join our Discord server