correlate

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

Discloses default time range and parameter behaviors (lag_days, scan_lags). However, it does not explain how start/end parameters interact with the default, nor the effect of missing data or the exact output format.

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?

Two concise sentences: first gives purpose and default, second explains key parameters. No wasted words, front-loaded with essential info.

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 core parameters but omits start/end, no output description, and no guidance on correlation method selection. With 6 parameters and no output schema, more detail is needed for full completeness.

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?

Adds meaning for metric_a, metric_b, lag_days, and scan_lags (e.g., lag explanation, scan range). But start and end parameters are not described, and schema coverage is 0%, so description must do more.

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 computes Pearson/Spearman correlation between two metrics with a default 30-day window. It distinguishes from sibling tools like 'anomalies' or 'baselines' by focusing on correlation analysis.

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?

No guidance on when to use this tool versus siblings. Does not provide context on when correlation is appropriate or what prerequisites exist.

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