Workbooks List Workbook Embeds

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

Annotations already establish that this is a read-only, non-destructive operation. The description adds useful behavioral detail by explaining that it follows Sigma pagination to the last page and describing how entries, total, nextPage, and hasMore are handled.

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 core purpose and remains reasonably concise. The second sentence is long and partly duplicates output-schema information, but it earns its place by clarifying pagination behavior.

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 simple read-only list tool with annotations and an output schema, the description is largely complete: it covers purpose and pagination behavior. The main remaining gap is the lack of workbook_id semantics and usage guidance.

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 only parameter, workbook_id, has 0% schema description coverage, and the description does not explain its format, source, or meaning beyond saying the list is "for a workbook." This does not compensate for the missing schema documentation.

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 states a specific verb and resource: "List embed configurations for a workbook." This clearly distinguishes it from create/delete embed operations by verb, but it does not explicitly name sibling alternatives or clarify scope differences.

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 explicit guidance on when to use this tool versus related tools such as create_workbook_embed or delete_workbook_embed. Usage is only implied by the phrase "for a workbook."

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