compare

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

With no annotations provided, the description carries full burden for behavioral disclosure but fails to indicate if the operation is read-only, what format results are returned in, or the significance of omitting the compareWithUuid parameter (which triggers a 'find similar' mode rather than a direct comparison).

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 single-sentence description is not verbose, but for a tool with four parameters and dual operating modes, it is undersized. It front-loads the verb and resource, yet the extreme brevity constitutes under-specification rather than efficient conciseness given the tool's complexity.

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 lack of annotations and output schema, the description should disclose safety properties (read-only status), return value structure, and behavioral nuances. It omits all of these, leaving significant gaps in contextual information needed for proper tool invocation.

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 all four parameters (recordUuid, compareWithUuid, databaseName, comparison) fully documented in the schema including enum explanations. The description adds no supplementary parameter guidance, meeting the baseline expectation when the schema is self-sufficient.

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 states the basic action (compare records for similarities) and resource (DEVONthink records), but remains vague about the comparison scope. It fails to distinguish from sibling tools like 'search' or 'classify' that also find similar items, and omits the tool's dual behavior (comparing two specific records vs. finding records similar to one).

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?

No guidance provided on when to use this tool versus alternatives like 'search' or 'ask_ai_about_documents'. The description lacks prerequisites (e.g., needing record UUIDs) and excludes context about when to use 'data comparison' versus 'tags comparison' modes.

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