get_tcm_suite_by_id
Retrieve test case management suite details by ID from Zebrunner projects to access test structure and execution data.
Instructions
🔍 Find TCM suite by ID with comprehensive search
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project_key | Yes | Project key (e.g., 'android' or 'ANDROID') | |
| suite_id | Yes | Suite ID to find | |
| only_root_suites | No | Search only in root suites | |
| format | No | Output format | json |
| include_clickable_links | No | Include clickable links to Zebrunner web UI |
Implementation Reference
- src/utils/hierarchy.ts:341-343 (helper)Core helper function that implements getTCMTestSuiteById - finds and returns a specific test suite by its ID from a list of suites. This matches the tool name 'get_tcm_suite_by_id' (camelCase equivalent).
static getTCMTestSuiteById(suites: ZebrunnerTestSuite[], id: number): ZebrunnerTestSuite | null { return suites.find(s => s.id === id) || null; } - src/api/enhanced-client.ts:761-761 (helper)Usage of getTCMTestSuiteById in enhanced client to enrich test cases with full suite information.
const fullSuite = HierarchyProcessor.getTCMTestSuiteById(processedSuites, foundSuiteId); - src/utils/hierarchy.ts:437-437 (helper)Internal usage of getTCMTestSuiteById within hierarchy processing to traverse parent suites.
const parentSuite = this.getTCMTestSuiteById(suites, currentSuite.parentSuiteId);