@mastra/mcp-docs-server 0.13.22 → 0.13.23

package/.docs/raw/reference/streaming/workflows/resumeStreamVNext.mdx

@@ -0,0 +1,100 @@
+---
+title: "Reference: Run.resumeStreamVNext() | Workflows | Mastra Docs"
+description: Documentation for the `Run.resumeStreamVNext()` method in workflows, which enables real-time resumption and streaming of suspended workflow runs.
+---
+
+import { StreamVNextCallout } from "@/components/streamVNext-callout.tsx"
+
+# Run.resumeStreamVNext() (Experimental)
+
+<StreamVNextCallout />
+
+The `.resumeStreamVNext()` method resumes a suspended workflow run with new data, allowing you to continue execution from a specific step and to observe the stream of events.
+
+## Usage example
+
+```typescript showLineNumbers copy
+const run = await workflow.createRunAsync();
+
+const stream = run.streamVNext({
+  inputData: {
+    value: "initial data",
+  },
+});
+
+
+const result = await stream.result;
+if (result.status === "suspended") {
+  const resumedStream = await run.resumeStreamVNext({
+    resumeData: { value: "resume data" }
+  });
+}
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "resumeData",
+      type: "z.infer<TInput>",
+      description: "Input data that matches the workflow's input schema",
+      isOptional: true,
+    },
+    {
+      name: "runtimeContext",
+      type: "RuntimeContext",
+      description: "Runtime context data to use during workflow execution",
+      isOptional: true,
+    },
+    {
+      name: "step",
+      type: "Step<string, any, any, any, any, TEngineType>",
+      description: "The step to resume execution from",
+      isOptional: true,
+    },
+  ]}
+/>
+
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: "stream",
+      type: "MastraWorkflowStream<ChunkType>",
+      description: "A custom stream that extends ReadableStream<ChunkType> with additional workflow-specific properties",
+    },
+    {
+      name: "stream.status",
+      type: "Promise<RunStatus>",
+      description: "A promise that resolves to the current workflow run status",
+    },
+    {
+      name: "stream.result",
+      type: "Promise<WorkflowResult<TOutput, TSteps>>",
+      description: "A promise that resolves to the final workflow result",
+    },
+    {
+      name: "stream.usage",
+      type: "Promise<{ inputTokens: number; outputTokens: number; totalTokens: number, reasoningTokens?: number, cacheInputTokens?: number }>",
+      description: "A promise that resolves to token usage statistics",
+    },
+  ]}
+/>
+
+## Stream Events
+
+The stream emits various event types during workflow execution. Each event has a `type` field and a `payload` containing relevant data:
+
+- **`workflow-start`**: Workflow execution begins
+- **`workflow-step-start`**: A step begins execution
+- **`workflow-step-output`**: Custom output from a step
+- **`workflow-step-result`**: A step completes with results
+- **`workflow-finish`**: Workflow execution completes with usage statistics
+
+## Related
+
+- [Workflows overview](../../../docs/workflows/overview.mdx#run-workflow)
+- [Workflow.createRunAsync()](../create-run.mdx)
+- [Run.streamVNext()](./streamVNext.mdx)

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

@@ -39,6 +39,12 @@ const stream = run.streamVNext({
       description: "Runtime context data to use during workflow execution",
       isOptional: true,
     },
+    {
+      name: "closeOnSuspend",
+      type: "boolean",
+      description: "Whether to close the stream when the workflow is suspended, or to keep the stream open until the workflow is finished (by success or error). Default value is true.",
+      isOptional: true,
+    },
   ]}
 />
 
@@ -97,3 +103,4 @@ The stream emits various event types during workflow execution. Each event has a
 
 - [Workflows overview](../../../docs/workflows/overview.mdx#run-workflow)
 - [Workflow.createRunAsync()](../create-run.mdx)
+- [Run.resumeStreamVNext()](./resumeStreamVNext.mdx)

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @mastra/mcp-docs-server
 
+## 0.13.23
+
+### Patch Changes
+
+- Updated dependencies [[`fd00e63`](https://github.com/mastra-ai/mastra/commit/fd00e63759cbcca3473c40cac9843280b0557cff), [`ab610f6`](https://github.com/mastra-ai/mastra/commit/ab610f6f41dbfe6c9502368671485ca7a0aac09b), [`e6bda5f`](https://github.com/mastra-ai/mastra/commit/e6bda5f954ee8493ea18adc1a883f0a5b785ad9b)]:
+  - @mastra/core@0.17.1
+
+## 0.13.23-alpha.0
+
+### Patch Changes
+
+- Updated dependencies [[`fd00e63`](https://github.com/mastra-ai/mastra/commit/fd00e63759cbcca3473c40cac9843280b0557cff), [`ab610f6`](https://github.com/mastra-ai/mastra/commit/ab610f6f41dbfe6c9502368671485ca7a0aac09b), [`e6bda5f`](https://github.com/mastra-ai/mastra/commit/e6bda5f954ee8493ea18adc1a883f0a5b785ad9b)]:
+  - @mastra/core@0.17.1-alpha.0
+
 ## 0.13.22
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/mcp-docs-server",
-  "version": "0.13.22",
+  "version": "0.13.23",
   "description": "MCP server for accessing Mastra.ai documentation, changelogs, and news.",
   "type": "module",
   "main": "dist/index.js",
@@ -33,7 +33,7 @@
     "uuid": "^11.1.0",
     "zod": "^3.25.76",
     "zod-to-json-schema": "^3.24.6",
-    "@mastra/core": "0.17.0",
+    "@mastra/core": "0.17.1",
     "@mastra/mcp": "^0.13.0"
   },
   "devDependencies": {
@@ -49,8 +49,8 @@
     "tsx": "^4.19.4",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4",
-    "@internal/lint": "0.0.40",
-    "@mastra/core": "0.17.0"
+    "@internal/lint": "0.0.41",
+    "@mastra/core": "0.17.1"
   },
   "homepage": "https://mastra.ai",
   "repository": {