generate_correlation_insight

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

Discloses synchronous execution, Markdown return, and credit consumption. With no annotations, these details add valuable transparency beyond purpose. Could mention error handling or rate limits to reach 5.

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?

Four sentences, each serving a distinct purpose (what, when, how, prerequisite). No fluff, front-loaded with the most critical information.

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 purpose, behavior, and key prerequisite. With no output schema, the 'returns Markdown' is helpful but lacks detail on response structure. Adequate for a synchronous tool with good schema coverage.

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 100%, so baseline is 3. Description adds no new parameter semantics beyond a usage hint for filters. The schema already fully documents parameters.

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 the tool generates a cross-source correlation insight, uses specific verb 'generate', and distinguishes from siblings like 'generate_architecture_insight' by focusing on cross-source links.

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 explicit usage context ('Use when the user wants to understand how activity connects across tools') and a prerequisite ('Call list_filter_options before using filters'). Lacks explicit alternatives or when-not-to-use.

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