Skip to main content
Glama

ethora-mcp-server

Widget Embed Snippet

ethora-widget-embed-snippet
Read-onlyIdempotent

Generate the tag that embeds the Ethora AI chat widget (the floating launcher + chat panel that website visitors use) for an app, plus the prerequisites that must hold before it answers. No API call; pure generator using this deployment's hosted widget URL and public API base. The widget answers with the app's ACTIVE bot: for API-created apps run ethora-agents-create-v2 -> ethora-agent-invite-to-chat -> ethora-agents-activate-v2 { agentId, chatJid } first, otherwise POST /v2/widget/sessions returns 422 and the widget stays silent. Auth: none required (uses the selected app when appId is omitted). Errors: effectively none; when no hosted widget is configured the snippet carries a <WIDGET_URL> placeholder. Related: ethora-agents-activate-v2, ethora-bot-widget-v2 (legacy per-app bot only).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
appIdNoApp the widget belongs to (24-char hex). Defaults to the app from `ethora-app-select`.
botIdNoLegacy `data-bot-id` (bot XMPP address); only for old embeds. Prefer `appId`: the backend picks the active agent from the app.
localeNoUI locale (`data-locale`), e.g. `en`, `fr`, `es`.
apiBaseNoOverride the public API base (`data-api-base`). Defaults to this deployment's public API URL.
botNameNoDisplay name shown in the widget header (`data-bot-name`), e.g. the agent's name.
greetingNoGreeting shown when the panel opens (`data-greeting-message`).
positionNoLauncher corner (`data-position`).
botAvatarNoAvatar image URL shown for the bot (`data-bot-avatar`).
widgetUrlNoOverride the widget bundle base URL (the script is `<widgetUrl>/assistant.js`).
primaryColorNoBrand colour for launcher and bubbles (`data-primary-color`), e.g. `#0052CC`.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.9/5.0
Behavior5/5

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

Beyond the readOnly/idempotent/destructive annotations, the description discloses that this is a pure generator with no API call, that auth is not required, that errors are effectively none, and that a `<WIDGET_URL>` placeholder appears when no hosted widget is configured. It also explains the silent-failure behavior when prerequisites are not met.

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?

The description is dense but every sentence earns its place: purpose, prerequisites, auth, error behavior, and related tools. It is front-loaded with the main action and immediately gives the condition that determines successful use.

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?

For a 10-parameter pure generator with no output schema, the description covers the essential operational context: prerequisites, auth, error mode, fallback placeholder behavior, and how to select the right app. Nothing an agent needs to invoke it correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description adds meaningful semantics beyond the schema: `botId` is legacy and `appId` is preferred because the backend picks the active agent, and `widgetUrl` determines the script path `<widgetUrl>/assistant.js`. This helps an agent choose between `appId` and `botId` correctly.

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 ('Generate the <script> tag'), names the exact resource (Ethora AI chat widget embed snippet), and explicitly distinguishes itself from the legacy `ethora-bot-widget-v2` sibling. It clearly identifies what the tool produces and what it is not.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

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

The description gives explicit prerequisites for correct use: run `ethora-agents-create-v2` -> `ethora-agent-invite-to-chat` -> `ethora-agents-activate-v2` first, otherwise the widget fails with a 422. It also names the relevant alternative (`ethora-agents-activate-v2`, legacy `ethora-bot-widget-v2`) and clarifies the legacy path is only for old embeds.

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.