Suites
The Suites tab of a project's Tests page: the folders the test cases are filed in, nested by area and then by screen or flow, each tied to a component when it covers one, with how many cases each holds.
By the end of this page you will have shaped the folders a project's test cases are filed in, know what a suite carries and what reads it, and know how a suite is renamed, moved, emptied and removed.
A suite is a named folder of test cases. Suites nest, so a project files its cases by area and then by screen or by flow (Checkout, then Vouchers), and a suite may say which component it covers so a plan for one component picks the right cases. A suite carries nothing a version would keep: it is renamed or moved in place, a case moves between suites from its own editor, and a suite that still holds suites or cases is never deleted, so no case is orphaned by accident.
Before you begin
| You want to | You need |
|---|---|
| Open the Suites tab | test-suite:view-any on the project, which every staff role carries. |
| Add a suite | test-suite:create. Project managers and QA engineers have it by default. |
| Rename or move one | test-suite:update. |
| Delete a suite | test-suite:delete, and the suite to hold no suites and no cases. |
| Tie one to a part | The component to be on the project's Components page. |
The tab lives on the project's Tests page: open the project, choose Tests in the sidebar and press Suites.
Read the suites
The table draws the tree, one suite per row, each indented under the suite it sits in:
| Column | What it shows |
|---|---|
| Suite | The name with the description beneath it. Press the name to open the editor. |
| Component | The component the suite covers, or Whole project. |
| Cases | How many test cases are filed in the suite itself, its children not counted. |
| Updated | How long ago the suite last changed. |
| Row menu | Edit Suite, Add Suite Inside, View Test Cases, Activity, Delete Suite. |
The search box above the table finds suites by words in the name or the description and shows the matches as a flat list; Clear Filters on the empty state brings the tree back. View Test Cases opens the Test Cases tab already narrowed to the suite.
Add a suite
- Press New Suite, or Add Suite Inside in the row menu of the suite the new one should sit under.
- Type the Name. Two suites in the same place never share a name.
- Pick where it sits Inside (or leave it at the root) and the Component it covers (or leave it for the whole project).
- Write a Description in a line or two, so a tester files a case in the right place.
- Press Create Suite.
The suite appears in the tree at once and test_suite.created goes out to every endpoint
subscribed to it.
Shape the tree the way the team talks
One suite per area of the system is a good start, with a suite inside for each screen or flow. A suite tied to a component lets a plan for that component pick its cases in one go, and a suite that describes what it holds keeps two testers from filing the same case twice.
Rename or move a suite
- Press a suite's name, or Edit Suite in its row menu.
- Change the name, the suite it sits inside, the component or the description. A suite never sits under itself or under one of its own suites, and the picker leaves those out.
- Press Save Changes.
Moving a suite moves every suite and case inside it with it. test_suite.updated goes out with
the columns that changed, each with its old and new value; a save that changes nothing announces
nothing.
Delete a suite
Delete Suite in the row menu opens the confirmation. Only an empty suite is removed: move or
delete the suites and the test cases inside it first. test_suite.deleted goes out and the
suite's activity history goes with it.
All the fields
What happens next
- Every add, change and removal writes an entry in the project's activity history.
test_suite.created,test_suite.updatedandtest_suite.deletedgo out to the webhook endpoints subscribed to thetest_suite.*family.- A test plan will pick the cases of a suite in one go, and the automation import will file the tests it finds no case for into a suite of your choosing, as those parts of the module land.
Heimdall on this page
Heimdall reads the suites through the same tool the MCP server offers, so it files a case it drafts into the right folder and names suites the way the team does; the tree itself is shaped by people.
From the API and MCP
Test Suites API
List the tree with its counts, read one suite, and add, change and delete suites under the tree rules.
Testing tools
list_test_suites: the MCP tool that reads the tree so an agent files a case by suite id.
Permissions
| Action | Permission |
|---|---|
| See the suites | test-suite:view-any, test-suite:view |
| Add a suite | test-suite:create |
| Rename or move | test-suite:update |
| Delete a suite | test-suite:delete, on an empty suite only |
Frequently asked
Related
- Test cases — what is filed in a suite
- Components — what a suite may say it covers
- Activity log — who changed a suite and when
test_suite.*webhook events
How is this guide?
Last updated on
Test Cases
The Test Cases page of a project: what each case proves, what must be true before it starts, the steps a tester walks or a script runs, the suite it is filed in, how it is automated, the review lifecycle and the versions.
Documents
The documents a project generates from the record its team wrote once: the business requirements document the client signs and the software requirements specification the team builds against, each rendered, reviewed, approved and shared from one page.