Skip to main content
Glama

Get the chat widget settings

get_widget_settings
Read-onlyIdempotent

Read all appearance and behaviour settings for one website's chat widget: colours, greeting, position, auto-trigger, data collection, bookings and the rest. Also returns which settings this account's plan cannot change, and the plan each of those needs. The greeting and auto-trigger are one general bubble for every visitor; messages for a click, a page, time on a page or an event are Proactive Messages (list_proactive_messages).

Input Schema

NameRequiredDescriptionDefault
website_idNoNumeric id of the website, from list_websites. Omit to use the account's primary website.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already establish read-only, idempotent, non-destructive, closed-world behavior, so the description adds useful context rather than carrying the full burden. It adds that the tool returns plan-gated settings and the required plan for each, and clarifies the boundary between general greeting/auto-trigger bubbles and Proactive Messages. It does not add auth, rate-limit, or detailed response-shape information, but those are less critical given the rich annotations.

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?

Three tight sentences, front-loaded with what the tool returns and what categories of settings are included. The third sentence earns its place by preventing confusion between general widget settings and Proactive Messages.

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

Completeness5/5

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

With one optional parameter, rich safety annotations, and no output schema, the description provides enough return-value context: all appearance and behaviour settings plus plan-restricted settings and required plans. An agent can call it correctly and understand the main content of the response without further output documentation.

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%: website_id is documented as coming from list_websites and omittable to use the primary website. The description only refers to 'one website's chat widget' and does not add syntax or format detail beyond the schema, so the baseline 3 applies.

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 uses a specific verb and resource: 'Read all appearance and behaviour settings for one website's chat widget'. It also distinguishes the scope from Proactive Messages by naming list_proactive_messages, and the read-only framing contrasts with update_widget_settings.

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?

It gives clear context for when to use the tool: reading all widget appearance and behaviour settings for a website. It explicitly routes click/page/time/event messages to list_proactive_messages, but does not explicitly say when to use update_widget_settings instead for mutations or list_widget_translations for translations.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources