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

Retrieve Jira bugs linked to a specific test step execution and filter by priority or status to identify and resolve step-level defects within a test cycle.

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

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

Beyond the annotations (readOnly, idempotent, non-destructive), the description reveals important behaviors: it looks up testStepExecutionId from three keys, resolves filter names to numeric IDs with warnings for unresolvable ones, treats empty results as non-errors, and requires set_project_context. These are valuable operational details not evident from annotations alone.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with clear sections (Purpose, Parameters, Output, Use Cases, Examples, Hints). It is lengthy but every section adds value; the core purpose is front-loaded in the first sentence, making it easy to scan.

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 is exceptionally complete for a tool with 6 parameters and nested objects. It includes output structure, examples, prerequisites, edge cases (empty results), and alternative tool guidance. The presence of an output schema reduces the need to explain return values, but the description still covers it thoroughly.

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 baseline is 3. The description adds examples, a clear explanation of the filter resolution behavior, pagination defaults, and an output description, enhancing understanding beyond the schema. The parameter list in the description mostly mirrors the schema but adds contextual details like 'Used directly as the API path parameter'.

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 the tool's purpose: retrieving Jira bugs linked to a specific test step execution, with optional filtering. It also explicitly differentiates from the sibling tool get_linked_bugs_of_test_case_execution in Hint 4, noting that the sibling retrieves all bugs across all steps.

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?

The description provides explicit use cases, examples, and an alternative tool reference. Hint 4 directly instructs when to use the sibling tool instead, covering both when-to-use and when-not-to-use.

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