Skip to main content
Glama

Get custom field

ghl_get_custom_field
Read-only

Retrieve a specific custom field definition by its ID from a GoHighLevel location, using the provided location ID to access details.

Instructions

Fetch a single custom field definition by id.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
locationIdNoGHL Location (sub-account) ID. Defaults to GHL_LOCATION_ID.
customFieldIdYes
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, covering the safety profile. The description adds no behavioral context beyond the fetch operation and does not mention what happens if the ID is not found, but it is consistent and does not contradict annotations.

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

Conciseness5/5

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

One short sentence with no filler, directly stating the action and object. It is appropriately concise and front-loaded.

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

Completeness4/5

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

For a simple single-resource fetch with annotations covering safety, the description is nearly sufficient. It correctly uses 'definition' to disambiguate from custom values. It does not describe the return format, but no output schema is provided, and for a get-by-id operation this is a minor gap.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 50%: locationId has a description, but customFieldId does not. The tool description only says 'by id' and does not clarify that customFieldId is the identifier or provide format or requiredness details. Since coverage is low, the description should compensate but does not, though the parameter name is self-explanatory.

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

Purpose5/5

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

The description uses a specific verb 'Fetch' and a precise resource 'a single custom field definition by id', making the operation unambiguous. The word 'definition' clearly distinguishes it from fetching a custom value or listing custom fields.

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 description implies usage—when you have a specific custom field ID and need its definition—but it does not explicitly mention alternatives like ghl_list_custom_fields or ghl_get_custom_value. There is no when-not-to-use guidance, but the purpose is clear enough to infer basic usage.

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/vmproductions631-tech/gohighlevel-mcp'

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