@floomhq/floom 5.1.8 → 5.1.9

package/README.md

@@ -1,400 +1,400 @@
-# Floom CLI + MCP
-
-Floom lets agents create, update, run, watch, and delete worker automations through an HTTP MCP endpoint backed by the hosted Floom Cloud API. The package installs into Claude Code, Cursor, VS Code, Windsurf, Continue, or any harness that accepts an MCP HTTP or stdio server entry.
-
-Floom ships as a single npm package that exposes:
-
-- **`floom` CLI** - `login`, `workspaces`, `workers`, `run`, `runs`, `secrets`, `mcp`, `whoami`, `logout`, plus an `install` shortcut that wires the MCP server into Claude Code / Cursor / Continue. `workeros` remains a compatibility alias for older installs.
-- **HTTP MCP endpoint** - `floom mcp install` writes an HTTP transport entry (`url` + `headers`) pointing at hosted Floom Cloud by default. No local subprocess is required.
-- **`floom-mcp` stdio server** - legacy stdio path; `workeros-mcp` still works as an alias. Use this for harnesses that do not support HTTP MCP transport.
-
-The CLI targets hosted Floom Cloud by default. Self-hosted/local mode is only for operators already running their own Floom API:
-
-| Mode | API base | Auth | Workspaces |
-|------|----------|------|------------|
-| **Hosted** (default) | `https://workeros-api.floom.dev` | browser/device login or bearer token | multi-workspace |
-| **Self-hosted** | `http://localhost:8000` or your API URL | `x-floom-secret` when `FLOOM_SECRET` is set | local workspace |
-
-## Hosted Quickstart
-
-```bash
-npx -y @floomhq/floom mcp install --target claude
-```
-
-`mcp install` is the one-command hosted setup path. It targets Floom Cloud by
-default, starts browser login only when no valid hosted credentials are saved,
-selects the active workspace, and writes the MCP config for the client. Use
-`--target cursor`, `--target vscode`, `--target windsurf`, `--target continue`,
-or `--target generic` for other clients.
-
-For CLI use outside an MCP client:
-
-```bash
-npm i -g @floomhq/floom@latest
-floom login
-floom workers list
-floom run <worker-id> --input key=value
-```
-
-## Self-Hosted Quickstart
-
-For the default local API at `http://localhost:8000`:
-
-```bash
-npm i -g @floomhq/floom@latest
-floom login --local
-floom workers list
-```
-
-For a custom self-hosted API base, set env vars instead of passing an `--api`
-flag:
-
-```bash
-WORKEROS_API_BASE=http://localhost:8000 floom login --local
-FLOOM_API_BASE=http://localhost:8000 floom doctor
-```
-
-If your local API runs without `FLOOM_SECRET`, login is not required for basic local development. For a protected self-hosted API, set `FLOOM_SECRET` on the backend and use the matching secret when the CLI prompts.
-
-If the self-hosted engine has user-header scope enabled (it requires `x-floom-user` alongside the shared secret), pass the identity with the `--user` flag or `WORKEROS_USER` env var:
-
-```bash
-WORKEROS_API_BASE=http://127.0.0.1:8011 WORKEROS_API_SECRET=<secret> WORKEROS_USER=<user> floom whoami
-# or
-floom --user <user> whoami
-```
-
-`WORKEROS_API_BASE` + `WORKEROS_API_SECRET` select self-hosted (OSS) mode and take precedence over any saved hosted credentials file; `mcp install` bakes `x-floom-user` into the generated client config when it is set.
-
-Credentials live at `~/.config/floom/credentials.json` (mode 0600). Existing `~/.config/workeros/credentials.json` files are still read for compatibility. `floom logout` clears both paths.
-
-## MCP install
-
-```bash
-npx -y @floomhq/floom mcp install
-```
-
-Targets hosted Floom Cloud unless self-hosted env vars or local login are used.
-It auto-detects the first existing config file and reuses saved hosted
-credentials when possible. To target a specific harness:
-
-```bash
-floom mcp install --target claude     # ~/.claude/settings.json
-floom mcp install --target cursor     # ~/.cursor/mcp.json
-floom mcp install --target vscode     # .vscode/mcp.json  (workspace-local)
-floom mcp install --target windsurf   # ~/.codeium/windsurf/mcp_config.json
-floom mcp install --target continue   # ~/.continue/.continuerc.json
-floom mcp install --target generic    # prints JSON snippet for manual paste
-```
-
-## Switching the active context
-
-```bash
-floom workspace list             # all workspaces your credentials can access, active marked with *
-floom workspace switch <name>    # by name or id; fails (exit 1) if not authenticated for it
-floom mcp list                   # configured MCP servers (connections of kind "mcp")
-floom mcp switch <name>          # set the active MCP server by label
-floom mcp test [name]            # live probe (initialize + tools/list); defaults to the active server
-```
-
-Switches persist in `~/.config/floom/credentials.json` and apply to every later CLI invocation. `workspaces`/`use` remain as aliases of `workspace`/`switch`. Workspace switching works in both modes: hosted deployments scope by membership, self-hosted deployments scope local workspaces via the legacy `x-workeros-workspace` header (which the CLI sends on every request, and `mcp install` bakes into the client config - re-run `mcp install` after switching to repoint installed MCP clients).
-
-Re-running the installer updates the existing `floom` entry, and migrates an older `workeros` entry instead of duplicating it.
-
-## Supported targets
-
-| Target | Config file written | Config shape |
-|---|---|---|
-| `claude` | `~/.claude/settings.json` | `{ mcpServers: { floom: {...} } }` |
-| `cursor` | `~/.cursor/mcp.json` | `{ mcpServers: { floom: {...} } }` |
-| `vscode` | `.vscode/mcp.json` (workspace) | `{ mcpServers: { floom: {...} } }` |
-| `windsurf` | `~/.codeium/windsurf/mcp_config.json` | `{ mcpServers: { floom: {...} } }` |
-| `continue` | `~/.continue/.continuerc.json` | `{ mcpServers: [ { name:"floom", ... } ] }` |
-| `generic` | (no file) | prints JSON snippet to stdout |
-
-All targets write **HTTP MCP transport** (`url` + `headers`) - no local subprocess is spawned. The MCP endpoint is hosted on the Floom API server.
-
-```json
-{
-  "mcpServers": {
-    "floom": {
-      "url": "https://workeros-api.floom.dev/mcp/<workspace_id>",
-      "headers": {
-        "Authorization": "Bearer <floom_token>"
-      }
-    }
-  }
-}
-```
-
-### HTTP transport (recommended - written by `floom mcp install`)
-
-Claude Code / Cursor / VS Code / Windsurf (`mcpServers` object shape), hosted
-Cloud:
-
-```json
-{
-  "mcpServers": {
-    "floom": {
-      "url": "https://workeros-api.floom.dev/mcp/<workspace_id>",
-      "headers": {
-        "Authorization": "Bearer <floom_token>"
-      }
-    }
-  }
-}
-```
-
-The published binary stays connected for that handshake when launched as `npx -p @floomhq/floom floom-mcp`.
-
-## Manual self-hosted config
-
-Use this section only when you run your own Floom API. Hosted users should let
-`floom mcp install` generate the config above.
-
-Claude Code / Cursor / VS Code / Windsurf (`mcpServers` object shape, HTTP MCP):
-
-```json
-{
-  "mcpServers": {
-    "floom": {
-      "url": "http://localhost:8000/mcp-tools/serve",
-      "headers": {
-        "x-floom-secret": "<WORKEROS_API_SECRET>"
-      }
-    }
-  }
-}
-```
-
-Continue (`~/.continue/.continuerc.json`, array shape, HTTP MCP):
-
-```json
-{
-  "mcpServers": [
-    {
-      "name": "floom",
-      "url": "http://localhost:8000/mcp-tools/serve",
-      "headers": {
-        "x-floom-secret": "<WORKEROS_API_SECRET>"
-      }
-    }
-  ]
-}
-```
-
-Replace `http://localhost:8000` with your deployed API base URL when connecting
-to a remote self-hosted instance.
-
-### Stdio transport (fallback - for harnesses that do not support HTTP MCP)
-
-```json
-{
-  "mcpServers": {
-    "floom": {
-      "command": "npx",
-      "args": ["-p", "@floomhq/floom", "floom-mcp"],
-      "env": {
-        "WORKEROS_API_SECRET": "<WORKEROS_API_SECRET>",
-        "WORKEROS_API_BASE": "http://localhost:8000"
-      }
-    }
-  }
-}
-```
-
-Or launch directly if the package is already installed: `node /path/to/@floomhq/floom/dist/server.js`.
-
-## Worker bundle CLI flow
-
-Use this path when a fresh agent has a local `workers/<id>/` folder and needs a repeatable create/edit/deploy loop:
-
-```bash
-floom login
-floom workers contract
-floom workers templates list
-floom workers templates get python-script
-floom workers validate ./workers/<id>
-floom workers push ./workers/<id>
-floom run <id> --inputs-file docs/workers/inputs/<id>.json
-floom workers info <id>
-```
-
-`workers validate` is offline. It checks that `worker.yml` parses, the entry file exists, the runtime is declared, and E2B Composio workers do not use the local `composio execute` CLI. For structured connection declarations it also verifies that referenced tool slugs are covered by `allowed_tools`.
-
-`workers push` uses `POST /workers` for new workers and `PUT /workers/{id}` for existing workers. If an older API returns 404/405 for source updates, upgrade the API before editing workers in place.
-
-Clean up stale or superseded workers without leaving the CLI:
-
-```bash
-floom workers disable <id>   # keep the worker but stop it running on triggers
-floom workers enable <id>    # re-enable a disabled worker
-floom workers delete <id>    # permanently remove it (and its runs/artifacts); prompts unless --yes
-```
-
-`workers delete` asks for confirmation; pass `-y/--yes` to skip the prompt (also required in non-interactive shells). `workers disable` is the reversible, soft option (`enabled=false`) for hiding a worker from triggers without deleting it.
-
-## Tools
-
-> **For full worked examples per tool, end-to-end recipes (deploy a worker from prompt, port a Claude skill, schedule + webhook + composio triggers), and the agent draft contract, see [docs/AGENT-COOKBOOK.md](../../docs/AGENT-COOKBOOK.md).**
-
-### Workers
-| Tool | Description |
-| --- | --- |
-| `workers.list` | List available Floom workers. |
-| `workers.get` | Read one worker, including config and recent run metadata. |
-| `workers.contract` | Read the canonical worker.yml/run.py/SKILL.md authoring contract. |
-| `workers.templates.list` | List golden worker templates agents should start from. |
-| `workers.templates.get` | Return a full template bundle with `worker_yml` plus `run_py` or `skill_md`. |
-| `workers.validate` | Validate a proposed worker bundle before creating it. |
-| `workers.create` | Create a worker from validated `worker_yml` plus `run_py` or `skill_md`. |
-| `workers.update` | Patch trigger, cron, default inputs, capabilities, or rotate webhook secret. |
-| `workers.delete` | Delete a worker and dependent run data. |
-| `workers.run` | Start a manual worker run with input values. |
-| `workers.logs` | Fetch cross-run log history, filterable by level and time. |
-| `workers.stats` | 7-day run statistics for a specific worker. |
-| `workers.timeseries` | Daily run counts and success/failure trend over N days. |
-| `workers.sample_input` | Get example input values for a worker's fields. |
-| `workers.archive` | Archive a worker (reversible). |
-| `workers.restore` | Restore an archived worker to active status. |
-| `workers.reload` | Reload all workers from disk on a self-hosted deployment. |
-| `workers.versions` | List saved versions of a worker. |
-| `workers.rollback` | Restore a worker to a previous version. |
-| `workers.alerts.list` | List configured alerts for a worker. |
-| `workers.alerts.create` | Add a failure/approval/success alert via webhook or email. |
-| `workers.alerts.delete` | Remove a worker alert. |
-
-### Runs
-| Tool | Description |
-| --- | --- |
-| `runs.list` | List runs, optionally filtered by worker id or status. |
-| `runs.get` | Read one run with logs, outputs, artifacts, and approval state. |
-| `runs.watch` | Stream SSE run events until a terminal state. |
-| `runs.cancel` | Cancel an in-progress run. |
-| `runs.replay` | Replay a completed or failed run with the same inputs. |
-
-### Approvals
-| Tool | Description |
-| --- | --- |
-| `approvals.list` | List pending approval requests across all workers. |
-| `approvals.approve` | Approve a pending run so it continues executing. |
-| `approvals.reject` | Reject a pending run, stopping it. |
-
-### Secrets
-| Tool | Description |
-| --- | --- |
-| `secrets.list` | List secret names and status. |
-| `secrets.set` | Create or update a secret value. |
-| `secrets.delete` | Delete a secret. |
-| `secrets.test` | Verify a secret exists without revealing its value. |
-
-### Connections
-| Tool | Description |
-| --- | --- |
-| `connections.list` | List configured app connections. |
-| `connections.add_mcp` | Add an MCP server connection. |
-| `connections.delete` | Remove a connection. |
-| `connections.status` | Check connection health and auth status. |
-| `connections.test` | Run a live connectivity check on a connection. |
-
-### Contexts (Brain Packs)
-| Tool | Description |
-| --- | --- |
-| `contexts.list` | List context folders. |
-| `contexts.create` | Create a new brain pack context. |
-| `contexts.delete` | Delete a brain pack and all its files. |
-| `contexts.read` | Read a file from a context. |
-| `contexts.write` | Create or update a file in a context. |
-| `contexts.upload` | Upload a binary file to a context. |
-| `contexts.delete_file` | Delete a specific file from a context. |
-| `contexts.versions` | List saved versions of a brain pack. |
-| `contexts.rollback` | Restore a brain pack to a previous version. |
-
-### Triggers & Integrations
-| Tool | Description |
-| --- | --- |
-| `triggers.list` | List integration triggers, globally or per worker/app. |
-| `integrations.catalog` | Browse all available integrations. |
-
-### Workspace
-| Tool | Description |
-| --- | --- |
-| `workspace.chat` | Send a message to the workspace agent and get a reply. |
-| `workspace.instructions.get` | Read current workspace agent system prompt. |
-| `workspace.instructions.set` | Update workspace agent system prompt. |
-| `workspace.versions` | List version history of workspace instructions. |
-| `workspace.rollback` | Restore workspace instructions to a previous version. |
-
-### Conversations
-| Tool | Description |
-| --- | --- |
-| `conversations.list` | List past workspace agent conversations. |
-| `conversations.get` | Retrieve a full conversation by ID. |
-
-### System
-| Tool | Description |
-| --- | --- |
-| `system.overview` | Full workspace dashboard - health, runs, pending approvals, alerts. |
-| `system.stats` | 7-day aggregate run statistics across the whole workspace. |
-| `system.info` | Platform version and configuration flags. |
-| `system.alerts` | Active system-wide alerts. |
-
-## Quick example - write + deploy + verify a worker in one MCP session
-
-```js
-// 1. Create
-await workers.create({
-  worker_yml: `
-schema_version: "0.3"
-name: text-summarizer
-title: Text Summarizer
-description: Summarizes any text in 3 bullets using GPT-4.1.
-entrypoint: run.py
-exec:
-  command: python run.py
-  runtime: python311
-  runner: e2b
-  entry: run.py
-  inputs:
-    - { name: text, kind: scalar, type: textarea, required: true, label: Text }
-  outputs:
-    - { name: summary, kind: file, media_type: text/markdown, path: out/summary.md, required: true, label: Summary }
-  secrets: [OPENAI_API_KEY]
-capabilities:
-  secrets: [OPENAI_API_KEY]
-  network: { egress: true }
-trigger: { type: manual }
-`,
-  run_py: `
-def run(inputs, context):
-    client = context.openai()
-    r = client.chat.completions.create(
-        model="gpt-4.1-mini",
-        messages=[
-            {"role": "system", "content": "Summarize in 3 bullets."},
-            {"role": "user", "content": inputs["text"]},
-        ],
-    )
-    summary = r.choices[0].message.content
-    context.write_output("summary", summary)
-    return {"summary": summary}
-`,
-});
-
-// 2. Run
-const { run_id } = await workers.run({
-  id: "text-summarizer",
-  inputs: { text: "Lorem ipsum dolor sit amet..." },
-});
-
-// 3. Watch until terminal
-const watched = await runs.watch({ id: run_id });
-console.log(watched.status);
-
-// 4. Verify
-const { run } = await runs.get({ id: run_id });
-console.log(run.status); // "succeeded"
-console.log(run.output?.summary);
-```
-
-See [docs/AGENT-COOKBOOK.md section 1](../../docs/AGENT-COOKBOOK.md) for the full annotated walkthrough plus six more recipes (agent mode, Gmail trigger, cron schedule, webhook, approval gate, claude-skill port).
+# Floom CLI + MCP
+
+Floom lets agents create, update, run, watch, and delete worker automations through an HTTP MCP endpoint backed by the hosted Floom Cloud API. The package installs into Claude Code, Cursor, VS Code, Windsurf, Continue, or any harness that accepts an MCP HTTP or stdio server entry.
+
+Floom ships as a single npm package that exposes:
+
+- **`floom` CLI** - `login`, `workspaces`, `workers`, `run`, `runs`, `secrets`, `mcp`, `whoami`, `logout`, plus an `install` shortcut that wires the MCP server into Claude Code / Cursor / Continue. `workeros` remains a compatibility alias for older installs.
+- **HTTP MCP endpoint** - `floom mcp install` writes an HTTP transport entry (`url` + `headers`) pointing at hosted Floom Cloud by default. No local subprocess is required.
+- **`floom-mcp` stdio server** - legacy stdio path; `workeros-mcp` still works as an alias. Use this for harnesses that do not support HTTP MCP transport.
+
+The CLI targets hosted Floom Cloud by default. Self-hosted/local mode is only for operators already running their own Floom API:
+
+| Mode | API base | Auth | Workspaces |
+|------|----------|------|------------|
+| **Hosted** (default) | `https://workeros-api.floom.dev` | browser/device login or bearer token | multi-workspace |
+| **Self-hosted** | `http://localhost:8000` or your API URL | `x-floom-secret` when `FLOOM_SECRET` is set | local workspace |
+
+## Hosted Quickstart
+
+```bash
+npx -y @floomhq/floom mcp install --target claude
+```
+
+`mcp install` is the one-command hosted setup path. It targets Floom Cloud by
+default, starts browser login only when no valid hosted credentials are saved,
+selects the active workspace, and writes the MCP config for the client. Use
+`--target cursor`, `--target vscode`, `--target windsurf`, `--target continue`,
+or `--target generic` for other clients.
+
+For CLI use outside an MCP client:
+
+```bash
+npm i -g @floomhq/floom@latest
+floom login
+floom workers list
+floom run <worker-id> --input key=value
+```
+
+## Self-Hosted Quickstart
+
+For the default local API at `http://localhost:8000`:
+
+```bash
+npm i -g @floomhq/floom@latest
+floom login --local
+floom workers list
+```
+
+For a custom self-hosted API base, set env vars instead of passing an `--api`
+flag:
+
+```bash
+WORKEROS_API_BASE=http://localhost:8000 floom login --local
+FLOOM_API_BASE=http://localhost:8000 floom doctor
+```
+
+If your local API runs without `FLOOM_SECRET`, login is not required for basic local development. For a protected self-hosted API, set `FLOOM_SECRET` on the backend and use the matching secret when the CLI prompts.
+
+If the self-hosted engine has user-header scope enabled (it requires `x-floom-user` alongside the shared secret), pass the identity with the `--user` flag or `WORKEROS_USER` env var:
+
+```bash
+WORKEROS_API_BASE=http://127.0.0.1:8011 WORKEROS_API_SECRET=<secret> WORKEROS_USER=<user> floom whoami
+# or
+floom --user <user> whoami
+```
+
+`WORKEROS_API_BASE` + `WORKEROS_API_SECRET` select self-hosted (OSS) mode and take precedence over any saved hosted credentials file; `mcp install` bakes `x-floom-user` into the generated client config when it is set.
+
+Credentials live at `~/.config/floom/credentials.json` (mode 0600). Existing `~/.config/workeros/credentials.json` files are still read for compatibility. `floom logout` clears both paths.
+
+## MCP install
+
+```bash
+npx -y @floomhq/floom mcp install
+```
+
+Targets hosted Floom Cloud unless self-hosted env vars or local login are used.
+It auto-detects the first existing config file and reuses saved hosted
+credentials when possible. To target a specific harness:
+
+```bash
+floom mcp install --target claude     # ~/.claude/settings.json
+floom mcp install --target cursor     # ~/.cursor/mcp.json
+floom mcp install --target vscode     # .vscode/mcp.json  (workspace-local)
+floom mcp install --target windsurf   # ~/.codeium/windsurf/mcp_config.json
+floom mcp install --target continue   # ~/.continue/.continuerc.json
+floom mcp install --target generic    # prints JSON snippet for manual paste
+```
+
+## Switching the active context
+
+```bash
+floom workspace list             # all workspaces your credentials can access, active marked with *
+floom workspace switch <name>    # by name or id; fails (exit 1) if not authenticated for it
+floom mcp list                   # configured MCP servers (connections of kind "mcp")
+floom mcp switch <name>          # set the active MCP server by label
+floom mcp test [name]            # live probe (initialize + tools/list); defaults to the active server
+```
+
+Switches persist in `~/.config/floom/credentials.json` and apply to every later CLI invocation. `workspaces`/`use` remain as aliases of `workspace`/`switch`. Workspace switching works in both modes: hosted deployments scope by membership, self-hosted deployments scope local workspaces via the legacy `x-workeros-workspace` header (which the CLI sends on every request, and `mcp install` bakes into the client config - re-run `mcp install` after switching to repoint installed MCP clients).
+
+Re-running the installer updates the existing `floom` entry, and migrates an older `workeros` entry instead of duplicating it.
+
+## Supported targets
+
+| Target | Config file written | Config shape |
+|---|---|---|
+| `claude` | `~/.claude/settings.json` | `{ mcpServers: { floom: {...} } }` |
+| `cursor` | `~/.cursor/mcp.json` | `{ mcpServers: { floom: {...} } }` |
+| `vscode` | `.vscode/mcp.json` (workspace) | `{ mcpServers: { floom: {...} } }` |
+| `windsurf` | `~/.codeium/windsurf/mcp_config.json` | `{ mcpServers: { floom: {...} } }` |
+| `continue` | `~/.continue/.continuerc.json` | `{ mcpServers: [ { name:"floom", ... } ] }` |
+| `generic` | (no file) | prints JSON snippet to stdout |
+
+All targets write **HTTP MCP transport** (`url` + `headers`) - no local subprocess is spawned. The MCP endpoint is hosted on the Floom API server.
+
+```json
+{
+  "mcpServers": {
+    "floom": {
+      "url": "https://workeros-api.floom.dev/mcp/<workspace_id>",
+      "headers": {
+        "Authorization": "Bearer <floom_token>"
+      }
+    }
+  }
+}
+```
+
+### HTTP transport (recommended - written by `floom mcp install`)
+
+Claude Code / Cursor / VS Code / Windsurf (`mcpServers` object shape), hosted
+Cloud:
+
+```json
+{
+  "mcpServers": {
+    "floom": {
+      "url": "https://workeros-api.floom.dev/mcp/<workspace_id>",
+      "headers": {
+        "Authorization": "Bearer <floom_token>"
+      }
+    }
+  }
+}
+```
+
+The published binary stays connected for that handshake when launched as `npx -p @floomhq/floom floom-mcp`.
+
+## Manual self-hosted config
+
+Use this section only when you run your own Floom API. Hosted users should let
+`floom mcp install` generate the config above.
+
+Claude Code / Cursor / VS Code / Windsurf (`mcpServers` object shape, HTTP MCP):
+
+```json
+{
+  "mcpServers": {
+    "floom": {
+      "url": "http://localhost:8000/mcp-tools/serve",
+      "headers": {
+        "x-floom-secret": "<WORKEROS_API_SECRET>"
+      }
+    }
+  }
+}
+```
+
+Continue (`~/.continue/.continuerc.json`, array shape, HTTP MCP):
+
+```json
+{
+  "mcpServers": [
+    {
+      "name": "floom",
+      "url": "http://localhost:8000/mcp-tools/serve",
+      "headers": {
+        "x-floom-secret": "<WORKEROS_API_SECRET>"
+      }
+    }
+  ]
+}
+```
+
+Replace `http://localhost:8000` with your deployed API base URL when connecting
+to a remote self-hosted instance.
+
+### Stdio transport (fallback - for harnesses that do not support HTTP MCP)
+
+```json
+{
+  "mcpServers": {
+    "floom": {
+      "command": "npx",
+      "args": ["-p", "@floomhq/floom", "floom-mcp"],
+      "env": {
+        "WORKEROS_API_SECRET": "<WORKEROS_API_SECRET>",
+        "WORKEROS_API_BASE": "http://localhost:8000"
+      }
+    }
+  }
+}
+```
+
+Or launch directly if the package is already installed: `node /path/to/@floomhq/floom/dist/server.js`.
+
+## Worker bundle CLI flow
+
+Use this path when a fresh agent has a local `workers/<id>/` folder and needs a repeatable create/edit/deploy loop:
+
+```bash
+floom login
+floom workers contract
+floom workers templates list
+floom workers templates get python-script
+floom workers validate ./workers/<id>
+floom workers push ./workers/<id>
+floom run <id> --inputs-file docs/workers/inputs/<id>.json
+floom workers info <id>
+```
+
+`workers validate` is offline. It checks that `worker.yml` parses, the entry file exists, the runtime is declared, and E2B Composio workers do not use the local `composio execute` CLI. For structured connection declarations it also verifies that referenced tool slugs are covered by `allowed_tools`.
+
+`workers push` uses `POST /workers` for new workers and `PUT /workers/{id}` for existing workers. If an older API returns 404/405 for source updates, upgrade the API before editing workers in place.
+
+Clean up stale or superseded workers without leaving the CLI:
+
+```bash
+floom workers disable <id>   # keep the worker but stop it running on triggers
+floom workers enable <id>    # re-enable a disabled worker
+floom workers delete <id>    # permanently remove it (and its runs/artifacts); prompts unless --yes
+```
+
+`workers delete` asks for confirmation; pass `-y/--yes` to skip the prompt (also required in non-interactive shells). `workers disable` is the reversible, soft option (`enabled=false`) for hiding a worker from triggers without deleting it.
+
+## Tools
+
+> **For full worked examples per tool, end-to-end recipes (deploy a worker from prompt, port a Claude skill, schedule + webhook + composio triggers), and the agent draft contract, see [docs/AGENT-COOKBOOK.md](../../docs/AGENT-COOKBOOK.md).**
+
+### Workers
+| Tool | Description |
+| --- | --- |
+| `workers.list` | List available Floom workers. |
+| `workers.get` | Read one worker, including config and recent run metadata. |
+| `workers.contract` | Read the canonical worker.yml/run.py/SKILL.md authoring contract. |
+| `workers.templates.list` | List golden worker templates agents should start from. |
+| `workers.templates.get` | Return a full template bundle with `worker_yml` plus `run_py` or `skill_md`. |
+| `workers.validate` | Validate a proposed worker bundle before creating it. |
+| `workers.create` | Create a worker from validated `worker_yml` plus `run_py` or `skill_md`. |
+| `workers.update` | Patch trigger, cron, default inputs, capabilities, or rotate webhook secret. |
+| `workers.delete` | Delete a worker and dependent run data. |
+| `workers.run` | Start a manual worker run with input values. |
+| `workers.logs` | Fetch cross-run log history, filterable by level and time. |
+| `workers.stats` | 7-day run statistics for a specific worker. |
+| `workers.timeseries` | Daily run counts and success/failure trend over N days. |
+| `workers.sample_input` | Get example input values for a worker's fields. |
+| `workers.archive` | Archive a worker (reversible). |
+| `workers.restore` | Restore an archived worker to active status. |
+| `workers.reload` | Reload all workers from disk on a self-hosted deployment. |
+| `workers.versions` | List saved versions of a worker. |
+| `workers.rollback` | Restore a worker to a previous version. |
+| `workers.alerts.list` | List configured alerts for a worker. |
+| `workers.alerts.create` | Add a failure/approval/success alert via webhook or email. |
+| `workers.alerts.delete` | Remove a worker alert. |
+
+### Runs
+| Tool | Description |
+| --- | --- |
+| `runs.list` | List runs, optionally filtered by worker id or status. |
+| `runs.get` | Read one run with logs, outputs, artifacts, and approval state. |
+| `runs.watch` | Stream SSE run events until a terminal state. |
+| `runs.cancel` | Cancel an in-progress run. |
+| `runs.replay` | Replay a completed or failed run with the same inputs. |
+
+### Approvals
+| Tool | Description |
+| --- | --- |
+| `approvals.list` | List pending approval requests across all workers. |
+| `approvals.approve` | Approve a pending run so it continues executing. |
+| `approvals.reject` | Reject a pending run, stopping it. |
+
+### Secrets
+| Tool | Description |
+| --- | --- |
+| `secrets.list` | List secret names and status. |
+| `secrets.set` | Create or update a secret value. |
+| `secrets.delete` | Delete a secret. |
+| `secrets.test` | Verify a secret exists without revealing its value. |
+
+### Connections
+| Tool | Description |
+| --- | --- |
+| `connections.list` | List configured app connections. |
+| `connections.add_mcp` | Add an MCP server connection. |
+| `connections.delete` | Remove a connection. |
+| `connections.status` | Check connection health and auth status. |
+| `connections.test` | Run a live connectivity check on a connection. |
+
+### Contexts (Brain Packs)
+| Tool | Description |
+| --- | --- |
+| `contexts.list` | List context folders. |
+| `contexts.create` | Create a new brain pack context. |
+| `contexts.delete` | Delete a brain pack and all its files. |
+| `contexts.read` | Read a file from a context. |
+| `contexts.write` | Create or update a file in a context. |
+| `contexts.upload` | Upload a binary file to a context. |
+| `contexts.delete_file` | Delete a specific file from a context. |
+| `contexts.versions` | List saved versions of a brain pack. |
+| `contexts.rollback` | Restore a brain pack to a previous version. |
+
+### Triggers & Integrations
+| Tool | Description |
+| --- | --- |
+| `triggers.list` | List integration triggers, globally or per worker/app. |
+| `integrations.catalog` | Browse all available integrations. |
+
+### Workspace
+| Tool | Description |
+| --- | --- |
+| `workspace.chat` | Send a message to the workspace agent and get a reply. |
+| `workspace.instructions.get` | Read current workspace agent system prompt. |
+| `workspace.instructions.set` | Update workspace agent system prompt. |
+| `workspace.versions` | List version history of workspace instructions. |
+| `workspace.rollback` | Restore workspace instructions to a previous version. |
+
+### Conversations
+| Tool | Description |
+| --- | --- |
+| `conversations.list` | List past workspace agent conversations. |
+| `conversations.get` | Retrieve a full conversation by ID. |
+
+### System
+| Tool | Description |
+| --- | --- |
+| `system.overview` | Full workspace dashboard - health, runs, pending approvals, alerts. |
+| `system.stats` | 7-day aggregate run statistics across the whole workspace. |
+| `system.info` | Platform version and configuration flags. |
+| `system.alerts` | Active system-wide alerts. |
+
+## Quick example - write + deploy + verify a worker in one MCP session
+
+```js
+// 1. Create
+await workers.create({
+  worker_yml: `
+schema_version: "0.3"
+name: text-summarizer
+title: Text Summarizer
+description: Summarizes any text in 3 bullets using GPT-4.1.
+entrypoint: run.py
+exec:
+  command: python run.py
+  runtime: python311
+  runner: e2b
+  entry: run.py
+  inputs:
+    - { name: text, kind: scalar, type: textarea, required: true, label: Text }
+  outputs:
+    - { name: summary, kind: file, media_type: text/markdown, path: out/summary.md, required: true, label: Summary }
+  secrets: [OPENAI_API_KEY]
+capabilities:
+  secrets: [OPENAI_API_KEY]
+  network: { egress: true }
+trigger: { type: manual }
+`,
+  run_py: `
+def run(inputs, context):
+    client = context.openai()
+    r = client.chat.completions.create(
+        model="gpt-4.1-mini",
+        messages=[
+            {"role": "system", "content": "Summarize in 3 bullets."},
+            {"role": "user", "content": inputs["text"]},
+        ],
+    )
+    summary = r.choices[0].message.content
+    context.write_output("summary", summary)
+    return {"summary": summary}
+`,
+});
+
+// 2. Run
+const { run_id } = await workers.run({
+  id: "text-summarizer",
+  inputs: { text: "Lorem ipsum dolor sit amet..." },
+});
+
+// 3. Watch until terminal
+const watched = await runs.watch({ id: run_id });
+console.log(watched.status);
+
+// 4. Verify
+const { run } = await runs.get({ id: run_id });
+console.log(run.status); // "succeeded"
+console.log(run.output?.summary);
+```
+
+See [docs/AGENT-COOKBOOK.md section 1](../../docs/AGENT-COOKBOOK.md) for the full annotated walkthrough plus six more recipes (agent mode, Gmail trigger, cron schedule, webhook, approval gate, claude-skill port).