Skip to main content
Glama

Add embed widget

add_embed_widget

Add an embed widget to a page. Position, width, and height use sensible defaults.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
page_idYesPage ID the widget will be placed on, from list_pages.
link_urlNoEmbed source URL (for 'URL' or 'IFRAME' modes).
client_idYesClient ID the report belongs to (from list_clients).
source_idYesReport ID the widget belongs to (from list_reports).
embed_typeYesEmbed mode.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataNoThe embed widget that was added — widget_id, plus the stored row with the defaults the server filled in (position, width, height).
successYesTrue when the call succeeded.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • removedInput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • removedOutput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • changedOutput schema / properties / success / description
      Previous value: -"True when the call succeeded. A failure comes back as an error result instead."New value: +"True when the call succeeded."
  2. First observed

TDQS

B3.2/5.0
Behavior3/5

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

Annotations are all default-false (readOnlyHint=false, openWorldHint=false, destructiveHint=false), so they convey no meaningful behavioral profile. The description adds one useful behavioral hint — 'Position, width, and height use sensible defaults' — implying the tool auto-handles layout settings. However, it does not disclose what happens on success, error conditions, or the embed_type/link_url dependency.

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?

Two short sentences with the core action front-loaded and the default-behavior note deferred to the second sentence. There is no filler or redundancy; every word earns its place.

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?

The description covers the essential purpose and the auto-default behavior, and the presence of an output schema covers return values. However, it leaves the embed_type/link_url relationship implicit and offers no guidance on distinguishing embed widgets from the many sibling widget-add tools, which is a meaningful gap given the large sibling set.

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%, so the baseline is 3. The description adds nothing beyond the schema, which already documents all five parameters, including the embed_type enum and the conditional note on link_url for URL/IFRAME modes. The description does not compensate for any schema gap, but none exists.

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 states the verb 'add,' the resource 'embed widget,' and the target 'a page,' clearly identifying the core operation. It distinguishes itself from sibling add_button_widget/add_image_widget/add_text_widget tools by widget type, though the differentiation relies mostly on the name 'embed' rather than a stated contrast.

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

Usage Guidelines2/5

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

No when-to-use guidance is provided. There is no mention of when to choose this over sibling add_*_widget tools, nor when update_embed_widget would be the appropriate alternative. The conditional relationship between embed_type and link_url (link_url only for URL/IFRAME modes) is left for the agent to infer from the schema.

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