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

ghl-mcp-server-v2

by zackscriven

ghl_chat_widget_get

Read-onlyIdempotent

Retrieves the full chat widget configuration for a specific location and widget ID, enabling you to inspect widget settings and data.

Instructions

Get Chat Widget by ID Returns the full chat widget configuration for the given location and widget ID Endpoint: GET /chat-widget/data/{locationId}/{id} (Version header: v3; source: v3/chat-widget-v3.json) Requires a Sub-Account (location) token. OAuth scopes: chat-widget.readonly

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": {
      "id": "<id>",
      "locationId": "<locationId>"
    },
    "name": "ghl_chat_widget_get"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesThe chat widget ID
locationIdYesThe location ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint and non-destructive. The description adds real context beyond that: the sub-account token requirement, the specific OAuth scope (chat-widget.readonly), and the endpoint path/version header — useful operational detail for correct invocation.

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 purpose and return, followed by endpoint and auth detail. The source-file/version provenance line is slightly meta but still compact and mostly earns its place.

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 simple 2-required-param read tool with annotations and no output schema, the description covers return nature, auth, and scope well. Only the omission of explicit list-vs-get guidance keeps it short of a 5.

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 both parameters are already documented, and the description only restates that the ID is the widget ID and location is the sub-account. Baseline 3 applies since the schema does the heavy lifting.

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+resource ('Get Chat Widget by ID') and clarifies the return ('full chat widget configuration for the given location and widget ID'), which clearly distinguishes it from the sibling list/create/update/clone/delete/patch tools.

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: fetching a single widget requires an ID, versus ghl_chat_widget_list for enumeration. However, it never explicitly names when to use this over list, nor any exclusions or prerequisites beyond the token/scope note.

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