Bulk Link Automated Tests

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

Goes well beyond the readOnlyHint=false/destructiveHint=false annotations by disclosing the write-permission and plan-feature prerequisites, the per-item result shape, and the critical partial-failure semantics ('one bad row never fails the batch'). The instruction to always check each item's success is exactly the kind of non-obvious behavior an agent needs.

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?

Front-loads purpose and scope, then prerequisites, then return/failure behavior, then the id gotcha. Dense and information-rich with no filler sentences; every clause 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?

With no output schema, the description carries the return contract (per-item success/error/link) and the failure model, plus permission and plan prerequisites and correct id sourcing. Nothing essential for a correct bulk mutation call 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 coverage is 100%, so the baseline is 3, but the description adds real value: it clarifies manualTestCaseId is the internal _id (tcm_tc_…), not the TC-123 key, and specifies the provenance of pwTestId/fullTitle. These are semantic details that prevent mis-population of the links array.

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?

States a specific verb (Link), the resource (manual case ↔ automated test pairs), and the scope (up to 500 in one call). It is immediately distinguishable from the singular sibling link_automated_test through the bulk framing and the 500-row cap.

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?

Gives clear operational context: requires write permission and the automation_linking plan feature, and directs the agent to source pwTestId + fullTitle from list_automated_tests. It does not explicitly state when to prefer this over the single-item link_automated_test sibling, but the 'up to 500 ... in one call' framing makes the choice inferable.

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