set-test-case-issues

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

Discloses the key behavior 'replaces all existing' which is critical. No annotations, so description carries full burden. Could add more on authorization or validation, but replacement is well covered.

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?

Two sentences, no waste. Front-loaded with action and key behavior. Every sentence adds value.

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?

Covers core purpose and behavior for a simple setter tool. Could mention that it overwrites all existing links, but overall adequate given no output schema and simple params.

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 coverage is 100%, so baseline 3. Description adds no extra parameter meaning beyond schema; the replacement behavior is contextual but not parameter-specific.

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?

Clearly states the verb 'Set', the resource 'issue links for a test case', and the behavior 'replaces all existing'. Distinguishes from siblings like get-test-case-issues by being a mutation that overwrites.

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?

Implies usage via examples ('Jira/YouTrack/etc'), but does not explicitly state when to use or not use this tool. Hints at get-test-case-issues via parameter description but not in main text.

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