Skip to main content
Glama
SmartBear

SmartBear MCP server

Official
by SmartBear

QTM4J: Start New Execution

qtm4j_start_new_execution

Start a new test case execution in a test cycle by providing cycle and case keys. Optionally set assignee, planned date, environment, build, or clone an existing execution.

Instructions

Start a new test case execution within a test cycle. Looks up the internal map ID from testCycleKey and testCaseKey; resolves environmentId and buildId 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'.

  • assignee (string): Jira account ID of the user to assign this execution to (e.g. '5e4a642c1c9d440008f2a2b4'). This is the account ID, not a display name.

  • executionPlannedDate (string): Planned execution date. Format: 'dd/MMM/yyyy' e.g. '15/Oct/2025'. Month must be capitalised (Oct, not oct or OCT).

  • environmentId (string): Environment name (e.g. 'Production', 'Staging', 'Google Chrome', 'Firefox'). Auto-resolved to its numeric ID; an unresolved name is dropped and a warning is returned.

  • buildId (string): Build name (e.g. 'Build 2.0', '1.0.0'). Auto-resolved to its numeric ID; an unresolved name is dropped and a warning is returned.

  • actualTime (string): Time already spent on the execution. Format: 'HH:mm:ss' e.g. '02:30:00' (2 hours 30 minutes 0 seconds).

  • cloneFrom (number): Source testCaseExecutionId to clone. When set, the new execution copies the source's execution and all other body fields are ignored by the server.

  • cloneExecutionCustomFields (boolean): When true, custom field values from the previous execution of this test case are copied into the new execution.

Output Description: Confirmation object with testCycleKey, testCaseKey, and created: true (set when server returns 204).

Use Cases: 1. Start a fresh execution for a test case in a test cycle 2. Clone an existing execution

Examples:

  1. Start an execution for a test case (minimal)

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

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

  1. Start execution with environment, build and planned date

{
  "testCycleKey": "PROJ-TR-101",
  "testCaseKey": "PROJ-TC-42",
  "environmentId": "Production",
  "buildId": "Build 2.0",
  "executionPlannedDate": "15/Oct/2025",
  "assignee": "5e4a642c1c9d440008f2a2b4"
}

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

  1. Clone an existing execution

{
  "testCycleKey": "PROJ-TR-101",
  "testCaseKey": "PROJ-TC-42",
  "cloneFrom": 725981
}

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

  1. Start a fresh execution and carry over custom field values from the previous execution

{
  "testCycleKey": "PROJ-TR-101",
  "testCaseKey": "PROJ-TC-42",
  "cloneExecutionCustomFields": true
}

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

Hints: 1. Call set_project_context before this tool. 2. executionPlannedDate must be in 'dd/MMM/yyyy' format (e.g. '15/Oct/2025', month 3-letter capitalised). Normalize from any user-provided format before calling. 3. When cloneFrom is non-zero, the server ignores all body fields. 4. assignee must be a Jira account ID (e.g. '5e4a642c1c9d440008f2a2b4'), not a display name. 5. environmentId and buildId accept name as strings that are resolved to numeric IDs; unresolved names are dropped and a warning is returned. 6. actualTime must be in 'HH:mm:ss' format (e.g. '02:30:00'). Always include seconds.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
buildIdNoBuild name (e.g. 'Build 2.0', '1.0.0'). Auto-resolved to its numeric ID; an unresolved name is dropped and a warning is returned.
assigneeNoJira account ID of the user to assign this execution to (e.g. '5e4a642c1c9d440008f2a2b4'). This is the account ID, not a display name.
cloneFromNoSource testCaseExecutionId to clone. When set, the new execution copies the source's execution and all other body fields are ignored by the server.
actualTimeNoTime already spent on the execution. Format: 'HH:mm:ss' e.g. '02:30:00' (2 hours 30 minutes 0 seconds).
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.
environmentIdNoEnvironment name (e.g. 'Production', 'Staging', 'Google Chrome', 'Firefox'). Auto-resolved to its numeric ID; an unresolved name is dropped and a warning is returned.
executionPlannedDateNoPlanned execution date. Format: 'dd/MMM/yyyy' e.g. '15/Oct/2025'. Month must be capitalised (Oct, not oct or OCT).
cloneExecutionCustomFieldsNoWhen true, custom field values from the previous execution of this test case are copied into the new execution.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
createdYesTrue when the server returned 204 No Content, confirming the execution was created successfully.
testCaseKeyYesTest case key of the created execution (e.g. 'SCRUM-TC-145').
testCycleKeyYesKey of the test cycle in which the execution was created (e.g. 'SCRUM-TR-101').
Install Server

TDQS

A4.6/5.0
Behavior5/5

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

Annotations only state readOnlyHint=false, idempotentHint=false, destructiveHint=false. The description adds substantial behavioral detail: internal map-ID lookup, name-to-ID resolution with drop-and-warn semantics for unresolved names, and cloneFrom causing the server to ignore all other body fields. It also discloses the exact success indicator ('created: true (set when server returns 204)').

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 well-structured with summary, toolset, parameters, output description, use cases, examples, and hints, and the high-level behavior is front-loaded. It is somewhat long and repeats schema-provided parameter details, but the organization keeps it navigable and each section contributes to correct usage.

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 9-parameter write operation, the description covers the full invocation contract: key formats, date/time formats, clone semantics, name-resolution warnings, prerequisite setup, and expected output. Four examples span minimal, fully specified, clone, and custom-field scenarios, leaving no significant gap for an agent to invoke the tool correctly.

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, and the description's parameter list largely mirrors the schema. However, the Examples and Hints add operational meaning beyond the schema: normalize user-provided dates, always include seconds for actualTime, and account ID vs display name emphasis. These extras justify a stronger score.

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 uses a specific verb-resource pair ('Start a new test case execution within a test cycle') and clarifies internal behavior ('Looks up the internal map ID... resolves environmentId and buildId names to numeric IDs'). The Use Cases section enumerates the two intended scenarios, clearly distinguishing this from sibling tools like qtm4j_update_test_case_execution.

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 ('Start a fresh execution... Clone an existing execution') and a prerequisite hint ('Call set_project_context before this tool'). It doesn't explicitly name alternative tools to use for other operations or state when not to use this tool, 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