Skip to main content
Glama
SmartBear

SmartBear MCP server

Official
by SmartBear
OverviewSchemaRelated ServersScoreDiscussions
TypeScript
Hybrid

QTM4J: Update Test Step Execution

qtm4j_update_test_step_execution
Idempotent

Update a test step execution in SmartBear by setting the execution result, actual result, or comment. Specify the test cycle and test case keys with the step sequence number to record outcome details and keep test results current.

Instructions

Update a test step execution (execution result, actual result, comment). Looks up testStepExecutionId from testCycleKey, testCaseKey, and step sequence number; resolves executionResultId name to a numeric ID.

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 step to update (e.g. 2 = the second step).

  • executionResultId (string): Execution result name, e.g. 'Pass', 'Fail', 'Blocked', 'In Progress', 'Not Executed'. Project-specific (custom results allowed); resolved case-insensitively to a numeric executionResultId.

  • comment (string): Step execution comment. Pass null to clear the existing comment.

  • actualResult (string): Actual result for this test step. Set to null to clear the existing value.

Output Description: Confirmation object with testCycleKey, testCaseKey, testStepSeqNo, and updated: true. executionResultName is included when the server returns it. Warnings are returned in content if executionResultId name could not be resolved.

Use Cases: 1. Set a test step execution result (e.g. Pass, Fail, Blocked) 2. Update actualResult or comment on a test step execution

Examples:

  1. Mark step 2 as Pass

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

Expected Output: { testCycleKey: 'PROJ-TR-101', testCaseKey: 'PROJ-TC-42', testStepSeqNo: 2, executionResultName: 'Pass', updated: true }

  1. Update step 3 with actualResult and comment

{
  "testCycleKey": "PROJ-TR-101",
  "testCaseKey": "PROJ-TC-42",
  "testStepSeqNo": 3,
  "executionResultId": "Fail",
  "actualResult": "Button not found on page.",
  "comment": "Reproduced consistently in Chrome."
}

Expected Output: { testCycleKey: 'PROJ-TR-101', testCaseKey: 'PROJ-TC-42', testStepSeqNo: 3, executionResultName: 'Fail', updated: true }

  1. Clear actualResult on step 1

{
  "testCycleKey": "PROJ-TR-101",
  "testCaseKey": "PROJ-TC-42",
  "testStepSeqNo": 1,
  "actualResult": null
}

Expected Output: { testCycleKey: 'PROJ-TR-101', testCaseKey: 'PROJ-TC-42', testStepSeqNo: 1, updated: true }

Hints: 1. Call set_project_context before this tool. 2. At least one updatable field must be provided.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
commentNoStep execution comment. Pass null to clear the existing comment.
testCaseKeyYesTest case key in the format '{PROJECT_KEY}-TC-{number}', e.g. 'SCRUM-TC-145'.
actualResultNoActual result for this test step. Set to null to clear the existing value.
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 step to update (e.g. 2 = the second step).
executionResultIdNoExecution result name, e.g. 'Pass', 'Fail', 'Blocked', 'In Progress', 'Not Executed'. Project-specific (custom results allowed); resolved case-insensitively to a numeric executionResultId.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
updatedYesTrue when the server confirms the update (HTTP 200 OK) and the test step execution is successfully updated.
testCaseKeyYesKey of the test case whose step execution was updated (e.g. 'SCRUM-TC-145').
testCycleKeyYesKey of the test cycle containing the updated step execution (e.g. 'SCRUM-TR-101').
testStepSeqNoYessequence number of the test step whose execution was updated.
executionResultNameNoName of the execution result applied to the step (e.g. 'Pass', 'Fail'). Present only when the server returns it.

Tool Definition Quality

A4.5/5.0
Behavior4/5

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

Annotations already cover readOnly/destructive/idempotent hints. The description adds beyond that: explains that executionResultId is resolved case-insensitively to a numeric ID, that passing null clears fields, and that warnings appear in content if name resolution fails. This is meaningful behavioral context not present in the structured annotations.

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 into concise sections: summary, parameters, output, use cases, examples, and hints. Every section serves a purpose. The examples are particularly useful and compact, showing realistic JSON payloads and expected outputs without unnecessary prose.

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 the tool's complexity (6 parameters, lookup logic, name resolution, multiple updatable fields), the description is fully complete. It covers the entity identification mechanism, parameter formats with examples, output shape, warnings behavior, use cases, and clear examples for typical scenarios including clearing fields. An output schema exists, and the description still explains return values adequately.

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 extra semantic value: testCycleKey is 'used directly as the API path parameter', executionResultId is 'project-specific (custom results allowed); resolved case-insensitively', and null values for comment/actualResult clear the existing value. This enriches the schema without redundancy.

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: 'Update a test step execution (execution result, actual result, comment).' It clearly distinguishes this from sibling tools like qtm4j_update_test_case_execution by targeting test steps specifically and explaining the lookup mechanism (testCycleKey, testCaseKey, step sequence number).

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 ('Set a test step execution result', 'Update actualResult or comment') and a prerequisite hint ('Call set_project_context before this tool'). It does not explicitly name alternative tools for when not to use this one, but the use cases and lookup details give clear context.

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