Api entities generate dora roi retrieve

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

Annotations already declare readOnlyHint=true, idempotentHint=true and destructiveHint=false, so safety is covered. The description adds useful behavior beyond that, namely that the output is a zip archive containing CSV files rather than JSON, but says nothing about generation cost, prerequisites (entities/contracts must exist), or whether the result is a download stream.

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?

A single front-loaded sentence with no filler; the key output format is attached directly to the action.

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 parameterless, no-output-schema tool, the description does cover the return shape (zip of CSVs), which is the main gap. However, with an adjacent lint sibling and no note on prerequisites or failure modes when DORA data is incomplete, an agent still lacks routing context.

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?

Zero parameters, so there is nothing for the description to disambiguate; baseline 4 applies. It correctly implies generation is scoped to the whole workspace with no filters, which matches the empty input 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 pairs a specific verb (Generate) with a specific resource (DORA Register of Information / ROI) and even states the artifact form, a zip of CSV data. It is clearly distinguishable from read-only burst siblings such as entities_dora_roi_lint_retrieve, though it never names or contrasts with them.

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 statement of when to use this versus the closely related entities_dora_roi_lint_retrieve (validate) or the various export_csv/export_xlsx siblings. An agent must infer the use case from the name alone.

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