Skip to main content
Glama
zackscriven

ghl-mcp-server-v2

by zackscriven

ghl_chat_widget_list

Read-onlyIdempotent

List chat widgets for a sub-account with pagination and optional filters such as chat type, exclusion type, or voice AI agent.

Instructions

List Chat Widgets Returns chat widgets for the sub-account with pagination and optional filters. Endpoint: GET /chat-widget/list (Version header: v3; source: v3/chat-widget-v3.json) OAuth scopes: chat-widget.readonly Pagination params: offset, limit — pass them to page through full result sets.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitYesLimit
offsetYesOffset
chatTypeNoThe type of chat widget. Supports normal ChatType values, plus the virtual umbrella "webChat" (maps to facebookChat/emailChat/instagramChat/waChat).
locationIdYesThe location ID
voiceAiAgentIdNoThe voice AI agent ID
excludeChatTypeNoThe type of chat widget
allInOneChatTypesNoAll-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).
Behavior4/5

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

Annotations already mark readOnlyHint, idempotentHint, destructiveHint. Description adds OAuth scope ('chat-widget.readonly') and endpoint details, which are useful beyond annotations. No contradictions.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Description is concise (4 lines), front-loads purpose, and includes all key details without redundancy.

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?

Given a simple list tool with no output schema, the description covers key aspects: resource, pagination, filters, auth, and endpoint. Could mention required locationId but it's in schema.

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 coverage is 100%, so baseline is 3. Description mentions pagination params and optional filters but does not add significant extra semantics for individual parameters beyond the schema.

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?

Title and description clearly state 'List Chat Widgets' and 'Returns chat widgets for the sub-account with pagination and optional filters.' This distinguishes it from sibling tools like get, create, delete for the same resource.

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?

Description explains when to use it (listing with pagination/filters) and mentions pagination params. However, it does not explicitly state when not to use it (e.g., for a single widget use get). Still clear enough.

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