Skip to main content
Glama

Embed snippet

embed_snippet
Read-onlyIdempotent

The embeddable widget's snippet, already assembled with the site's name and colour — one script tag, no account, no lead capture. One script tag puts the audit form on your own site, with your name and colour, and no account or key. Send the same query you would send to /embed and the answer comes back with snippet already assembled. The widget never asks the visitor for an e-mail.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlNooptional URL to pre-fill
brandNosite name shown above the form
colorNoaccent colour in hex
themeNoauto, light or dark

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

C2.9/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive and closed-world, so the safety profile is covered. The description adds genuinely useful behavior: no account, no key, and no visitor e-mail capture. It does not, however, describe return shape beyond the `snippet` field.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness2/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description repeats itself: 'one script tag' is asserted twice, and 'no account' is restated as 'no account or key'. The redundant second sentence crowds out content that would actually help, such as parameter or return detail.

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 no output schema, the description does mention that the response carries a pre-assembled `snippet`, which is helpful. But it omits other response content and any deployment caveats, leaving the picture only partially complete for a generator tool.

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 schema documents all four parameters (url, brand, color, theme). The description only implies that these mirror a `/embed` query and adds no syntax or format detail. Baseline 3 applies.

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 a specific deliverable: an already-assembled embeddable widget snippet containing the site's name and colour. It is reasonably distinguishable from siblings like get_badge, though it never names an alternative to contrast against.

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?

It gestures at context ('puts the audit form on your own site') but gives no explicit when-to-use, when-not-to-use, or alternatives. The agent is left to infer that this is the widget path versus get_badge or preview routes.

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.