compare_issue_lists

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

Annotations already declare readOnlyHint, openWorldHint, idempotentHint, and non-destructive behavior. The description adds valuable behavioral context by specifying the exact three-way diff outcome (matched, missing-from-list, no-longer-matching) and explaining each category. It does not mention auth or rate limits, but those are less critical given the read-only annotations.

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 with the core diff operation, followed by the result categories and then concise parameter explanations. Every sentence earns its place, and the structure is easy for an agent to parse quickly.

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?

For a read-only tool with three parameters and an output schema available, the description is complete: it explains what the tool does, what inputs it needs, what outputs to expect, and when it is useful. Nothing required for correct invocation is missing.

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%, so the description fully carries the parameter-documentation burden. It does so well: known_ids is explained as comma-separated issue IDs with an example, query is explained as a YouTrack query with an example, and instance is marked optional.

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 a specific verb, 'Diff', and clearly names the two inputs: a known issue list and a YouTrack query. It further enumerates the three result categories, which makes the tool's purpose unmistakable and distinguishes it from retrieval-focused siblings like search_issues or count_issues.

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 'Useful for finding tasks you're not tracking, or items in your list that are stale' sentence provides clear context for when to choose this tool. It does not explicitly name sibling alternatives or state when not to use it, so it stops short of a 5.

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