compare_issue_lists

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

No annotations are provided, so the description carries the full burden. It accurately describes the return format (matched, missing-from-list, no-longer-matching) and implies no side effects. However, it does not explicitly state that the tool is read-only or disclose any behavioral traits such as permissions, rate limits, or data stability. The description is adequate but not comprehensive.

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 concise and well-structured, using a bullet-like list for return categories and clear labeling for arguments. Every sentence adds value without redundancy. It fits within a few lines and is 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 has 3 parameters (2 required, 1 optional) and an output schema, the description covers purpose, usage, and parameter semantics adequately. It does not explain the output schema in detail, but that is handled separately. The description could mention that the tool is read-only or clarify instance handling, but overall it is sufficiently complete for an agent to decide when to invoke it.

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?

The input schema has 0% description coverage, so the description must compensate. It explains each parameter: known_ids is 'Comma-separated issue IDs you already know' with an example, query is a 'YouTrack query to compare against' with an example, and instance is optional. This adds meaningful context beyond the parameter names and types.

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 diffs a known issue list against a YouTrack query, with specific verbs ('diff', 'returns') and resources ('known issue list', 'YouTrack query'). It distinguishes from siblings by detailing the three result categories (matched, missing-from-list, no-longer-matching), which is not found in any sibling tool description.

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 usage context: 'Useful for finding tasks you're not tracking, or items in your list that are stale.' It implies when to use the tool but does not explicitly state when not to use it or compare it to alternatives like 'audit_issue_list'. The guidance is helpful but lacks exclusions.

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