QMetry: Link Platforms to Test Suite

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

Annotations already signal that this is a mutation (readOnlyHint=false) and is not idempotent, and the description confirms the side effect is linking platforms to a test suite. It adds an output description ('JSON object with linkage status, success message, and details') and expected outputs in examples, but it does not address failures, authorization, or whether multiple links are atomic. With annotations carrying the basic safety profile, this is adequate but not rich.

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 information is valuable but heavily redundant: qmTsId/qmPlatformId retrieval and 'CRITICAL' naming warnings appear in Parameters, Examples, and Hints, and the hint list restates requiredness and comma rules. It is front-loaded but not concise, and many sentences do not earn their 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?

The description is unusually complete for a mutation tool: it has use cases, two worked examples with expected outputs, parameter formatting rules, and ID-retrieval steps. It does not clarify when projectKey should be overridden or what happens on partial failure or repeated linking, leaving a small practical gap.

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?

Beyond a 100%-covered schema, the description gives concrete example payloads, warns against wrong parameter names ('do NOT use tsId...'), explains comma-separated formatting with no spaces, and tells exactly how to obtain qmTsId and qmPlatformId from API responses. It also covers the projectKey default and resolution of test suite entity keys.

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?

Opens with a specific verb and object: 'Link one or more platforms to a QMetry Test Suite,' which clearly identifies the action and target resource. This is a distinct operation from sibling tools like qmetry_link_test_cases_to_test_suite or qmetry_link_requirements_to_testcase.

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?

Use Cases enumerate concrete scenarios such as linking single/multiple platforms, defining execution environments, and organizing suites by platform. Hints also name prerequisite APIs ('Testsuite/Fetch Testsuite', 'Platform/List') for resolving IDs, but the description does not explicitly contrast this tool with alternative link tools or state when not to use it.

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