Skip to main content
Glama
SmartBear

SmartBear MCP server

Official
by SmartBear

QTM4J: Create Test Case

qtm4j_create_test_case

Create a new test case in a QTM4J project with summary, priority, status, labels, components, and steps. Auto-resolves human-readable names to IDs.

Instructions

Create a new test case in a QTM4J project. Supports auto-resolving human-readable names for priority, status, labels, and components.

Toolset: Test Cases

Parameters:

  • summary (string) required: Test case summary/title

  • description (string): Test case description

  • folderId (number): Folder ID to place the test case in

  • priority (string): Priority name (e.g., 'High', 'Medium', 'Low'). Auto-resolved to ID.

  • status (string): Status name (e.g., 'To Do', 'In Progress', 'Done'). Auto-resolved to ID.

  • assignee (string): Assignee account ID

  • reporter (string): Reporter account ID

  • components (array): List of component names (e.g., ['UI', 'Cloud']). Auto-resolved to IDs.

  • labels (array): List of label names (e.g., ['Release_1', 'Sprint 1']). Auto-resolved to IDs.

  • steps (array): List of test steps

Output Description: JSON object with test case ID, key, version number, and summary. Warnings included if any fields were skipped.

Use Cases: 1. Create a basic test case with just a summary 2. Create a test case with priority and status using names from set_project_context response 3. Create a test case with labels and components by exact name 4. Add detailed test steps with step descriptions, test data, and expected results 5. Create a test case in a specific folder using folderId 6. Set assignee and reporter using Jira account IDs 7. Create test cases for manual testing with step-by-step instructions 8. Create test cases with all metadata fields for comprehensive test management

Examples:

  1. Create a simple test case (project must be set via set_project_context first)

{
  "summary": "Search Functionality"
}

Expected Output: Test case created with key 'SCRUM-TC-xxx'

  1. Create a test case with priority and status

{
  "summary": "Search Functionality",
  "description": "Verify search functionality works correctly",
  "priority": "High",
  "status": "To Do"
}

Expected Output: Test case created with resolved priority and status IDs

  1. Create a test case with labels, components, and steps

{
  "summary": "Search Functionality",
  "description": "Search Functionality Test",
  "priority": "High",
  "status": "To Do",
  "labels": [
    "Release_1",
    "Sprint 1"
  ],
  "components": [
    "UI",
    "Cloud"
  ],
  "steps": [
    {
      "stepDetails": "Enter a keyword in the search box",
      "testData": "Keyword = \"Test\"",
      "expectedResult": "The keyword should be visible in the search box"
    },
    {
      "stepDetails": "Click on the Search button",
      "testData": "Click on Search Button",
      "expectedResult": "Search results matching the keyword should be displayed"
    },
    {
      "stepDetails": "Verify the search results",
      "testData": "Expected results list",
      "expectedResult": "Results should be relevant to the entered keyword"
    }
  ]
}

Expected Output: Test case created with resolved labels/components/priority/status and 3 steps

Hints: 1. PREREQUISITE: set_project_context must be called before this tool. NEVER auto-select a project. 2. Priority and status values were returned by set_project_context. Use NLP to map user input (e.g., 'Major' → 'High', 'Critical' → 'Blocker'). 3. If priority or status name is not found, the operation proceeds without that field and a warning is returned. 4. Labels and components are resolved on demand. If a name is not found, it is skipped with a warning. 5. Steps: ALWAYS include all three fields — stepDetails, testData, and expectedResult. Generate reasonable values if not provided. 6. folderId is optional. assignee and reporter accept Jira account IDs.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
stepsNoList of test steps
labelsNoList of label names (e.g., ['Release_1', 'Sprint 1']). Auto-resolved to IDs.
statusNoStatus name (e.g., 'To Do', 'In Progress', 'Done'). Auto-resolved to ID.
summaryYesTest case summary/title
assigneeNoAssignee account ID
folderIdNoFolder ID to place the test case in
priorityNoPriority name (e.g., 'High', 'Medium', 'Low'). Auto-resolved to ID.
reporterNoReporter account ID
componentsNoList of component names (e.g., ['UI', 'Cloud']). Auto-resolved to IDs.
descriptionNoTest case description

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesUnique test case ID
keyYesTest case key (e.g., 'SCRUM-TC-190')
summaryYesTest case summary
versionNoYesVersion number
Behavior4/5

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

Annotations declare readOnlyHint=false, destructiveHint=false (not read-only, not destructive). The description adds behavioral details: auto-resolves human-readable names for priority, status, labels, components; if a name is not found, the operation proceeds without that field and a warning is returned. This adds transparency beyond 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 well-structured with sections (parameter list, output description, use cases, examples, hints). It is front-loaded with the purpose. Though lengthy, each section serves a purpose. Some repetition of schema descriptions, but overall efficient.

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 10 parameters and no enums, the description covers prerequisites, parameter behaviors, output format, use cases, examples, and troubleshooting hints. It includes warnings about skipped fields and auto-resolution behavior. Output is described. The tool is complex, and the description is comprehensive.

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 value by grouping parameters, indicating auto-resolution, and providing hints (e.g., 'steps: ALWAYS include all three fields'). Examples further clarify usage. No parameter is left without context.

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 'Create a new test case in a QTM4J project' and highlights auto-resolution of names, distinguishing it from sibling tools like qmetry_create_test_case and zephyr_create_test_case by specifying the QTM4J system. The verb 'Create' and resource 'Test Case' are explicit.

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?

The description provides explicit prerequisite: 'PREREQUISITE: set_project_context must be called before this tool. NEVER auto-select a project.' It also lists 8 use cases covering various scenarios. However, it does not explicitly contrast with the update tool or other create tools, missing some guidance on when not to use this tool.

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