Skip to main content
Glama
SmartBear

SmartBear MCP server

Official
by SmartBear

QTM4J: Link Requirements to Test Cycle

qtm4j_link_requirements_to_test_cycle

Link Jira requirements to a QTM4J test cycle using requirement keys or a JQL filter to build traceability.

Instructions

Link one or more Jira requirements to a QTM4J test cycle by requirement keys or JQL filter. Requirement keys are resolved to internal IDs automatically.

Toolset: Test Cycles

Parameters:

  • cycleKey (string) required: Test cycle key in '{PROJECT_KEY}-TR-{id}' format (e.g., 'SCRUM-TR-1'). Resolved to the internal cycle UID automatically.

  • requirementKeys (array): List of Jira requirement keys to link (e.g., ['SCRUM-1', 'SCRUM-2']). Resolved to internal IDs automatically. Provide this OR filter.jql — not both.

  • filter (object): JQL filter to select requirements to link. Use instead of requirementKeys when filtering by JQL.

Output Description: Confirmation with the cycle key and linked: true. Warnings are included if any requirements could not be resolved or linked.

Use Cases: 1. Link one or more Jira requirements (stories, bugs, epics) to a test cycle 2. Associate requirements with a test cycle using a JQL filter 3. Build traceability between requirements and a test cycle 4. Link all stories from a sprint to a test cycle using JQL

Examples:

  1. Link two requirements by key

{
  "cycleKey": "SCRUM-TR-1",
  "requirementKeys": [
    "SCRUM-1",
    "SCRUM-2"
  ]
}

Expected Output: Requirements SCRUM-1 and SCRUM-2 linked to test cycle

  1. Link requirements by JQL filter

{
  "cycleKey": "SCRUM-TR-1",
  "filter": {
    "jql": "project = DEMO AND issuetype = Story"
  }
}

Expected Output: Requirements matched by JQL linked to test cycle

Hints: 1. PREREQUISITE: set_project_context must be called before this tool. NEVER auto-select a project. 2. CYCLE KEY FORMAT: '{PROJECT_KEY}-TR-{id}' — e.g. 'SCRUM-TR-1'. Resolved to internal UID automatically. 3. Requirement keys follow Jira issue key format: '{PROJECT_KEY}-{number}' (e.g. 'SCRUM-1'). 4. Provide either requirementKeys or filter.jql — not both. 5. If a requirement key cannot be resolved or linked, it is reported in warnings and other requirements are still linked.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
filterNoJQL filter to select requirements to link. Use instead of requirementKeys when filtering by JQL.
cycleKeyYesTest cycle key in '{PROJECT_KEY}-TR-{id}' format (e.g., 'SCRUM-TR-1'). Resolved to the internal cycle UID automatically.
requirementKeysNoList of Jira requirement keys to link (e.g., ['SCRUM-1', 'SCRUM-2']). Resolved to internal IDs automatically. Provide this OR filter.jql — not both.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
linkedYes
cycleKeyYes
Behavior4/5

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

Annotations are minimal (readOnlyHint=false, destructiveHint=false, idempotentHint=false). The description adds behavioral context beyond annotations: automatic resolution of keys to internal IDs, partial linking with warnings, and output confirmation. It does not contradict annotations.

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 well-structured with sections (intro, parameters, output, use cases, examples, hints). It is comprehensive but concise, with each section providing necessary information without redundancy. Front-loaded with the core purpose.

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?

Despite complexity (3 params, nested objects, output schema exists), the description covers all necessary information: both usage methods, prerequisites, format details, error handling, and expected output. Output schema exists, so return values are already documented.

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 baseline is 3. The description adds value by explaining automatic resolution for cycleKey and requirementKeys, and mutual exclusivity between requirementKeys and filter. Examples illustrate usage, enhancing understanding 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 action (link), the resource (requirements to test cycle), and the methods (by requirement keys or JQL filter). It distinguishes from siblings like qtm4j_link_requirements_to_test_case and qtm4j_link_test_cases_to_test_cycle, which target different pairs.

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

Usage Guidelines5/5

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

The description provides explicit usage guidelines: prerequisites (set_project_context), mutual exclusivity of requirementKeys and filter.jql, handling of unresolved keys (warnings), and multiple use cases listed. This helps the agent decide when to use this tool and how.

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