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

ghl-mcp-server-v2

by zackscriven

ghl_saas_pause_location

Pause a sub-account location by location ID using an agency-level token, stopping activity for that specific SaaS sub-account.

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-api-v3.json) Requires an Agency (company-level) token. OAuth scopes: saas/company.write

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

Input Schema

NameRequiredDescriptionDefault
bodyYesRequest body (schema carried verbatim from the official OpenAPI spec).
locationIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.1.0
    • addedInput schema / properties / body / title
      Added value: +"PauseLocationDto"
  2. First observedv2.0.0

TDQS

B3.1/5.0
Behavior4/5

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

The description adds substantive context beyond the annotations by explicitly calling out the agency-level token requirement, the OAuth scope saas/company.write, the HTTP endpoint, and the API version header. It still does not describe the effect of pausing on the sub-account or how to reverse it, but the auth requirements are valuable operational context.

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?

The key purpose is front-loaded, but the agency-token requirement is repeated twice, and the endpoint/source metadata is verbose. The description is not bloated, but redundancy and low-value spec provenance reduce efficiency.

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?

For a mutation tool with no output schema, the description covers auth and endpoint details but omits important behavioral context: what pausing does to the location, whether it is reversible, and what happens to existing subscriptions or settings. It is adequate but leaves meaningful gaps.

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 coverage is only 50%, and the description does little to compensate. It clarifies that locationId is the target but says nothing about the required body's paused boolean, leaving ambiguity about whether paused=true or paused=false performs the pause versus resume action.

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 gives a specific verb and resource ("Pause Sub account") and scopes it to a given locationId. However, it does not differentiate this tool from the closely named deprecated sibling ghl_saas_pause_location_deprecated or from ghl_saas_enable_location, so an agent must infer which variant to call.

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

Usage Guidelines2/5

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

The description states a prerequisite (agency-level token) and OAuth scope, but it never explains when to use this tool versus alternatives such as ghl_saas_enable_location, ghl_saas_bulk_disable, or the deprecated pause sibling. There is no when-not guidance, only an auth requirement.

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