Skip to main content
Glama

Get the embed code of a channel

get_widget_embed_code

HTML to paste on a site for a channel: website widget (settings load from the server), website button (style it here: text, colours, radius, size — not stored server-side) or Slide Presenter (also the direct link). Read-only.

Input Schema

NameRequiredDescriptionDefault
idYesAgent id (UUID) — from list_agents
sizeNoButton only
textNoButton only: label (default "Talk to Assistant")
text_colorNoButton only
border_radiusNoButton only (px)
connection_idYesChannel (connection) id (UUID) — from list_agent_connections
background_colorNoButton only
modal_primary_colorNoButton only: colour of the chat window it opens

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed9 schema fields changed
    • addedInput schema / properties / background_color
      Added value: +{
      +  "description": "Button only",
      +  "pattern": "^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
      +  "type": "string"
      +}
    • addedInput schema / properties / border_radius
      Added value: +{
      +  "description": "Button only (px)",
      +  "maximum": 50,
      +  "minimum": 0,
      +  "type": "number"
      +}
    • addedInput schema / properties / connection_id
      Added value: +{
      +  "description": "Channel (connection) id (UUID) — from list_agent_connections",
      +  "type": "string"
      +}
    • addedInput schema / properties / id / description
      Added value: +"Agent id (UUID) — from list_agents"
    • addedInput schema / properties / modal_primary_color
      Added value: +{
      +  "$ref": "#/properties/background_color",
      +  "description": "Button only: colour of the chat window it opens"
      +}
    • addedInput schema / properties / size
      Added value: +{
      +  "description": "Button only",
      +  "enum": [
      +    "small",
      +    "medium",
      +    "large"
      +  ],
      +  "type": "string"
      +}
    • addedInput schema / properties / text
      Added value: +{
      +  "description": "Button only: label (default \"Talk to Assistant\")",
      +  "type": "string"
      +}
    • addedInput schema / properties / text_color
      Added value: +{
      +  "$ref": "#/properties/background_color",
      +  "description": "Button only"
      +}
    • changedInput schema / required
      Previous value: -[
      -  "id"
      -]New value: +[
      +  "id",
      +  "connection_id"
      +]
  2. First observed

TDQS

A3.6/5.0
Behavior4/5

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

No annotations exist, so the description carries the full burden, and it delivers meaningful traits: it declares the operation read-only and — importantly — that website widget settings load from the server while button styling is not stored server-side (so the returned HTML is static for buttons). It omits return shape and permission needs, keeping it from a 5.

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?

One front-loaded sentence led by the core output (HTML to paste on a site for a channel), with the variants following. Dense and mostly waste-free, though the telegraphic style and parentheticals make it slightly harder to parse than a cleaner sentence would.

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

Completeness3/5

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

With 8 parameters, no annotations, and no output schema, the description does cover the three variants and the read-only nature, but it never says what the return value looks like (raw HTML string, object, per-variant fields) or auth requirements. Adequate for a get tool, but with clear gaps left to inference.

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%, so the schema already documents all eight parameters, establishing the baseline of 3. The description only echoes the grouping (text, colours, radius, size belong to the button; Slide Presenter adds a direct link) without adding format or default detail beyond the schema.

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?

States the resource precisely: returns HTML embed code to paste on a site for a channel, and enumerates the three variants (website widget, website button, Slide Presenter). An agent can tell what it produces. It stops short of explicitly distinguishing itself from the sibling get_presentation_embed_code, so it isn't a 5.

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

Usage Guidelines3/5

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

Use is implied — you call it when you need embed HTML for a channel — but there is no explicit when-to-use/when-not or naming of alternatives such as get_presentation_embed_code or create_widget_test_page. The variant breakdown hints at selection but doesn't route the agent.

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