Skip to main content
Glama
SmartBear

SmartBear MCP server

Official
by SmartBear

QMetry: Link Requirements to Testcase

qmetry_link_requirements_to_testcase

Link one or more requirements to a test case by entityKey and version IDs to establish traceability and automate coverage mapping.

Instructions

Link one or more requirements to a test case by entityKey and version IDs.

Toolset: Requirements

Parameters:

  • tcID (string) required: EntityKey of Testcase (e.g. 'COD-TC-29')

  • tcVersionId (number) required: Test Case version number. This is the internal numeric identifier for the version.

  • rqVersionIds (string) required: Comma-separated values of versionId of the Requirement (e.g. '236124,236125')

Output Description: JSON object with success status and linkage details.

Use Cases: 1. Link requirements to a test case for traceability 2. Bulk link multiple requirements to a single test case 3. Automate requirement coverage mapping

Examples:

  1. Link requirements to test case VT-TC-26

{
  "tcID": "VT-TC-26",
  "tcVersionId": 5448515,
  "rqVersionIds": "5009939,5009937,4970699"
}

Expected Output: Requirements linked to test case VT-TC-26 successfully.

Hints: 1. To get the tcID, call the Testcase/Fetch List for Bulk Operation API and use data[].entityKey. 2. To get the tcVersionId, call the Testcase/Fetch Versions API and use data[].tcVersionID. 3. To get the rqVersionIds, call the requirement/List Versions API and use data[].rqVersionID. 4. If user provides requirement entityKey (e.g., VT-RQ-18), first call requirements list with a filter on entityKeyId to resolve the rqVersionIds 5. If user provides testcase entityKey (e.g., VT-TC-26), first call testcase list with a filter on entityKeyId to resolve the tcVersionId and tcID. 6. rqVersionIds must be a comma-separated string of requirement version IDs.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
tcIDYesEntityKey of Testcase (e.g. 'COD-TC-29')
tcVersionIdYesTest Case version number. This is the internal numeric identifier for the version.
rqVersionIdsYesComma-separated values of versionId of the Requirement (e.g. '236124,236125')
Behavior3/5

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

Annotations indicate non-read-only, non-destructive, non-idempotent. The description confirms a mutation operation ('Link') and describes output as 'JSON object with success status and linkage details.' It does not disclose side effects (e.g., whether links are additive or replace existing), permissions, rate limits, or error conditions. This adds modest value beyond annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with sections (Toolset, Parameters, Output, Use Cases, Examples, Hints). It is front-loaded with the core purpose. While somewhat lengthy, each section adds essential information for correct usage, justifying its length. Minor redundancy with schema descriptions could be trimmed.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (linking with version IDs), the description covers almost all needed context: parameter values, examples, and hints for resolving IDs from other API calls. No output schema exists, but output is described. Missing: error handling and idempotency details, but overall adequate for a linking operation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, providing baseline 3. The description adds extra semantics: clarifies that tcVersionId is an 'internal numeric identifier', that rqVersionIds is a 'comma-separated string', and provides examples. The 'Hints' section explains how to obtain these parameters from other APIs, which is valuable context beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose: 'Link one or more requirements to a test case by entityKey and version IDs.' It uses a specific verb ('Link') and resources ('requirements to test case'). The tool is clearly distinguished from sibling QMetry fetch tools and from similar QTM4J tools by name and context.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides use cases but no explicit guidance on when to use this tool versus alternatives (e.g., to create links rather than fetch existing ones). It lacks 'when to use' and 'when not to use' statements, and does not reference sibling tools like qmetry_fetch_requirements_linked_to_test_case for comparison.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/SmartBear/smartbear-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server