Skip to main content
Glama
NightSquawk

@nightsquawktech/gohighlevel-mcp-server

by NightSquawk

List GoHighLevel Custom Fields V2 By Object Key

ghl_list_custom_fields_v2
Read-onlyIdempotent

List custom fields and folders for a given object key (e.g., custom_objects.pet or business) via GoHighLevel API.

Instructions

List Custom Fields V2 fields/folders by object key with GET /custom-fields/object-key/{objectKey}. Supports Custom Objects and Company/Business per HighLevel docs.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMaximum number of items to return from the local page.
offsetNoNumber of items to skip locally after receiving the API response.
objectKeyYesObject key, for example custom_objects.pet or business.
location_idNoOptional GoHighLevel location ID override. Defaults to GHL_LOCATION_ID.
response_formatNoOutput format: markdown for human-readable summaries, json for structured output.markdown
Behavior3/5

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

Annotations already provide readOnlyHint, openWorldHint, idempotentHint, and destructiveHint. Description adds the endpoint path and supported object types, but does not disclose additional behaviors like pagination behavior or output structure. Adds minimal value beyond 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?

Single concise sentence with no fluff. Efficiently conveys purpose and endpoint, earning its place.

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?

Given 5 parameters, rich annotations, but no output schema, the description could explain return format or pagination. It states 'fields/folders' but not how they are structured. Adequate but incomplete for a listing tool.

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 coverage is 100%, so baseline is 3. Description does not add any parameter information beyond what's in the schema. It mentions objectKey in the description but that is already documented.

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 clearly states the action (List) and resource (Custom Fields V2 fields/folders by objectKey), and distinguishes from sibling tools like ghl_list_custom_fields by specifying V2 and object key.

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 explicit guidance on when to use this tool versus alternatives like ghl_list_custom_fields for v1, or how to choose between different list tools. The description mentions 'Supports Custom Objects and Company/Business' but lacks context for when to use each.

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/NightSquawk/gohighlevel-mcp-server'

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