@dbx-tools/appkit-mastra 0.1.3 → 0.1.5

package/src/genie.ts

@@ -11,14 +11,17 @@
  * upstream change in `@databricks/appkit` flows in automatically.
  *
  * As Genie streams its long-running events (`FETCHING_METADATA` →
- * `ASKING_AI` → `EXECUTING_QUERY` → `COMPLETED`, plus SQL queries and
- * row data in `message_result.attachments` / `query_result`), the tool
- * forwards a normalised {@link GenieProgress} discriminated union out
- * through `ctx.writer` so the client can render incremental feedback
- * (status pill, SQL code block, row count) while the LLM still sees a
- * single clean final payload.
+ * `ASKING_AI` → `EXECUTING_QUERY` → `COMPLETED`, plus SQL text and
+ * follow-ups in `message_result.attachments`), the tool forwards a
+ * normalised {@link GenieProgress} discriminated union out through
+ * `ctx.writer` so the client can render an incremental loading pill.
+ * Row payloads from `query_result` are intentionally discarded - the
+ * LLM never sees rows, and charts come from the separate
+ * `render_data` tool when the model decides one is useful.
  */
 
+import { randomUUID } from "node:crypto";
+
 import { genie } from "@databricks/appkit";
 import { stringUtils } from "@dbx-tools/appkit-shared";
 import { createTool } from "@mastra/core/tools";
@@ -42,14 +45,109 @@ export type GenieStreamEvent =
 /** Conversation history returned by `genie.exports().getConversation`. */
 export type GenieConversation = Awaited<ReturnType<GenieExports["getConversation"]>>;
 
-type GenieMessage = Extract<GenieStreamEvent, { type: "message_result" }>["message"];
-type GenieStatement = Extract<GenieStreamEvent, { type: "query_result" }>["data"];
+/**
+ * Per-dataset metadata surfaced to the LLM. The actual rows are
+ * dispatched separately as a `kind: "chart"` writer event so the
+ * model never has the rows in its context (token cost stays flat
+ * regardless of dataset size). The model uses `chartId` to
+ * reference the chart inline via the `[[chart:<chartId>]]` marker.
+ */
+const datasetSchema = z.object({
+  chartId: z.string().describe(stringUtils.toDescription`
+    Short id (8 hex chars) for the chart-render slot the host UI
+    has staged for this dataset. Embed
+    \`[[chart:<chartId>]]\` on its own line in your reply at the
+    position you want the chart to appear; the client renders it
+    inline. Do not paraphrase the dataset's rows in prose - the
+    chart is the rendering.
+  `),
+  title: z.string().optional().describe(stringUtils.toDescription`
+    Genie's own title for the SQL that produced this dataset.
+    Useful as a label when you reference the chart in prose.
+  `),
+  description: z.string().optional().describe(stringUtils.toDescription`
+    Genie's prose description of the SQL, if any.
+  `),
+  columns: z.array(z.string()).describe(stringUtils.toDescription`
+    Column names in display order. Use these when describing what
+    is being charted (e.g. "trend of fill_rate over date").
+  `),
+  rowCount: z.number().describe(stringUtils.toDescription`
+    Total rows in this dataset. Mention only if it adds context
+    (e.g. "across the last 90 days").
+  `),
+  sql: z
+    .string()
+    .optional()
+    .describe(stringUtils.toDescription`
+      SQL Genie generated and executed. The host UI shows this on
+      demand; you do not need to repeat it.
+    `),
+});
+
+/**
+ * Top-level output schema returned to the LLM from a Genie tool
+ * call. The `datasets` array is intentionally metadata-only - row
+ * data rides a writer event the host UI consumes directly and is
+ * not in the model's context.
+ */
+const genieToolOutputSchema = z.object({
+  conversationId: z
+    .string()
+    .optional()
+    .describe(stringUtils.toDescription`
+      Pass back on the next call to continue the same Genie thread.
+    `),
+  genieAnswer: z
+    .string()
+    .optional()
+    .describe(stringUtils.toDescription`
+      Genie's natural-language answer to the question. Pass this
+      through to the user (verbatim, or as the basis of your
+      reply). Genie may have run multiple SQL queries and tools to
+      produce this; the full text is the answer.
+    `),
+  datasets: z
+    .array(datasetSchema)
+    .optional()
+    .describe(stringUtils.toDescription`
+      Datasets Genie produced for this turn (one per executed SQL
+      statement). Each entry is metadata only; the rows are
+      streamed to the host UI out-of-band. To render any of these
+      as a chart inline in your reply, embed
+      \`[[chart:<chartId>]]\` where you want the chart to appear.
+      Do not paraphrase the rows - the chart is what the user
+      should see; your prose should add interpretation
+      (highlights, deltas, anomalies) around the chart.
+    `),
+  suggestedFollowUps: z
+    .array(z.string())
+    .optional()
+    .describe(stringUtils.toDescription`
+      Follow-up question suggestions Genie produced. The host UI
+      renders these as clickable buttons; you do not need to list
+      them in your reply.
+    `),
+  error: z
+    .string()
+    .optional()
+    .describe(stringUtils.toDescription`
+      Genie-side error message if the request failed.
+    `),
+});
+
+type DrainResult = z.infer<typeof genieToolOutputSchema>;
+type DatasetMeta = z.infer<typeof datasetSchema> & { statementId: string };
 
 /**
- * Normalised progress event surfaced to the UI as a Mastra `tool-output`
- * chunk. The discriminator (`kind`) keeps the union open for future
- * Genie features (charts, attachments, retries) without forcing the
- * client to know any Genie wire format.
+ * Normalised progress event surfaced to the UI as a Mastra
+ * `tool-output` chunk. Loading pill events (`started`, `status`,
+ * `sql`, `suggested`, `error`) are pure UI metadata and never reach
+ * the LLM. The `chart` variant carries the rows from a Genie SQL
+ * statement so the host UI's `<ChartSlot>` can render them inline
+ * via the same path as the `render_data` tool; the LLM still only
+ * sees the matching {@link datasetSchema} metadata in
+ * `genieAnswer`'s sibling `datasets[]` field.
  */
 export type GenieProgress =
   | { kind: "started"; conversationId: string; messageId: string; spaceId: string }
@@ -61,31 +159,131 @@ export type GenieProgress =
       description?: string;
       statementId?: string;
     }
-  | { kind: "data"; rowCount: number; columns: string[] }
+  | {
+      kind: "chart";
+      chartId: string;
+      title: string;
+      description?: string;
+      data: Array<Record<string, unknown>>;
+    }
   | { kind: "text"; content: string }
   | { kind: "suggested"; questions: string[] }
   | { kind: "error"; error: string };
 
 const sendMessageSchema = z.object({
-  content: z.string().describe("Natural-language question to send to the Genie space."),
+  content: z.string().describe(stringUtils.toDescription`
+    Natural-language question to send to the Genie space.
+  `),
   conversationId: z
     .string()
     .optional()
-    .describe(
-      "Optional Genie conversation id to continue an earlier thread. " +
-        "Omit on the first call; pass the id returned in the previous " +
-        "result's `conversationId` to follow up.",
-    ),
+    .describe(stringUtils.toDescription`
+      Optional Genie conversation id to continue an earlier thread.
+      Omit on the first call; pass the id returned in the previous
+      result's \`conversationId\` to follow up.
+    `),
 });
 
 const getConversationSchema = z.object({
-  alias: z
-    .string()
-    .describe(
-      "Alias of the Genie space the conversation belongs to (matches the " +
-        "key in the genie plugin's `spaces` config).",
-    ),
-  conversationId: z.string().describe("Genie conversation id whose history to fetch."),
+  alias: z.string().describe(stringUtils.toDescription`
+    Alias of the Genie space the conversation belongs to (matches
+    the key in the genie plugin's \`spaces\` config).
+  `),
+  conversationId: z.string().describe(stringUtils.toDescription`
+    Genie conversation id whose history to fetch.
+  `),
+});
+
+/** Per-attachment shape returned inside a stored Genie message. */
+const genieAttachmentSchema = z.object({
+  attachmentId: z.string().optional().describe(stringUtils.toDescription`
+    Genie attachment id; internal bookkeeping.
+  `),
+  query: z
+    .object({
+      title: z.string().optional().describe(stringUtils.toDescription`
+        Genie's title for the SQL, if any.
+      `),
+      description: z.string().optional().describe(stringUtils.toDescription`
+        Genie's prose description of the SQL, if any.
+      `),
+      query: z.string().optional().describe(stringUtils.toDescription`
+        SQL Genie generated and executed.
+      `),
+      statementId: z.string().optional().describe(stringUtils.toDescription`
+        Statement-execution id; internal bookkeeping.
+      `),
+    })
+    .optional()
+    .describe(stringUtils.toDescription`
+      SQL Genie attached to this message, if it ran any.
+    `),
+  text: z
+    .object({
+      content: z.string().optional().describe(stringUtils.toDescription`
+        Genie's natural-language answer text for this attachment.
+      `),
+    })
+    .optional()
+    .describe(stringUtils.toDescription`
+      Per-attachment text content (independent of the message-level
+      \`content\` field).
+    `),
+  suggestedQuestions: z
+    .array(z.string())
+    .optional()
+    .describe(stringUtils.toDescription`
+      Follow-up question suggestions Genie generated for this turn.
+    `),
+});
+
+/** Single message inside a Genie conversation history page. */
+const genieMessageSchema = z.object({
+  messageId: z.string().describe(stringUtils.toDescription`
+    Genie message id; internal bookkeeping.
+  `),
+  conversationId: z.string().describe(stringUtils.toDescription`
+    Conversation id this message belongs to.
+  `),
+  spaceId: z.string().describe(stringUtils.toDescription`
+    Genie space id this message belongs to.
+  `),
+  status: z.string().describe(stringUtils.toDescription`
+    Genie message status (\`COMPLETED\`, \`FAILED\`, etc.).
+  `),
+  content: z.string().describe(stringUtils.toDescription`
+    Outer message-level natural-language content Genie wrote.
+  `),
+  attachments: z
+    .array(genieAttachmentSchema)
+    .optional()
+    .describe(stringUtils.toDescription`
+      Attachments (SQL queries, text blocks, suggested follow-ups)
+      Genie produced for this message.
+    `),
+  error: z.string().optional().describe(stringUtils.toDescription`
+    Genie-side error attached to this message, if any.
+  `),
+});
+
+/**
+ * Output schema for the \`genie_get_conversation\` tool. Mirrors
+ * AppKit's \`GenieConversationHistoryResponse\` so the model gets a
+ * clear, typed view of prior messages instead of an opaque blob.
+ */
+const genieGetConversationOutputSchema = z.object({
+  conversationId: z.string().describe(stringUtils.toDescription`
+    Conversation id you fetched.
+  `),
+  spaceId: z.string().describe(stringUtils.toDescription`
+    Genie space the conversation belongs to.
+  `),
+  messages: z.array(genieMessageSchema).describe(stringUtils.toDescription`
+    Messages in the conversation, oldest to newest. Each
+    \`message.content\` is Genie's natural-language answer for
+    that turn; attachments carry the SQL and follow-ups Genie
+    produced.
+  `),
 });
 
 /**
@@ -116,14 +314,29 @@ export function buildGenieTools(opts: {
     const id = defaultGenieToolName(alias);
     tools[id] = createTool({
       id,
-      description:
-        `Ask the Databricks Genie space "${alias}" a natural-language ` +
-        "question. Genie translates the question to SQL, runs it against " +
-        "the configured datasets, and returns a written answer plus any " +
-        "SQL statements it executed. Returns `{ conversationId, content, " +
-        "queries, ... }`; pass `conversationId` back in to follow up in " +
-        "the same Genie thread.",
+      description: stringUtils.toDescription`
+        Ask the Databricks Genie space "${alias}" a single
+        natural-language question. Genie translates it to SQL,
+        runs the SQL against the configured datasets, and returns
+        \`genieAnswer\` (its prose answer) plus \`datasets[]\`
+        (one metadata entry per executed query). Each dataset
+        carries a short \`chartId\`; embed
+        \`[[chart:<chartId>]]\` on its own line in your reply at
+        the position where you want that data rendered as an
+        inline chart. Do not paraphrase row values - the chart is
+        the rendering. Add interpretation around the chart
+        (highlights, deltas, anomalies, takeaways) instead of
+        repeating numbers.
+
+        Calling this tool is expensive; issue **one** focused
+        question per user turn. If the first answer doesn't fit,
+        ask the user a clarifying question rather than
+        re-querying with rephrased intent. Prefer aggregated
+        questions over raw-row queries (e.g. ask for "monthly
+        averages" instead of "all rows" for time-series).
+      `,
       inputSchema: sendMessageSchema,
+      outputSchema: genieToolOutputSchema,
       execute: async ({ content, conversationId }, ctx) => {
         const stream = opts.exports.sendMessage(alias, content, conversationId, {
           signal: opts.signal,
@@ -135,11 +348,13 @@ export function buildGenieTools(opts: {
 
   tools.genie_get_conversation = createTool({
     id: "genie_get_conversation",
-    description:
-      "Fetch the full message history of a prior Genie conversation by id. " +
-      "Use when the user references an earlier Genie thread by id, or to " +
-      "inspect attachments / SQL from previous turns.",
+    description: stringUtils.toDescription`
+      Fetch the full message history of a prior Genie conversation
+      by id. Use when the user references an earlier Genie thread
+      by id, or to inspect attachments / SQL from previous turns.
+    `,
     inputSchema: getConversationSchema,
+    outputSchema: genieGetConversationOutputSchema,
     execute: async ({ alias, conversationId }) => {
       return opts.exports.getConversation(alias, conversationId, opts.signal);
     },
@@ -149,42 +364,53 @@ export function buildGenieTools(opts: {
 }
 
 /**
- * Drain the genie `sendMessage` AsyncGenerator into a flat result the
- * agent's calling LLM can reason about. Final assistant text is pulled
- * from the last `message_result`; SQL statements are extracted from
- * `query_result` events; conversation / message ids are surfaced so the
- * caller can pass `conversationId` back into a follow-up tool call.
+ * Drain the genie `sendMessage` AsyncGenerator into a flat result
+ * the agent's calling LLM can reason about, while forwarding
+ * progress and chart events to the host UI.
+ *
+ * Three streams of output happen in parallel:
  *
- * When a Mastra `writer` is passed (i.e. the tool runs inside an agent
- * stream), normalised {@link GenieProgress} events are pushed mid-flight
- * so the UI can show status changes, SQL, and row counts as they
- * happen instead of staring at a spinner for the full Genie round-trip.
+ * 1. {@link GenieProgress} pill events on the writer (`started`,
+ *    `status`, `sql`, `suggested`, `error`) drive the loading
+ *    pill in the chat bubble.
+ * 2. `kind: "chart"` events on the writer carry the row payload
+ *    from each Genie SQL statement so the host UI's
+ *    `<ChartSlot>` can render the chart inline at the marker
+ *    position the model picked. The data never reaches the LLM.
+ * 3. The `DrainResult` returned to the LLM contains
+ *    Genie's prose answer plus a `datasets[]` array of metadata
+ *    (chartId, title, columns, rowCount, sql) the model uses to
+ *    cite charts via `[[chart:<chartId>]]` markers.
+ *
+ * `query_result` and `message_result` events arrive in either
+ * order; we buffer per-statement metadata in
+ * {@link DatasetMeta} so each half can fill in the bits it knows
+ * about and we emit the chart event once `query_result` lands
+ * (with whatever title was already set, falling back to a
+ * generic label otherwise).
  */
 async function drainGenieStream(
   stream: AsyncGenerator<GenieStreamEvent>,
   writer?: ToolStream,
-): Promise<{
-  conversationId?: string;
-  messageId?: string;
-  spaceId?: string;
-  status?: string;
-  content?: string;
-  attachments?: GenieMessage["attachments"];
-  queries: { attachmentId: string; statementId: string; data: GenieStatement }[];
-  error?: string;
-}> {
+): Promise<DrainResult> {
   let conversationId: string | undefined;
-  let messageId: string | undefined;
-  let spaceId: string | undefined;
-  let status: string | undefined;
-  let content: string | undefined;
-  let attachments: GenieMessage["attachments"] | undefined;
+  let genieAnswer: string | undefined;
+  let suggestedFollowUps: string[] | undefined;
   let error: string | undefined;
-  const queries: {
-    attachmentId: string;
-    statementId: string;
-    data: GenieStatement;
-  }[] = [];
+  // AppKit's `streamSendMessage` forwards every SDK `onProgress`
+  // callback verbatim - the same `EXECUTING_QUERY` can fire several
+  // times during a single poll loop. AppKit's other path,
+  // `streamGetMessage`, dedupes on the connector side; we mirror that
+  // behaviour here so the UI status pill doesn't flicker and we don't
+  // burn writer bytes on no-op events.
+  let lastStatus: string | undefined;
+
+  // Per-statement scratch keyed by Genie's `statementId`. Filled in
+  // by both `query_result` (rows + columns) and `message_result`
+  // (sql + title + description); the LLM-bound `datasets[]` is
+  // built from this at end-of-stream, and chart writer events fire
+  // when `query_result` lands.
+  const datasetsByStatementId = new Map<string, DatasetMeta>();
 
   // Best-effort progress emission. Awaited so the underlying agent
   // stream sees events in order; write failures are swallowed so a
@@ -199,20 +425,26 @@ async function drainGenieStream(
   };
 
   for await (const event of stream) {
+    // Uncomment to log every raw Genie wire event before the switch
+    // routes it through the writer / DrainResult. Useful when tuning
+    // the pill / answer pipeline against real Genie payloads (status
+    // codes, attachment shapes, query_result manifests Genie surfaces
+    // only on certain question types, etc.).
+    // eslint-disable-next-line no-console
+    // console.log("[mastra/genie] event", event);
     switch (event.type) {
       case "message_start":
         conversationId = event.conversationId;
-        messageId = event.messageId;
-        spaceId = event.spaceId;
         await emit({
           kind: "started",
-          conversationId,
-          messageId,
-          spaceId,
+          conversationId: event.conversationId,
+          messageId: event.messageId,
+          spaceId: event.spaceId,
         });
         break;
       case "status":
-        status = event.status;
+        if (event.status === lastStatus) break;
+        lastStatus = event.status;
         await emit({
           kind: "status",
           status: event.status,
@@ -220,36 +452,57 @@ async function drainGenieStream(
         });
         break;
       case "query_result": {
-        queries.push({
-          attachmentId: event.attachmentId,
-          statementId: event.statementId,
-          data: event.data,
-        });
-        const rowCount = event.data?.result?.data_array?.length ?? 0;
         const columns = (event.data?.manifest?.schema?.columns ?? []).map(
           (c) => c.name,
         );
-        await emit({ kind: "data", rowCount, columns });
+        const dataArray = (event.data?.result?.data_array ?? []) as Array<
+          Array<string | null>
+        >;
+        const rows = genieRowsToObjects(columns, dataArray);
+        const meta = upsertDatasetMeta(datasetsByStatementId, event.statementId, {
+          columns,
+          rowCount: rows.length,
+        });
+        await emit({
+          kind: "chart",
+          chartId: meta.chartId,
+          title: meta.title ?? `Genie query`,
+          ...(meta.description ? { description: meta.description } : {}),
+          data: rows,
+        });
         break;
       }
       case "message_result":
-        content = event.message.content;
-        attachments = event.message.attachments;
-        status = event.message.status;
-        for (const attachment of attachments ?? []) {
-          if (attachment.query?.query) {
+        genieAnswer = event.message.content;
+        for (const attachment of event.message.attachments ?? []) {
+          const sqlText = attachment.query?.query;
+          const stmtId = attachment.query?.statementId;
+          if (sqlText && stmtId) {
+            upsertDatasetMeta(datasetsByStatementId, stmtId, {
+              sql: sqlText,
+              ...(attachment.query?.title ? { title: attachment.query.title } : {}),
+              ...(attachment.query?.description
+                ? { description: attachment.query.description }
+                : {}),
+            });
+          }
+          if (sqlText) {
             await emit({
               kind: "sql",
-              sql: attachment.query.query,
-              title: attachment.query.title,
-              description: attachment.query.description,
-              statementId: attachment.query.statementId,
+              sql: sqlText,
+              title: attachment.query?.title,
+              description: attachment.query?.description,
+              statementId: stmtId,
             });
           }
           if (attachment.text?.content) {
             await emit({ kind: "text", content: attachment.text.content });
           }
           if (attachment.suggestedQuestions?.length) {
+            // Last attachment with suggestions wins (same merge rule
+            // the UI uses via `collectSuggestions`); keeping just one
+            // copy per turn caps token usage.
+            suggestedFollowUps = attachment.suggestedQuestions;
             await emit({
               kind: "suggested",
               questions: attachment.suggestedQuestions,
@@ -266,16 +519,92 @@ async function drainGenieStream(
     }
   }
 
+  // Strip statementId / row-only fields when handing the LLM the
+  // datasets - the model never references statementId, and the
+  // chartId is what the marker uses.
+  const datasets: Array<z.infer<typeof datasetSchema>> = [];
+  for (const meta of datasetsByStatementId.values()) {
+    datasets.push({
+      chartId: meta.chartId,
+      ...(meta.title ? { title: meta.title } : {}),
+      ...(meta.description ? { description: meta.description } : {}),
+      columns: meta.columns,
+      rowCount: meta.rowCount,
+      ...(meta.sql ? { sql: meta.sql } : {}),
+    });
+  }
+
   return {
-    conversationId,
-    messageId,
-    spaceId,
-    status,
-    content,
-    attachments,
-    queries,
-    error,
+    ...(conversationId ? { conversationId } : {}),
+    ...(genieAnswer ? { genieAnswer } : {}),
+    ...(datasets.length > 0 ? { datasets } : {}),
+    ...(suggestedFollowUps ? { suggestedFollowUps } : {}),
+    ...(error ? { error } : {}),
+  };
+}
+
+/**
+ * Get-or-create-and-merge the per-statement scratch entry. Both
+ * `query_result` and `message_result` paths call this with their
+ * partial bag of fields; the resulting record is the union of
+ * everything we know about that statement so far.
+ */
+function upsertDatasetMeta(
+  store: Map<string, DatasetMeta>,
+  statementId: string,
+  patch: Partial<Omit<DatasetMeta, "chartId" | "statementId">>,
+): DatasetMeta {
+  const existing = store.get(statementId);
+  const merged: DatasetMeta = {
+    chartId: existing?.chartId ?? randomUUID().replace(/-/g, "").slice(0, 8),
+    statementId,
+    columns: patch.columns ?? existing?.columns ?? [],
+    rowCount: patch.rowCount ?? existing?.rowCount ?? 0,
+    ...(patch.title ?? existing?.title
+      ? { title: patch.title ?? existing?.title }
+      : {}),
+    ...(patch.description ?? existing?.description
+      ? { description: patch.description ?? existing?.description }
+      : {}),
+    ...(patch.sql ?? existing?.sql ? { sql: patch.sql ?? existing?.sql } : {}),
   };
+  store.set(statementId, merged);
+  return merged;
+}
+
+/**
+ * Convert Genie's `data_array` (column-positional `string | null`
+ * tuples) into plain JS row objects keyed by column name. Numeric
+ * strings are coerced to numbers so the chart-planner picks
+ * `value` axes instead of `category` axes; everything else passes
+ * through verbatim. `null` becomes `null`.
+ */
+function genieRowsToObjects(
+  columns: ReadonlyArray<string>,
+  dataArray: ReadonlyArray<ReadonlyArray<string | null>>,
+): Array<Record<string, unknown>> {
+  const out: Array<Record<string, unknown>> = [];
+  for (const row of dataArray) {
+    const obj: Record<string, unknown> = {};
+    columns.forEach((col, i) => {
+      const cell = row[i] ?? null;
+      obj[col] = coerceCell(cell);
+    });
+    out.push(obj);
+  }
+  return out;
+}
+
+/** Best-effort numeric coercion for Genie's all-strings cells. */
+function coerceCell(cell: string | null): unknown {
+  if (cell === null) return null;
+  // Anchored to keep `12.5px` / `123abc` as strings; only fully
+  // numeric values become JS numbers.
+  if (/^-?\d+(\.\d+)?$/.test(cell)) {
+    const n = Number(cell);
+    if (Number.isFinite(n)) return n;
+  }
+  return cell;
 }
 
 /**
@@ -349,6 +678,11 @@ function humanizeGenieStatus(status: string): string {
     case "FAILED":
       return "Failed";
     default:
-      return status.toLowerCase().replace(/_/g, " ");
+      return [
+        ...stringUtils.tokenizeWithOptions(
+          { capitalize: true, lowerCase: true },
+          status,
+        ),
+      ].join(" ");
   }
 }