generate_embed_code
Generate embed code for HTML, Next.js, WordPress, Shopify, iOS, or Android.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| bot_id | Yes | ||
| framework | No | html_script |
Generate embed code for HTML, Next.js, WordPress, Shopify, iOS, or Android.
| Name | Required | Description | Default |
|---|---|---|---|
| bot_id | Yes | ||
| framework | No | html_script |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full behavioral burden, yet says nothing about side effects, whether the operation is safe/read-only, permission requirements, or whether a published bot is needed. For a generation tool this is low-risk, but the agent still cannot tell whether calling it mutates state or requires specific auth.
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?
A single front-loaded sentence with zero waste; the verb and platform enumeration come first. Nothing is padded or repeated.
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?
The tool is simple (1 required param), but with no annotations, no output schema, and 0% schema coverage, the description should at minimum explain bot_id and what the returned embed code looks like (a string snippet vs. structured object). Neither is covered.
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?
Schema coverage is 0%, so the description must compensate: it does list the framework options (HTML, Next.js, WordPress, Shopify, iOS, Android), which adds real meaning for the 'framework' parameter. However, 'bot_id' is never explained and the listed platform labels don't map to the exact accepted string values (e.g., 'html_script'), leaving a gap.
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?
States a specific verb (Generate) and resource (embed code) and enumerates the supported target frameworks, so the agent knows exactly what comes back. It does not explicitly distinguish itself from the sibling get_voice_agent_embed_code or say this is for the chat widget rather than a voice agent, leaving some ambiguity.
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 statement of when to use this tool versus alternatives such as get_voice_agent_embed_code or preview_widget_html, and no prerequisites (e.g., bot must exist/published). The only implied usage is 'call after creating a bot,' which the agent must infer.
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.