Skip to main content

Suites

Agent Suites are pre-packaged, versioned bundles that provision a complete set of runtime resources — agents, skills, datasources, and MCP servers — in a single install operation. The Suites section consists of two views: the Catalogue (/suites/catalogue) where you browse what is available, and Installed Suites (/suites/installs) where you manage what has already been deployed. Both views are admin-only.

Note: Resources materialised from a suite are marked as suite-managed and display a locked badge in the Agents grid and Configure page. Orchestration settings (skills, knowledge, MCP) for suite-managed agents cannot be edited directly in Runtime; changes must come from the suite itself.


Suite Catalogue (/suites/catalogue)​

The catalogue page lists every suite published to the Hub. A search bar filters results by name or slug in real time. The page header shows the total number of available suites alongside the search bar. A View Installs button in the top right navigates to /suites/installs.

Each suite is presented as a card showing:

  • Suite icon and latest version badge (e.g. v1.2.0)
  • Name — the display name of the suite
  • Description — up to two lines; truncated with an ellipsis if longer
  • Resource counts — agent count, skill count, datasource count, and MCP server count displayed as icon + number pairs
  • Industry tag — an optional industry classification badge (e.g. Finance, Healthcare)

Clicking a suite card navigates to the suite version page at /suites/:slug/versions/:version, which shows the full manifest and the install wizard.

Install Wizard​

The install wizard opens as a modal dialog and walks through up to three steps:

Summary — displays the suite name, version, and a breakdown of what will be materialised: agent count, skill count, datasource count, and MCP server count. Agent names and slugs are listed so you know exactly which agents will be created.

Parameters — shown only when the suite defines one or more parameters. Each parameter field renders according to its declared type. Secret-type parameters are masked. Required parameters must be filled before advancing. Validation errors are shown inline beneath the relevant field.

Confirm — shows a review table of all non-empty parameter values before install. Secret values are displayed as ••••••. Suites with no parameters skip the Parameters step and go directly from Summary to Confirm.

Clicking Install in the final step submits the install request. The dialog closes and the install record appears in the Installed Suites view with status Installing.


Installed Suites (/suites/installs)​

The installed suites page lists all suite install records for the current tenant. The header shows the total install count. A Browse catalogue button navigates to /suites/catalogue.

Each installed suite is shown as a card displaying:

  • Status pill — Installed or Active (both shown in green), Installing (primary colour), Pending (muted), Failed (red), Uninstalling (muted), or Uninstalled (muted)
  • Suite name and slug · vX.Y.Z identifier
  • Auto-track — the tracking policy if configured (e.g. minor, patch), displayed next to the version
  • Resource counts — agent, skill, datasource, and MCP server counts in the same icon format as the catalogue
  • Install date — formatted as Month Day, Year
  • Error message — shown in red beneath the resource counts if the install failed

Clicking a card navigates to the install detail page at /suites/installs/:id.


Install Detail (/suites/installs/:id)​

The detail page shows the full state of a single installed suite. A Back to installs link returns to the list.

The header shows the suite name, installed version badge, status pill, and — for suites that have been upgraded — an upgraded from vX badge showing the previous version. The install timestamp and slug appear below the name.

Three action buttons appear in the top-right corner when applicable:

  • Upgrade — shown when other versions exist in the catalogue; opens the Upgrade Wizard dialog
  • Rollback — shown when previous_version is set; opens a confirmation dialog to restore the prior version
  • Uninstall — always available; opens a confirmation dialog that warns all materialised resources will be removed and the action cannot be undone

Below the header, resources are grouped into four sections:

  • Agents — each agent card is clickable and deep-links to /chat/:agentId for that agent
  • Skills — read-only list of installed skills
  • Datasources — read-only list of installed datasources
  • MCP Servers — read-only list of installed MCP servers

Each resource card shows the resource name, slug, status pill, and any error message.

Upgrade Wizard​

The Upgrade Wizard dialog is functionally similar to the Install Wizard. It adds a version selector at the top showing all available catalogue versions other than the currently installed one. Selecting a target version fetches an upgrade diff that shows which resources will be added, updated, or removed. Parameters from the target version's schema are presented in the Parameters step. Submitting the wizard initiates the upgrade; the page status transitions to Installing.

Rollback​

The rollback confirmation dialog shows the target version (the previous_version value) and warns that uploaded files are preserved but tenant edits to suite-managed rows will be lost. Confirming triggers the rollback operation.


Best Practices​

  • Review the Summary step of the Install Wizard carefully before confirming — agent and skill slugs are used as stable identifiers and cannot be renamed after installation without uninstalling the suite.
  • Supply all required parameters during install; missing required parameters cause the install to fail with a validation error that must be corrected by uninstalling and reinstalling.
  • For secret-type parameters such as API keys, use the least-privilege key scoped to only the permissions the suite's agents need.
  • After a successful install, verify each agent card in the Agents grid shows Active status before sharing the agents with end users — the Installing status means the backend provisioning job is still running.
  • Use Rollback rather than Uninstall + Reinstall when reverting a failed upgrade; rollback preserves uploaded files and thread history, while uninstall removes all materialised resources permanently.

  • Overview — runtime dashboard showing active agent and resource counts
  • Agents — agent grid where suite-installed agents appear after provisioning
  • Configure — per-agent configuration; suite-managed agents show a locked badge
  • Connections — stored credentials that may be required as suite parameters
  • Providers — LLM provider credentials referenced by suite-installed agents