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 (stories, bugs) linked to a QTM4J test case to verify traceability and coverage.

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

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

Annotations already indicate readOnlyHint, idempotentHint, destructiveHint=false. Description adds context: automatic ID resolution, pagination behavior, default version. No contradictions. Adds value beyond annotations but doesn't cover rate limits or auth beyond prerequisite.

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 for parameters, output, use cases, examples, hints. Front-loaded with purpose. Some redundancy with schema descriptions but each section serves a purpose. Could be slightly more concise but overall efficient.

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?

Given full schema coverage, output schema described, use cases, examples, and hints covering prerequisites and pagination, the description is thorough and enables correct tool invocation. No missing critical information.

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

Parameters3/5

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

Schema coverage is 100% with parameter descriptions. Description repeats these descriptions verbatim, adding little new semantic meaning. Examples and hints provide some extra context (e.g., versionNo defaults to latest), but overall limited additive value.

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 'Retrieve the Jira requirements linked to a specific test case in QTM4J.' It uses a specific verb (retrieve) and resource (linked requirements), clearly differentiating it from sibling tools like qtm4j_link_requirements_to_test_case (mutate) or qtm4j_get_linked_requirements_for_test_cycle (different entity).

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 (4 scenarios), prerequisites (set_project_context must be called first), and hints about key format and pagination. However, lacks explicit when-not-to-use or direct comparisons to alternatives, so a 4 is appropriate.

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