flowzap_diff

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It mentions the tool returns a 'structured diff' but doesn't specify the format, size limits, error conditions, or performance characteristics. For a comparison tool with no annotation coverage, this lacks critical details about how it behaves beyond the basic purpose.

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 front-loaded and efficiently structured in two sentences: the first states the core functionality, and the second provides usage context. Every sentence earns its place with no wasted words, making it highly concise and easy to parse.

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 the tool's moderate complexity (comparing code versions) and lack of annotations or output schema, the description is adequate but incomplete. It covers the purpose and usage context but misses behavioral details like output format or error handling. For a diff tool without structured output documentation, this leaves gaps in understanding what to expect.

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 description coverage is 100%, with both parameters clearly documented in the schema. The description adds no additional meaning beyond what the schema provides (e.g., it doesn't explain what constitutes valid FlowZap Code or how versions should be formatted). Baseline 3 is appropriate since the schema does the heavy lifting.

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 tool's purpose with specific verbs ('compare', 'get a structured diff') and resources ('two versions of FlowZap Code'), distinguishing it from siblings like flowzap_validate or flowzap_export_graph. It explicitly mentions what the diff shows ('nodes/edges added, removed, updated'), making the purpose highly specific and actionable.

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 clear context for when to use this tool ('to explain changes to users'), which implies it's for analyzing differences between code versions. However, it doesn't explicitly state when not to use it or name alternatives among siblings (e.g., flowzap_validate for checking code correctness instead of comparing changes), leaving some guidance gaps.

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