Create Embed Widget

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

Annotations already indicate this is a non-destructive write operation. The description adds the specific type of widget and parameter logic. No contradictions; but it could disclose more about side effects or dependencies, though output schema exists for return details.

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?

Two concise sentences with no wasted words; action verb and resource are front-loaded, making it easy to scan.

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?

Covers the main purpose and parameter choice adequately. With an output schema, it doesn't need to detail returns. However, it could mention prerequisites like access permissions, which is a minor gap.

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 100%, baseline 3. The description adds conditional semantics ('Provide mediaId for a single-media embed, or folderIds for a folder/library embed'), enriching understanding beyond the schema's descriptions.

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 specifies the exact action ('create an embeddable player/transcript widget') and identifies two distinct use cases (single-media with mediaId vs folder/library with folderIds), clearly differentiating it from sibling tools like 'check_embed' or 'update_embed'.

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?

It provides explicit context for when to use each parameter (mediaId vs folderIds), but does not mention when not to use this tool or point to alternatives like 'get_embed_iframe_url' for retrieval.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.