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

ghl-mcp-server-v2

by zackscriven

ghl_custom_field_create

Creates a custom field for GoHighLevel Company or Custom Object records, letting you define its data type, key, options, and form visibility for structured data capture.

Instructions

Create Custom Field

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

Input Schema

NameRequiredDescriptionDefault
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: +"CreateCustomFieldsDTO"
  2. First observedv2.0.0

TDQS

A3.5/5.0
Behavior4/5

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

Annotations already declare readOnly=false, destructive=false, idempotent=false, and openWorld=true, so the safety profile is covered. The description adds value beyond that with the required OAuth scope (locations/customFields.write), the endpoint and API version header, and a hard object-type limitation that will cause failures if ignored. It stops short of saying what the response contains or how duplicate fieldKeys behave.

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 useful content (scope limitation, endpoint, auth scope) is short and largely front-loaded, but the definition wastes space on a duplicated title wrapped in raw HTML div and :::info markup. The repetition of "Create Custom Field" three times is noise an agent must parse past to reach the one substantive constraint.

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 create tool with a single but deeply nested body parameter and no output schema, the description supplies the essentials: object-type restriction, auth scope, and endpoint. It is still silent on return values (e.g., the new field's ID), duplicate-key behavior, and limits, which an agent would want before calling.

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% and the nested body schema is unusually rich — fieldKey format rules, the dataType enum, per-type validity of options, and FILE_UPLOAD-only fields are all documented there. The description adds no parameter-level meaning of its own, so the baseline of 3 applies.

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 and resource ("Create Custom Field") and adds a genuine scope constraint: it only works for Custom Objects and Company (Business) today. That limitation is the key fact separating it from the many sibling create tools, though it never names those siblings explicitly. The repeated title inside HTML markup adds nothing, but the informative sentence carries the purpose.

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?

The "Only supports Custom Objects and Company (Business) today" note implies when this tool applies and when it will fail, which is useful routing information. However, it never explicitly contrasts with close siblings such as ghl_location_create_custom_field, ghl_custom_field_create_folder, or ghl_custom_field_update, leaving the agent to infer which create variant to pick.

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