Skip to main content
Glama

search_contacts

Read-onlyIdempotent

Search contacts in the bound GoHighLevel sub-account by name, email, or phone, paging all results and returning allowlisted fields with a complete flag when a limit stops the walk.

Instructions

Search contacts in the bound sub-account. Paginates every cursor and reports complete=false when a limit stopped the walk. Returns allowlisted fields only.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "search_contacts"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum contacts to return. A limited read reports complete=false.
queryNoFree-text match on name, email or phone. Omit to page all contacts.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive), and the description goes further by disclosing that it walks every cursor, signals truncation via complete=false, and returns only allowlisted fields. Those are real behavioral traits an agent could not infer from annotations or schema. It does not say what the allowlist contains or whether results are ordered.

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?

Three short sentences, each carrying a distinct fact (scope, pagination/truncation, field restriction), with the most important scoping statement front-loaded. No filler or restatement of the name.

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 two-parameter read tool with no output schema, the definition covers scope, pagination semantics, and the shape of the result well enough to call correctly. Missing pieces are minor: which fields are allowlisted and whether the sub-account binding requires any setup.

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 both parameters are already documented, including the limit/complete=false relationship that the description restates. The only added nuance is 'Omit to page all contacts', which the schema also states, so nothing meaningful is added beyond structured fields.

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?

States a specific verb and resource ('Search contacts') plus scope ('in the bound sub-account'), which clearly separates it from get_contact (single fetch) and upsert_contact (write). It stops short of naming those siblings, so an agent must infer the boundary rather than read it.

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?

'Omit to page all contacts' is the only usage cue and it concerns parameter values rather than tool selection. There is no statement about when to prefer this over get_contact or when a search is unnecessary, so the guidance is implied rather than explicit.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.