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

ghl-mcp-server-v2

by zackscriven

ghl_location_search

Read-onlyIdempotent

Search GoHighLevel sub-accounts by email or company ID and paginate results with skip and limit parameters.

Instructions

Search Search Sub-Account (Formerly Location) Endpoint: GET /locations/search (Version header: v3; source: v3/locations-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: locations.readonly Pagination params: skip, limit — pass them to page through full result sets.

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": "ghl_location_search"
  }
}

Input Schema

NameRequiredDescriptionDefault
skipNoThe value by which the results should be skipped. Default will be 00
emailNo
limitNoThe value by which the results should be limited. Default will be 1010
orderNoThe order in which the results should be returned - Allowed values asc, desc. Default will be ascasc
companyIdNoThe company/agency id on which you want to perform the search

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare read-only/idempotent, so credit goes to the additions: required auth level (Agency or Sub-Account token), the exact OAuth scope, the endpoint and API version header. It does not say how paging terminates or what fields results contain, keeping it below a 5.

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

Conciseness4/5

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

Front-loaded with the resource name, then auth, scope and pagination in short fragments — no filler sentences. The bare leading 'Search' duplicates the title, a minor inefficiency, and the endpoint/provenance metadata is somewhat internal-facing but still useful.

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?

No output schema, so the description should say what a search returns (list of locations with IDs?) and how the email filter behaves (exact vs. partial match), neither of which is covered. Auth and scope are well handled, so it is adequate but has clear gaps for a 5-parameter search tool.

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

Parameters4/5

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

Schema coverage is 80%, so baseline is 3; the description earns a bump by explaining that skip/limit are pagination controls to 'page through full result sets' rather than generic filters, which clarifies intent. The 'email' parameter is undocumented in both schema and description, leaving the primary search filter ambiguous.

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 Sub-Account (Formerly Location)') and resolves the naming ambiguity that would otherwise confuse an agent looking for 'location' endpoints. It does not distinguish itself from the many sibling list/get tools (ghl_location_get, ghl_saas_get_locations), so it stops short of a 5.

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?

Usage is implied by the token and scope notes (Agency or Sub-Account token, locations.readonly) which tell the agent it can call it, but there is no when-to-use vs. when-not guidance and no named alternative such as ghl_location_get for a known ID. The agent must infer that this is the discovery path.

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