Skip to main content
Glama
SmartBear

SmartBear MCP server

Official
by SmartBear

QTM4J: Get Linked Requirements for Test Cycle

qtm4j_get_linked_requirements_for_test_cycle
Read-onlyIdempotent

Get Jira requirements linked to a QTM4J test cycle to audit traceability, check coverage, or verify linked items. Resolves cycle key automatically and returns paginated results.

Instructions

Retrieve Jira requirements linked to a QTM4J test cycle. Test cycle key is resolved to internal UID 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.

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

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

  • sort (string): Sort pattern in 'field:asc|desc' format. Allowed fields: key, status, priority. Default: 'key:desc'.

Output Description: Paginated result 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 are covered by a test cycle 2. Audit requirement traceability for a test cycle 3. Retrieve requirement keys linked to a cycle before a release 4. Verify correct requirements are linked to a test cycle

Examples:

  1. Get all requirements linked to a test cycle

{
  "cycleKey": "SCRUM-TR-1"
}

Expected Output: Paginated list of linked requirements with Jira metadata

  1. Get requirements sorted by priority with custom page size

{
  "cycleKey": "SCRUM-TR-5",
  "sort": "priority:asc",
  "maxResults": 20
}

Expected Output: Requirements linked to cycle sorted by priority ascending

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. Allowed sort fields: key, status, priority. Default sort: 'key:desc'. 4. Paginate using startAt — increment by maxResults until startAt >= total.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sortNoSort pattern in 'field:asc|desc' format. Allowed fields: key, status, priority. Default: 'key:desc'.
startAtNoZero-indexed offset for pagination. Default: 0.
cycleKeyYesTest cycle key in '{PROJECT_KEY}-TR-{id}' format (e.g., 'SCRUM-TR-1'). Resolved to the internal cycle UID automatically.
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 mark this as read-only, idempotent, and non-destructive. The description adds valuable behavior beyond that: cycleKey is automatically resolved to an internal UID, pagination should use startAt incremented by maxResults until startAt >= total, and project context is required. None of this contradicts the annotations.

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 long but well-structured with clear sections for parameters, output, use cases, examples, and hints. The opening sentence is front-loaded and immediately informative. Some content duplicates the input schema and hints repeat parameter details, so it is not perfectly concise, but the operational guidance and examples justify the length.

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?

The description covers purpose, prerequisites, parameter semantics, pagination behavior, output shape, and realistic use cases. It also provides multiple examples. With an output schema already present, the description does not need to explain return values in depth. Nothing an agent needs to call this tool correctly appears to be missing.

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?

The input schema already documents all four parameters, including defaults and ranges, so baseline is 3. The description adds value with examples showing exact payloads, the auto-resolution of cycleKey, and clarification of how startAt and maxResults drive pagination. It does not meaningfully explain parameters not already in the schema, but the examples and hints push it above baseline.

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 and resource: 'Retrieve Jira requirements linked to a QTM4J test cycle.' This clearly states the direction of the relationship and distinguishes it from siblings like qtm4j_get_linked_test_cases_for_requirement or qtm4j_get_linked_requirements. The 'Toolset: Test Cycles' label reinforces the scope.

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 concrete use cases such as checking requirement coverage, auditing traceability, and retrieving keys before release. It also states an explicit prerequisite: set_project_context must be called first and a project must never be auto-selected. It lacks explicit 'when not to use this tool' routing to alternatives, so it stops short of a 5.

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