Skip to main content
Glama
SmartBear

SmartBear MCP server

Official
by SmartBear

QMetry: Link Test Cases to Test Suite

qmetry_link_test_cases_to_test_suite

Link test case versions to a QMetry test suite using the suite ID and version IDs. Enables bulk linking and assembling suites from test cases.

Instructions

Link test cases to a test suite in QMetry.

Toolset: Test Suites

Parameters:

  • tsID (number) required: Id of Test Suite (required). CRITICAL: parameter name is 'tsID' — do NOT use 'testSuiteId', 'testSuiteID', or other variants.

  • tcvdIDs (array) required: Array of Test Case Version IDs (required if fromReqs is false). CRITICAL: parameter name is 'tcvdIDs' — do NOT use 'tcVersionIds', 'testCaseVersionIds', or other variants.

  • fromReqs (boolean): Link TestCases from Requirements (optional, default false)

Output Description: JSON object with linkage status and details.

Use Cases: 1. Link test cases to a test suite by entity keys 2. Bulk link multiple test cases to a suite 3. Automate test suite composition from test cases

Examples:

  1. Link test cases to a test suite

{
  "tsID": 8674,
  "tcvdIDs": [
    5448504,
    5448503
  ],
  "fromReqs": false
}

Expected Output: Test cases QTM-TC-32 and QTM-TC-35 linked to test suite 8674.

  1. Link test cases directly to test suites with test cases entityKeys VT-TC-9, VT-TC-10 to test suite id 1487397

{
  "tsID": 1487397,
  "tcvdIDs": [
    5448504,
    5448503
  ],
  "fromReqs": false
}

Expected Output: Test cases VT-TC-9 and VT-TC-10 linked to test suite 1487397.

  1. Link test case VT-TC-4, VT-TC-1,VT-TC-101, VT-TC-22 to test suite VT-TS-3

{
  "tsID": 1487397,
  "tcvdIDs": [
    5448504,
    5448503,
    5448505,
    5448506
  ],
  "fromReqs": false
}

Expected Output: Test cases VT-TC-4, VT-TC-1, VT-TC-101, and VT-TC-22 linked to test suite VT-TS-3.

Hints: 1. To get the tsID, call the Fetch Test Suites for Test Case API with rootFolderId otherwise if given folderid so use that and from response get the id. 2. To get the tcvdIDs by testcase entityKey, call the Testcase/Fetch Versions API and use data[].tcVersionID. 3. Set fromReqs to false to direct test case linkage.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
tsIDYesId of Test Suite (required). CRITICAL: parameter name is 'tsID' — do NOT use 'testSuiteId', 'testSuiteID', or other variants.
tcvdIDsYesArray of Test Case Version IDs (required if fromReqs is false). CRITICAL: parameter name is 'tcvdIDs' — do NOT use 'tcVersionIds', 'testCaseVersionIds', or other variants.
fromReqsNoLink TestCases from Requirements (optional, default false)
Install Server

TDQS

A4.1/5.0
Behavior3/5

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

Annotations include readOnlyHint:false, destructiveHint:false, idempotentHint:false. The description says 'Link test cases,' which is a write operation consistent with readOnlyHint:false. It adds context about the output (JSON object with linkage status) and expected results in examples. However, it does not disclose potential side effects (e.g., behavior on duplicate links) or discuss idempotency, relying on annotations to convey non-idempotency. No contradiction exists, but the description could add more behavioral detail.

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

Conciseness3/5

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

The description is well-structured with clear sections (Parameters, Use Cases, Examples, Hints), but it is verbose. Three examples with similar content add redundancy; a single example would suffice. The parameter list repeats schema descriptions, adding length. However, the critical naming warnings and hints are valuable. The structure is logical but not concise enough for optimal quick scanning.

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 tool has 3 parameters, no output schema, and moderate complexity. The description provides a complete picture: parameter details, output description, use cases, examples with expected outputs, and acquisition hints. It fully compensates for the lack of an output schema by describing the JSON return. The hints ensure the agent can correctly obtain and supply parameter values, making the tool's usage self-contained.

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%—the schema already describes all parameters in detail. The description adds value by emphasizing CRITICAL parameter naming constraints ('do NOT use testSuiteId...') and providing hints on how to derive values for tsID and tcvdIDs from other APIs. It also explains the fromReqs option's default and purpose. While the schema covers semantics, the description enhances usability with practical examples and acquisition guidance.

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 action: 'Link test cases to a test suite in QMetry.' The verb 'link' and resources 'test cases' and 'test suite' are specific. It differentiates from siblings like qmetry_link_requirements_to_testcase and qmetry_link_platforms_to_test_suite by specifying the target entity. The use cases list distinct scenarios, reinforcing the tool's purpose.

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 'Hints' section provides explicit guidance on when to use the tool and how to obtain required parameters (tsID via Fetch Test Suites for Test Case API, tcvdIDs via Testcase/Fetch Versions API). It also clarifies when to set fromReqs to false. However, it does not explicitly compare with sibling tools or state when NOT to use it, such as alternative linking tools. The use cases imply usage context but lack explicit exclusions.

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