Get Embed Code
get_embed_codeThe embed code of a widget, with the steps to add it to WordPress, Wix, Shopify, Squarespace or a plain HTML page.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| widget_id | Yes | The widget's id (the id in list_widgets). |
get_embed_codeThe embed code of a widget, with the steps to add it to WordPress, Wix, Shopify, Squarespace or a plain HTML page.
| Name | Required | Description | Default |
|---|---|---|---|
| widget_id | Yes | The widget's id (the id in list_widgets). |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description adds useful return-context (embed code plus platform-specific steps) but says nothing about auth requirements, whether the widget must be published first, or output format. With annotations carrying the safety burden, this is adequate but thin.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
One compact sentence with no filler, front-loading the core resource. It is a sentence fragment rather than a complete statement, but that costs little and brevity is appropriate for a simple read tool.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a one-parameter read-only tool with no output schema, the description tells the agent both what is fetched and what extra content (per-platform instructions) comes back, which is the main thing missing from structured fields. Only prerequisites and return format remain unstated, which are minor gaps.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The single widget_id parameter has 100% schema description coverage and explicitly points to list_widgets as the source of the id. The description adds nothing beyond the schema, which is fine given full coverage, but means no extra value here.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description names the resource (a widget's embed code) and adds that the response includes platform-specific setup steps for WordPress, Wix, Shopify, Squarespace, and plain HTML. That distinguishes it from get_widget or preview_widget, though it is a noun phrase with no explicit verb and never says 'returns' or 'retrieves'.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use guidance and no mention of alternatives such as get_widget or preview_widget. The agent must infer from the name and the sibling list that this is the tool for embedding-related needs rather than previewing or editing a widget.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.