Skip to main content
Glama
SmartBear

SmartBear MCP server

Official
by SmartBear

QTM4J: Unlink Requirements from Test Case

qtm4j_unlink_requirements_from_test_case

Remove Jira requirement links from a QTM4J test case by using requirement keys or unlink all associations at once. Clean up stale or incorrect requirement traces efficiently.

Instructions

Unlink one or more Jira requirements from a test case in QTM4J by requirement keys, or unlink all requirements at once with unLinkAll.

Toolset: Test Cases

Parameters:

  • key (string) required: Test case key in '{PROJECT_KEY}-TC-{number}' format (e.g., 'SCRUM-TC-145'). Required.

  • versionNo (number): Test case version number. Defaults to the latest version.

  • requirementKeys (array): List of requirement keys to unlink (e.g., ['SCRUM-1', 'SCRUM-2']). Ignored when unLinkAll is true.

  • unLinkAll (boolean): If true, all linked requirements are unlinked from this test case. Ignores requirementKeys when set.

Output Description: Confirmation with the test case key, version number, and unlinked: true. Warnings are included if any requirements could not be resolved or unlinked.

Use Cases: 1. Remove specific requirements from a test case 2. Unlink all requirements from a test case at once 3. Clean up stale or incorrect requirement links from a test case 4. Remove requirement associations from a specific test case version

Examples:

  1. Unlink specific requirements by key

{
  "key": "SCRUM-TC-145",
  "requirementKeys": [
    "SCRUM-1",
    "SCRUM-2"
  ]
}

Expected Output: Requirements SCRUM-1 and SCRUM-2 unlinked from test case

  1. Unlink all requirements from a test case

{
  "key": "SCRUM-TC-145",
  "unLinkAll": true
}

Expected Output: All requirements unlinked from test case

  1. Unlink a requirement from a specific version

{
  "key": "SCRUM-TC-85",
  "versionNo": 2,
  "requirementKeys": [
    "SCRUM-10"
  ]
}

Expected Output: Requirement unlinked from version 2 of test case

Hints: 1. PREREQUISITE: set_project_context must be called before this tool. NEVER auto-select a project. 2. KEY FORMAT: '{PROJECT_KEY}-TC-{number}' — e.g. 'SCRUM-TC-145'. 3. Requirement keys follow the Jira issue key format: '{PROJECT_KEY}-{number}' (e.g. 'SCRUM-1'). 4. Set unLinkAll to true to remove all requirements in one call — no need to list them individually. 5. If a requirement key cannot be resolved or unlinked, it is reported in warnings and others are still unlinked. 6. versionNo defaults to the latest version. Use search_test_cases to find available versions if needed.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
keyYesTest case key in '{PROJECT_KEY}-TC-{number}' format (e.g., 'SCRUM-TC-145'). Required.
unLinkAllNoIf true, all linked requirements are unlinked from this test case. Ignores requirementKeys when set.
versionNoNoTest case version number. Defaults to the latest version.
requirementKeysNoList of requirement keys to unlink (e.g., ['SCRUM-1', 'SCRUM-2']). Ignored when unLinkAll is true.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
keyYes
unlinkedYes
versionNoYes
Install Server

TDQS

A4.7/5.0
Behavior5/5

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

The description goes well beyond annotations by disclosing partial-failure behavior: 'If a requirement key cannot be resolved or unlinked, it is reported in warnings and others are still unlinked.' It also states version defaulting, output confirmation shape, and interaction between unLinkAll and requirementKeys. Annotations only provide generic booleans, so the description carries the burden and fully meets it.

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

Conciseness5/5

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

The description is long but well-structured with clear sections: Toolset, Parameters, Output Description, Use Cases, Examples, and Hints. The action is front-loaded in the first sentence, and every section contributes operational detail. The length is justified for a tool with multiple modes and a prerequisite.

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

Completeness5/5

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

For a mutation tool with 4 parameters and a prerequisite, the description is exceptionally complete. It covers project context setup, key format requirements, default version behavior, partial success handling, output feedback, and a pointer to search_test_cases for finding versions. The presence of an output schema further reduces the need to explain return values.

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%, so the baseline is 3. The description adds value with concrete examples for each parameter combination, clarifies precedence ('unLinkAll ignores requirementKeys when set'), and explains key formats in the Hints section. This goes beyond the schema without being redundant, justifying a 4.

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 opens with a specific verb-object pair: 'Unlink one or more Jira requirements from a test case in QTM4J by requirement keys, or unlink all requirements at once with unLinkAll.' This clearly distinguishes the tool from siblings like qtm4j_link_requirements_to_test_case and qtm4j_unlink_requirements_from_test_cycle by specifying the resource ('test case') and the operation ('unlink requirements').

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

Usage Guidelines4/5

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

The description provides explicit use cases (remove specific requirements, unlink all, clean up stale links, remove from a specific version) and a prerequisite hint ('set_project_context must be called before this tool. NEVER auto-select a project.'). It does not explicitly name the inverse sibling tool for linking requirements, so it lacks a clear exclusion, but the context is strong.

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

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