diff_diff_similar

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

No annotations are provided, so the description must carry the burden. It discloses return format (sorted list of {text, score}) but omits algorithmic details, performance characteristics, or edge-case behaviors. Basic transparency is present.

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 two sentences with no redundant information. It front-loads the core purpose, then adds output format and use cases. Every sentence earns its place.

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 4 parameters (2 required) and no annotations. The description explains output format but leaves 'top_n' and 'threshold' unexplained, and does not specify the expected element type for 'candidates'. Incomplete for a fuzzy matching function.

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 0%, but the description only implicitly covers 'query' and 'candidates' via context. Parameters 'top_n' and 'threshold' are not explained, leaving their semantics unclear. The description adds minimal value beyond schema.

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 finds most similar strings to a query from candidates and returns sorted results. However, it does not explicitly differentiate from sibling diff tools (e.g., diff_diff_text, diff_diff_files), though the focus on similarity is distinct.

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 mentions usefulness for fuzzy matching and near-duplicate detection, which provides some context. However, it lacks explicit when-to-use or when-not-to-use guidance and does not compare to alternatives.

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