@dbx-tools/shared-mastra

Browser-safe contract for the AppKit Mastra plugin.

Share route constants, headers, embed parsing, feedback schemas, thread selection fields, and response schemas between clients, tests, routes, and @dbx-tools/appkit-mastra.

Quick Start

import { wire } from "@dbx-tools/shared-mastra";

const config = wire.MastraClientConfigSchema.parse(await response.json());

Key features:

• Route constants for the official AI SDK chat mount and AppKit-Mastra additions, including suggestions, model lists, the per-agent default-model lookup, embeds, and feedback. History and threads use Mastra’s native client API.
• Header/query/body constants for thread selection and model override requests.
• Embed-marker parsing for delayed chart and statement-data payloads in streaming assistant text.
• Zod schemas for plugin-published client config and route responses.
• MLflow feedback request/response schemas and trace-header constants.
• Browser-safe types that let UI packages stay aligned with the server without importing Node or Mastra runtime code.

Client Configuration Fields

import { wire } from "@dbx-tools/shared-mastra";

const config = wire.MastraClientConfigSchema.parse(await response.json());

wire.MastraClientConfigSchema describes the plugin-published client config: mount path, default agent, the agent roster, and feedback enablement. Use it to bootstrap a UI without hard-coding server paths.

Use Route Constants

import { routes } from "@dbx-tools/shared-mastra";

const suggestionsUrl = `${basePath}${routes.MASTRA_ROUTES.suggestions}`;
const chatUrl = `${basePath}${routes.MASTRA_ROUTES.chat}/${agentId}`;

routes.MASTRA_ROUTES keeps client fetch calls aligned with plugin route names for chat, models, the default-model lookup, suggestions, feedback, and embeds.

Select Threads And Models

import { override, thread } from "@dbx-tools/shared-mastra";

await fetch(chatUrl, {
  method: "POST",
  headers: {
    [thread.THREAD_ID_HEADER]: activeThreadId,
    [override.MODEL_OVERRIDE_HEADER]: "claude sonnet",
  },
  body: JSON.stringify({ messages }),
});

Use the header/query constants instead of string literals so browser code, server middleware, and tests agree on how a request selects the active conversation and model.

Parse Embed Markers

import { markers } from "@dbx-tools/shared-mastra";

const parts = markers.parseMarkers("Here is the chart:\n[chart:abc123]");
const safeText = markers.stripIncompleteMarkerTail(streamingText);

Markers let an agent mention large or delayed artifacts by id, such as [chart:<id>] and [data:<statement_id>]. The parser is useful for rendering assistant text while a stream is still arriving.

Validate Feedback

import { feedback } from "@dbx-tools/shared-mastra";

const body = feedback.MastraFeedbackRequestSchema.parse({
  traceId: "tr-abc",
  value: true,
  comment: "Helpful",
});

Feedback constants include the MLflow trace header and default assessment names. The schemas validate thumbs/comment payloads before they are sent to the plugin.

Validate Plugin Responses

const chart = wire.ChartSchema.parse(await chartRes.json());
const event = wire.GenieWriterEventSchema.parse(writerPayload);

The wire module contains response schemas for suggestions, model lists, charts, statement data, and Genie writer events. It also defines the chart/data result shapes consumed by embed renderers.

Modules

• wire - zod schemas and types for client config, model lists, suggestions, charts, statement data, and writer events.
• routes - plugin route segment constants.
• marker - embed-marker parsing and incomplete-tail stripping.
• feedback - MLflow feedback headers, assessment names, request/response schemas.
• override - model override header/query/body constants.
• thread - thread id header/query constants.

Server-side implementation is in @dbx-tools/appkit-mastra.

See more

Open the complete API reference