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

ghl-mcp-server-v2

by zackscriven

ghl_saas_pause_location_deprecated

Pause or unpause a GoHighLevel sub-account location via an agency-level token and company ID; deprecated legacy fallback—prefer the current pause endpoint.

Instructions

DEPRECATED per spec — superseded by POST /saas/pause/{locationId}. REQUIRES AN AGENCY-LEVEL (Company) TOKEN. [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.] Pause location Pause Sub account for given locationId Endpoint: POST /saas-api/public-api/pause/{locationId} (Version header: 2021-04-15; source: saas-api.json) Requires an Agency (company-level) token.

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>",
      "body": "<body>"
    },
    "name": "ghl_saas_pause_location_deprecated"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyYesRequest body (schema carried verbatim from the official OpenAPI spec).
locationIdYesLocation ID to pause/unpause

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

A3.6/5.0
Behavior3/5

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

Adds real context beyond annotations: an Agency/company-level token is required, the Version header is 2021-04-15, and the endpoint carries removal risk. With destructiveHint=false and readOnlyHint=false already set, the bar is lower, but the description never explains the effect of pausing a sub-account (billing suspension? access loss?) or whether it is reversible via unpause.

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?

Deprecation is correctly front-loaded, but the warning is repeated three times in brackets ('DEPRECATED per spec', '[DEPRECATED per official docs...]', '[LEGACY FALLBACK...]') before the actual purpose appears. That redundancy crowds out the substantive sentence ('Pause Sub account for given locationId'), pushing the core meaning to the middle.

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 deprecated mutation with full schema coverage and no output schema, the description covers the essentials an agent needs: auth level, version header, endpoint, and deprecation status. The remaining gap is the user-facing consequence and reversibility of pausing, which is left unstated.

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 locationId, paused, and companyId fields are already documented in the schema, and the description adds nothing about their semantics. Notably it does not clarify that the same call with paused=false unpauses, nor why companyId is required alongside locationId.

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 clear verb and resource ('Pause location', 'Pause Sub account for given locationId') plus the concrete endpoint POST /saas-api/public-api/pause/{locationId}. It identifies itself as superseded by the non-deprecated '/saas/pause/{locationId}' path, which in practice maps to the sibling ghl_saas_pause_location, though it names an endpoint rather than the sibling tool.

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

Usage Guidelines4/5

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

Explicitly warns that it is deprecated, still served only under the legacy Version header, and should be replaced by a current equivalent when one exists — effectively telling the agent when not to use it. It falls short of a crisp 'use X instead' pointer to the sibling tool, leaving the agent to infer the mapping from the URL.

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