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

ghl-mcp-server-v2

by zackscriven

ghl_chat_widget_list

Read-onlyIdempotent

Retrieve chat widgets for a GoHighLevel location, with optional filters and offset/limit pagination to page through results.

Instructions

List Chat Widgets Retrieves a list of chat widgets for a specific location Endpoint: GET /chat-widget/list (Version header: v3; source: v3/chat-widget-v3.json) Requires a Sub-Account (location) token. OAuth scopes: chat-widget.readonly Pagination params: offset, 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": {
      "locationId": "<locationId>",
      "offset": "<offset>",
      "limit": "<limit>"
    },
    "name": "ghl_chat_widget_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitYesPage size. Must be greater than 0, capped at 100.
offsetYesRow offset. Defaults to 0, capped at 10000.
chatTypeNoThe type of chat widget. Supports normal ChatType values, plus the virtual umbrella "webChat" (maps to facebookChat/emailChat/instagramChat/waChat).
locationIdYesThe location ID
creationSourceNoThe source that created the widget
voiceAiAgentIdNoThe voice AI agent ID
excludeChatTypeNoThe type of chat widget
excludeCreationSourceNoExclude widgets with this creation source

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changedv2.1.0
    • removedInput schema / properties / allInOneChatTypes
      Removed value: -{
      -  "description": "All-in-one chat type to filter by. Only applies when chatType is \"allInOneChat\". Supports normal ChatType values plus the virtual umbrella \"webChat\" (maps to facebookChat/emailChat/instagramChat/waChat).",
      -  "enum": [
      -    "liveChat",
      -    "waChat",
      -    "emailChat",
      -    "allInOneChat",
      -    "voiceAiChat",
      -    "facebookChat",
      -    "instagramChat",
      -    "webChat"
      -  ],
      -  "example": "emailChat",
      -  "type": "string"
      -}
    • addedInput schema / properties / creationSource
      Added value: +{
      +  "description": "The source that created the widget",
      +  "enum": [
      +    "chat-widget",
      +    "a2pCompliance",
      +    "public-api",
      +    "snapshot"
      +  ],
      +  "example": "chat-widget",
      +  "type": "string"
      +}
    • addedInput schema / properties / excludeCreationSource
      Added value: +{
      +  "description": "Exclude widgets with this creation source",
      +  "enum": [
      +    "chat-widget",
      +    "a2pCompliance",
      +    "public-api",
      +    "snapshot"
      +  ],
      +  "example": "a2pCompliance",
      +  "type": "string"
      +}
    • changedInput schema / properties / limit / description
      Previous value: -"Limit"New value: +"Page size. Must be greater than 0, capped at 100."
    • changedInput schema / properties / limit / example
      Previous value: -0New value: +"10"
    • changedInput schema / properties / offset / description
      Previous value: -"Offset"New value: +"Row offset. Defaults to 0, capped at 10000."
    • changedInput schema / properties / offset / example
      Previous value: -10New value: +"0"
  2. First observedv2.0.0

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, so the bar is lower, yet the description still adds real context: the exact endpoint and API version, the Sub-Account token requirement, and the OAuth scope. What's missing is any note on result size or pagination termination behavior.

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?

Front-loaded with the action and scope, then prerequisites, then pagination advice in four short lines. The '(Version header: v3; source: v3/chat-widget-v3.json)' parenthetical is internal metadata of marginal use to an agent and is the one piece of filler.

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 an 8-param read-only list tool with no output schema, it covers auth, scope, filtering scope, and pagination, which is enough to call it correctly. The absence of any description of the returned widget objects is the main residual gap.

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

Parameters4/5

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

Schema coverage is 100%, so the enum filters are already documented; the description still adds value by explaining that offset and limit are pagination controls to 'pass them to page through full result sets', which is usage semantics the schema doesn't convey. It says nothing about the four filter params, but the schema handles those.

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?

States a specific verb+resource ('Retrieves a list of chat widgets') and the scoping dimension ('for a specific location'), which cleanly separates it from the sibling CRUD tools (ghl_chat_widget_get/create/update/delete/clone). It does not explicitly name the read-one sibling, but the list-vs-get distinction is unambiguous.

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

Usage Guidelines3/5

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

Usage is implied by 'for a specific location' and the pagination note, and it usefully states the required Sub-Account token and chat-widget.readonly scope. However, it never explicitly says when to pick this over ghl_chat_widget_get or how to combine filters, so the agent must infer routing.

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