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

ghl-mcp-server-v2

by zackscriven

ghl_object_search_records

Read-onlyIdempotent

Search custom and standard object records by schema key, location, query, and pagination to retrieve matching GoHighLevel records.

Instructions

Body (SearchRecordsBody) fully specified in the OpenAPI, unlike the sibling create/update record ops — locationId, page, pageLimit, query, and searchAfter are all present and required. Search Object Records Supported Objects are custom objects and standard objects like "business". Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0/87cpx-379336 Endpoint: POST /objects/{schemaKey}/records/search (Version header: v3; source: v3/objects-v3.json) OAuth scopes: objects/record.readonly

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

Input Schema

NameRequiredDescriptionDefault
bodyYesRequest body (schema carried verbatim from the official OpenAPI spec).
schemaKeyYescustom object key

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.1.0
    • addedInput schema / properties / body / title
      Added value: +"SearchRecordsBody"
  2. First observedv2.0.0

TDQS

B3.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile is covered. The description adds genuinely new operational context: the required OAuth scope (objects/record.readonly) and the v3 version header, both of which affect whether a call will succeed.

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 doc link, endpoint and OAuth scope lines are all high-value and compact. However, the leading sentence about SearchRecordsBody being "fully specified in the OpenAPI, unlike the sibling create/update record ops" is internal spec commentary that doesn't help an agent decide or invoke correctly, and it is front-loaded where purpose should be.

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 nested two-parameter tool with no output schema, the description covers endpoint, supported object types and auth. It leaves gaps on the return shape (what a records search actually returns) and on how the searchAfter cursor interacts with page/pageLimit, which matters for a paginated search.

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 the schema already documents locationId, page, pageLimit and query (including the searchable-property syntax). The description's only added value is confirming that all five body fields are present and required, and it says nothing about searchAfter's cursor role, which remains undocumented in both places.

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?

It states a specific verb and resource ("Search Object Records") and scopes applicability by naming the object classes it works on (custom objects and standard objects such as "business"). It also distinguishes itself from the record create/update siblings, so an agent can identify what this does without opening the schema, though it does not differentiate from ghl_object_search_notes or ghl_object_get_record_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?

There is no explicit statement of when to call this instead of ghl_object_get_record_by_id or ghl_object_search_notes. The opening sentence compares the schema completeness against sibling create/update ops, which is meta-commentary about the spec rather than guidance on tool selection.

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