Skip to main content
Glama

Update the web chat

update_web_chat
DestructiveIdempotent

Change what visitors of the customer's website see in the chat: on/off, title, greeting, agent name, subtitle, colours, logo, pre-chat form, email alerts, conversation starters, satisfaction rating, live-visitor tracking, quick links, AI-notice and privacy links, and placement. Only the fields you pass change. Changes go live on the website at once: show the user what will change and confirm first. Allowed domains and the widget key can only be changed by a person in the Ignix app.

Input Schema

NameRequiredDescriptionDefault
csatNoAsk visitors πŸ‘/πŸ‘Ž whether the chat helped; the rating shows in the inbox.
lookNoVisual style: "classic" (coloured header) or "glass" (translucent panel with the logo as a cover, quick links on top and the AI-notice/privacy links at the foot).
titleNoHeader title (max 60 characters).
enabledNoTurn the chat on or off on the website.
logoUrlNoPublic http(s) URL of the logo; "" removes it.
offsetXNoDistance from that side, in pixels (0-200). Raise this to clear a fixed sidebar.
offsetYNoDistance from the bottom, in pixels (0-200). Raise this to sit above a sticky bar instead of moving to the other corner.
preChatNoAsk the visitor for their name before chatting.
greetingNoFirst message the visitor sees (max 500 characters). "" removes it.
positionNoWhich side the bubble sticks to.
startersNoConversation starters shown as buttons (max 6, 80 characters each). Replaces the list; [] clears it.
subtitleNoLine under the title, e.g. "We reply in minutes" (max 80 characters).
agentNameNoName the assistant signs with (max 60 characters). "" removes it.
hidePathsNoPaths where the bubble must not appear (max 20). "*" matches anything after it, e.g. "/checkout*". Pass an empty array to clear.
textColorNoText colour on the accent, hex; "" = automatic by contrast.
panelColorNoPanel background for the glass look, hex; "" = automatic.
privacyUrlNohttp(s) link to the privacy policy; "" removes it.
quickLinksNoAction buttons of the glass look, max 3: [{"label":"Book","url":"https://…"}] (label max 24 characters). Replaces the list; [] clears it.
themeColorNoAccent colour, hex like #FF6A00.
aiNoticeUrlNohttp(s) link to the page explaining the AI assistant; "" removes it.
collapsibleNoLet visitors fold the bubble into a tab at the edge. It does not close the chat: it comes back on the next page, and reopens on its own if someone replies.
notifyEmailNoEmail that gets an alert when a visitor writes; "" stops the alerts.
workspaceIdNoDefaults to the workspace this connection is scoped to.
hideOnMobileNoDo not load the chat at all on screens under 640px.
liveVisitorsNoTrack who is browsing the site right now (page path and an anonymous id only) for the Live visitors page.
preChatEmailNoAlso ask for their email in that form (needs preChat).
customLauncherNoHide our bubble entirely; the site opens the chat by calling Ignix.open() from its own button.
idempotencyKeyNoOptional. A unique id for this action (16-128 chars: letters, digits, _ : . -). If you are unsure whether a call went through (timeout, network error), repeat it with the SAME idempotencyKey and the same arguments: you get the original result and nothing is done twice.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare destructive=true and idempotent=true, but the description adds two traits they cannot convey: changes 'go live on the website at once' and the update is partial, touching only passed fields. It also discloses what the tool cannot do (allowed domains, widget key), which is useful boundary information. It does not cover permissions/auth requirements or rate limits.

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?

Three sentences, front-loaded with purpose, then patch semantics, then the live-change warning and exclusion. The long field list in sentence one is somewhat redundant with the schema but functions as a scannable overview, so it 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 28-parameter mutation with no output schema, the description covers the critical facts an agent needs: partial update semantics, immediate publication, the confirmation obligation, and what is out of scope. The only real gap is that it says nothing about what the call returns or how failures surface, which matters slightly given no output 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 description coverage is 100% and every one of the 28 parameters is individually documented in the schema, so the description's field enumeration is largely a restatement of structured data. Baseline 3 applies; the narrative grouping ('what visitors see') adds only mild orientation value over the per-field descriptions.

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 a specific verb and resource ('Change what visitors of the customer's website see in the chat') and enumerates the editable surface (title, greeting, colours, logo, pre-chat form, placement, etc.), so an agent immediately knows this is the full web-chat configuration writer. It does not explicitly differentiate itself from the narrower sibling set_web_chat_placement, which overlaps on the 'placement' field it lists.

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 real operating guidance: 'Only the fields you pass change' (patch semantics), 'show the user what will change and confirm first' (a required confirmation step before an immediate live change), and an explicit exclusion ('allowed domains and the widget key can only be changed by a person in the Ignix app'). It stops short of naming alternatives such as reading current state with get_web_chat first.

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