@mastra/mcp-docs-server 0.13.37 → 0.13.38

package/.docs/raw/reference/streaming/ChunkType.mdx

@@ -1,10 +1,9 @@
 ---
-title: "Reference: ChunkType | Agents | Mastra Docs"
+title: "Reference: ChunkType | Streaming | Mastra Docs"
 description: "Documentation for the ChunkType type used in Mastra streaming responses, defining all possible chunk types and their payloads."
 ---
 
-import { Callout } from "nextra/components";
-import { PropertiesTable } from "@/components/properties-table";
+import PropertiesTable from "@site/src/components/PropertiesTable";
 
 # ChunkType
 
@@ -19,27 +18,45 @@ All chunks include these base properties:
     {
       name: "type",
       type: "string",
-      description: "The specific chunk type identifier"
+      description: "The specific chunk type identifier",
     },
     {
       name: "runId",
       type: "string",
-      description: "Unique identifier for this execution run"
+      description: "Unique identifier for this execution run",
     },
     {
       name: "from",
       type: "ChunkFrom",
       description: "Source of the chunk",
-      properties: [{
-        type: "enum",
-        parameters: [
-          { name: "AGENT", type: "'AGENT'", description: "Chunk from agent execution" },
-          { name: "USER", type: "'USER'", description: "Chunk from user input" },
-          { name: "SYSTEM", type: "'SYSTEM'", description: "Chunk from system processes" },
-          { name: "WORKFLOW", type: "'WORKFLOW'", description: "Chunk from workflow execution" }
-        ]
-      }]
-    }
+      properties: [
+        {
+          type: "enum",
+          parameters: [
+            {
+              name: "AGENT",
+              type: "'AGENT'",
+              description: "Chunk from agent execution",
+            },
+            {
+              name: "USER",
+              type: "'USER'",
+              description: "Chunk from user input",
+            },
+            {
+              name: "SYSTEM",
+              type: "'SYSTEM'",
+              description: "Chunk from system processes",
+            },
+            {
+              name: "WORKFLOW",
+              type: "'WORKFLOW'",
+              description: "Chunk from workflow execution",
+            },
+          ],
+        },
+      ],
+    },
   ]}
 />
 
@@ -54,20 +71,31 @@ Signals the beginning of text generation.
     {
       name: "type",
       type: '"text-start"',
-      description: "Chunk type identifier"
+      description: "Chunk type identifier",
     },
     {
       name: "payload",
       type: "TextStartPayload",
       description: "Text start information",
-      properties: [{
-        type: "TextStartPayload",
-        parameters: [
-          { name: "id", type: "string", description: "Unique identifier for this text generation" },
-          { name: "providerMetadata", type: "SharedV2ProviderMetadata", isOptional: true, description: "Provider-specific metadata" }
-        ]
-      }]
-    }
+      properties: [
+        {
+          type: "TextStartPayload",
+          parameters: [
+            {
+              name: "id",
+              type: "string",
+              description: "Unique identifier for this text generation",
+            },
+            {
+              name: "providerMetadata",
+              type: "SharedV2ProviderMetadata",
+              isOptional: true,
+              description: "Provider-specific metadata",
+            },
+          ],
+        },
+      ],
+    },
   ]}
 />
 
@@ -80,21 +108,36 @@ Incremental text content during generation.
     {
       name: "type",
       type: '"text-delta"',
-      description: "Chunk type identifier"
+      description: "Chunk type identifier",
     },
     {
       name: "payload",
       type: "TextDeltaPayload",
       description: "Incremental text content",
-      properties: [{
-        type: "TextDeltaPayload",
-        parameters: [
-          { name: "id", type: "string", description: "Unique identifier for this text generation" },
-          { name: "text", type: "string", description: "The incremental text content" },
-          { name: "providerMetadata", type: "SharedV2ProviderMetadata", isOptional: true, description: "Provider-specific metadata" }
-        ]
-      }]
-    }
+      properties: [
+        {
+          type: "TextDeltaPayload",
+          parameters: [
+            {
+              name: "id",
+              type: "string",
+              description: "Unique identifier for this text generation",
+            },
+            {
+              name: "text",
+              type: "string",
+              description: "The incremental text content",
+            },
+            {
+              name: "providerMetadata",
+              type: "SharedV2ProviderMetadata",
+              isOptional: true,
+              description: "Provider-specific metadata",
+            },
+          ],
+        },
+      ],
+    },
   ]}
 />
 
@@ -107,20 +150,31 @@ Signals the end of text generation.
     {
       name: "type",
       type: '"text-end"',
-      description: "Chunk type identifier"
+      description: "Chunk type identifier",
     },
     {
       name: "payload",
       type: "TextEndPayload",
       description: "Text end information",
-      properties: [{
-        type: "TextEndPayload",
-        parameters: [
-          { name: "id", type: "string", description: "Unique identifier for this text generation" },
-          { name: "providerMetadata", type: "SharedV2ProviderMetadata", isOptional: true, description: "Provider-specific metadata" }
-        ]
-      }]
-    }
+      properties: [
+        {
+          type: "TextEndPayload",
+          parameters: [
+            {
+              name: "id",
+              type: "string",
+              description: "Unique identifier for this text generation",
+            },
+            {
+              name: "providerMetadata",
+              type: "SharedV2ProviderMetadata",
+              isOptional: true,
+              description: "Provider-specific metadata",
+            },
+          ],
+        },
+      ],
+    },
   ]}
 />
 
@@ -135,21 +189,37 @@ Signals the beginning of reasoning generation (for models that support reasoning
     {
       name: "type",
       type: '"reasoning-start"',
-      description: "Chunk type identifier"
+      description: "Chunk type identifier",
     },
     {
       name: "payload",
       type: "ReasoningStartPayload",
       description: "Reasoning start information",
-      properties: [{
-        type: "ReasoningStartPayload",
-        parameters: [
-          { name: "id", type: "string", description: "Unique identifier for this reasoning generation" },
-          { name: "signature", type: "string", isOptional: true, description: "Reasoning signature if available" },
-          { name: "providerMetadata", type: "SharedV2ProviderMetadata", isOptional: true, description: "Provider-specific metadata" }
-        ]
-      }]
-    }
+      properties: [
+        {
+          type: "ReasoningStartPayload",
+          parameters: [
+            {
+              name: "id",
+              type: "string",
+              description: "Unique identifier for this reasoning generation",
+            },
+            {
+              name: "signature",
+              type: "string",
+              isOptional: true,
+              description: "Reasoning signature if available",
+            },
+            {
+              name: "providerMetadata",
+              type: "SharedV2ProviderMetadata",
+              isOptional: true,
+              description: "Provider-specific metadata",
+            },
+          ],
+        },
+      ],
+    },
   ]}
 />
 
@@ -162,21 +232,36 @@ Incremental reasoning text during generation.
     {
       name: "type",
       type: '"reasoning-delta"',
-      description: "Chunk type identifier"
+      description: "Chunk type identifier",
     },
     {
       name: "payload",
       type: "ReasoningDeltaPayload",
       description: "Incremental reasoning content",
-      properties: [{
-        type: "ReasoningDeltaPayload",
-        parameters: [
-          { name: "id", type: "string", description: "Unique identifier for this reasoning generation" },
-          { name: "text", type: "string", description: "The incremental reasoning text" },
-          { name: "providerMetadata", type: "SharedV2ProviderMetadata", isOptional: true, description: "Provider-specific metadata" }
-        ]
-      }]
-    }
+      properties: [
+        {
+          type: "ReasoningDeltaPayload",
+          parameters: [
+            {
+              name: "id",
+              type: "string",
+              description: "Unique identifier for this reasoning generation",
+            },
+            {
+              name: "text",
+              type: "string",
+              description: "The incremental reasoning text",
+            },
+            {
+              name: "providerMetadata",
+              type: "SharedV2ProviderMetadata",
+              isOptional: true,
+              description: "Provider-specific metadata",
+            },
+          ],
+        },
+      ],
+    },
   ]}
 />
 
@@ -189,21 +274,37 @@ Signals the end of reasoning generation.
     {
       name: "type",
       type: '"reasoning-end"',
-      description: "Chunk type identifier"
+      description: "Chunk type identifier",
     },
     {
       name: "payload",
       type: "ReasoningEndPayload",
       description: "Reasoning end information",
-      properties: [{
-        type: "ReasoningEndPayload",
-        parameters: [
-          { name: "id", type: "string", description: "Unique identifier for this reasoning generation" },
-          { name: "signature", type: "string", isOptional: true, description: "Final reasoning signature if available" },
-          { name: "providerMetadata", type: "SharedV2ProviderMetadata", isOptional: true, description: "Provider-specific metadata" }
-        ]
-      }]
-    }
+      properties: [
+        {
+          type: "ReasoningEndPayload",
+          parameters: [
+            {
+              name: "id",
+              type: "string",
+              description: "Unique identifier for this reasoning generation",
+            },
+            {
+              name: "signature",
+              type: "string",
+              isOptional: true,
+              description: "Final reasoning signature if available",
+            },
+            {
+              name: "providerMetadata",
+              type: "SharedV2ProviderMetadata",
+              isOptional: true,
+              description: "Provider-specific metadata",
+            },
+          ],
+        },
+      ],
+    },
   ]}
 />
 
@@ -216,21 +317,38 @@ Contains the reasoning signature from models that support advanced reasoning (li
     {
       name: "type",
       type: '"reasoning-signature"',
-      description: "Chunk type identifier"
+      description: "Chunk type identifier",
     },
     {
       name: "payload",
       type: "ReasoningSignaturePayload",
-      description: "Metadata about the model's reasoning process characteristics",
-      properties: [{
-        type: "ReasoningSignaturePayload",
-        parameters: [
-          { name: "id", type: "string", description: "Unique identifier for the reasoning session" },
-          { name: "signature", type: "string", description: "Signature describing the reasoning approach or effort level (e.g., reasoning effort settings)" },
-          { name: "providerMetadata", type: "SharedV2ProviderMetadata", isOptional: true, description: "Provider-specific metadata" }
-        ]
-      }]
-    }
+      description:
+        "Metadata about the model's reasoning process characteristics",
+      properties: [
+        {
+          type: "ReasoningSignaturePayload",
+          parameters: [
+            {
+              name: "id",
+              type: "string",
+              description: "Unique identifier for the reasoning session",
+            },
+            {
+              name: "signature",
+              type: "string",
+              description:
+                "Signature describing the reasoning approach or effort level (e.g., reasoning effort settings)",
+            },
+            {
+              name: "providerMetadata",
+              type: "SharedV2ProviderMetadata",
+              isOptional: true,
+              description: "Provider-specific metadata",
+            },
+          ],
+        },
+      ],
+    },
   ]}
 />
 
@@ -245,24 +363,54 @@ A tool is being called.
     {
       name: "type",
       type: '"tool-call"',
-      description: "Chunk type identifier"
+      description: "Chunk type identifier",
     },
     {
       name: "payload",
       type: "ToolCallPayload",
       description: "Tool call information",
-      properties: [{
-        type: "ToolCallPayload",
-        parameters: [
-          { name: "toolCallId", type: "string", description: "Unique identifier for this tool call" },
-          { name: "toolName", type: "string", description: "Name of the tool being called" },
-          { name: "args", type: "Record<string, any>", isOptional: true, description: "Arguments passed to the tool" },
-          { name: "providerExecuted", type: "boolean", isOptional: true, description: "Whether the provider executed the tool" },
-          { name: "output", type: "any", isOptional: true, description: "Tool output if available" },
-          { name: "providerMetadata", type: "SharedV2ProviderMetadata", isOptional: true, description: "Provider-specific metadata" }
-        ]
-      }]
-    }
+      properties: [
+        {
+          type: "ToolCallPayload",
+          parameters: [
+            {
+              name: "toolCallId",
+              type: "string",
+              description: "Unique identifier for this tool call",
+            },
+            {
+              name: "toolName",
+              type: "string",
+              description: "Name of the tool being called",
+            },
+            {
+              name: "args",
+              type: "Record<string, any>",
+              isOptional: true,
+              description: "Arguments passed to the tool",
+            },
+            {
+              name: "providerExecuted",
+              type: "boolean",
+              isOptional: true,
+              description: "Whether the provider executed the tool",
+            },
+            {
+              name: "output",
+              type: "any",
+              isOptional: true,
+              description: "Tool output if available",
+            },
+            {
+              name: "providerMetadata",
+              type: "SharedV2ProviderMetadata",
+              isOptional: true,
+              description: "Provider-specific metadata",
+            },
+          ],
+        },
+      ],
+    },
   ]}
 />
 
@@ -275,25 +423,59 @@ Result from a tool execution.
     {
       name: "type",
       type: '"tool-result"',
-      description: "Chunk type identifier"
+      description: "Chunk type identifier",
     },
     {
       name: "payload",
       type: "ToolResultPayload",
       description: "Tool execution result",
-      properties: [{
-        type: "ToolResultPayload",
-        parameters: [
-          { name: "toolCallId", type: "string", description: "Unique identifier for the tool call" },
-          { name: "toolName", type: "string", description: "Name of the executed tool" },
-          { name: "result", type: "any", description: "The result of the tool execution" },
-          { name: "isError", type: "boolean", isOptional: true, description: "Whether the result is an error" },
-          { name: "providerExecuted", type: "boolean", isOptional: true, description: "Whether the provider executed the tool" },
-          { name: "args", type: "Record<string, any>", isOptional: true, description: "Arguments that were passed to the tool" },
-          { name: "providerMetadata", type: "SharedV2ProviderMetadata", isOptional: true, description: "Provider-specific metadata" }
-        ]
-      }]
-    }
+      properties: [
+        {
+          type: "ToolResultPayload",
+          parameters: [
+            {
+              name: "toolCallId",
+              type: "string",
+              description: "Unique identifier for the tool call",
+            },
+            {
+              name: "toolName",
+              type: "string",
+              description: "Name of the executed tool",
+            },
+            {
+              name: "result",
+              type: "any",
+              description: "The result of the tool execution",
+            },
+            {
+              name: "isError",
+              type: "boolean",
+              isOptional: true,
+              description: "Whether the result is an error",
+            },
+            {
+              name: "providerExecuted",
+              type: "boolean",
+              isOptional: true,
+              description: "Whether the provider executed the tool",
+            },
+            {
+              name: "args",
+              type: "Record<string, any>",
+              isOptional: true,
+              description: "Arguments that were passed to the tool",
+            },
+            {
+              name: "providerMetadata",
+              type: "SharedV2ProviderMetadata",
+              isOptional: true,
+              description: "Provider-specific metadata",
+            },
+          ],
+        },
+      ],
+    },
   ]}
 />
 
@@ -306,23 +488,48 @@ Signals the start of streaming tool call arguments.
     {
       name: "type",
       type: '"tool-call-input-streaming-start"',
-      description: "Chunk type identifier"
+      description: "Chunk type identifier",
     },
     {
       name: "payload",
       type: "ToolCallInputStreamingStartPayload",
       description: "Tool call input streaming start information",
-      properties: [{
-        type: "ToolCallInputStreamingStartPayload",
-        parameters: [
-          { name: "toolCallId", type: "string", description: "Unique identifier for this tool call" },
-          { name: "toolName", type: "string", description: "Name of the tool being called" },
-          { name: "providerExecuted", type: "boolean", isOptional: true, description: "Whether the provider executed the tool" },
-          { name: "dynamic", type: "boolean", isOptional: true, description: "Whether the tool call is dynamic" },
-          { name: "providerMetadata", type: "SharedV2ProviderMetadata", isOptional: true, description: "Provider-specific metadata" }
-        ]
-      }]
-    }
+      properties: [
+        {
+          type: "ToolCallInputStreamingStartPayload",
+          parameters: [
+            {
+              name: "toolCallId",
+              type: "string",
+              description: "Unique identifier for this tool call",
+            },
+            {
+              name: "toolName",
+              type: "string",
+              description: "Name of the tool being called",
+            },
+            {
+              name: "providerExecuted",
+              type: "boolean",
+              isOptional: true,
+              description: "Whether the provider executed the tool",
+            },
+            {
+              name: "dynamic",
+              type: "boolean",
+              isOptional: true,
+              description: "Whether the tool call is dynamic",
+            },
+            {
+              name: "providerMetadata",
+              type: "SharedV2ProviderMetadata",
+              isOptional: true,
+              description: "Provider-specific metadata",
+            },
+          ],
+        },
+      ],
+    },
   ]}
 />
 
@@ -335,22 +542,42 @@ Incremental tool call arguments during streaming.
     {
       name: "type",
       type: '"tool-call-delta"',
-      description: "Chunk type identifier"
+      description: "Chunk type identifier",
     },
     {
       name: "payload",
       type: "ToolCallDeltaPayload",
       description: "Incremental tool call arguments",
-      properties: [{
-        type: "ToolCallDeltaPayload",
-        parameters: [
-          { name: "argsTextDelta", type: "string", description: "Incremental text delta for tool arguments" },
-          { name: "toolCallId", type: "string", description: "Unique identifier for this tool call" },
-          { name: "toolName", type: "string", isOptional: true, description: "Name of the tool being called" },
-          { name: "providerMetadata", type: "SharedV2ProviderMetadata", isOptional: true, description: "Provider-specific metadata" }
-        ]
-      }]
-    }
+      properties: [
+        {
+          type: "ToolCallDeltaPayload",
+          parameters: [
+            {
+              name: "argsTextDelta",
+              type: "string",
+              description: "Incremental text delta for tool arguments",
+            },
+            {
+              name: "toolCallId",
+              type: "string",
+              description: "Unique identifier for this tool call",
+            },
+            {
+              name: "toolName",
+              type: "string",
+              isOptional: true,
+              description: "Name of the tool being called",
+            },
+            {
+              name: "providerMetadata",
+              type: "SharedV2ProviderMetadata",
+              isOptional: true,
+              description: "Provider-specific metadata",
+            },
+          ],
+        },
+      ],
+    },
   ]}
 />
 
@@ -363,20 +590,31 @@ Signals the end of streaming tool call arguments.
     {
       name: "type",
       type: '"tool-call-input-streaming-end"',
-      description: "Chunk type identifier"
+      description: "Chunk type identifier",
     },
     {
       name: "payload",
       type: "ToolCallInputStreamingEndPayload",
       description: "Tool call input streaming end information",
-      properties: [{
-        type: "ToolCallInputStreamingEndPayload",
-        parameters: [
-          { name: "toolCallId", type: "string", description: "Unique identifier for this tool call" },
-          { name: "providerMetadata", type: "SharedV2ProviderMetadata", isOptional: true, description: "Provider-specific metadata" }
-        ]
-      }]
-    }
+      properties: [
+        {
+          type: "ToolCallInputStreamingEndPayload",
+          parameters: [
+            {
+              name: "toolCallId",
+              type: "string",
+              description: "Unique identifier for this tool call",
+            },
+            {
+              name: "providerMetadata",
+              type: "SharedV2ProviderMetadata",
+              isOptional: true,
+              description: "Provider-specific metadata",
+            },
+          ],
+        },
+      ],
+    },
   ]}
 />
 
@@ -389,25 +627,59 @@ An error occurred during tool execution.
     {
       name: "type",
       type: '"tool-error"',
-      description: "Chunk type identifier"
+      description: "Chunk type identifier",
     },
     {
       name: "payload",
       type: "ToolErrorPayload",
       description: "Tool error information",
-      properties: [{
-        type: "ToolErrorPayload",
-        parameters: [
-          { name: "id", type: "string", isOptional: true, description: "Optional identifier" },
-          { name: "toolCallId", type: "string", description: "Unique identifier for the tool call" },
-          { name: "toolName", type: "string", description: "Name of the tool that failed" },
-          { name: "args", type: "Record<string, any>", isOptional: true, description: "Arguments that were passed to the tool" },
-          { name: "error", type: "unknown", description: "The error that occurred" },
-          { name: "providerExecuted", type: "boolean", isOptional: true, description: "Whether the provider executed the tool" },
-          { name: "providerMetadata", type: "SharedV2ProviderMetadata", isOptional: true, description: "Provider-specific metadata" }
-        ]
-      }]
-    }
+      properties: [
+        {
+          type: "ToolErrorPayload",
+          parameters: [
+            {
+              name: "id",
+              type: "string",
+              isOptional: true,
+              description: "Optional identifier",
+            },
+            {
+              name: "toolCallId",
+              type: "string",
+              description: "Unique identifier for the tool call",
+            },
+            {
+              name: "toolName",
+              type: "string",
+              description: "Name of the tool that failed",
+            },
+            {
+              name: "args",
+              type: "Record<string, any>",
+              isOptional: true,
+              description: "Arguments that were passed to the tool",
+            },
+            {
+              name: "error",
+              type: "unknown",
+              description: "The error that occurred",
+            },
+            {
+              name: "providerExecuted",
+              type: "boolean",
+              isOptional: true,
+              description: "Whether the provider executed the tool",
+            },
+            {
+              name: "providerMetadata",
+              type: "SharedV2ProviderMetadata",
+              isOptional: true,
+              description: "Provider-specific metadata",
+            },
+          ],
+        },
+      ],
+    },
   ]}
 />
 
@@ -422,25 +694,55 @@ Contains source information for content.
     {
       name: "type",
       type: '"source"',
-      description: "Chunk type identifier"
+      description: "Chunk type identifier",
     },
     {
       name: "payload",
       type: "SourcePayload",
       description: "Source information",
-      properties: [{
-        type: "SourcePayload",
-        parameters: [
-          { name: "id", type: "string", description: "Unique identifier" },
-          { name: "sourceType", type: "'url' | 'document'", description: "Type of source" },
-          { name: "title", type: "string", description: "Title of the source" },
-          { name: "mimeType", type: "string", isOptional: true, description: "MIME type of the source" },
-          { name: "filename", type: "string", isOptional: true, description: "Filename if applicable" },
-          { name: "url", type: "string", isOptional: true, description: "URL if applicable" },
-          { name: "providerMetadata", type: "SharedV2ProviderMetadata", isOptional: true, description: "Provider-specific metadata" }
-        ]
-      }]
-    }
+      properties: [
+        {
+          type: "SourcePayload",
+          parameters: [
+            { name: "id", type: "string", description: "Unique identifier" },
+            {
+              name: "sourceType",
+              type: "'url' | 'document'",
+              description: "Type of source",
+            },
+            {
+              name: "title",
+              type: "string",
+              description: "Title of the source",
+            },
+            {
+              name: "mimeType",
+              type: "string",
+              isOptional: true,
+              description: "MIME type of the source",
+            },
+            {
+              name: "filename",
+              type: "string",
+              isOptional: true,
+              description: "Filename if applicable",
+            },
+            {
+              name: "url",
+              type: "string",
+              isOptional: true,
+              description: "URL if applicable",
+            },
+            {
+              name: "providerMetadata",
+              type: "SharedV2ProviderMetadata",
+              isOptional: true,
+              description: "Provider-specific metadata",
+            },
+          ],
+        },
+      ],
+    },
   ]}
 />
 
@@ -453,22 +755,42 @@ Contains file data.
     {
       name: "type",
       type: '"file"',
-      description: "Chunk type identifier"
+      description: "Chunk type identifier",
     },
     {
       name: "payload",
       type: "FilePayload",
       description: "File data",
-      properties: [{
-        type: "FilePayload",
-        parameters: [
-          { name: "data", type: "string | Uint8Array", description: "The file data" },
-          { name: "base64", type: "string", isOptional: true, description: "Base64 encoded data if applicable" },
-          { name: "mimeType", type: "string", description: "MIME type of the file" },
-          { name: "providerMetadata", type: "SharedV2ProviderMetadata", isOptional: true, description: "Provider-specific metadata" }
-        ]
-      }]
-    }
+      properties: [
+        {
+          type: "FilePayload",
+          parameters: [
+            {
+              name: "data",
+              type: "string | Uint8Array",
+              description: "The file data",
+            },
+            {
+              name: "base64",
+              type: "string",
+              isOptional: true,
+              description: "Base64 encoded data if applicable",
+            },
+            {
+              name: "mimeType",
+              type: "string",
+              description: "MIME type of the file",
+            },
+            {
+              name: "providerMetadata",
+              type: "SharedV2ProviderMetadata",
+              isOptional: true,
+              description: "Provider-specific metadata",
+            },
+          ],
+        },
+      ],
+    },
   ]}
 />
 
@@ -483,19 +805,25 @@ Signals the start of streaming.
     {
       name: "type",
       type: '"start"',
-      description: "Chunk type identifier"
+      description: "Chunk type identifier",
     },
     {
       name: "payload",
       type: "StartPayload",
       description: "Start information",
-      properties: [{
-        type: "StartPayload",
-        parameters: [
-          { name: "[key: string]", type: "any", description: "Additional start data" }
-        ]
-      }]
-    }
+      properties: [
+        {
+          type: "StartPayload",
+          parameters: [
+            {
+              name: "[key: string]",
+              type: "any",
+              description: "Additional start data",
+            },
+          ],
+        },
+      ],
+    },
   ]}
 />
 
@@ -508,21 +836,37 @@ Signals the start of a processing step.
     {
       name: "type",
       type: '"step-start"',
-      description: "Chunk type identifier"
+      description: "Chunk type identifier",
     },
     {
       name: "payload",
       type: "StepStartPayload",
       description: "Step start information",
-      properties: [{
-        type: "StepStartPayload",
-        parameters: [
-          { name: "messageId", type: "string", isOptional: true, description: "Optional message identifier" },
-          { name: "request", type: "object", description: "Request information including body and other data" },
-          { name: "warnings", type: "LanguageModelV2CallWarning[]", isOptional: true, description: "Any warnings from the language model call" }
-        ]
-      }]
-    }
+      properties: [
+        {
+          type: "StepStartPayload",
+          parameters: [
+            {
+              name: "messageId",
+              type: "string",
+              isOptional: true,
+              description: "Optional message identifier",
+            },
+            {
+              name: "request",
+              type: "object",
+              description: "Request information including body and other data",
+            },
+            {
+              name: "warnings",
+              type: "LanguageModelV2CallWarning[]",
+              isOptional: true,
+              description: "Any warnings from the language model call",
+            },
+          ],
+        },
+      ],
+    },
   ]}
 />
 
@@ -535,26 +879,67 @@ Signals the completion of a processing step.
     {
       name: "type",
       type: '"step-finish"',
-      description: "Chunk type identifier"
+      description: "Chunk type identifier",
     },
     {
       name: "payload",
       type: "StepFinishPayload",
       description: "Step completion information",
-      properties: [{
-        type: "StepFinishPayload",
-        parameters: [
-          { name: "id", type: "string", isOptional: true, description: "Optional identifier" },
-          { name: "messageId", type: "string", isOptional: true, description: "Optional message identifier" },
-          { name: "stepResult", type: "object", description: "Step execution result with reason, warnings, and continuation info" },
-          { name: "output", type: "object", description: "Output information including usage statistics" },
-          { name: "metadata", type: "object", description: "Execution metadata including request and provider info" },
-          { name: "totalUsage", type: "LanguageModelV2Usage", isOptional: true, description: "Total usage statistics" },
-          { name: "response", type: "LanguageModelV2ResponseMetadata", isOptional: true, description: "Response metadata" },
-          { name: "providerMetadata", type: "SharedV2ProviderMetadata", isOptional: true, description: "Provider-specific metadata" }
-        ]
-      }]
-    }
+      properties: [
+        {
+          type: "StepFinishPayload",
+          parameters: [
+            {
+              name: "id",
+              type: "string",
+              isOptional: true,
+              description: "Optional identifier",
+            },
+            {
+              name: "messageId",
+              type: "string",
+              isOptional: true,
+              description: "Optional message identifier",
+            },
+            {
+              name: "stepResult",
+              type: "object",
+              description:
+                "Step execution result with reason, warnings, and continuation info",
+            },
+            {
+              name: "output",
+              type: "object",
+              description: "Output information including usage statistics",
+            },
+            {
+              name: "metadata",
+              type: "object",
+              description:
+                "Execution metadata including request and provider info",
+            },
+            {
+              name: "totalUsage",
+              type: "LanguageModelV2Usage",
+              isOptional: true,
+              description: "Total usage statistics",
+            },
+            {
+              name: "response",
+              type: "LanguageModelV2ResponseMetadata",
+              isOptional: true,
+              description: "Response metadata",
+            },
+            {
+              name: "providerMetadata",
+              type: "SharedV2ProviderMetadata",
+              isOptional: true,
+              description: "Provider-specific metadata",
+            },
+          ],
+        },
+      ],
+    },
   ]}
 />
 
@@ -567,19 +952,25 @@ Contains raw data from the provider.
     {
       name: "type",
       type: '"raw"',
-      description: "Chunk type identifier"
+      description: "Chunk type identifier",
     },
     {
       name: "payload",
       type: "RawPayload",
       description: "Raw provider data",
-      properties: [{
-        type: "RawPayload",
-        parameters: [
-          { name: "[key: string]", type: "any", description: "Raw data from the provider" }
-        ]
-      }]
-    }
+      properties: [
+        {
+          type: "RawPayload",
+          parameters: [
+            {
+              name: "[key: string]",
+              type: "any",
+              description: "Raw data from the provider",
+            },
+          ],
+        },
+      ],
+    },
   ]}
 />
 
@@ -592,22 +983,40 @@ Stream has completed successfully.
     {
       name: "type",
       type: '"finish"',
-      description: "Chunk type identifier"
+      description: "Chunk type identifier",
     },
     {
       name: "payload",
       type: "FinishPayload",
       description: "Completion information",
-      properties: [{
-        type: "FinishPayload",
-        parameters: [
-          { name: "stepResult", type: "object", description: "Step execution result" },
-          { name: "output", type: "object", description: "Output information including usage" },
-          { name: "metadata", type: "object", description: "Execution metadata" },
-          { name: "messages", type: "object", description: "Message history" }
-        ]
-      }]
-    }
+      properties: [
+        {
+          type: "FinishPayload",
+          parameters: [
+            {
+              name: "stepResult",
+              type: "object",
+              description: "Step execution result",
+            },
+            {
+              name: "output",
+              type: "object",
+              description: "Output information including usage",
+            },
+            {
+              name: "metadata",
+              type: "object",
+              description: "Execution metadata",
+            },
+            {
+              name: "messages",
+              type: "object",
+              description: "Message history",
+            },
+          ],
+        },
+      ],
+    },
   ]}
 />
 
@@ -620,19 +1029,25 @@ An error occurred during streaming.
     {
       name: "type",
       type: '"error"',
-      description: "Chunk type identifier"
+      description: "Chunk type identifier",
     },
     {
       name: "payload",
       type: "ErrorPayload",
       description: "Error information",
-      properties: [{
-        type: "ErrorPayload",
-        parameters: [
-          { name: "error", type: "unknown", description: "The error that occurred" }
-        ]
-      }]
-    }
+      properties: [
+        {
+          type: "ErrorPayload",
+          parameters: [
+            {
+              name: "error",
+              type: "unknown",
+              description: "The error that occurred",
+            },
+          ],
+        },
+      ],
+    },
   ]}
 />
 
@@ -645,19 +1060,25 @@ Stream was aborted.
     {
       name: "type",
       type: '"abort"',
-      description: "Chunk type identifier"
+      description: "Chunk type identifier",
     },
     {
       name: "payload",
       type: "AbortPayload",
       description: "Abort information",
-      properties: [{
-        type: "AbortPayload",
-        parameters: [
-          { name: "[key: string]", type: "any", description: "Additional abort data" }
-        ]
-      }]
-    }
+      properties: [
+        {
+          type: "AbortPayload",
+          parameters: [
+            {
+              name: "[key: string]",
+              type: "any",
+              description: "Additional abort data",
+            },
+          ],
+        },
+      ],
+    },
   ]}
 />
 
@@ -672,13 +1093,14 @@ Emitted when using output generation with defined schemas. Contains partial or c
     {
       name: "type",
       type: '"object"',
-      description: "Chunk type identifier"
+      description: "Chunk type identifier",
     },
     {
       name: "object",
       type: "PartialSchemaOutput<OUTPUT>",
-      description: "Partial or complete structured data matching the defined schema. The type is determined by the OUTPUT schema parameter."
-    }
+      description:
+        "Partial or complete structured data matching the defined schema. The type is determined by the OUTPUT schema parameter.",
+    },
   ]}
 />
 
@@ -691,19 +1113,26 @@ Contains output from agent or workflow execution, particularly used for tracking
     {
       name: "type",
       type: '"tool-output"',
-      description: "Chunk type identifier"
+      description: "Chunk type identifier",
     },
     {
       name: "payload",
       type: "ToolOutputPayload",
       description: "Wrapped execution output with metadata",
-      properties: [{
-        type: "ToolOutputPayload",
-        parameters: [
-          { name: "output", type: "ChunkType", description: "Nested chunk data, often containing finish events with usage statistics" }
-        ]
-      }]
-    }
+      properties: [
+        {
+          type: "ToolOutputPayload",
+          parameters: [
+            {
+              name: "output",
+              type: "ChunkType",
+              description:
+                "Nested chunk data, often containing finish events with usage statistics",
+            },
+          ],
+        },
+      ],
+    },
   ]}
 />
 
@@ -716,19 +1145,26 @@ Contains output from workflow step execution, used primarily for usage tracking
     {
       name: "type",
       type: '"step-output"',
-      description: "Chunk type identifier"
+      description: "Chunk type identifier",
     },
     {
       name: "payload",
       type: "StepOutputPayload",
       description: "Workflow step execution output with metadata",
-      properties: [{
-        type: "StepOutputPayload",
-        parameters: [
-          { name: "output", type: "ChunkType", description: "Nested chunk data from step execution, typically containing finish events or other step results" }
-        ]
-      }]
-    }
+      properties: [
+        {
+          type: "StepOutputPayload",
+          parameters: [
+            {
+              name: "output",
+              type: "ChunkType",
+              description:
+                "Nested chunk data from step execution, typically containing finish events or other step results",
+            },
+          ],
+        },
+      ],
+    },
   ]}
 />
 
@@ -743,20 +1179,32 @@ Contains metadata about the LLM provider's response. Emitted by some providers a
     {
       name: "type",
       type: '"response-metadata"',
-      description: "Chunk type identifier"
+      description: "Chunk type identifier",
     },
     {
       name: "payload",
       type: "ResponseMetadataPayload",
       description: "Provider response metadata for tracking and debugging",
-      properties: [{
-        type: "ResponseMetadataPayload",
-        parameters: [
-          { name: "signature", type: "string", isOptional: true, description: "Response signature if available" },
-          { name: "[key: string]", type: "any", description: "Additional provider-specific metadata fields (e.g., id, modelId, timestamp, headers)" }
-        ]
-      }]
-    }
+      properties: [
+        {
+          type: "ResponseMetadataPayload",
+          parameters: [
+            {
+              name: "signature",
+              type: "string",
+              isOptional: true,
+              description: "Response signature if available",
+            },
+            {
+              name: "[key: string]",
+              type: "any",
+              description:
+                "Additional provider-specific metadata fields (e.g., id, modelId, timestamp, headers)",
+            },
+          ],
+        },
+      ],
+    },
   ]}
 />
 
@@ -769,21 +1217,39 @@ Contains monitoring and observability data from agent execution. Can include wor
     {
       name: "type",
       type: '"watch"',
-      description: "Chunk type identifier"
+      description: "Chunk type identifier",
     },
     {
       name: "payload",
       type: "WatchPayload",
-      description: "Monitoring data for observability and debugging of agent execution",
-      properties: [{
-        type: "WatchPayload",
-        parameters: [
-          { name: "workflowState", type: "object", isOptional: true, description: "Current workflow execution state (when used in workflows)" },
-          { name: "eventTimestamp", type: "number", isOptional: true, description: "Timestamp when the event occurred" },
-          { name: "[key: string]", type: "any", description: "Additional monitoring and execution data" }
-        ]
-      }]
-    }
+      description:
+        "Monitoring data for observability and debugging of agent execution",
+      properties: [
+        {
+          type: "WatchPayload",
+          parameters: [
+            {
+              name: "workflowState",
+              type: "object",
+              isOptional: true,
+              description:
+                "Current workflow execution state (when used in workflows)",
+            },
+            {
+              name: "eventTimestamp",
+              type: "number",
+              isOptional: true,
+              description: "Timestamp when the event occurred",
+            },
+            {
+              name: "[key: string]",
+              type: "any",
+              description: "Additional monitoring and execution data",
+            },
+          ],
+        },
+      ],
+    },
   ]}
 />
 
@@ -796,19 +1262,27 @@ Emitted when the stream is forcibly terminated due to content being blocked by o
     {
       name: "type",
       type: '"tripwire"',
-      description: "Chunk type identifier"
+      description: "Chunk type identifier",
     },
     {
       name: "payload",
       type: "TripwirePayload",
-      description: "Information about why the stream was terminated by safety mechanisms",
-      properties: [{
-        type: "TripwirePayload",
-        parameters: [
-          { name: "tripwireReason", type: "string", description: "Explanation of why the content was blocked (e.g., 'Output processor blocked content')" }
-        ]
-      }]
-    }
+      description:
+        "Information about why the stream was terminated by safety mechanisms",
+      properties: [
+        {
+          type: "TripwirePayload",
+          parameters: [
+            {
+              name: "tripwireReason",
+              type: "string",
+              description:
+                "Explanation of why the content was blocked (e.g., 'Output processor blocked content')",
+            },
+          ],
+        },
+      ],
+    },
   ]}
 />
 
@@ -819,29 +1293,29 @@ const stream = await agent.stream("Hello");
 
 for await (const chunk of stream.fullStream) {
   switch (chunk.type) {
-    case 'text-delta':
-      console.log('Text:', chunk.payload.text);
+    case "text-delta":
+      console.log("Text:", chunk.payload.text);
       break;
 
-    case 'tool-call':
-      console.log('Calling tool:', chunk.payload.toolName);
+    case "tool-call":
+      console.log("Calling tool:", chunk.payload.toolName);
       break;
 
-    case 'tool-result':
-      console.log('Tool result:', chunk.payload.result);
+    case "tool-result":
+      console.log("Tool result:", chunk.payload.result);
       break;
 
-    case 'reasoning-delta':
-      console.log('Reasoning:', chunk.payload.text);
+    case "reasoning-delta":
+      console.log("Reasoning:", chunk.payload.text);
       break;
 
-    case 'finish':
-      console.log('Finished:', chunk.payload.stepResult.reason);
-      console.log('Usage:', chunk.payload.output.usage);
+    case "finish":
+      console.log("Finished:", chunk.payload.stepResult.reason);
+      console.log("Usage:", chunk.payload.output.usage);
       break;
 
-    case 'error':
-      console.error('Error:', chunk.payload.error);
+    case "error":
+      console.error("Error:", chunk.payload.error);
       break;
   }
 }
@@ -849,6 +1323,6 @@ for await (const chunk of stream.fullStream) {
 
 ## Related Types
 
-- [.stream()](./agents/stream.mdx) - Method that returns streams emitting these chunks
-- [MastraModelOutput](./agents/MastraModelOutput.mdx) - The stream object that emits these chunks
-- [workflow.streamVNext()](./workflows/streamVNext.mdx) - Method that returns streams emitting these chunks for workflows
+- [.stream()](./agents/stream) - Method that returns streams emitting these chunks
+- [MastraModelOutput](./agents/MastraModelOutput) - The stream object that emits these chunks
+- [workflow.streamVNext()](./workflows/streamVNext) - Method that returns streams emitting these chunks for workflows