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

ghl-mcp-server-v2

by zackscriven

ghl_oauth_get_installed_location

Read-onlyIdempotent

Retrieves the locations where a specified app is installed using an agency-level token, with pagination and filters for company, plan, and trial status.

Instructions

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only, no Location-Access alternative. Legacy twin of GET /oauth/installed-locations (v3); prefer the v3 op for new integrations. [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 Location where app is installed This API allows you fetch location where app is installed upon Endpoint: GET /oauth/installedLocations (Version header: 2021-07-28; source: oauth.json) Requires an Agency (company-level) token. OAuth access token only — Private Integration Tokens are rejected. OAuth scopes: oauth.readonly Pagination params: skip, limit — pass them to page through full result sets.

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": {
      "companyId": "<companyId>",
      "appId": "<appId>"
    },
    "name": "ghl_oauth_get_installed_location"
  }
}

Input Schema

NameRequiredDescriptionDefault
skipNoParameter to skip the number installed locations0
appIdYesParameter to search by the appId
limitNoParameter to limit the number installed locations20
queryNoParameter to search for the installed location by name
planIdNoFilters out location which are installed for specified app under the specified planId
onTrialNoFilters out locations which are installed for specified app in trial mode
companyIdYesParameter to search by the companyId
versionIdNoVersionId of the app
locationIdNolocationId
isInstalledNoFilters out location which are installed for specified app under the specified company

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already cover read-only, idempotent, non-destructive behavior, but the description adds substantive context: agency-level auth only, PIT rejection, oauth.readonly scope, and deprecation/removal risk. It does not describe the response shape or how pagination terminates, which would have made this 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.

Conciseness3/5

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

Auth and deprecation warnings are correctly front-loaded, but the legacy status is stated twice (the 'Legacy twin… prefer v3' sentence and the bracketed LEGACY FALLBACK block say the same thing), and the fragment 'install app is installed upon' is dead text.

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, 10-parameter, no-output-schema read endpoint, the description supplies what an agent most needs: auth tier, deprecation status, scope, and pagination hint. Filter semantics are left entirely to the schema, which is acceptable given full coverage, but return shape is unaddressed.

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 baseline is 3. The description adds only one piece of meaning beyond the schema — that skip/limit are pagination parameters to page through full result sets — and says nothing about the filter params (query, planId, onTrial, isInstalled) or which two are required.

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?

States a specific verb and resource ('fetch location where app is installed') and pins the endpoint (GET /oauth/installedLocations, legacy Version header). It explicitly distinguishes itself from its v3 sibling ghl_oauth_get_installed_locations, so the agent can tell the two apart without opening a schema.

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?

Explicit routing guidance: 'prefer the v3 op for new integrations', plus a clearly labeled LEGACY FALLBACK block warning of expected removal. It also states the prerequisite that selects this tool over alternatives — an agency/company-level OAuth token, with Private Integration Tokens rejected.

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