@mastra/mcp-docs-server 0.13.11-alpha.1 → 0.13.11-alpha.2

package/.docs/raw/reference/workflows/stream.mdx

@@ -1,234 +1,84 @@
 ---
-title: "Reference: Workflow.stream() | Building Workflows | Mastra Docs"
-description: Documentation for the `.stream()` method in workflows, which allows you to monitor the execution of a workflow run as a stream.
+title: "Reference: WorkflowRun.stream() | Workflows | Mastra Docs"
+description: Documentation for the `WorkflowRun.stream()` method in workflows, which allows you to monitor the execution of a workflow run as a stream.
 ---
 
-# Run.stream()
+# WorkflowRun.stream()
 
 The `.stream()` method allows you to monitor the execution of a workflow run, providing real-time updates on the status of steps.
 
-## Usage
+## Usage example
 
-```typescript
-const run = await myWorkflow.createRunAsync();
+```typescript showLineNumbers copy
+const run = await workflow.createRunAsync();
 
-// Add a stream to monitor execution
-const result = run.stream({ inputData: {...} });
-
-
-for (const chunk of stream) {
-  // do something with the chunk
-}
+const stream = await run.stream({
+  inputData: {
+    value: "initial data",
+  },
+});
 ```
 
-## Messages
+## Parameters
 
 <PropertiesTable
   content={[
     {
-      name: "start",
-      type: "object",
-      description: "The workflow starts",
-      isOptional: false,
-      properties: [
-        {
-          type: "object",
-          parameters: [
-            {
-              name: "example",
-              type: "{ type: 'start', payload: { runId: '1' } }",
-              description: "Example message structure",
-              isOptional: false,
-            },
-          ],
-        },
-      ],
-    },
-    {
-      name: "step-start",
-      type: "object",
-      description: "The start of a step",
-      isOptional: false,
-      properties: [
-        {
-          type: "object",
-          parameters: [
-            {
-              name: "example",
-              type: "{ type: 'step-start', payload: { id: 'fetch-weather' } }",
-              description: "Example message structure",
-              isOptional: false,
-            },
-          ],
-        },
-      ],
-    },
-    {
-      name: "tool-call",
-      type: "object",
-      description: "A tool call has started",
-      isOptional: false,
-      properties: [
-        {
-          type: "object",
-          parameters: [
-            {
-              name: "example",
-              type: "{ type: 'tool-call', toolCallId: 'weatherAgent', toolName: 'Weather Agent', args: { prompt: 'Based on the following weather forecast for New York, suggest appropriate activities:...' } }",
-              description: "Example message structure",
-              isOptional: false,
-            },
-          ],
-        },
-      ],
-    },
-    {
-      name: "tool-call-streaming-start",
-      type: "object",
-      description: "A tool call/agent has started",
-      isOptional: false,
-      properties: [
-        {
-          type: "object",
-          parameters: [
-            {
-              name: "example",
-              type: "{ type: 'tool-call-streaming-start', toolCallId: 'weatherAgent', toolName: 'Weather Agent', args: { prompt: 'Based on the following weather forecast for New York, suggest appropriate activities:...' } }",
-              description: "Example message structure",
-              isOptional: false,
-            },
-          ],
-        },
-      ],
+      name: "inputData",
+      type: "z.infer<TInput>",
+      description: "Input data that matches the workflow's input schema",
+      isOptional: true,
     },
     {
-      name: "tool-call-delta",
-      type: "object",
-      description: "The delta of the tool output",
-      isOptional: false,
-      properties: [
-        {
-          type: "object",
-          parameters: [
-            {
-              name: "example",
-              type: "{ type: 'tool-call-delta', toolCallId: 'weatherAgent', toolName: 'Weather Agent', args: { prompt: 'Based on the following weather forecast for New York, suggest appropriate activities:\\n' + '            [\\n' + '  {\\n' + '    \"date\": \"2025-05-16\",\\n' + '    \"maxTemp\": 22.2,\\n' + '    \"minTemp\": 16,\\n' + '    \"precipitationChance\": 5,\\n' + '    \"condition\": \"Dense drizzle\",\\n' + '    \"location\": \"New York\"\\n' + '  },\\n' + '            ' }, argsTextDelta: '📅' }",
-              description: "Example message structure",
-              isOptional: false,
-            },
-          ],
-        },
-      ],
-    },
-    {
-      name: "step-result",
-      type: "object",
-      description: "The result of a step",
-      isOptional: false,
-      properties: [
-        {
-          type: "object",
-          parameters: [
-            {
-              name: "example",
-              type: "{ type: 'step-result', payload: { id: 'Weather Agent', status: 'success', output: [Object] } }",
-              description: "Example message structure",
-              isOptional: false,
-            },
-          ],
-        },
-      ],
-    },
-    {
-      name: "step-finish",
-      type: "object",
-      description: "The end of a step",
-      isOptional: false,
-      properties: [
-        {
-          type: "object",
-          parameters: [
-            {
-              name: "example",
-              type: "{ type: 'step-finish', payload: { id: 'Weather Agent', metadata: {} } }",
-              description: "Example message structure",
-              isOptional: false,
-            },
-          ],
-        },
-      ],
-    },
-    {
-      name: "finish",
-      type: "object",
-      description: "The end of the workflow",
-      isOptional: false,
-      properties: [
-        {
-          type: "object",
-          parameters: [
-            {
-              name: "example",
-              type: "{ type: 'finish', payload: { runId: '1' } }",
-              description: "Example message structure",
-              isOptional: false,
-            },
-          ],
-        },
-      ],
+      name: "runtimeContext",
+      type: "RuntimeContext",
+      description: "Runtime context data to use during workflow execution",
+      isOptional: true,
     },
   ]}
 />
 
-## Parameters
+## Returns
 
 <PropertiesTable
   content={[
     {
-      name: "params",
-      type: "object",
-      description: "Configuration object for starting the workflow run",
-      isOptional: false,
-      properties: [
-        {
-          name: "inputData",
-          type: "z.infer<TInput>",
-          parameters: [
-            {
-              name: "z.infer<TInput>",
-              type: "inputData",
-              description:
-                "Runtime context data to use when starting the workflow",
-              isOptional: true,
-            },
-          ],
-        },
-        {
-          name: "runtimeContext",
-          type: "RuntimeContext",
-          parameters: [
-            {
-              name: "runtimeContext",
-              type: "RuntimeContext",
-              description:
-                "Runtime context data to use when starting the workflow",
-              isOptional: true,
-            },
-          ],
-        },
-      ],
+      name: "stream",
+      type: "ReadableStream<StreamEvent>",
+      description: "A readable stream that emits workflow execution events in real-time",
     },
-  ]}
-/>
-
-## Returns
-
-<PropertiesTable
-  content={[
     {
-      name: "result",
-      type: "Promise<WorkflowResult<TOutput, TSteps>>",
-      description: "A stream that pipes each step to the stream",
+      name: "getWorkflowState",
+      type: "() => Promise<WorkflowResult<TOutput, TSteps>>",
+      description: "A function that returns a promise resolving to the final workflow result",
     },
   ]}
 />
+
+## Extended usage example
+
+```typescript showLineNumbers copy
+const { getWorkflowState } = await run.stream({
+  inputData: {
+    value: "initial data"
+  }
+});
+
+const result = await getWorkflowState();
+```
+
+## Stream Events
+
+The stream emits various event types during workflow execution. Each event has a `type` field and a `payload` containing relevant data:
+
+- **`start`**: Workflow execution begins
+- **`step-start`**: A step begins execution
+- **`tool-call`**: A tool call is initiated
+- **`tool-call-streaming-start`**: Tool call streaming begins
+- **`tool-call-delta`**: Incremental tool output updates
+- **`step-result`**: A step completes with results
+- **`step-finish`**: A step finishes execution
+- **`finish`**: Workflow execution completes
+
+
+

package/.docs/raw/reference/workflows/streamVNext.mdx

@@ -1,215 +1,96 @@
 ---
-title: "Reference: Workflow.streamVNext() | Streaming | Workflows | Mastra Docs"
-description: Documentation for the `.streamVNext()` method in Mastra workflows, which enables real-time streaming of responses.
+title: "Reference: WorkflowRun.streamVNext() | Workflows | Mastra Docs"
+description: Documentation for the `WorkflowRun.streamVNext()` method in workflows, which enables real-time streaming of responses.
 ---
 
-# `streamVNext()`
+# WorkflowRun.streamVNext()
 
-The `streamVNext()` method enables real-time streaming of responses from a workflow.
+The `.streamVNext()` method enables real-time streaming of responses from a workflow.
 
-## Usage
+## Usage example
 
-```typescript
-const run = await myWorkflow.createRunAsync();
-
-// Add a stream to monitor execution
-const stream = run.streamVNext({ inputData: {...} });
-
-
-for (const chunk of stream) {
-  // do something with the chunk
-}
+```typescript showLineNumbers copy
+const run = await workflow.createRunAsync();
 
+const stream = run.streamVNext({
+  inputData: {
+    value: "initial data",
+  },
+});
 ```
 
-## Protocol
+## Parameters
 
 <PropertiesTable
   content={[
     {
-      name: "start",
-      type: "object",
-      description: "The workflow starts",
-      isOptional: false,
-      properties: [
-        {
-          type: "object",
-          parameters: [
-            {
-              name: "example",
-              type: "{ type: 'start', runId: '1', from: 'WORKFLOW', payload: { runId: '1' } }",
-              description: "Example message structure",
-              isOptional: false,
-            },
-          ],
-        },
-      ],
-    },
-    {
-      name: "step-start",
-      type: "object",
-      description: "The start of a step",
-      isOptional: false,
-      properties: [
-        {
-          type: "object",
-          parameters: [
-            {
-              name: "example",
-              type: "{ type: 'step-start', runId: '1', from: 'WORKFLOW', payload: { id: 'fetch-weather' } }",
-              description: "Example message structure",
-              isOptional: false,
-            },
-          ],
-        },
-      ],
-    },
-    {
-      name: "step-output",
-      type: "object",
-      description: "Custom output from a step",
-      isOptional: false,
-      properties: [
-        {
-          type: "object",
-          parameters: [
-            {
-              name: "example",
-              type: "{ type: 'step-output', runId: '1', from: 'WORKFLOW', payload: { stepName: 'my step', args: { ... }, stepCallId: 'uuid', startedAt: 1717000000000, status: 'running' } }",
-              description: "Example message structure",
-              isOptional: false,
-            },
-          ],
-        },
-      ],
-    },
-    {
-      name: "step-result",
-      type: "object",
-      description: "The result of a step",
-      isOptional: false,
-      properties: [
-        {
-          type: "object",
-          parameters: [
-            {
-              name: "example",
-              type: "{ type: 'step-result', runId: '1', from: 'WORKFLOW', payload: { stepName: 'my step', result: { ... }, stepCallId: 'uuid', endedAt: 1717000000000, status: 'success', output: [Object] } }",
-              description: "Example message structure",
-              isOptional: false,
-            },
-          ],
-        },
-      ],
+      name: "inputData",
+      type: "z.infer<TInput>",
+      description: "Input data that matches the workflow's input schema",
+      isOptional: true,
     },
     {
-      name: "finish",
-      type: "object",
-      description: "The end of the workflow",
-      isOptional: false,
-      properties: [
-        {
-          type: "object",
-          parameters: [
-            {
-              name: "example",
-              type: "{ type: 'finish', runId: '1', from: 'WORKFLOW', payload: { totalUsage: { promptTokens: 100, completionTokens: 100, totalTokens: 200 } } }",
-              description: "Example message structure",
-              isOptional: false,
-            },
-          ],
-        },
-      ],
+      name: "runtimeContext",
+      type: "RuntimeContext",
+      description: "Runtime context data to use during workflow execution",
+      isOptional: true,
     },
   ]}
 />
 
 ## Returns
 
-### PropertiesTable for Return Values
-
 <PropertiesTable
   content={[
     {
-      name: "usage",
-      type: "Promise<object>",
-      isOptional: true,
-      description:
-        "Total usage of the workflow, including sub agents/workflows as a step.",
-      properties: [
-        {
-          type: "number",
-          parameters: [
-            {
-              name: "promptTokens",
-              type: "number",
-              isOptional: true,
-              description: "The number of prompt tokens used by the agent.",
-            },
-          ],
-        },
-        {
-          type: "number",
-          parameters: [
-            {
-              name: "completionTokens",
-              type: "number",
-              isOptional: true,
-              description: "The number of completion tokens used by the agent.",
-            },
-          ],
-        },
-        {
-          type: "number",
-          parameters: [
-            {
-              name: "totalTokens",
-              type: "number", 
-              isOptional: true,
-              description: "The total number of tokens used by the agent.",
-            },
-          ],
-        },
-      ],
+      name: "stream",
+      type: "MastraWorkflowStream<ChunkType>",
+      description: "A custom stream that extends ReadableStream<ChunkType> with additional workflow-specific properties",
     },
     {
-      name: "status",
-      type: "Promise<string>",
-      isOptional: true,
-      description:
-        "The status of the workflow run.",
+      name: "stream.status",
+      type: "Promise<WorkflowRunStatus>",
+      description: "A promise that resolves to the current workflow run status",
     },
     {
-      name: "result",
-      type: "Promise<object>",
-      isOptional: true,
-      description:
-        "The result of the workflow run.",
+      name: "stream.result",
+      type: "Promise<WorkflowResult<TOutput, TSteps>>",
+      description: "A promise that resolves to the final workflow result",
+    },
+    {
+      name: "stream.usage",
+      type: "Promise<{ promptTokens: number; completionTokens: number; totalTokens: number }>",
+      description: "A promise that resolves to token usage statistics",
     },
   ]}
 />
 
-## Examples
+## Extended usage example
 
-### Basic Streaming
+```typescript showLineNumbers copy
+const run = await workflow.createRunAsync();
 
-```typescript
-const run = await myWorkflow.createRunAsync();
-const stream = run.streamVNext({ inputData: {...} });
+const stream = run.streamVNext({
+  inputData: {
+    value: "initial data",
+  },
+});
 
-for await (const chunk of stream) {
-  process.stdout.write(chunk);
-}
+const result = await stream.result;
 ```
 
-### Structured Output Streaming
+## Stream Events
+
+The stream emits various event types during workflow execution. Each event has a `type` field and a `payload` containing relevant data:
+
+- **`start`**: Workflow execution begins
+- **`step-start`**: A step begins execution
+- **`step-output`**: Custom output from a step
+- **`step-result`**: A step completes with results
+- **`finish`**: Workflow execution completes with usage statistics
+
+
 
-```typescript
-const run = await myWorkflow.createRunAsync();
-const stream = run.streamVNext({ inputData: {...} });
 
 
-const result = await stream.result;
-console.log("Final structured result:", result);
-```
 

package/.docs/raw/reference/workflows/then.mdx

@@ -1,16 +1,16 @@
 ---
-title: "Reference: Workflow.then() | Building Workflows | Mastra Docs"
-description: Documentation for the `.then()` method in workflows, which creates sequential dependencies between steps.
+title: "Reference: Workflow.then() | Workflows | Mastra Docs"
+description: Documentation for the `Workflow.then()` method in workflows, which creates sequential dependencies between steps.
 ---
 
 # Workflow.then()
 
 The `.then()` method creates a sequential dependency between workflow steps, ensuring steps execute in a specific order.
 
-## Usage
+## Usage example
 
-```typescript
-workflow.then(stepOne).then(stepTwo);
+```typescript copy
+workflow.then(step1).then(step2);
 ```
 
 ## Parameters

package/.docs/raw/reference/workflows/waitForEvent.mdx

@@ -1,16 +1,16 @@
 ---
-title: "Reference: Workflow.waitForEvent() | Building Workflows | Mastra Docs"
-description: Documentation for the `.waitForEvent()` method in workflows, which pauses execution until an event is received.
+title: "Reference: Workflow.waitForEvent() | Workflows | Mastra Docs"
+description: Documentation for the `Workflow.waitForEvent()` method in workflows, which pauses execution until an event is received.
 ---
 
 # Workflow.waitForEvent()
 
 The `.waitForEvent()` method pauses execution until an event is received.
 
-## Usage
+## Usage example
 
-```typescript
-workflow.waitForEvent('my-event-name', step1);
+```typescript copy
+workflow.waitForEvent('event-name', step1);
 ```
 
 ## Parameters

package/.docs/raw/reference/workflows/watch.mdx

@@ -1,24 +1,22 @@
 ---
-title: "Reference: Workflow.watch() | Building Workflows | Mastra Docs"
-description: Documentation for the `.watch()` method in workflows, which allows you to monitor the execution of a workflow run.
+title: "Reference: WorkflowRun.watch() | Workflows | Mastra Docs"
+description: Documentation for the `WorkflowRun.watch()` method in workflows, which allows you to monitor the execution of a workflow run.
 ---
 
-# Workflow.watch()
+# WorkflowRun.watch()
 
 The `.watch()` method allows you to monitor the execution of a workflow run, providing real-time updates on the status of steps.
 
-## Usage
+## Usage example
 
-```typescript
-const run = await myWorkflow.createRunAsync();
+```typescript showLineNumbers copy
+const run = await workflow.createRunAsync();
 
-// Add a watcher to monitor execution
 run.watch(event => {
-  console.log('Step completed:', event.payload.currentStep.id);
+  console.log('Step completed:', event?.payload?.currentStep?.id);
 });
 
-// Start the workflow
-const result = await run.start({ inputData: {...} });
+const result = await run.start({ inputData: { value: "initial data" } });
 ```
 
 ## Parameters
@@ -26,15 +24,22 @@ const result = await run.start({ inputData: {...} });
 <PropertiesTable
   content={[
     {
-      name: "cb",
+      name: "callback",
       type: "(event: WatchEvent) => void",
-      description:
-        "A callback function that is called whenever a step is completed or the workflow state changes",
+      description: "A callback function that is called whenever a step is completed or the workflow state changes. The event parameter contains: type ('watch'), payload (currentStep and workflowState), and eventTimestamp",
       isOptional: false,
     },
+    {
+      name: "type",
+      type: "'watch' | 'watch-v2'",
+      description: "The type of watch events to listen for. 'watch' for step completion events, 'watch-v2' for data stream events",
+      isOptional: true,
+      defaultValue: "'watch'",
+    },
   ]}
 />
 
+
 ## Returns
 
 <PropertiesTable
@@ -48,6 +53,19 @@ const result = await run.start({ inputData: {...} });
   ]}
 />
 
+## Extended usage example
+
+```typescript showLineNumbers copy
+const run = await workflow.createRunAsync();
+
+run.watch((event) => {
+  console.log("Step completed:", event?.payload?.currentStep?.id);
+}, 'watch');
+
+
+const result = await run.start({ inputData: { value: "initial data" } });
+```
+
 ## Related
 
 - [Suspend and resume](../../docs/workflows/suspend-and-resume.mdx)