@mastra/core 1.7.0 → 1.8.0

package/dist/docs/references/docs-streaming-events.md

@@ -0,0 +1,237 @@
+# Streaming Events
+
+Streaming from agents or workflows provides real-time visibility into either the LLM’s output or the status of a workflow run. This feedback can be passed directly to the user, or used within applications to handle workflow status more effectively, creating a smoother and more responsive experience.
+
+Events emitted from agents or workflows represent different stages of generation and execution, such as when a run starts, when text is produced, or when a tool is invoked.
+
+## Event types
+
+Below is a complete list of events emitted from `.stream()`. Depending on whether you’re streaming from an **agent** or a **workflow**, only a subset of these events will occur:
+
+- **start**: Marks the beginning of an agent or workflow run.
+- **step-start**: Indicates a workflow step has begun execution.
+- **text-delta**: Incremental text chunks as they're generated by the LLM.
+- **tool-call**: When the agent decides to use a tool, including the tool name and arguments.
+- **tool-result**: The result returned from tool execution.
+- **step-finish**: Confirms that a specific step has fully finalized, and may include metadata like the finish reason for that step.
+- **finish**: When the agent or workflow completes, including usage statistics.
+
+## Network event types
+
+When using `agent.network()` for multi-agent collaboration, additional event types are emitted to track the orchestration flow:
+
+- **routing-agent-start**: The routing agent begins analyzing the task to decide which primitive (agent/workflow/tool) to delegate to.
+- **routing-agent-text-delta**: Incremental text as the routing agent processes the response from the selected primitive.
+- **routing-agent-end**: The routing agent completes its selection, including the selected primitive and reason for selection.
+- **agent-execution-start**: A delegated agent begins execution.
+- **agent-execution-end**: A delegated agent completes execution.
+- **agent-execution-event-\***: Events from the delegated agent's execution (e.g., `agent-execution-event-text-delta`).
+- **workflow-execution-start**: A delegated workflow begins execution.
+- **workflow-execution-end**: A delegated workflow completes execution.
+- **workflow-execution-event-\***: Events from the delegated workflow's execution.
+- **tool-execution-start**: A delegated tool begins execution.
+- **tool-execution-end**: A delegated tool completes execution.
+- **network-execution-event-step-finish**: A network iteration step completes.
+- **network-execution-event-finish**: The entire network execution completes.
+
+## Inspecting agent streams
+
+Iterate over the `stream` with a `for await` loop to inspect all emitted event chunks.
+
+```typescript
+const testAgent = mastra.getAgent('testAgent')
+
+const stream = await testAgent.stream([{ role: 'user', content: 'Help me organize my day' }])
+
+for await (const chunk of stream) {
+  console.log(chunk)
+}
+```
+
+> **Info:** Visit [Agent.stream()](https://mastra.ai/reference/streaming/agents/stream) for more information.
+
+### Example agent output
+
+Below is an example of events that may be emitted. Each event always includes a `type` and can include additional fields like `from` and `payload`.
+
+```typescript
+{
+  type: 'start',
+  from: 'AGENT',
+  // ..
+}
+{
+  type: 'step-start',
+  from: 'AGENT',
+  payload: {
+    messageId: 'msg-cdUrkirvXw8A6oE4t5lzDuxi',
+    // ...
+  }
+}
+{
+  type: 'tool-call',
+  from: 'AGENT',
+  payload: {
+    toolCallId: 'call_jbhi3s1qvR6Aqt9axCfTBMsA',
+    toolName: 'testTool'
+    // ..
+  }
+}
+```
+
+## Inspecting workflow streams
+
+Iterate over the `stream` with a `for await` loop to inspect all emitted event chunks.
+
+```typescript
+const testWorkflow = mastra.getWorkflow('testWorkflow')
+
+const run = await testWorkflow.createRun()
+
+const stream = await run.stream({
+  inputData: {
+    value: 'initial data',
+  },
+})
+
+for await (const chunk of stream) {
+  console.log(chunk)
+}
+```
+
+### Example workflow output
+
+Below is an example of events that may be emitted. Each event always includes a `type` and can include additional fields like `from` and `payload`.
+
+```typescript
+{
+  type: 'workflow-start',
+  runId: '221333ed-d9ee-4737-922b-4ab4d9de73e6',
+  from: 'WORKFLOW',
+  // ...
+}
+{
+  type: 'workflow-step-start',
+  runId: '221333ed-d9ee-4737-922b-4ab4d9de73e6',
+  from: 'WORKFLOW',
+  payload: {
+    stepName: 'step-1',
+    args: { value: 'initial data' },
+    stepCallId: '9e8c5217-490b-4fe7-8c31-6e2353a3fc98',
+    startedAt: 1755269732792,
+    status: 'running'
+  }
+}
+```
+
+### Foreach progress events
+
+When a workflow uses `.foreach()`, each iteration emits a `workflow-step-progress` event. You can use these to track real-time progress:
+
+```typescript
+for await (const chunk of stream) {
+  if (chunk.type === 'workflow-step-progress') {
+    console.log(
+      `${chunk.payload.id}: ${chunk.payload.completedCount}/${chunk.payload.totalCount} — ${chunk.payload.iterationStatus}`,
+    )
+  }
+}
+```
+
+Each progress event includes:
+
+- **`id`**: The step ID of the foreach step
+- **`completedCount`**: Number of iterations completed so far
+- **`totalCount`**: Total number of iterations
+- **`currentIndex`**: Index of the iteration that just completed
+- **`iterationStatus`**: Status of the iteration (`success`, `failed`, or `suspended`)
+- **`iterationOutput`**: Output of the iteration (when successful)
+
+## Inspecting agent networks
+
+When using multi-agent collaboration with `agent.network()`, iterate over the stream to track how tasks are delegated and executed across agents, workflows, and tools.
+
+```typescript
+const networkAgent = mastra.getAgent('networkAgent')
+
+const networkStream = await networkAgent.network('Research dolphins then write a report')
+
+for await (const chunk of networkStream) {
+  console.log(chunk)
+}
+```
+
+> **Info:** Visit [Agent.network()](https://mastra.ai/reference/agents/network) for more information.
+
+### Example network output
+
+Network streams emit events that track the orchestration flow. Each iteration begins with routing, followed by execution of the selected primitive.
+
+```typescript
+// Routing agent decides what to do
+{
+  type: 'routing-agent-start',
+  from: 'NETWORK',
+  runId: '7a3b9c2d-1e4f-5a6b-8c9d-0e1f2a3b4c5d',
+  payload: {
+    agentId: 'routing-agent',
+    // ...
+  }
+}
+// Routing agent makes a selection
+{
+  type: 'routing-agent-end',
+  from: 'NETWORK',
+  runId: '7a3b9c2d-1e4f-5a6b-8c9d-0e1f2a3b4c5d',
+  payload: {
+    // ...
+  }
+}
+// Delegated agent begins execution
+{
+  type: 'agent-execution-start',
+  from: 'NETWORK',
+  runId: '8b4c0d3e-2f5a-6b7c-9d0e-1f2a3b4c5d6e',
+  payload: {
+    // ...
+  }
+}
+// Events from the delegated agent's execution
+{
+  type: 'agent-execution-event-text-delta',
+  from: 'NETWORK',
+  runId: '8b4c0d3e-2f5a-6b7c-9d0e-1f2a3b4c5d6e',
+  payload: {
+    type: 'text-delta',
+    payload: {
+      // ...
+    }
+  }
+}
+```
+
+### Filtering network events
+
+You can filter events by type to track specific aspects of the network execution:
+
+```typescript
+const networkStream = await networkAgent.network('Analyze data and create visualization')
+
+for await (const chunk of networkStream) {
+  // Track routing decisions
+  if (chunk.type === 'routing-agent-end') {
+    console.log('Selected:', chunk.payload.resourceType, chunk.payload.resourceId)
+    console.log('Reason:', chunk.payload.selectionReason)
+  }
+
+  // Track agent delegations
+  if (chunk.type === 'agent-execution-start') {
+    console.log('Delegating to agent:', chunk.payload.agentId)
+  }
+
+  // Track workflow delegations
+  if (chunk.type === 'workflow-execution-start') {
+    console.log('Executing workflow:', chunk.payload.name)
+  }
+}
+```

package/dist/docs/references/docs-streaming-tool-streaming.md

@@ -0,0 +1,175 @@
+# Tool streaming
+
+Tool streaming in Mastra enables tools to send incremental results while they run, rather than waiting until execution finishes. This allows you to surface partial progress, intermediate states, or progressive data directly to users or upstream agents and workflows.
+
+Streams can be written to in two main ways:
+
+- **From within a tool**: every tool receives a `context.writer` object, which is a writable stream you can use to push updates as execution progresses.
+- **From an agent stream**: you can also pipe an agent's `stream` output directly into a tool's writer, making it easy to chain agent responses into tool results without extra glue code.
+
+By combining writable tool streams with agent streaming, you gain fine grained control over how intermediate results flow through your system and into the user experience.
+
+## Agent using tool
+
+Agent streaming can be combined with tool calls, allowing tool outputs to be written directly into the agent’s streaming response. This makes it possible to surface tool activity as part of the overall interaction.
+
+```typescript
+import { Agent } from '@mastra/core/agent'
+import { testTool } from '../tools/test-tool'
+
+export const testAgent = new Agent({
+  id: 'test-agent',
+  name: 'Test Agent',
+  instructions: 'You are a weather agent.',
+  model: 'openai/gpt-5.1',
+  tools: { testTool },
+})
+```
+
+### Using `context.writer`
+
+The `context.writer` object is available in a tool's `execute()` function and can be used to emit custom events, data, or values into the active stream. This enables tools to provide intermediate results or status updates while execution is still in progress.
+
+> **Warning:** You must `await` the call to `writer.write()` or else you will lock the stream and get a `WritableStream is locked` error.
+
+```typescript
+import { createTool } from "@mastra/core/tools";
+
+export const testTool = createTool({
+  execute: async (inputData, context) => {
+    const { value } = inputData;
+
+    await context?.writer?.write({
+      type: "custom-event",
+      status: "pending"
+    });
+
+    const response = await fetch(...);
+
+    await context?.writer?.write({
+      type: "custom-event",
+      status: "success"
+    });
+
+    return {
+      value: ""
+    };
+  }
+});
+```
+
+You can also use `writer.custom()` if you want to emit top level stream chunks, This useful and relevant when integrating with UI Frameworks
+
+```typescript
+import { createTool } from "@mastra/core/tools";
+
+export const testTool = createTool({
+  execute: async (inputData, context) => {
+    const { value } = inputData;
+
+   await context?.writer?.custom({
+      type: "data-tool-progress",
+      status: "pending"
+    });
+
+    const response = await fetch(...);
+
+   await context?.writer?.custom({
+      type: "data-tool-progress",
+      status: "success"
+    });
+
+    return {
+      value: ""
+    };
+  }
+});
+```
+
+### Inspecting stream payloads
+
+Events written to the stream are included in the emitted chunks. These chunks can be inspected to access any custom fields, such as event types, intermediate values, or tool-specific data.
+
+```typescript
+const stream = await testAgent.stream(['What is the weather in London?', 'Use the testTool'])
+
+for await (const chunk of stream) {
+  if (chunk.payload.output?.type === 'custom-event') {
+    console.log(JSON.stringify(chunk, null, 2))
+  }
+}
+```
+
+## Tool Lifecycle Hooks
+
+Tools support lifecycle hooks that allow you to monitor different stages of tool execution during streaming. These hooks are particularly useful for logging or analytics.
+
+### Example: Using onInputAvailable and onOutput
+
+```typescript
+import { createTool } from '@mastra/core/tools'
+import { z } from 'zod'
+
+export const weatherTool = createTool({
+  id: 'weather-tool',
+  description: 'Get weather information',
+  inputSchema: z.object({
+    city: z.string(),
+  }),
+  outputSchema: z.object({
+    temperature: z.number(),
+    conditions: z.string(),
+  }),
+  // Called when the complete input is available
+  onInputAvailable: ({ input, toolCallId }) => {
+    console.log(`Weather requested for: ${input.city}`)
+  },
+  execute: async input => {
+    const weather = await fetchWeather(input.city)
+    return weather
+  },
+  // Called after successful execution
+  onOutput: ({ output, toolName }) => {
+    console.log(`${toolName} result: ${output.temperature}°F, ${output.conditions}`)
+  },
+})
+```
+
+### Available Hooks
+
+- **onInputStart**: Called when tool call input streaming begins
+- **onInputDelta**: Called for each chunk of input as it streams in
+- **onInputAvailable**: Called when complete input is parsed and validated
+- **onOutput**: Called after the tool successfully executes with the output
+
+For detailed documentation on all lifecycle hooks, see the [createTool() reference](https://mastra.ai/reference/tools/create-tool).
+
+### Streaming tool input in UIs
+
+When a model generates a tool call, the arguments arrive incrementally as `tool-call-delta` stream chunks before the final `tool-call` chunk. UIs can listen for the corresponding `tool_input_start`, `tool_input_delta`, and `tool_input_end` events to render tool arguments as they stream in — for example, showing a file path or command immediately rather than waiting for the complete tool call.
+
+Using a partial JSON parser on the accumulated `argsTextDelta` fragments lets you extract usable argument values before the JSON is complete. This enables features like live diff previews for edit tools, streaming file content for write tools, and instant display of search patterns or file paths.
+
+## Tool using an agent
+
+Pipe an agent's `fullStream` to the tool's `writer`. This streams partial output, and Mastra automatically aggregates the agent's usage into the tool run.
+
+```typescript
+import { createTool } from '@mastra/core/tools'
+import { z } from 'zod'
+
+export const testTool = createTool({
+  execute: async (inputData, context) => {
+    const { city } = inputData
+
+    const agent = context?.mastra?.getAgent('testAgent')
+    const stream = await agent?.stream(`What is the weather in ${city}?`)
+
+    await stream!.fullStream.pipeTo(context?.writer!)
+
+    return {
+      value: await stream!.text,
+    }
+  },
+})
+```

package/dist/docs/references/docs-streaming-workflow-streaming.md

@@ -0,0 +1,109 @@
+# Workflow streaming
+
+Workflow streaming in Mastra enables workflows to send incremental results while they execute, rather than waiting until completion. This allows you to surface partial progress, intermediate states, or progressive data directly to users or upstream agents and workflows.
+
+Streams can be written to in two main ways:
+
+- **From within a workflow step**: every workflow step receives a `writer` argument, which is a writable stream you can use to push updates as execution progresses.
+- **From an agent stream**: you can also pipe an agent's `stream` output directly into a workflow step's writer, making it easy to chain agent responses into workflow results without extra glue code.
+
+By combining writable workflow streams with agent streaming, you gain fine-grained control over how intermediate results flow through your system and into the user experience.
+
+## Using the `writer` argument
+
+The `writer` argument is passed to a workflow step's `execute` function and can be used to emit custom events, data, or values into the active stream. This enables workflow steps to provide intermediate results or status updates while execution is still in progress.
+
+> **Warning:** You must `await` the call to `writer.write(...)` or else you will lock the stream and get a `WritableStream is locked` error.
+
+```typescript
+import { createStep } from "@mastra/core/workflows";
+
+export const testStep = createStep({
+  execute: async ({ inputData, writer }) => {
+    const { value } = inputData;
+
+    await writer?.write({
+      type: "custom-event",
+      status: "pending"
+    });
+
+    const response = await fetch(...);
+
+    await writer?.write({
+      type: "custom-event",
+      status: "success"
+    });
+
+    return {
+      value: ""
+    };
+  },
+});
+```
+
+## Inspecting workflow stream payloads
+
+Events written to the stream are included in the emitted chunks. These chunks can be inspected to access any custom fields, such as event types, intermediate values, or step-specific data.
+
+```typescript
+const testWorkflow = mastra.getWorkflow('testWorkflow')
+
+const run = await testWorkflow.createRun()
+
+const stream = await run.stream({
+  inputData: {
+    value: 'initial data',
+  },
+})
+
+for await (const chunk of stream) {
+  console.log(chunk)
+}
+
+if (result!.status === 'suspended') {
+  // if the workflow is suspended, we can resume it with the resumeStream method
+  const resumedStream = await run.resumeStream({
+    resumeData: { value: 'resume data' },
+  })
+
+  for await (const chunk of resumedStream) {
+    console.log(chunk)
+  }
+}
+```
+
+## Resuming an interrupted workflow stream
+
+If a workflow stream is closed or interrupted for any reason, you can resume it with the `resumeStream` method. This will return a new `ReadableStream` that you can use to observe the workflow events.
+
+```typescript
+const newStream = await run.resumeStream()
+
+for await (const chunk of newStream) {
+  console.log(chunk)
+}
+```
+
+## Workflow using an agent
+
+Pipe an agent's `textStream` to the workflow step's `writer`. This streams partial output, and Mastra automatically aggregates the agent's usage into the workflow run.
+
+```typescript
+import { createStep } from '@mastra/core/workflows'
+import { z } from 'zod'
+
+export const testStep = createStep({
+  execute: async ({ inputData, mastra, writer }) => {
+    const { city } = inputData
+
+    const testAgent = mastra?.getAgent('testAgent')
+    const stream = await testAgent?.stream(`What is the weather in ${city}$?`)
+
+    await stream!.textStream.pipeTo(writer!)
+
+    return {
+      value: await stream!.text,
+    }
+  },
+})
+```