Update Embed Widget

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

Annotations already declare readOnlyHint false and destructiveHint false, indicating this is a safe, non-destructive mutation. The description adds that it updates appearance toggles, scope, and privacy, but does not elaborate on behavioral traits like idempotency (already in annotations) or error conditions. Thus, it adds moderate value beyond annotations.

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?

The description is a single, compact sentence that front-loads the main purpose and immediately lists the key update categories. No wasted words.

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?

Given that an output schema exists, the description does not need to explain return values. The tool is straightforward (update an embed), and the description covers the main update aspects. However, it lacks usage guidance and could mention that it is idempotent (already in annotations). Overall, it is sufficiently complete for a simple update tool.

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 description coverage is 100%, so each parameter has a description. The description groups parameters into 'appearance/feature toggles via meta', 'scope', and 'privacy', providing high-level context that aids understanding. This adds value beyond the raw schema.

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 clearly states the tool updates an existing embed widget and lists the three areas of update: appearance/feature toggles via meta, scope, and privacy. This distinguishes it from siblings like create_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?

The description implies usage for updating existing embeds but does not explicitly state when to use this over alternatives or when not to use it. No exclusions or alternative comparisons are provided.

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