Skip to main content
Glama
SmartBear

SmartBear MCP server

Official
by SmartBear

QTM4J: Get Linked Requirements

qtm4j_get_linked_requirements
Read-onlyIdempotent

Retrieve Jira requirements linked to any QTM4J test case by providing its key. Returns a paginated list with status, priority, and issue type.

Instructions

Retrieve the Jira requirements linked to a specific test case in QTM4J. Test case key is resolved to internal ID automatically.

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 to retrieve linked requirements for. Defaults to the latest version.

  • maxResults (number): Maximum results per page (1-100). Default: 50.

  • startAt (number): Zero-indexed offset for pagination. Default: 0.

  • sort (string): Sort pattern in 'field:asc|desc' format. Default: 'key:desc'.

Output Description: Paginated list with total, startAt, maxResults, and data array of linked requirement objects (id, key, summary, status, priority, issueType).

Use Cases: 1. Check which Jira stories or bugs a test case covers 2. Audit requirement traceability for a test case 3. Retrieve requirement keys to use in other operations 4. Verify that the correct requirements are linked to a test case before a release

Examples:

  1. Get all requirements linked to a test case

{
  "key": "SCRUM-TC-145"
}

Expected Output: Paginated list of linked requirements with Jira metadata

  1. Get requirements for a specific version

{
  "key": "SCRUM-TC-85",
  "versionNo": 2,
  "maxResults": 20
}

Expected Output: Requirements linked to version 2 of the 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. versionNo defaults to the latest version. Use search_test_cases to find available versions. 4. Paginate using startAt — increment by maxResults until startAt >= total.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
keyYesTest case key in '{PROJECT_KEY}-TC-{number}' format (e.g., 'SCRUM-TC-145'). Required.
sortNoSort pattern in 'field:asc|desc' format. Default: 'key:desc'.
startAtNoZero-indexed offset for pagination. Default: 0.
versionNoNoTest case version number to retrieve linked requirements for. Defaults to the latest version.
maxResultsNoMaximum results per page (1-100). Default: 50.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataYesLinked requirements on this page.
totalYesTotal linked requirements (across all pages).
startAtYes
maxResultsYes
Install Server

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already establish read-only, idempotent, non-destructive behavior. The description adds valuable behavioral context beyond those annotations: test case keys are auto-resolved to internal IDs, versionNo defaults to latest, pagination follows a startAt/maxResults pattern, and a project context must be set beforehand. No hidden mutation or side effects are suggested.

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 longer than average but well-organized with clear sections: parameters, output, use cases, examples, and hints. Some redundancy exists, such as key format being repeated in the intro, parameter list, and hints, but the structure makes the information easy for an agent to consume and the key details are front-loaded.

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 read-only retrieval tool with five parameters and an output schema, the description is complete: it covers prerequisites, key formatting, pagination, version selection, examples, and output shape. An agent has everything needed to select and invoke the tool correctly, including how to handle multi-page results.

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 parameter section largely duplicates the schema. However, the description adds operational semantics through examples and hints: how versionNo interacts with search_test_cases, how to paginate by incrementing startAt by maxResults until startAt >= total, and concrete request/expected-output pairs that illustrate parameter usage.

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 opening sentence names a specific verb ('Retrieve'), a specific resource ('Jira requirements linked to a specific test case in QTM4J'), and notes automatic key-to-ID resolution. This clearly differentiates the direction from sibling tools like qtm4j_get_linked_test_cases_for_requirement, which operates in the reverse direction.

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 'Use Cases' section gives concrete application contexts: checking requirement coverage, auditing traceability, retrieving keys for downstream operations, and release verification. It also documents the set_project_context prerequisite with a strong 'NEVER auto-select a project' warning, though it does not explicitly name alternatives or state when not to use this tool.

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