Get time-series report

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

No annotations provided, so description must cover behavioral traits. It specifies that output is 'aligned timestamp/value points' but omits details on rate limits, authentication, data volume, or side effects. Lacks important operational context for a mutation-free tool.

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?

Three sentences, no filler, front-loaded with primary action. Efficiently conveys purpose, types, date format, and scoping without redundancy.

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?

Covers main aspects (purpose, types, date format, scoping) but lacks explanation of 'resolution' parameter (default daily) and output structure beyond 'aligned timestamp/value points'. With no output schema, more detail on return format would improve usability.

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 description adds little beyond the schema. It repeats type enum, date format, and id usage, but does not provide new semantics or constraints. Baseline of 3 is appropriate as the description does not detract but does not enhance understanding.

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?

Clearly states 'Fetch a reporting time-series for a controller' with specific resource (controller) and verb (fetch). Lists all report types, date format, and scope option, distinguishing it from sibling tools which are other data retrieval or list operations.

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?

Provides clear context on when to use the 'id' parameter (scope to single zone/device vs. omit for controller-wide). Does not explicitly mention alternatives or when not to use the tool, but the distinct purpose and sibling list imply appropriateness for time-series data.

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