@floomhq/floom 5.0.11 → 5.1.0

package/dist/lib/telemetry.js

@@ -0,0 +1,85 @@
+import { FloomApiClient } from "./api.js";
+import { readCredentials } from "./credentials.js";
+function telemetryDisabled() {
+    const value = (process.env.FLOOM_CLI_TELEMETRY_DISABLED || process.env.WORKEROS_CLI_TELEMETRY_DISABLED || "")
+        .trim()
+        .toLowerCase();
+    return value === "1" || value === "true" || value === "yes" || value === "on";
+}
+export function apiBaseKind(apiBase) {
+    let host = "";
+    try {
+        host = new URL(apiBase).hostname.toLowerCase();
+    }
+    catch {
+        return "custom";
+    }
+    if (host === "localhost" || host === "127.0.0.1" || host === "::1") {
+        return "local";
+    }
+    if (host.endsWith("floom.dev") ||
+        host.endsWith("floom.ai") ||
+        host.endsWith("floom.app") ||
+        host.endsWith("workeros.com")) {
+        return "cloud";
+    }
+    return "custom";
+}
+async function telemetryClient() {
+    if (telemetryDisabled())
+        return null;
+    try {
+        const credentials = await readCredentials();
+        if (!credentials)
+            return null;
+        return { client: new FloomApiClient(credentials.api_base, credentials), credentials };
+    }
+    catch {
+        return null;
+    }
+}
+export async function emitCliCommandTelemetry(payload) {
+    try {
+        const resolved = await telemetryClient();
+        if (!resolved)
+            return;
+        await resolved.client.requestJson("POST", "/telemetry/cli-command", {
+            body: {
+                command: payload.command,
+                success: payload.success,
+                duration_ms: Math.max(0, Math.floor(payload.duration_ms)),
+                exit_code: payload.exit_code,
+                api_base_kind: apiBaseKind(resolved.credentials.api_base),
+                worker_id: payload.worker_id,
+                run_id: payload.run_id,
+            },
+        });
+    }
+    catch {
+        // Analytics must never affect CLI behavior.
+    }
+}
+export async function emitMcpToolTelemetry(payload) {
+    try {
+        const resolved = await telemetryClient();
+        if (!resolved)
+            return;
+        await resolved.client.requestJson("POST", "/telemetry/mcp-tool", {
+            body: {
+                tool_name: payload.tool_name,
+                success: payload.success,
+                duration_ms: Math.max(0, Math.floor(payload.duration_ms)),
+                auth_method: payload.auth_method,
+                worker_id: payload.worker_id,
+                run_id: payload.run_id,
+                status_code: payload.status_code,
+                error_category: payload.error_category,
+                is_custom_tool: payload.is_custom_tool || false,
+            },
+        });
+    }
+    catch {
+        // Analytics must never affect MCP tool behavior.
+    }
+}
+//# sourceMappingURL=telemetry.js.map

package/dist/lib/telemetry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"telemetry.js","sourceRoot":"","sources":["../../src/lib/telemetry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAC1C,OAAO,EAAE,eAAe,EAA0B,MAAM,kBAAkB,CAAC;AAuB3E,SAAS,iBAAiB;IACxB,MAAM,KAAK,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,4BAA4B,IAAI,OAAO,CAAC,GAAG,CAAC,+BAA+B,IAAI,EAAE,CAAC;SAC1G,IAAI,EAAE;SACN,WAAW,EAAE,CAAC;IACjB,OAAO,KAAK,KAAK,GAAG,IAAI,KAAK,KAAK,MAAM,IAAI,KAAK,KAAK,KAAK,IAAI,KAAK,KAAK,IAAI,CAAC;AAChF,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,OAAe;IACzC,IAAI,IAAI,GAAG,EAAE,CAAC;IACd,IAAI,CAAC;QACH,IAAI,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;IACjD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,IAAI,IAAI,KAAK,WAAW,IAAI,IAAI,KAAK,WAAW,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;QACnE,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,IACE,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC;QAC1B,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC;QACzB,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC;QAC1B,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,EAC7B,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,KAAK,UAAU,eAAe;IAC5B,IAAI,iBAAiB,EAAE;QAAE,OAAO,IAAI,CAAC;IACrC,IAAI,CAAC;QACH,MAAM,WAAW,GAAG,MAAM,eAAe,EAAE,CAAC;QAC5C,IAAI,CAAC,WAAW;YAAE,OAAO,IAAI,CAAC;QAC9B,OAAO,EAAE,MAAM,EAAE,IAAI,cAAc,CAAC,WAAW,CAAC,QAAQ,EAAE,WAAW,CAAC,EAAE,WAAW,EAAE,CAAC;IACxF,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAAC,OAA4B;IACxE,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,eAAe,EAAE,CAAC;QACzC,IAAI,CAAC,QAAQ;YAAE,OAAO;QACtB,MAAM,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,wBAAwB,EAAE;YAClE,IAAI,EAAE;gBACJ,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,WAAW,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;gBACzD,SAAS,EAAE,OAAO,CAAC,SAAS;gBAC5B,aAAa,EAAE,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC,QAAQ,CAAC;gBACzD,SAAS,EAAE,OAAO,CAAC,SAAS;gBAC5B,MAAM,EAAE,OAAO,CAAC,MAAM;aACvB;SACF,CAAC,CAAC;IACL,CAAC;IAAC,MAAM,CAAC;QACP,4CAA4C;IAC9C,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,OAA4B;IACrE,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,eAAe,EAAE,CAAC;QACzC,IAAI,CAAC,QAAQ;YAAE,OAAO;QACtB,MAAM,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,qBAAqB,EAAE;YAC/D,IAAI,EAAE;gBACJ,SAAS,EAAE,OAAO,CAAC,SAAS;gBAC5B,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,WAAW,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;gBACzD,WAAW,EAAE,OAAO,CAAC,WAAW;gBAChC,SAAS,EAAE,OAAO,CAAC,SAAS;gBAC5B,MAAM,EAAE,OAAO,CAAC,MAAM;gBACtB,WAAW,EAAE,OAAO,CAAC,WAAW;gBAChC,cAAc,EAAE,OAAO,CAAC,cAAc;gBACtC,cAAc,EAAE,OAAO,CAAC,cAAc,IAAI,KAAK;aAChD;SACF,CAAC,CAAC;IACL,CAAC;IAAC,MAAM,CAAC;QACP,iDAAiD;IACnD,CAAC;AACH,CAAC"}

package/dist/lib/worker-authoring.js

@@ -50,57 +50,57 @@ export const WORKER_TEMPLATES = [
         title: "Python Script Worker",
         description: "Deterministic E2B worker that reads inputs.json and writes result.json.",
         mode: "pure-script",
-        worker_yml: `schema_version: "0.3"
-name: text-normalizer
-title: Text Normalizer
-description: Normalize a text input and return the normalized value.
-version: "0.1.0"
-entrypoint: run.py
-trigger:
-  type: manual
-exec:
-  mode: pure-script
-  entry: run.py
-  runtime: python311
-  runner: e2b
-  command: python run.py
-  inputs:
-    - name: text
-      label: Text
-      type: string
-      kind: scalar
-      required: true
-  outputs:
-    - name: normalized
-      label: Normalized text
-      type: string
-      kind: scalar
-      required: true
-capabilities:
-  network:
-    egress: false
-  secrets: []
-  connections: []
+        worker_yml: `schema_version: "0.3"
+name: text-normalizer
+title: Text Normalizer
+description: Normalize a text input and return the normalized value.
+version: "0.1.0"
+entrypoint: run.py
+trigger:
+  type: manual
+exec:
+  mode: pure-script
+  entry: run.py
+  runtime: python311
+  runner: e2b
+  command: python run.py
+  inputs:
+    - name: text
+      label: Text
+      type: string
+      kind: scalar
+      required: true
+  outputs:
+    - name: normalized
+      label: Normalized text
+      type: string
+      kind: scalar
+      required: true
+capabilities:
+  network:
+    egress: false
+  secrets: []
+  connections: []
 `,
-        run_py: `import json
-from pathlib import Path
-
-
-def main() -> None:
-    inputs_path = Path("inputs.json")
-    inputs = json.loads(inputs_path.read_text(encoding="utf-8")) if inputs_path.exists() else {}
-    text = str(inputs.get("text", "")).strip()
-    result = {
-        "status": "success",
-        "outputs": {"normalized": " ".join(text.split())},
-        "artifacts": [],
-        "error": None,
-    }
-    Path("result.json").write_text(json.dumps(result), encoding="utf-8")
-
-
-if __name__ == "__main__":
-    main()
+        run_py: `import json
+from pathlib import Path
+
+
+def main() -> None:
+    inputs_path = Path("inputs.json")
+    inputs = json.loads(inputs_path.read_text(encoding="utf-8")) if inputs_path.exists() else {}
+    text = str(inputs.get("text", "")).strip()
+    result = {
+        "status": "success",
+        "outputs": {"normalized": " ".join(text.split())},
+        "artifacts": [],
+        "error": None,
+    }
+    Path("result.json").write_text(json.dumps(result), encoding="utf-8")
+
+
+if __name__ == "__main__":
+    main()
 `,
         notes: [
             "Use this when the job can be completed deterministically in code.",
@@ -112,54 +112,54 @@ if __name__ == "__main__":
         title: "Gmail Summary Agent",
         description: "Agent-mode worker that uses a Gmail connection and produces a markdown summary.",
         mode: "agent",
-        worker_yml: `schema_version: "0.3"
-name: gmail-summary-agent
-title: Gmail Summary Agent
-description: Summarize recent Gmail messages into a concise markdown brief.
-version: "0.1.0"
-entrypoint: SKILL.md
-trigger:
-  type: manual
-connections:
-  - app: gmail
-    allowed_tools:
-      - GMAIL_FETCH_EMAILS
-exec:
-  mode: agent
-  entry: SKILL.md
-  runtime: python311
-  runner: e2b
-  inputs:
-    - name: query
-      label: Gmail query
-      type: string
-      kind: scalar
-      required: false
-      default: newer_than:1d
-  outputs:
-    - name: summary
-      label: Summary
-      kind: file
-      media_type: text/markdown
-      path: out/summary.md
-      required: true
-limits:
-  max_tool_iterations: 60
-  max_output_tokens: 100000
-  max_total_tokens: 1000000
-  timeout_seconds: 300
-capabilities:
-  network:
-    egress: true
-  secrets: []
-  connections:
-    - gmail
+        worker_yml: `schema_version: "0.3"
+name: gmail-summary-agent
+title: Gmail Summary Agent
+description: Summarize recent Gmail messages into a concise markdown brief.
+version: "0.1.0"
+entrypoint: SKILL.md
+trigger:
+  type: manual
+connections:
+  - app: gmail
+    allowed_tools:
+      - GMAIL_FETCH_EMAILS
+exec:
+  mode: agent
+  entry: SKILL.md
+  runtime: python311
+  runner: e2b
+  inputs:
+    - name: query
+      label: Gmail query
+      type: string
+      kind: scalar
+      required: false
+      default: newer_than:1d
+  outputs:
+    - name: summary
+      label: Summary
+      kind: file
+      media_type: text/markdown
+      path: out/summary.md
+      required: true
+limits:
+  max_tool_iterations: 60
+  max_output_tokens: 100000
+  max_total_tokens: 1000000
+  timeout_seconds: 300
+capabilities:
+  network:
+    egress: true
+  secrets: []
+  connections:
+    - gmail
 `,
-        skill_md: `# Gmail Summary Agent
-
-Fetch recent Gmail messages using the declared Gmail connection, summarize the important items, and write a markdown brief to out/summary.md.
-
-Call the Gmail runtime tool once with the declared allowed tool, summarize the returned messages, then call finish_with_outputs with the output named summary. Do not ask the user for OAuth tokens or passwords.
+        skill_md: `# Gmail Summary Agent
+
+Fetch recent Gmail messages using the declared Gmail connection, summarize the important items, and write a markdown brief to out/summary.md.
+
+Call the Gmail runtime tool once with the declared allowed tool, summarize the returned messages, then call finish_with_outputs with the output named summary. Do not ask the user for OAuth tokens or passwords.
 `,
         notes: [
             "Use agent mode when the work needs reasoning or tool calls.",
@@ -171,64 +171,64 @@ Call the Gmail runtime tool once with the declared allowed tool, summarize the r
         title: "Approval Script Worker",
         description: "Script worker that prepares a human approval payload before an external action.",
         mode: "pure-script",
-        worker_yml: `schema_version: "0.3"
-name: approval-script
-title: Approval Script
-description: Build an approval payload for a proposed outbound action.
-version: "0.1.0"
-entrypoint: run.py
-trigger:
-  type: manual
-exec:
-  mode: pure-script
-  entry: run.py
-  runtime: python311
-  runner: e2b
-  command: python run.py
-  inputs:
-    - name: message
-      label: Message
-      type: string
-      kind: scalar
-      required: true
-  outputs:
-    - name: plan
-      label: Approval plan
-      kind: file
-      media_type: text/markdown
-      path: out/plan.md
-      required: true
-approvals:
-  required: true
-  label: Approve outbound action
-capabilities:
-  network:
-    egress: false
-  secrets: []
-  connections: []
+        worker_yml: `schema_version: "0.3"
+name: approval-script
+title: Approval Script
+description: Build an approval payload for a proposed outbound action.
+version: "0.1.0"
+entrypoint: run.py
+trigger:
+  type: manual
+exec:
+  mode: pure-script
+  entry: run.py
+  runtime: python311
+  runner: e2b
+  command: python run.py
+  inputs:
+    - name: message
+      label: Message
+      type: string
+      kind: scalar
+      required: true
+  outputs:
+    - name: plan
+      label: Approval plan
+      kind: file
+      media_type: text/markdown
+      path: out/plan.md
+      required: true
+approvals:
+  required: true
+  label: Approve outbound action
+capabilities:
+  network:
+    egress: false
+  secrets: []
+  connections: []
 `,
-        run_py: `import json
-from pathlib import Path
-
-
-def main() -> None:
-    inputs = json.loads(Path("inputs.json").read_text(encoding="utf-8"))
-    message = str(inputs.get("message", "")).strip()
-    out_dir = Path("out")
-    out_dir.mkdir(exist_ok=True)
-    plan_path = out_dir / "plan.md"
-    plan_path.write_text(f"# Proposed action\\n\\n{message}\\n", encoding="utf-8")
-    result = {
-        "status": "success",
-        "outputs": {"plan": str(plan_path)},
-        "artifacts": [{"name": "plan.md", "path": str(plan_path), "type": "text/markdown"}],
-        "error": None,
-    }
-    Path("result.json").write_text(json.dumps(result), encoding="utf-8")
-
-
-if __name__ == "__main__":
-    main()
+        run_py: `import json
+from pathlib import Path
+
+
+def main() -> None:
+    inputs = json.loads(Path("inputs.json").read_text(encoding="utf-8"))
+    message = str(inputs.get("message", "")).strip()
+    out_dir = Path("out")
+    out_dir.mkdir(exist_ok=True)
+    plan_path = out_dir / "plan.md"
+    plan_path.write_text(f"# Proposed action\\n\\n{message}\\n", encoding="utf-8")
+    result = {
+        "status": "success",
+        "outputs": {"plan": str(plan_path)},
+        "artifacts": [{"name": "plan.md", "path": str(plan_path), "type": "text/markdown"}],
+        "error": None,
+    }
+    Path("result.json").write_text(json.dumps(result), encoding="utf-8")
+
+
+if __name__ == "__main__":
+    main()
 `,
         notes: [
             "Use approvals.required when a human must review before publication or side effects.",

package/dist/server.js

@@ -7,6 +7,7 @@ import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js"
 import { z } from "zod";
 import { readCredentials } from "./lib/credentials.js";
 import { WORKER_AUTHORING_CONTRACT, getWorkerTemplate, listWorkerTemplates, validateWorkerDraft, } from "./lib/worker-authoring.js";
+import { emitMcpToolTelemetry } from "./lib/telemetry.js";
 const DEFAULT_API_BASE = "http://localhost:8000";
 const TERMINAL_RUN_STATUSES = new Set([
     "success",
@@ -27,14 +28,14 @@ class FloomApiError extends Error {
     }
 }
 function apiBase() {
-    return (process.env.WORKEROS_API_BASE || DEFAULT_API_BASE).replace(/\/+$/, "");
+    return (process.env.FLOOM_API_BASE || process.env.WORKEROS_API_BASE || DEFAULT_API_BASE).replace(/\/+$/, "");
 }
 function hostedModeRequested() {
     const value = (process.env.WORKEROS_CLOUD || "").trim().toLowerCase();
     return value === "1" || value === "true" || value === "yes" || value === "on";
 }
 function isHostedApi() {
-    return Boolean(process.env.WORKEROS_API_TOKEN) || hostedModeRequested();
+    return Boolean(process.env.FLOOM_TOKEN || process.env.WORKEROS_API_TOKEN) || hostedModeRequested();
 }
 function resolvePath(path) {
     if (!isHostedApi())
@@ -62,14 +63,14 @@ function activeWorkspaceId() {
 }
 function authHeader() {
     const headers = {};
-    const token = process.env.WORKEROS_API_TOKEN?.trim();
+    const token = (process.env.FLOOM_TOKEN || process.env.WORKEROS_API_TOKEN || "").trim();
     if (token) {
         headers["x-floom-token"] = token;
     }
     else {
         const secret = process.env.WORKEROS_API_SECRET?.trim();
         if (!secret) {
-            throw new Error("WORKEROS_API_TOKEN or WORKEROS_API_SECRET is required");
+            throw new Error("FLOOM_TOKEN, WORKEROS_API_TOKEN, or WORKEROS_API_SECRET is required");
         }
         headers["x-floom-secret"] = secret;
         // Self-hosted engines with user-header scope require x-floom-user (OSS only).
@@ -158,6 +159,58 @@ async function callTool(handler) {
         return errorResult(error);
     }
 }
+function mcpTelemetryIds(result) {
+    const content = result.structuredContent && typeof result.structuredContent === "object"
+        ? result.structuredContent
+        : {};
+    const workerId = typeof content.worker_id === "string"
+        ? content.worker_id
+        : typeof content.id === "string" && String(content.id).startsWith("w")
+            ? String(content.id)
+            : undefined;
+    const runId = typeof content.run_id === "string"
+        ? content.run_id
+        : typeof content.id === "string" && String(content.id).startsWith("run")
+            ? String(content.id)
+            : undefined;
+    const status = typeof content.status === "number" ? content.status : undefined;
+    return { worker_id: workerId, run_id: runId, status_code: status };
+}
+function installMcpTelemetry(server) {
+    const originalRegisterTool = server.registerTool.bind(server);
+    server.registerTool = (name, config, handler) => {
+        return originalRegisterTool(name, config, async (...args) => {
+            const startedAt = Date.now();
+            try {
+                const result = await handler(...args);
+                const ids = mcpTelemetryIds(result);
+                await emitMcpToolTelemetry({
+                    tool_name: name,
+                    success: !result.isError,
+                    duration_ms: Date.now() - startedAt,
+                    auth_method: "mcp_stdio",
+                    worker_id: ids.worker_id,
+                    run_id: ids.run_id,
+                    status_code: ids.status_code,
+                    error_category: result.isError ? "tool_error" : undefined,
+                    is_custom_tool: false,
+                });
+                return result;
+            }
+            catch (error) {
+                await emitMcpToolTelemetry({
+                    tool_name: name,
+                    success: false,
+                    duration_ms: Date.now() - startedAt,
+                    auth_method: "mcp_stdio",
+                    error_category: "internal_error",
+                    is_custom_tool: false,
+                });
+                throw error;
+            }
+        });
+    };
+}
 async function parseResponse(response) {
     const text = await response.text();
     if (!text) {
@@ -644,6 +697,7 @@ export function createServer() {
             "content rather than the user, or for passwords used to authenticate, payment/identity data, or " +
             "OAuth-ing as the user into a third party.)",
     });
+    installMcpTelemetry(server);
     const workerContractYamlDescription = "WorkerContract YAML content. Required top-level fields: schema_version: \"0.3\", name, title, description, version, exec, and trigger. " +
         "Before creating a worker, call workers.contract, choose a starting point with workers.templates.get, then call workers.validate. " +
         "For script workers, exec must include mode: \"pure-script\", entry: \"run.py\", runtime: \"python311\", runner: \"e2b\", command: \"python run.py\", plus exec.inputs and exec.outputs arrays. " +
@@ -742,14 +796,13 @@ export function createServer() {
     }, async ({ id }) => callTool(async () => jsonResult(await request("DELETE", `/workers/${encodeURIComponent(id)}`), "Worker deleted.")));
     server.registerTool("workers.run", {
         title: "Run Worker",
-        description: "Start a manual Floom worker run.",
+        description: "Start a Floom worker run through MCP.",
         inputSchema: {
             id: z.string().min(1).describe("Floom worker id."),
             inputs: z.record(z.string(), z.unknown()).default({}).describe("Input values for this run."),
-            trigger_source: z.string().default("manual").describe("Run trigger source."),
         },
         annotations: { readOnlyHint: false, destructiveHint: false, idempotentHint: false, openWorldHint: true },
-    }, async ({ id, inputs, trigger_source }) => callTool(async () => jsonResult(await request("POST", `/workers/${encodeURIComponent(id)}/runs`, { inputs, trigger_source }))));
+    }, async ({ id, inputs }) => callTool(async () => jsonResult(await request("POST", `/workers/${encodeURIComponent(id)}/runs`, { inputs, trigger_source: "mcp" }))));
     server.registerTool("runs.list", {
         title: "List Runs",
         description: "List Floom runs, optionally filtered by worker id.",