sigma_create_workbook_embed

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

Annotations already indicate a non-read-only, non-destructive operation. The description adds the constraint that only 'public' embed_type is supported and clarifies conditional source_id requirement, but it does not disclose side effects like whether the embed becomes publicly accessible or how it can be removed.

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 front-loaded with the purpose and uses a compact bullet-like structure for parameter details. Every sentence contributes value.

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 the presence of an output schema and annotations, the description covers the key invocation parameters and constraints. It lacks some contextual detail about the embed's lifecycle, but overall is sufficient for the tool's moderate complexity.

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 0%, yet the description explains embed_type, source_type, and source_id, including allowed values and conditional requirements. workbook_id is not described, but its purpose is clear from the name. This compensates for the missing schema 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 clearly states 'Create an embed for a workbook' with a specific verb and resource. This distinguishes it from siblings like sigma_list_workbook_embeds and sigma_create_workbook.

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 the tool is used when creating an embed, but it does not explicitly contrast it with alternative tools or state when not to use it. There is no mention of prerequisites or relationships to other embed-related operations.

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