Skip to main content
Glama
SmartBear

SmartBear MCP server

Official
by SmartBear

QTM4J: Get Linked Bugs of Test Step Execution

qtm4j_get_linked_bugs_of_test_step_execution
Read-onlyIdempotent

Find Jira bugs linked to a specific test step execution by supplying test cycle, test case, and step sequence. Optionally filter by priority or status.

Instructions

Retrieve Jira bugs linked to a test step execution with optional priority and status filtering. Looks up testStepExecutionId from testCycleKey, testCaseKey, and step sequence number; resolves filter names to numeric IDs.

Toolset: Test Executions

Parameters:

  • testCycleKey (string) required: Test cycle key in the format '{PROJECT_KEY}-TR-{number}', e.g. 'SCRUM-TR-101'. Used directly as the API path parameter.

  • testCaseKey (string) required: Test case key in the format '{PROJECT_KEY}-TC-{number}', e.g. 'SCRUM-TC-145'.

  • testStepSeqNo (number) required: sequence number of the test step within the test case (e.g. 2 = the second step).

  • filter (object): Filter criteria for linked bugs. Omit to return all linked bugs. priority and status names are resolved to numeric IDs; unresolvable names are skipped with a warning.

  • startAt (number): Zero-based index of the first result to return (pagination offset). (default: 0)

  • maxResults (number): Maximum number of bugs to return per page. Range 1–100; defaults to 20. (default: 20)

Output Description: JSON object with startAt, maxResults, total, and data array of linked bug objects. Each bug has: id, key, summary, status, priority, issueType, level, stepSeqNo, parameterGroup.

Use Cases: 1. List all Jira bugs linked to a specific test step execution 2. Filter step-level linked bugs by priority or status

Examples:

  1. Get linked bugs for step 2

{
  "testCycleKey": "PROJ-TR-101",
  "testCaseKey": "PROJ-TC-42",
  "testStepSeqNo": 2
}

Expected Output: Bugs linked to step 2 of the execution

  1. Filter by priority

{
  "testCycleKey": "PROJ-TR-101",
  "testCaseKey": "PROJ-TC-42",
  "testStepSeqNo": 1,
  "filter": {
    "priority": [
      "High"
    ]
  }
}

Expected Output: High-priority bugs linked to step 1

  1. Filter by status

{
  "testCycleKey": "PROJ-TR-101",
  "testCaseKey": "PROJ-TC-42",
  "testStepSeqNo": 1,
  "filter": {
    "status": [
      "In Progress"
    ]
  }
}

Expected Output: In Progress bugs linked to step 1

Hints: 1. Call set_project_context before this tool. 2. An empty result (total = 0) means no bugs are linked — it is not an error. 3. priority and status names are resolved to numeric IDs; unresolved names are skipped with a warning. 4. Use get_linked_bugs_of_test_case_execution to retrieve all bugs on the test case execution across all steps.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
filterNoFilter criteria for linked bugs. Omit to return all linked bugs. priority and status names are resolved to numeric IDs; unresolvable names are skipped with a warning.
startAtNoZero-based index of the first result to return (pagination offset).
maxResultsNoMaximum number of bugs to return per page. Range 1–100; defaults to 20.
testCaseKeyYesTest case key in the format '{PROJECT_KEY}-TC-{number}', e.g. 'SCRUM-TC-145'.
testCycleKeyYesTest cycle key in the format '{PROJECT_KEY}-TR-{number}', e.g. 'SCRUM-TR-101'. Used directly as the API path parameter.
testStepSeqNoYessequence number of the test step within the test case (e.g. 2 = the second step).

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataYesLinked bugs on the current page; empty when total is 0.
totalYesTotal number of linked bugs matching the filter across all pages. 0 means none are linked.
startAtYesZero-based index of the first item in this page.
maxResultsYesPage size applied to this response.
Install Server

TDQS

A4.8/5.0
Behavior5/5

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

Annotations already mark the tool read-only, idempotent, and non-destructive, and the description adds crucial behavioral context: it performs a testStepExecutionId lookup from three keys, resolves priority/status names to numeric IDs, skips unresolvable names with a warning, and clarifies that an empty result is not an error. No contradiction with 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 into Parameters, Output Description, Use Cases, Examples, and Hints, with the core action front-loaded. Some parameter details duplicate the schema, but each section serves a clear purpose and the redundancy is acceptable for a complex tool.

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 6-parameter tool with an output schema, the description covers the output shape, pagination, filtering semantics, prerequisites, and alternative tool routing. Nothing an agent needs to call this tool correctly is 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?

Schema description coverage is 100%, so the baseline is 3. The description adds value beyond the schema by explaining the compound relationship among testCycleKey/testCaseKey/testStepSeqNo, the auto-resolution of filter names, and by providing concrete JSON examples that illustrate parameter usage. This extra context lifts it to a 4.

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 states a precise action: 'Retrieve Jira bugs linked to a test step execution with optional priority and status filtering.' It also explains how the target execution is resolved (from testCycleKey, testCaseKey, and step sequence number), and Hint 4 distinguishes it from the sibling qtm4j_get_linked_bugs_of_test_case_execution. No ambiguity about what this tool does.

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?

A 'Use Cases' section spells out when to use the tool, and Hint 1 says to call set_project_context first. Hint 4 explicitly names the alternative for retrieving bugs across all steps, defining when not to use this tool. The behavior when omitting the filter is also stated.

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