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

Retrieve linked Jira requirements for a test cycle to audit traceability and verify coverage before release.

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

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

Annotations already mark as read-only and idempotent. Description adds key behaviors: auto-resolution of cycle key, pagination with startAt/maxResults, sort options, and return structure. No contradictions.

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 (toolset, parameters, output, use cases, examples, hints). Front-loaded with purpose. Some repetition (cycle key format in param and hint) but overall efficient for the detail provided.

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 4 parameters and output schema, description covers all: input format, pagination, sorting, prerequisite, output structure. Use cases and examples provide typical scenarios. No gaps.

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?

100% schema coverage. Description adds examples, allowed sort fields, and format examples for cycleKey. While not radically new, it enriches understanding beyond schema. Baseline 3, plus one for examples.

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 it retrieves Jira requirements linked to a QTM4J test cycle. 'Retrieve...linked requirements' is a specific verb-resource pair. The 'Toolset: Test Cycles' and sibling context (no other tool with same purpose) ensure distinction.

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 prerequisite ('set_project_context must be called before') and warns against auto-selecting project. Includes four specific use cases. Lacks explicit when-not-to-use or alternative tools, but overall guidance is strong.

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