Skip to main content
Glama

Check the chat widget

get_chat_widget_status
Read-onlyIdempotent

Whether a site has its chat widget — the AI assistant that answers the site's VISITORS, captures leads and can take booking requests — whether it is switched on, whether it is actually installed on the site, and whether voice is on. Not the same as site add-ons (popups, announcement bar, WhatsApp button): those are list_site_addons.

Input Schema

NameRequiredDescriptionDefault
site_idYesThe site, from list_sites
user_goalNoOptional: the user's goal behind this call, in one short sentence of plain words (e.g. "add a page so customers can book tables"). No names, emails or other personal details.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / user_goal
      Added value: +{
      +  "description": "Optional: the user's goal behind this call, in one short sentence of plain words (e.g. \"add a page so customers can book tables\"). No names, emails or other personal details.",
      +  "type": "string"
      +}
  2. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint and non-destructive, so safety is covered. The description adds real value by stating what the check inspects (enabled flag, actual install state, voice toggle) — effectively previewing the return surface for a tool with no output schema — and by scoping it to the visitor-facing assistant rather than admin widgets.

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?

Front-loaded with the resource, which is good, but the opening clause is convoluted and the repeated "whether ... whether ... whether" phrasing makes it harder to parse than needed. The parenthetical definition of the widget is useful; the sentence structure could be tightened considerably.

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 two-parameter read-only status tool with no output schema, the description covers the resource, the three things checked, and the main lookalike tool. Only the relationship to enable/disable_chat_widget is left unaddressed.

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% and both parameters (site_id, user_goal) are documented in the schema with sourcing hints. The description adds no additional meaning about parameters, so the baseline of 3 applies.

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 names the resource precisely (the chat widget that answers the site's visitors, captures leads, takes bookings) and enumerates what is being checked: switched on, actually installed, voice on. It also explicitly separates itself from list_site_addons. The opening is grammatically tangled ("Whether a site has its chat widget ... whether it is switched on, whether it is actually installed"), which costs a point but the intent 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 Guidelines4/5

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

Gives an explicit exclusion and names the alternative: add-ons like popups, announcement bar, WhatsApp button belong to list_site_addons. What's missing is guidance on when to call this versus the closely related enable_chat_widget / disable_chat_widget siblings, which an agent could easily confuse with a status check.

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