Workbooks List Report Controls

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

Annotations already declare readOnlyHint=true, openWorldHint=true, and destructiveHint=false. The description adds meaningful behavior beyond that: it follows Sigma pagination to the last page, returns entries from every page, and sets nextPageToken to null.

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 purpose is front-loaded in one short sentence, and the second sentence only adds non-obvious pagination behavior. There is no wasted text for a simple one-parameter listing tool.

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 rich annotations and an existing output schema, the description is complete enough for correct invocation. It covers purpose, report scoping, and pagination/return behavior without needing to restate schema fields.

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?

There is one parameter, report_id, but schema description coverage is 0%. The description implies that the parameter identifies the report, yet it does not explain the expected ID format or where to obtain it, so it only partially compensates 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 the controls in a report. The parenthetical '(filters and parameters)' clarifies what controls means, and 'in a report' distinguishes this from sibling workbook-control and report-element listing tools.

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 context of use is clear: call this to retrieve controls for a specific report. It does not explicitly name alternatives or exclusions, but the report-scoped phrasing differentiates it adequately from siblings like elements_list_workbook_controls.

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