Skip to main content
Glama
zackscriven

ghl-mcp-server-v2

by zackscriven

ghl_saas_pause_location

Pause a sub-account (location) using its location ID and company ID. This action temporarily disables the specified location in the GoHighLevel platform.

Instructions

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only. Pause location Pause Sub account for given locationId Endpoint: POST /saas/pause/{locationId} (Version header: v3; source: v3/saas-v3.json)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyYesRequest body (schema carried verbatim from the official OpenAPI spec).
locationIdYes
Behavior3/5

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

Annotations already indicate readOnlyHint=false and destructiveHint=false. The description adds the security requirement but does not explain the effects of pausing (e.g., whether it can be reversed) or side effects. No contradiction with annotations.

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?

Three sentences, front-loaded with critical security info. Slightly redundant ('Pause location' and 'Pause Sub account') but overall concise and well-structured.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

No output schema; description does not mention return values, reversibility, or how to resume. The openWorldHint indicates possible undocumented side effects. Missing important context for a state-changing tool.

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

Parameters2/5

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

Schema description coverage is 50% (only body nested properties have descriptions; locationId lacks description). The tool description does not add any parameter semantics or explain the meaning of the 'paused' field or companyId.

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?

The description clearly states the verb 'Pause' and the resource 'Sub account / location', distinguishing it from sibling tools like ghl_saas_enable_location. The endpoint and action are unambiguous.

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?

The description explicitly requires an agency-level token, providing a key usage constraint. However, it does not contrast with alternatives (e.g., deprecated version, enable) or specify when not to use this tool.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/zackscriven/ghl-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server