mike_plot_timeseries

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

With no annotations, the description carries full burden. It discloses one behavioral trait ('no license needed') but omits details on side effects (e.g., file overwriting), output format, or return behavior.

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?

Extremely concise: two sentences front-load the action and key condition. Every word adds value with no 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?

Given no output schema and moderate complexity, the description provides the essential purpose but lacks details on output expectations (e.g., that it saves a PNG) and examples. It is minimally complete for a tool of this simplicity.

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 coverage is 0%, so description must compensate. It mentions 'quantity at an element' and 'single-panel time-series plot', hinting at parameter roles, but does not explicitly describe each parameter (res1d, quantity, element, out_png) beyond these cues.

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 clearly states it renders a single-panel time-series plot, specifying 'house style' and 'no license needed'. It distinguishes from sibling tools like mike_plot_network and mike_plot_rain_flow by focusing on time-series.

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 description mentions 'no license needed' as a precondition, but lacks explicit guidance on when to use this tool versus alternatives. The name and context imply timeseries plotting, but no direct comparisons or exclusions are provided.

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