@mastra/mcp-docs-server 0.13.37 → 0.13.39-alpha.0

package/.docs/raw/reference/streaming/agents/stream.mdx

@@ -1,31 +1,29 @@
 ---
-title: "Reference: Agent.stream() | Agents | Mastra Docs"
+title: "Reference: Agent.stream() | Streaming | Mastra Docs"
 description: "Documentation for the `Agent.stream()` method in Mastra agents, which enables real-time streaming of responses with enhanced capabilities."
 ---
 
-import { Callout } from 'nextra/components';
-
-# Agent.stream() 
-
+# Agent.stream()
 
 The `.stream()` method enables real-time streaming of responses from an agent with enhanced capabilities and format flexibility. This method accepts messages and optional streaming options, providing a next-generation streaming experience with support for both Mastra's native format and AI SDK v5 compatibility.
 
 ## Usage example
 
-```ts filename="index.ts" copy
+```ts title="index.ts" copy
 // Default Mastra format
 const mastraStream = await agent.stream("message for agent");
 
 // AI SDK v5 compatible format
 const aiSdkStream = await agent.stream("message for agent", {
-  format: 'aisdk'
+  format: "aisdk",
 });
 ```
 
-<Callout type="info">
-  **Model Compatibility**: This method is designed for V2 models. V1 models should use the [`.streamLegacy()`](./streamLegacy.mdx) method. The framework automatically detects your model version and will throw an error if there's a mismatch.
-</Callout>
+:::info
 
+**Model Compatibility**: This method is designed for V2 models. V1 models should use the [`.streamLegacy()`](./streamLegacy) method. The framework automatically detects your model version and will throw an error if there's a mismatch.
+
+:::
 
 ## Parameters
 
@@ -34,7 +32,8 @@ const aiSdkStream = await agent.stream("message for agent", {
     {
       name: "messages",
       type: "string | string[] | CoreMessage[] | AiMessageType[] | UIMessageWithMetadata[]",
-      description: "The messages to send to the agent. Can be a single string, array of strings, or structured message objects.",
+      description:
+        "The messages to send to the agent. Can be a single string, array of strings, or structured message objects.",
     },
     {
       name: "options",
@@ -45,8 +44,6 @@ const aiSdkStream = await agent.stream("message for agent", {
   ]}
 />
 
-
-
 ### Options
 
 <PropertiesTable
@@ -56,7 +53,8 @@ const aiSdkStream = await agent.stream("message for agent", {
       type: "'mastra' | 'aisdk'",
       isOptional: true,
       defaultValue: "'mastra'",
-      description: "Determines the output stream format. Use 'mastra' for Mastra's native format (default) or 'aisdk' for AI SDK v5 compatibility.",
+      description:
+        "Determines the output stream format. Use 'mastra' for Mastra's native format (default) or 'aisdk' for AI SDK v5 compatibility.",
     },
     {
       name: "maxSteps",
@@ -71,40 +69,50 @@ const aiSdkStream = await agent.stream("message for agent", {
       description: "Evaluation scorers to run on the execution results.",
       properties: [
         {
-          parameters: [{
-            name: "scorer",
-            type: "string",
-            isOptional: false,
-            description: "Name of the scorer to use."
-          }]
-        },
-        {
-          parameters: [{
-            name: "sampling",
-            type: "ScoringSamplingConfig",
-            isOptional: true,
-            description: "Sampling configuration for the scorer.",
-            properties: [
-              {
-                parameters: [{
-                  name: "type",
-                  type: "'none' | 'ratio'",
-                  isOptional: false,
-                  description: "Type of sampling strategy. Use 'none' to disable sampling or 'ratio' for percentage-based sampling."
-                }]
-              },
-              {
-                parameters: [{
-                  name: "rate",
-                  type: "number",
-                  isOptional: true,
-                  description: "Sampling rate (0-1). Required when type is 'ratio'."
-                }]
-              }
-            ]
-          }]
-        }
-      ]
+          parameters: [
+            {
+              name: "scorer",
+              type: "string",
+              isOptional: false,
+              description: "Name of the scorer to use.",
+            },
+          ],
+        },
+        {
+          parameters: [
+            {
+              name: "sampling",
+              type: "ScoringSamplingConfig",
+              isOptional: true,
+              description: "Sampling configuration for the scorer.",
+              properties: [
+                {
+                  parameters: [
+                    {
+                      name: "type",
+                      type: "'none' | 'ratio'",
+                      isOptional: false,
+                      description:
+                        "Type of sampling strategy. Use 'none' to disable sampling or 'ratio' for percentage-based sampling.",
+                    },
+                  ],
+                },
+                {
+                  parameters: [
+                    {
+                      name: "rate",
+                      type: "number",
+                      isOptional: true,
+                      description:
+                        "Sampling rate (0-1). Required when type is 'ratio'.",
+                    },
+                  ],
+                },
+              ],
+            },
+          ],
+        },
+      ],
     },
     {
       name: "tracingContext",
@@ -128,7 +136,8 @@ const aiSdkStream = await agent.stream("message for agent", {
       name: "onError",
       type: "({ error }: { error: Error | string }) => Promise<void> | void",
       isOptional: true,
-      description: "Callback function called when an error occurs during streaming.",
+      description:
+        "Callback function called when an error occurs during streaming.",
     },
     {
       name: "onAbort",
@@ -140,19 +149,22 @@ const aiSdkStream = await agent.stream("message for agent", {
       name: "abortSignal",
       type: "AbortSignal",
       isOptional: true,
-      description: "Signal object that allows you to abort the agent's execution. When the signal is aborted, all ongoing operations will be terminated.",
+      description:
+        "Signal object that allows you to abort the agent's execution. When the signal is aborted, all ongoing operations will be terminated.",
     },
     {
       name: "activeTools",
       type: "Array<keyof ToolSet> | undefined",
       isOptional: true,
-      description: "Array of active tool names that can be used during execution.",
+      description:
+        "Array of active tool names that can be used during execution.",
     },
     {
       name: "prepareStep",
       type: "PrepareStepFunction<any>",
       isOptional: true,
-      description: "Callback function called before each step of multi-step execution.",
+      description:
+        "Callback function called before each step of multi-step execution.",
     },
     {
       name: "context",
@@ -167,66 +179,85 @@ const aiSdkStream = await agent.stream("message for agent", {
       description: "Options to fine tune your structured output generation.",
       properties: [
         {
-          parameters: [{
-            name: "schema",
-            type: "z.ZodSchema<S>",
-            isOptional: false,
-            description: "Zod schema defining the expected output structure."
-          }]
+          parameters: [
+            {
+              name: "schema",
+              type: "z.ZodSchema<S>",
+              isOptional: false,
+              description: "Zod schema defining the expected output structure.",
+            },
+          ],
         },
         {
-          parameters: [{
-            name: "model",
-            type: "MastraLanguageModel",
-            isOptional: true,
-            description: "Language model to use for structured output generation. If provided, enables the agent to respond in multi step with tool calls, text, and structured output"
-          }]
+          parameters: [
+            {
+              name: "model",
+              type: "MastraLanguageModel",
+              isOptional: true,
+              description:
+                "Language model to use for structured output generation. If provided, enables the agent to respond in multi step with tool calls, text, and structured output",
+            },
+          ],
         },
         {
-          parameters: [{
-            name: "errorStrategy",
-            type: "'strict' | 'warn' | 'fallback'",
-            isOptional: true,
-            description: "Strategy for handling schema validation errors. 'strict' throws errors, 'warn' logs warnings, 'fallback' uses fallback values."
-          }]
+          parameters: [
+            {
+              name: "errorStrategy",
+              type: "'strict' | 'warn' | 'fallback'",
+              isOptional: true,
+              description:
+                "Strategy for handling schema validation errors. 'strict' throws errors, 'warn' logs warnings, 'fallback' uses fallback values.",
+            },
+          ],
         },
         {
-          parameters: [{
-            name: "fallbackValue",
-            type: "<S extends ZodTypeAny>",
-            isOptional: true,
-            description: "Fallback value to use when schema validation fails and errorStrategy is 'fallback'."
-          }]
+          parameters: [
+            {
+              name: "fallbackValue",
+              type: "<S extends ZodTypeAny>",
+              isOptional: true,
+              description:
+                "Fallback value to use when schema validation fails and errorStrategy is 'fallback'.",
+            },
+          ],
         },
         {
-          parameters: [{
-            name: "instructions",
-            type: "string",
-            isOptional: true,
-            description: "Additional instructions for the structured output model."
-          }]
+          parameters: [
+            {
+              name: "instructions",
+              type: "string",
+              isOptional: true,
+              description:
+                "Additional instructions for the structured output model.",
+            },
+          ],
         },
         {
-          parameters: [{
-            name: "jsonPromptInjection",
-            type: "boolean",
-            isOptional: true,
-            description: "Injects system prompt into the main agent instructing it to return structured output, useful for when a model does not natively support structured outputs."
-          }]
-        }
-      ]
+          parameters: [
+            {
+              name: "jsonPromptInjection",
+              type: "boolean",
+              isOptional: true,
+              description:
+                "Injects system prompt into the main agent instructing it to return structured output, useful for when a model does not natively support structured outputs.",
+            },
+          ],
+        },
+      ],
     },
     {
       name: "outputProcessors",
       type: "Processor[]",
       isOptional: true,
-      description: "Overrides the output processors set on the agent. Output processors that can modify or validate messages from the agent before they are returned to the user. Must implement either (or both) of the `processOutputResult` and `processOutputStream` functions.",
+      description:
+        "Overrides the output processors set on the agent. Output processors that can modify or validate messages from the agent before they are returned to the user. Must implement either (or both) of the `processOutputResult` and `processOutputStream` functions.",
     },
     {
       name: "inputProcessors",
       type: "Processor[]",
       isOptional: true,
-      description: "Overrides the input processors set on the agent. Input processors that can modify or validate messages before they are processed by the agent. Must implement the `processInput` function.",
+      description:
+        "Overrides the input processors set on the agent. Input processors that can modify or validate messages before they are processed by the agent. Must implement the `processInput` function.",
     },
     {
       name: "instructions",
@@ -239,7 +270,8 @@ const aiSdkStream = await agent.stream("message for agent", {
       name: "system",
       type: "string | string[] | CoreSystemMessage | SystemModelMessage | CoreSystemMessage[] | SystemModelMessage[]",
       isOptional: true,
-      description: "Custom system message(s) to include in the prompt. Can be a single string, message object, or array of either. System messages provide additional context or behavior instructions that supplement the agent's main instructions.",
+      description:
+        "Custom system message(s) to include in the prompt. Can be a single string, message object, or array of either. System messages provide additional context or behavior instructions that supplement the agent's main instructions.",
     },
     {
       name: "output",
@@ -252,33 +284,43 @@ const aiSdkStream = await agent.stream("message for agent", {
       name: "memory",
       type: "object",
       isOptional: true,
-      description: "Configuration for memory. This is the preferred way to manage memory.",
+      description:
+        "Configuration for memory. This is the preferred way to manage memory.",
       properties: [
         {
-          parameters: [{
+          parameters: [
+            {
               name: "thread",
               type: "string | { id: string; metadata?: Record<string, any>, title?: string }",
               isOptional: false,
-              description: "The conversation thread, as a string ID or an object with an `id` and optional `metadata`."
-          }]
+              description:
+                "The conversation thread, as a string ID or an object with an `id` and optional `metadata`.",
+            },
+          ],
         },
         {
-          parameters: [{
+          parameters: [
+            {
               name: "resource",
               type: "string",
               isOptional: false,
-              description: "Identifier for the user or resource associated with the thread."
-          }]
+              description:
+                "Identifier for the user or resource associated with the thread.",
+            },
+          ],
         },
         {
-          parameters: [{
+          parameters: [
+            {
               name: "options",
               type: "MemoryConfig",
               isOptional: true,
-              description: "Configuration for memory behavior, like message history and semantic recall."
-          }]
-        }
-      ]
+              description:
+                "Configuration for memory behavior, like message history and semantic recall.",
+            },
+          ],
+        },
+      ],
     },
     {
       name: "onFinish",
@@ -309,38 +351,50 @@ const aiSdkStream = await agent.stream("message for agent", {
         "Settings for OTLP telemetry collection during streaming (not AI tracing).",
       properties: [
         {
-          parameters: [{
-            name: "isEnabled",
-            type: "boolean",
-            isOptional: true,
-            description: "Enable or disable telemetry. Disabled by default while experimental."
-          }]
+          parameters: [
+            {
+              name: "isEnabled",
+              type: "boolean",
+              isOptional: true,
+              description:
+                "Enable or disable telemetry. Disabled by default while experimental.",
+            },
+          ],
         },
         {
-          parameters: [{
-            name: "recordInputs",
-            type: "boolean",
-            isOptional: true,
-            description: "Enable or disable input recording. Enabled by default. You might want to disable input recording to avoid recording sensitive information."
-          }]
+          parameters: [
+            {
+              name: "recordInputs",
+              type: "boolean",
+              isOptional: true,
+              description:
+                "Enable or disable input recording. Enabled by default. You might want to disable input recording to avoid recording sensitive information.",
+            },
+          ],
         },
         {
-          parameters: [{
-            name: "recordOutputs",
-            type: "boolean",
-            isOptional: true,
-            description: "Enable or disable output recording. Enabled by default. You might want to disable output recording to avoid recording sensitive information."
-          }]
+          parameters: [
+            {
+              name: "recordOutputs",
+              type: "boolean",
+              isOptional: true,
+              description:
+                "Enable or disable output recording. Enabled by default. You might want to disable output recording to avoid recording sensitive information.",
+            },
+          ],
         },
         {
-          parameters: [{
-            name: "functionId",
-            type: "string",
-            isOptional: true,
-            description: "Identifier for this function. Used to group telemetry data by function."
-          }]
-        }
-      ]
+          parameters: [
+            {
+              name: "functionId",
+              type: "string",
+              isOptional: true,
+              description:
+                "Identifier for this function. Used to group telemetry data by function.",
+            },
+          ],
+        },
+      ],
     },
     {
       name: "modelSettings",
@@ -350,62 +404,82 @@ const aiSdkStream = await agent.stream("message for agent", {
         "Model-specific settings like temperature, maxTokens, topP, etc. These are passed to the underlying language model.",
       properties: [
         {
-          parameters: [{
-            name: "temperature",
-            type: "number",
-            isOptional: true,
-            description: "Controls randomness in the model's output. Higher values (e.g., 0.8) make the output more random, lower values (e.g., 0.2) make it more focused and deterministic."
-          }]
+          parameters: [
+            {
+              name: "temperature",
+              type: "number",
+              isOptional: true,
+              description:
+                "Controls randomness in the model's output. Higher values (e.g., 0.8) make the output more random, lower values (e.g., 0.2) make it more focused and deterministic.",
+            },
+          ],
         },
         {
-          parameters: [{
-            name: "maxRetries",
-            type: "number",
-            isOptional: true,
-            description: "Maximum number of retries for failed requests."
-          }]
+          parameters: [
+            {
+              name: "maxRetries",
+              type: "number",
+              isOptional: true,
+              description: "Maximum number of retries for failed requests.",
+            },
+          ],
         },
         {
-          parameters: [{
-            name: "topP",
-            type: "number",
-            isOptional: true,
-            description: "Nucleus sampling. This is a number between 0 and 1. It is recommended to set either temperature or topP, but not both."
-          }]
+          parameters: [
+            {
+              name: "topP",
+              type: "number",
+              isOptional: true,
+              description:
+                "Nucleus sampling. This is a number between 0 and 1. It is recommended to set either temperature or topP, but not both.",
+            },
+          ],
         },
         {
-          parameters: [{
-            name: "topK",
-            type: "number",
-            isOptional: true,
-            description: "Only sample from the top K options for each subsequent token. Used to remove 'long tail' low probability responses."
-          }]
+          parameters: [
+            {
+              name: "topK",
+              type: "number",
+              isOptional: true,
+              description:
+                "Only sample from the top K options for each subsequent token. Used to remove 'long tail' low probability responses.",
+            },
+          ],
         },
         {
-          parameters: [{
-            name: "presencePenalty",
-            type: "number",
-            isOptional: true,
-            description: "Presence penalty setting. It affects the likelihood of the model to repeat information that is already in the prompt. A number between -1 (increase repetition) and 1 (maximum penalty, decrease repetition)."
-          }]
+          parameters: [
+            {
+              name: "presencePenalty",
+              type: "number",
+              isOptional: true,
+              description:
+                "Presence penalty setting. It affects the likelihood of the model to repeat information that is already in the prompt. A number between -1 (increase repetition) and 1 (maximum penalty, decrease repetition).",
+            },
+          ],
         },
         {
-          parameters: [{
-            name: "frequencyPenalty",
-            type: "number",
-            isOptional: true,
-            description: "Frequency penalty setting. It affects the likelihood of the model to repeatedly use the same words or phrases. A number between -1 (increase repetition) and 1 (maximum penalty, decrease repetition)."
-          }]
+          parameters: [
+            {
+              name: "frequencyPenalty",
+              type: "number",
+              isOptional: true,
+              description:
+                "Frequency penalty setting. It affects the likelihood of the model to repeatedly use the same words or phrases. A number between -1 (increase repetition) and 1 (maximum penalty, decrease repetition).",
+            },
+          ],
         },
         {
-          parameters: [{
-            name: "stopSequences",
-            type: "string[]",
-            isOptional: true,
-            description: "Stop sequences. If set, the model will stop generating text when one of the stop sequences is generated."
-          }]
+          parameters: [
+            {
+              name: "stopSequences",
+              type: "string[]",
+              isOptional: true,
+              description:
+                "Stop sequences. If set, the model will stop generating text when one of the stop sequences is generated.",
+            },
+          ],
         },
-      ]
+      ],
     },
     {
       name: "threadId",
@@ -422,34 +496,43 @@ const aiSdkStream = await agent.stream("message for agent", {
       description: "Controls how the agent uses tools during streaming.",
       properties: [
         {
-          parameters: [{
-            name: "'auto'",
-            type: "string",
-            description: "Let the model decide whether to use tools (default)."
-          }]
+          parameters: [
+            {
+              name: "'auto'",
+              type: "string",
+              description:
+                "Let the model decide whether to use tools (default).",
+            },
+          ],
         },
         {
-          parameters: [{
-            name: "'none'",
-            type: "string",
-            description: "Do not use any tools."
-          }]
+          parameters: [
+            {
+              name: "'none'",
+              type: "string",
+              description: "Do not use any tools.",
+            },
+          ],
         },
         {
-          parameters: [{
-            name: "'required'",
-            type: "string",
-            description: "Require the model to use at least one tool."
-          }]
+          parameters: [
+            {
+              name: "'required'",
+              type: "string",
+              description: "Require the model to use at least one tool.",
+            },
+          ],
         },
         {
-          parameters: [{
-            name: "{ type: 'tool'; toolName: string }",
-            type: "object",
-            description: "Require the model to use a specific tool by name."
-          }]
-        }
-      ]
+          parameters: [
+            {
+              name: "{ type: 'tool'; toolName: string }",
+              type: "object",
+              description: "Require the model to use a specific tool by name.",
+            },
+          ],
+        },
+      ],
     },
     {
       name: "toolsets",
@@ -469,75 +552,95 @@ const aiSdkStream = await agent.stream("message for agent", {
       name: "savePerStep",
       type: "boolean",
       isOptional: true,
-      description: "Save messages incrementally after each stream step completes (default: false).",
+      description:
+        "Save messages incrementally after each stream step completes (default: false).",
     },
     {
       name: "providerOptions",
       type: "Record<string, Record<string, JSONValue>>",
       isOptional: true,
-      description: "Additional provider-specific options that are passed through to the underlying LLM provider. The structure is `{ providerName: { optionKey: value } }`. For example: `{ openai: { reasoningEffort: 'high' }, anthropic: { maxTokens: 1000 } }`.",
+      description:
+        "Additional provider-specific options that are passed through to the underlying LLM provider. The structure is `{ providerName: { optionKey: value } }`. For example: `{ openai: { reasoningEffort: 'high' }, anthropic: { maxTokens: 1000 } }`.",
       properties: [
         {
-          parameters: [{
-            name: "openai",
-            type: "Record<string, JSONValue>",
-            isOptional: true,
-            description: "OpenAI-specific options. Example: `{ reasoningEffort: 'high' }`"
-          }]
+          parameters: [
+            {
+              name: "openai",
+              type: "Record<string, JSONValue>",
+              isOptional: true,
+              description:
+                "OpenAI-specific options. Example: `{ reasoningEffort: 'high' }`",
+            },
+          ],
         },
         {
-          parameters: [{
-            name: "anthropic",
-            type: "Record<string, JSONValue>",
-            isOptional: true,
-            description: "Anthropic-specific options. Example: `{ maxTokens: 1000 }`"
-          }]
+          parameters: [
+            {
+              name: "anthropic",
+              type: "Record<string, JSONValue>",
+              isOptional: true,
+              description:
+                "Anthropic-specific options. Example: `{ maxTokens: 1000 }`",
+            },
+          ],
         },
         {
-          parameters: [{
-            name: "google",
-            type: "Record<string, JSONValue>",
-            isOptional: true,
-            description: "Google-specific options. Example: `{ safetySettings: [...] }`"
-          }]
+          parameters: [
+            {
+              name: "google",
+              type: "Record<string, JSONValue>",
+              isOptional: true,
+              description:
+                "Google-specific options. Example: `{ safetySettings: [...] }`",
+            },
+          ],
         },
         {
-          parameters: [{
-            name: "[providerName]",
-            type: "Record<string, JSONValue>",
-            isOptional: true,
-            description: "Other provider-specific options. The key is the provider name and the value is a record of provider-specific options."
-          }]
-        }
-      ]
+          parameters: [
+            {
+              name: "[providerName]",
+              type: "Record<string, JSONValue>",
+              isOptional: true,
+              description:
+                "Other provider-specific options. The key is the provider name and the value is a record of provider-specific options.",
+            },
+          ],
+        },
+      ],
     },
     {
       name: "runId",
       type: "string",
       isOptional: true,
-      description: "Unique ID for this generation run. Useful for tracking and debugging purposes.",
+      description:
+        "Unique ID for this generation run. Useful for tracking and debugging purposes.",
     },
     {
       name: "runtimeContext",
       type: "RuntimeContext",
       isOptional: true,
-      description: "Runtime context for dependency injection and contextual information.",
+      description:
+        "Runtime context for dependency injection and contextual information.",
     },
     {
       name: "tracingContext",
       type: "TracingContext",
       isOptional: true,
-      description: "AI tracing context for creating child spans and adding metadata. Automatically injected when using Mastra's tracing system.",
+      description:
+        "AI tracing context for creating child spans and adding metadata. Automatically injected when using Mastra's tracing system.",
       properties: [
         {
-          parameters: [{
-            name: "currentSpan",
-            type: "AISpan",
-            isOptional: true,
-            description: "Current AI span for creating child spans and adding metadata. Use this to create custom child spans or update span attributes during execution."
-          }]
-        }
-      ]
+          parameters: [
+            {
+              name: "currentSpan",
+              type: "AISpan",
+              isOptional: true,
+              description:
+                "Current AI span for creating child spans and adding metadata. Use this to create custom child spans or update span attributes during execution.",
+            },
+          ],
+        },
+      ],
     },
     {
       name: "tracingOptions",
@@ -546,20 +649,24 @@ const aiSdkStream = await agent.stream("message for agent", {
       description: "Options for AI tracing configuration.",
       properties: [
         {
-          parameters: [{
-            name: "metadata",
-            type: "Record<string, any>",
-            isOptional: true,
-            description: "Metadata to add to the root trace span. Useful for adding custom attributes like user IDs, session IDs, or feature flags."
-          }]
-        }
-      ]
+          parameters: [
+            {
+              name: "metadata",
+              type: "Record<string, any>",
+              isOptional: true,
+              description:
+                "Metadata to add to the root trace span. Useful for adding custom attributes like user IDs, session IDs, or feature flags.",
+            },
+          ],
+        },
+      ],
     },
     {
       name: "maxTokens",
       type: "number",
       isOptional: true,
-      description: "Condition(s) that determine when to stop the agent's execution. Can be a single condition or array of conditions.",
+      description:
+        "Condition(s) that determine when to stop the agent's execution. Can be a single condition or array of conditions.",
     },
   ]}
 />
@@ -571,13 +678,15 @@ const aiSdkStream = await agent.stream("message for agent", {
     {
       name: "stream",
       type: "MastraModelOutput<Output> | AISDKV5OutputStream<Output>",
-      description: "Returns a streaming interface based on the format parameter. When format is 'mastra' (default), returns MastraModelOutput. When format is 'aisdk', returns AISDKV5OutputStream for AI SDK v5 compatibility.",
+      description:
+        "Returns a streaming interface based on the format parameter. When format is 'mastra' (default), returns MastraModelOutput. When format is 'aisdk', returns AISDKV5OutputStream for AI SDK v5 compatibility.",
     },
     {
       name: "traceId",
       type: "string",
       isOptional: true,
-      description: "The trace ID associated with this execution when AI tracing is enabled. Use this to correlate logs and debug execution flow.",
+      description:
+        "The trace ID associated with this execution when AI tracing is enabled. Use this to correlate logs and debug execution flow.",
     },
   ]}
 />
@@ -586,8 +695,8 @@ const aiSdkStream = await agent.stream("message for agent", {
 
 ### Mastra Format (Default)
 
-```ts filename="index.ts" showLineNumbers copy
-import { stepCountIs } from 'ai-v5';
+```ts title="index.ts" showLineNumbers copy
+import { stepCountIs } from "ai-v5";
 
 const stream = await agent.stream("Tell me a story", {
   stopWhen: stepCountIs(3), // Stop after 3 steps
@@ -607,11 +716,11 @@ const fullText = await stream.text;
 
 ### AI SDK v5 Format
 
-```ts filename="index.ts" showLineNumbers copy
-import { stepCountIs } from 'ai-v5';
+```ts title="index.ts" showLineNumbers copy
+import { stepCountIs } from "ai-v5";
 
 const stream = await agent.stream("Tell me a story", {
-  format: 'aisdk',
+  format: "aisdk",
   stopWhen: stepCountIs(3), // Stop after 3 steps
   modelSettings: {
     temperature: 0.7,
@@ -620,7 +729,7 @@ const stream = await agent.stream("Tell me a story", {
 
 // Use with AI SDK v5 compatible interfaces
 for await (const part of stream.fullStream) {
-  if (part.type === 'text-delta') {
+  if (part.type === "text-delta") {
     console.log(part.text);
   }
 }
@@ -633,22 +742,22 @@ return stream.toUIMessageStreamResponse();
 
 All callback functions are now available as top-level properties for a cleaner API experience.
 
-```ts filename="index.ts" showLineNumbers copy
+```ts title="index.ts" showLineNumbers copy
 const stream = await agent.stream("Tell me a story", {
   onFinish: (result) => {
-    console.log('Streaming finished:', result);
+    console.log("Streaming finished:", result);
   },
   onStepFinish: (step) => {
-    console.log('Step completed:', step);
+    console.log("Step completed:", step);
   },
   onChunk: (chunk) => {
-    console.log('Received chunk:', chunk);
+    console.log("Received chunk:", chunk);
   },
   onError: ({ error }) => {
-    console.error('Streaming error:', error);
+    console.error("Streaming error:", error);
   },
   onAbort: (event) => {
-    console.log('Stream aborted:', event);
+    console.log("Stream aborted:", event);
   },
 });
 
@@ -660,29 +769,29 @@ for await (const chunk of stream.textStream) {
 
 ### Advanced Example with Options
 
-```ts filename="index.ts" showLineNumbers copy
+```ts title="index.ts" showLineNumbers copy
 import { z } from "zod";
-import { stepCountIs } from 'ai-v5';
+import { stepCountIs } from "ai-v5";
 
 await agent.stream("message for agent", {
-  format: 'aisdk', // Enable AI SDK v5 compatibility
+  format: "aisdk", // Enable AI SDK v5 compatibility
   stopWhen: stepCountIs(3), // Stop after 3 steps
   modelSettings: {
     temperature: 0.7,
   },
   memory: {
     thread: "user-123",
-    resource: "test-app"
+    resource: "test-app",
   },
   toolChoice: "auto",
   // Structured output with better DX
   structuredOutput: {
     schema: z.object({
-      sentiment: z.enum(['positive', 'negative', 'neutral']),
+      sentiment: z.enum(["positive", "negative", "neutral"]),
       confidence: z.number(),
     }),
     model: "openai/gpt-4o-mini",
-    errorStrategy: 'warn',
+    errorStrategy: "warn",
   },
   // Output processors for streaming response validation
   outputProcessors: [
@@ -694,5 +803,5 @@ await agent.stream("message for agent", {
 
 ## Related
 
-- [Generating responses](../../../../docs/agents/overview.mdx#generating-responses)
-- [Streaming responses](../../../../docs/agents/overview.mdx#streaming-responses)
+- [Generating responses](/docs/agents/overview#generating-responses)
+- [Streaming responses](/docs/agents/overview#generating-responses)