Get Sweep Tool

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

Annotations only declare readOnlyHint, so the description usefully adds that sweeps are pre-gathered before the gatherer runs and that data is stored as sections of compact records, including what the index contains. It omits auth/permission needs and any rate or size caveats beyond the schema's page_size max.

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?

Front-loads the core action in the first sentence and follows with just enough mechanism and call-order detail. The gatherer/Metsuke framing is somewhat jargon-heavy but earns its place by explaining where the data comes from.

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?

With an output schema present, return values need not be documented, yet the description still tells the agent what the index yields and how to page. Read-only, no required params, and 100% schema coverage make this nearly self-sufficient.

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 the baseline is 3. The description reinforces the section/index relationship and pagination flow, but the run_id-vs-report_name selection and page defaults are left to the schema, adding little beyond it.

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?

States a specific verb and resource: read the pre-gathered sweep for a run. The concept is clearly distinct from the listed siblings (output/report/definition tools), though it never explicitly names an alternative to contrast against, so it falls just short of 5.

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?

Gives concrete call-order guidance: call with no section to get the index, then page through each section needed. That is clear usage context, but there are no explicit when-not conditions or named alternatives for choosing between run_id and report_name.

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