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

ghl-mcp-server-v2

by zackscriven

ghl_user_get_by_location

Read-onlyIdempotent

Retrieve users by location ID from GoHighLevel's legacy endpoint; use /users/search instead for richer filtering and paging.

Instructions

DEPRECATED per spec — superseded by GET /users/search (v3), which supports the same locationId filter plus richer query/paging options. [DEPRECATED per official docs — prefer the documented replacement if one exists.] [LEGACY FALLBACK — this endpoint is no longer in the live v3 docs (checked 2026-10-28) but is still served under the legacy Version header. Expect removal; prefer a current equivalent.] Get User by Location Deprecated. Use GET /users/search instead. Pass locationId as a query parameter to filter results by location, along with the required companyId and other search filters as needed. Endpoint: GET /users/ (Version header: 2021-07-28; source: users.json) Requires a Sub-Account (location) token. OAuth scopes: users.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": {
      "locationId": "<locationId>"
    },
    "name": "ghl_user_get_by_location"
  }
}

Input Schema

NameRequiredDescriptionDefault
locationIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already cover readOnly/idempotent/openWorld, but the description adds genuinely non-redundant operational facts: a Sub-Account (location) token is required, the OAuth scope is users.readonly, the endpoint path and Version header 2021-07-28, and that removal is expected. It does not describe the response shape (no output schema exists), which is the remaining gap.

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

Conciseness2/5

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

The same deprecation message appears four times (the spec note, the bracketed official-docs note, the LEGACY FALLBACK note, and 'Deprecated. Use GET /users/search instead.'), pushing the actual operation description past the middle of the text. Substantial pruning would improve it without losing any information.

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 deprecated single-parameter read endpoint with annotations and no output schema, the description supplies auth requirements, scope, endpoint, version pin and lifecycle status. Only the return payload is left unspecified, which is a minor omission here.

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 0% for the single locationId parameter, and the description only clarifies that locationId is passed as a query parameter and filters results by location. It adds a little meaning beyond the raw schema but gives no format, validation rules, or contrast with a plain user-id lookup, which matters given the sibling ghl_user_get.

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?

The description states a specific verb+resource ('Get User by Location') and names the replacement endpoint (GET /users/search) with its differing capability set, so the agent can distinguish it from ghl_user_search, ghl_user_get and ghl_user_filter_by_email. However, the actual purpose statement is buried beneath three separate deprecation banners, so the operation is not front-loaded.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly says to use GET /users/search instead and labels this a 'LEGACY FALLBACK ... still served under the legacy Version header. Expect removal.' That is a clear when-not-to-use plus a named alternative, which is exactly what routing guidance should look like.

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