Skip to main content
Glama
AIWerk

@aiwerk/mcp-server-ghl

by AIWerk

custom_fields_create_custom_field

Create custom fields in GoHighLevel by specifying data type, field key, and object key, with options for forms, file uploads, and custom values.

Instructions

Create Custom Field

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoField name
optionsNoOptions for the field (Optional, valid only for SINGLE_OPTIONS, MULTIPLE_OPTIONS, RADIO, CHECKBOX, TEXTBOX_LIST type)
dataTypeYesType of field that you are trying to create
fieldKeyYesField key. For Custom Object it's formatted as "custom_object.{objectKey}.{fieldKey}". "custom_object" is a fixed prefix, "{objectKey}" is your custom object's identifier, and "{fieldKey}" is the unique field name within that object. Example: "custom_object.pet.name" for a "name" field in a "pet" cu
parentIdYesID of the parent folder
objectKeyYesThe key for your custom object. This key uniquely identifies the custom object. Example: "custom_object.pet" for a custom object related to pets.
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
allowCustomOptionNoDetermines if users can add a custom option value different from the predefined options in records for RADIO type fields. A custom value added in one record does not automatically become an option and will not appear as an option for other records.
Behavior1/5

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

The description adds no behavioral information beyond what the annotations already provide. The annotations indicate readOnlyHint=false and idempotentHint=false, and the description simply restates the creation action without disclosing side effects, required permissions, or consequences. It provides no value beyond the structured metadata.

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 a single terse phrase that doesn't constitute a meaningful sentence. While it's concise, it is under-specified and fails to provide any useful content. Every word should earn its place, but here the words 'Create' and 'Custom Field' merely echo the tool name.

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

Completeness1/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a tool with 13 parameters, 5 required, and no output schema, the description is grossly inadequate. It provides no overall context about what a custom field is, how objectKey and fieldKey relate, when to use this over other creation tools, or what the response will look like. The schema alone cannot compensate for the complete lack of domain guidance.

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 all 13 parameters have detailed descriptions in the input schema. The tool description itself adds no parameter meaning, but the baseline of 3 applies because the schema already documents parameters thoroughly.

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 'Create Custom Field' states a clear verb and resource, but it's extremely generic and doesn't specify what a custom field is or how it differs from related tools like custom_fields_create_custom_field_folder. It's more than a pure tautology because 'custom field' is a specific entity, but it lacks any differentiating detail.

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

Usage Guidelines1/5

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

The description provides no guidance on when to use this tool versus alternatives such as custom_fields_update_custom_field or custom_fields_create_custom_field_folder. There is no mention of prerequisites, conditions, or exclusions. An agent has no information to select this tool appropriately.

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