Skip to main content
Glama
SmartBear

SmartBear MCP server

Official
by SmartBear

QTM4J: Unlink Requirements from Test Case

qtm4j_unlink_requirements_from_test_case

Unlink specific or all Jira requirements from a test case in QTM4J by providing requirement keys or setting a flag to remove all links.

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
Behavior5/5

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

Discloses mutation, return confirmation with warnings for failures, version default behavior, and interaction between unLinkAll and requirementKeys. Adds significant value beyond annotations that only indicate non-readOnly, non-destructive but not detailed behavior.

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?

Well-structured with sections (Parameters, Output, Use Cases, Examples, Hints). Content is dense and front-loaded, but length is justified by completeness. Slightly verbose but not wasteful.

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?

Covers all aspects: input parameters, output description, use cases, examples, prerequisites, key formats, error handling, and version defaults. Output schema exists, but description adds more context.

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 has 100% coverage with descriptions. Description adds context with format examples, default values, and examples of usage, enhancing understanding beyond schema alone.

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?

Clearly states the tool unlinks requirements from test cases in QTM4J, specifying two modes (by keys or all at once). Distinguishes from siblings like link and unlink for cycles and test cases.

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?

Provides explicit use cases, prerequisites (set_project_context), key format hints, and when to use unLinkAll. Lacks direct exclusion of alternatives but gives sufficient context for proper use.

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