correlate_flow

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

With no annotations provided, the description carries the full burden of disclosing behavior. It explains the core operation (detect and rewrite), the accepted input forms (flow object or flow_path), and the outputs (correlation report, rewritten flow, new flow_path). However, it does not disclose whether the original flow is mutated in place, whether persistence overwrites existing flow paths, or any environment prerequisites beyond 'after import_traffic.' These gaps justify a mid-range score.

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?

The description is three sentences with no fluff. The first sentence is a precise one-liner stating the purpose, the second gives a usage directive, and the third lists the return values. Every sentence contributes meaning, making it highly concise and well-structured.

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?

The tool has moderate complexity with an output schema, so return values are covered elsewhere. The description covers the core parameter and usage timing, but it omits the second parameter's purpose and side-effect details. Given that annotations are absent and the description is the only source of behavioral context, it is not fully complete, though it covers the essentials. This warrants a 3.

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?

The schema has 2 parameters with 0% description coverage. The description compensates partially by explaining the `flow` parameter, noting it accepts either an object or a persisted flow_path. It does not explain `confidence_floor`, leaving that parameter semantically opaque. Because the most important parameter is clarified but the second is ignored, a score of 3 reflects the partial compensation.

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 the specific function: 'Detect dynamic values and rewrite the flow with JMeter variables.' It names the resource (flow) and the specific action, distinguishing it from sibling tools like analyze_results and run_test. The mention of 'Use after import_traffic' further situates its unique role in the workflow.

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 provides an explicit usage cue: 'Use after import_traffic.' This gives clear contextual guidance on when this tool should be invoked. It does not mention when not to use it or alternative tools, so it stops short of a full 5, but the clear sequencing earns a 4.

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