diff_flows

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

With no annotations, the description carries the full burden and discloses rich behavior: unchanged parameters are omitted from output, JSON bodies are flattened to a.b.c keys and compared per key, and non-JSON bodies are returned verbatim. The only gap is that the effect of body_max is never disclosed.

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 dense paragraphs, each earning its place: purpose, usage workflow, and body-handling semantics. The core purpose is front-loaded and the explanatory detail about output omission and flattening is tightly written with no filler.

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?

An output schema exists, so return values need no explanation. The description covers purpose, workflow, output semantics, and JSON/non-JSON handling comprehensively. The remaining gaps are the unexplained body_max parameter and whether headers are compared alongside bodies.

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?

With 0% schema description coverage, the description must compensate. It contextualizes the two required flow_id parameters well ('call the same endpoint twice'), but never explicitly maps them to the schema fields and leaves body_max entirely unexplained despite it having a default value.

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 opening line 'Compare two requests field by field — the tool for reverse-engineering signatures' states a specific verb, resource, and a distinctive purpose that separates it from siblings like inspect_flow (single flow) and replay_flow (execution). An agent can tell exactly what this tool is for without opening the schema.

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?

Gives clear when-to-use context: 'call the same endpoint twice (or capture it before and after paging), then diff.' It explains what the output means and how to interpret the varying fields for signature reverse-engineering. However, it does not explicitly name sibling alternatives or state when not to use it.

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