Folders

Organize resources of a given kind into folders with defineFolder.

Folders organize resources in the workspace UI. They are per-kind — a model folder and an agent folder are separate namespaces — so you place each resource in a folder of its own kind. You define one with defineFolder. kind is model, agent, play, tool, file, mcpServer, app, worker, alert, or mailbox.

Define folders

folders/crm.ts

import { defineFolder } from "@cargo-ai/cdk";

export const modelsFolder = defineFolder("crm-models", { kind: "model", name: "CRM" });
export const agentsFolder = defineFolder("crm-agents", { kind: "agent", name: "CRM" });

Pass a folder handle into the resource it organizes:

export const contacts = defineModel("contacts", {
  connector: hubspot,
  extractSlug: "fetchRecords",
  folder: modelsFolder,
});

export const jane = defineMailbox("jane", {
  domain: outreach,
  type: "google",
  firstName: "Jane",
  lastName: "Doe",
  folder: mailboxFolder,
});

From the CLI

cargo-ai workspaceManagement folder list
cargo-ai workspaceManagement folder create --name "Enrichment" --emoji-slug sparkles --kind tool