Skip to main content
Glama

Turn off the chat widget

disable_chat_widget
Idempotent

Switch a site's chat widget off so visitors stop seeing it after the next publish. Its settings, knowledge and conversation history are kept, so enable_chat_widget brings it back as it was.

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

A4.2/5.0
Behavior4/5

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

Annotations already declare destructiveHint=false and idempotentHint=true, so the description earns credit for the details annotations cannot express: settings, knowledge and conversation history are retained, and the change takes effect only after the next publish. It doesn't say what happens to conversations while the widget is off or whether a response body is returned.

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?

Two sentences, zero filler, with the effect and the timing caveat front-loaded before the reversibility note. Every clause 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, non-destructive toggle with full schema coverage, annotations, and no output schema, the description covers effect, timing and reversibility adequately. Minor gaps: no statement of what the call returns or how to verify the state changed.

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 site_id is documented in the schema with provenance ('from list_sites'), so the schema does the heavy lifting. The description adds no parameter-level detail (e.g. that site_id is the only required one, or what user_goal is used for), leaving this at the baseline.

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?

Specific verb + resource + scope: 'switch a site's chat widget off so visitors stop seeing it.' It is unambiguously distinct from enable_chat_widget, get_chat_widget_status, and the widget-knowledge tools named in the sibling list.

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?

Names the inverse tool explicitly and the condition under which to use it ('enable_chat_widget brings it back as it was'), which gives an agent a clear routing rule. It stops short of explicit when-not guidance (e.g. use get_chat_widget_status to first check state), so not a 5.

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