@mastra/mcp-docs-server 0.13.37 → 0.13.38

package/.docs/raw/reference/workflows/run-methods/resume.mdx

@@ -16,10 +16,11 @@ const result = await run.start({ inputData: { value: "initial data" } });
 
 if (result.status === "suspended") {
   const resumedResults = await run.resume({
-    resumeData: { value: "resume data" }
+    resumeData: { value: "resume data" },
   });
 }
 ```
+
 ## Parameters
 
 <PropertiesTable
@@ -33,7 +34,8 @@ if (result.status === "suspended") {
     {
       name: "step",
       type: "Step<string, any, any, TResumeSchema, any, TEngineType> | [...Step<string, any, any, any, any, TEngineType>[], Step<string, any, any, TResumeSchema, any, TEngineType>] | string | string[]",
-      description: "The step(s) to resume execution from. Can be a Step instance, array of Steps, step ID string, or array of step ID strings",
+      description:
+        "The step(s) to resume execution from. Can be a Step instance, array of Steps, step ID string, or array of step ID strings",
       isOptional: true,
     },
     {
@@ -52,17 +54,21 @@ if (result.status === "suspended") {
       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",
@@ -71,14 +77,17 @@ if (result.status === "suspended") {
       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: "outputOptions",
@@ -87,14 +96,17 @@ if (result.status === "suspended") {
       description: "Options for AI tracing configuration.",
       properties: [
         {
-          parameters: [{
-            name: "includeState",
-            type: "boolean",
-            isOptional: true,
-            description: "Whether to include the workflow run state in the result."
-          }]
-        }
-      ]
+          parameters: [
+            {
+              name: "includeState",
+              type: "boolean",
+              isOptional: true,
+              description:
+                "Whether to include the workflow run state in the result.",
+            },
+          ],
+        },
+      ],
     },
   ]}
 />
@@ -106,13 +118,15 @@ if (result.status === "suspended") {
     {
       name: "result",
       type: "Promise<WorkflowResult<TState, TOutput, TSteps>>",
-      description: "A promise that resolves to the workflow execution result containing step outputs and status",
+      description:
+        "A promise that resolves to the workflow execution result containing step outputs and status",
     },
     {
       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.",
     },
   ]}
 />
@@ -123,15 +137,16 @@ if (result.status === "suspended") {
 if (result.status === "suspended") {
   const resumedResults = await run.resume({
     step: result.suspended[0],
-    resumeData: { value: "resume data" }
+    resumeData: { value: "resume data" },
   });
 }
 ```
+
 > **Note**: When exactly one step is suspended, you can omit the `step` parameter and the workflow will automatically resume that step. For workflows with multiple suspended steps, you must explicitly specify which step to resume.
 
 ## Related
 
-- [Workflows overview](../../../docs/workflows/overview.mdx#run-workflow)
-- [Workflow.createRunAsync()](../create-run.mdx)
-- [Suspend and resume](../../../docs/workflows/suspend-and-resume.mdx)
-- [Human in the loop example](../../../examples/workflows/human-in-the-loop.mdx)
+- [Workflows overview](/docs/workflows/overview#running-workflows)
+- [Workflow.createRunAsync()](../workflow-methods/create-run)
+- [Suspend and resume](/docs/workflows/suspend-and-resume)
+- [Human in the loop example](/examples/workflows_legacy/human-in-the-loop)

package/.docs/raw/reference/workflows/run-methods/start.mdx

@@ -45,17 +45,21 @@ const result = await run.start({
       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",
@@ -64,14 +68,17 @@ const result = await run.start({
       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: "outputOptions",
@@ -80,14 +87,17 @@ const result = await run.start({
       description: "Options for AI tracing configuration.",
       properties: [
         {
-          parameters: [{
-            name: "includeState",
-            type: "boolean",
-            isOptional: true,
-            description: "Whether to include the workflow run state in the result."
-          }]
-        }
-      ]
+          parameters: [
+            {
+              name: "includeState",
+              type: "boolean",
+              isOptional: true,
+              description:
+                "Whether to include the workflow run state in the result.",
+            },
+          ],
+        },
+      ],
     },
   ]}
 />
@@ -99,13 +109,15 @@ const result = await run.start({
     {
       name: "result",
       type: "Promise<WorkflowResult<TState, TOutput, TSteps>>",
-      description: "A promise that resolves to the workflow execution result containing step outputs and status",
+      description:
+        "A promise that resolves to the workflow execution result containing step outputs and status",
     },
     {
       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.",
     },
   ]}
 />
@@ -122,13 +134,13 @@ runtimeContext.set("variable", false);
 
 const result = await run.start({
   inputData: {
-    value: "initial data"
+    value: "initial data",
   },
-  runtimeContext
+  runtimeContext,
 });
 ```
 
 ## Related
 
-- [Workflows overview](../../../docs/workflows/overview.mdx#run-workflow)
-- [Workflow.createRunAsync()](../create-run.mdx)
+- [Workflows overview](/docs/workflows/overview#running-workflows)
+- [Workflow.createRunAsync()](../workflow-methods/create-run)

package/.docs/raw/reference/workflows/run-methods/watch.mdx

@@ -26,20 +26,21 @@ const result = await run.start({ inputData: { value: "initial data" } });
     {
       name: "callback",
       type: "(event: WatchEvent) => void",
-      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",
+      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",
+      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
@@ -67,8 +68,6 @@ const result = await run.start({ inputData: { value: "initial data" } });
 
 ## Related
 
-## Related
-
-- [Workflows overview](../../../docs/workflows/overview.mdx#run-workflow)
-- [Workflow.createRunAsync()](../create-run.mdx)
-- [Watch Workflow](../../../docs/workflows/overview.mdx#watch-workflow)
+- [Workflows overview](/docs/workflows/overview#running-workflows)
+- [Workflow.createRunAsync()](../workflow-methods/create-run)
+- [Watch Workflow](/docs/workflows/overview)

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

@@ -13,12 +13,12 @@ The `Run` class represents a workflow execution instance, providing methods to s
 const run = await workflow.createRunAsync();
 
 const result = await run.start({
-  inputData: { value: "initial data" }
+  inputData: { value: "initial data" },
 });
 
 if (result.status === "suspended") {
   const resumedResult = await run.resume({
-    resumeData: { value: "resume data" }
+    resumeData: { value: "resume data" },
   });
 }
 ```
@@ -62,7 +62,7 @@ if (result.status === "suspended") {
       type: "() => Promise<void>",
       description: "Cancels the workflow execution",
       required: true,
-    }
+    },
   ]}
 />
 
@@ -95,10 +95,7 @@ A workflow run's `status` indicates its current execution state. The possible va
 
 ## Related
 
-- [Running workflows](../../examples/workflows/running-workflows.mdx)
-- [Run.start()](./run-methods/start.mdx)
-- [Run.resume()](./run-methods/resume.mdx)
-- [Run.stream()](./run-methods/stream.mdx)
-- [Run.streamVNext()](./run-methods/streamVNext.mdx)
-- [Run.watch()](./run-methods/watch.mdx)
-- [Run.cancel()](./run-methods/cancel.mdx)
+- [Run.start()](./run-methods/start)
+- [Run.resume()](./run-methods/resume)
+- [Run.watch()](./run-methods/watch)
+- [Run.cancel()](./run-methods/cancel)

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

@@ -10,7 +10,7 @@ It can take either a tool or an agent as a parameter to automatically create a s
 
 ## Usage example
 
-```typescript filename="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
+```typescript title="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
 import { createWorkflow, createStep } from "@mastra/core/workflows";
 import { z } from "zod";
 
@@ -18,17 +18,17 @@ const step1 = createStep({
   id: "step-1",
   description: "passes value from input to output",
   inputSchema: z.object({
-    value: z.number()
+    value: z.number(),
   }),
   outputSchema: z.object({
-    value: z.number()
+    value: z.number(),
   }),
   execute: async ({ inputData }) => {
     const { value } = inputData;
     return {
-      value
+      value,
     };
-  }
+  },
 });
 ```
 
@@ -75,7 +75,8 @@ const step1 = createStep({
     {
       name: "stateSchema",
       type: "z.ZodObject<any>",
-      description: "Optional Zod schema for the step state. Automatically injected when using Mastra's state system. The stateSchema must be a subset of the workflow's stateSchema. If not specified, type is 'any'.",
+      description:
+        "Optional Zod schema for the step state. Automatically injected when using Mastra's state system. The stateSchema must be a subset of the workflow's stateSchema. If not specified, type is 'any'.",
       required: false,
     },
     {
@@ -83,7 +84,7 @@ const step1 = createStep({
       type: "(params: ExecuteParams) => Promise<any>",
       description: "Async function containing step logic",
       required: true,
-    }
+    },
   ]}
 />
 
@@ -126,7 +127,8 @@ const step1 = createStep({
     {
       name: "setState",
       type: "(state: z.infer<TState>) => void",
-      description: "Function to set the state of the workflow. Inject via reducer-like pattern, such as 'setState({ ...state, ...newState })'",
+      description:
+        "Function to set the state of the workflow. Inject via reducer-like pattern, such as 'setState({ ...state, ...newState })'",
     },
     {
       name: "runId",
@@ -143,13 +145,14 @@ const step1 = createStep({
     {
       name: "runCount",
       type: "number",
-      description: "The run count for this specific step, it automatically increases each time the step runs",
+      description:
+        "The run count for this specific step, it automatically increases each time the step runs",
       isOptional: true,
-    }
+    },
   ]}
 />
 
 ## Related
 
-- [Control flow](../../docs/workflows/control-flow.mdx)
-- [Using agents and tools](../../docs/workflows/agents-and-tools.mdx)
+- [Control flow](/docs/workflows/control-flow)
+- [Using agents and tools](/docs/workflows/agents-and-tools)

package/.docs/raw/reference/workflows/workflow-methods/branch.mdx

@@ -44,5 +44,5 @@ workflow.branch([
 
 ## Related
 
-- [Conditional Branching Logic](../../../docs/workflows/control-flow#conditional-logic-with-branch)
-- [Conditional Branching Example](../../../examples/workflows/conditional-branching)
+- [Conditional Branching Logic](/docs/workflows/control-flow#conditional-logic-with-branch)
+- [Conditional Branching Example](/examples/workflows_legacy/conditional-branching)

package/.docs/raw/reference/workflows/workflow-methods/commit.mdx

@@ -27,4 +27,4 @@ workflow.then(step1).commit();
 
 ## Related
 
-- [Control Flow](../../../docs/workflows/control-flow.mdx)
+- [Control Flow](/docs/workflows/control-flow)

package/.docs/raw/reference/workflows/workflow-methods/create-run.mdx

@@ -3,15 +3,15 @@ title: "Reference: Workflow.createRunAsync() | Workflows | Mastra Docs"
 description: Documentation for the `Workflow.createRunAsync()` method in workflows, which creates a new workflow run instance.
 ---
 
-import { Callout } from "nextra/components";
-
 # Workflow.createRunAsync()
 
 The `.createRunAsync()` method creates a new workflow run instance, allowing you to execute the workflow with specific input data. This is the current API that returns a `Run` instance.
 
-<Callout>
-For the legacy `createRun()` method that returns an object with methods, see the [Legacy Workflows](../../legacyWorkflows/createRun.mdx) section.
-</Callout>
+:::note
+
+For the legacy `createRun()` method that returns an object with methods, see the [Legacy Workflows](../../legacyWorkflows/createRun) section.
+
+:::
 
 ## Usage example
 
@@ -61,5 +61,5 @@ const result = await run.start({
 
 ## Related
 
-- [Run Class](../run.mdx)
-- [Running workflows](../../../examples/workflows/running-workflows.mdx)
+- [Run Class](../run)
+- [Workflows overview](/docs/workflows/overview)

package/.docs/raw/reference/workflows/workflow-methods/dountil.mdx

@@ -47,6 +47,6 @@ workflow.dountil(step1, async ({ inputData }) => true);
 
 ## Related
 
-- [Control Flow](../../../docs/workflows/control-flow.mdx)
+- [Control Flow](/docs/workflows/control-flow)
 
-- [ExecuteParams](../step.mdx#ExecuteParams)
+- [ExecuteParams](../step#executeparams)

package/.docs/raw/reference/workflows/workflow-methods/dowhile.mdx

@@ -47,6 +47,6 @@ workflow.dowhile(step1, async ({ inputData }) => true);
 
 ## Related
 
-- [Control Flow](../../../docs/workflows/control-flow.mdx)
+- [Control Flow](/docs/workflows/control-flow)
 
-- [ExecuteParams](../step.mdx#ExecuteParams)
+- [ExecuteParams](../step#executeparams)

package/.docs/raw/reference/workflows/workflow-methods/foreach.mdx

@@ -57,4 +57,4 @@ workflow.foreach(step1, { concurrency: 2 });
 
 ## Related
 
-- [Repeating with foreach](../../../docs/workflows/control-flow.mdx#repeating-with-foreach)
+- [Repeating with foreach](/docs/workflows/control-flow#repeating-with-foreach)

package/.docs/raw/reference/workflows/workflow-methods/map.mdx

@@ -20,7 +20,8 @@ workflow.map(async ({ inputData }) => `${inputData.value} - map`
     {
       name: "mappingFunction",
       type: "(params: { inputData: any }) => any",
-      description: "Function that transforms input data and returns the mapped result",
+      description:
+        "Function that transforms input data and returns the mapped result",
       isOptional: false,
     },
   ]}
@@ -40,4 +41,4 @@ workflow.map(async ({ inputData }) => `${inputData.value} - map`
 
 ## Related
 
-- [Input data mapping](../../../docs/workflows/input-data-mapping.mdx)
+- [Input data mapping](/docs/workflows/input-data-mapping)

package/.docs/raw/reference/workflows/workflow-methods/parallel.mdx

@@ -40,4 +40,4 @@ workflow.parallel([step1, step2]);
 
 ## Related
 
-- [Parallel Workflow Example](../../../examples/workflows/parallel-steps.mdx)
+- [Simultaneous steps with parallel](/docs/workflows/control-flow#simultaneous-steps-with-parallel)

package/.docs/raw/reference/workflows/workflow-methods/sendEvent.mdx

@@ -10,7 +10,7 @@ The `.sendEvent()` resumes execution when an event is sent.
 ## Usage example
 
 ```typescript copy
-run.sendEvent('event-name', { value: "data" });
+run.sendEvent("event-name", { value: "data" });
 ```
 
 ## Parameters
@@ -53,8 +53,8 @@ const run = await mastra.getWorkflow("testWorkflow").createRunAsync();
 
 const result = run.start({
   inputData: {
-    value: "hello"
-  }
+    value: "hello",
+  },
 });
 
 setTimeout(() => {
@@ -66,5 +66,5 @@ setTimeout(() => {
 
 ## Related
 
-- [.waitForEvent()](./waitForEvent.mdx)
-- [Suspend & Resume](../../../docs/workflows/suspend-and-resume.mdx#sleep--events)
+- [.waitForEvent()](./waitForEvent)
+- [Suspend & Resume](/docs/workflows/suspend-and-resume#sleep--events)

package/.docs/raw/reference/workflows/workflow-methods/sleep.mdx

@@ -20,7 +20,8 @@ workflow.sleep(5000);
     {
       name: "milliseconds",
       type: "number | ((context: { inputData: any }) => number | Promise<number>)",
-      description: "The number of milliseconds to pause execution, or a callback that returns the delay",
+      description:
+        "The number of milliseconds to pause execution, or a callback that returns the delay",
       isOptional: false,
     },
   ]}
@@ -58,4 +59,4 @@ export const testWorkflow = createWorkflow({...})
 
 ## Related
 
-- [Suspend & Resume](../../../docs/workflows/suspend-and-resume.mdx#sleep--events)
+- [Suspend & Resume](/docs/workflows/suspend-and-resume#sleep--events)

package/.docs/raw/reference/workflows/workflow-methods/sleepUntil.mdx

@@ -20,7 +20,8 @@ workflow.sleepUntil(new Date(Date.now() + 5000));
     {
       name: "dateOrCallback",
       type: "Date | ((params: ExecuteFunctionParams) => Promise<Date>)",
-      description: "Either a Date object or a callback function that returns a Date. The callback receives execution context and can compute the target time dynamically based on input data.",
+      description:
+        "Either a Date object or a callback function that returns a Date. The callback receives execution context and can compute the target time dynamically based on input data.",
       isOptional: false,
     },
   ]}
@@ -58,4 +59,4 @@ export const testWorkflow = createWorkflow({...})
 
 ## Related
 
-- [Suspend & Resume](../../../docs/workflows/suspend-and-resume.mdx#sleep--events)
+- [Suspend & Resume](/docs/workflows/suspend-and-resume#sleep--events)

package/.docs/raw/reference/workflows/workflow-methods/then.mdx

@@ -41,4 +41,4 @@ workflow.then(step1).then(step2);
 
 ## Related
 
-- [Control flow](../../../docs/workflows/control-flow.mdx)
+- [Control flow](/docs/workflows/control-flow)

package/.docs/raw/reference/workflows/workflow-methods/waitForEvent.mdx

@@ -10,7 +10,7 @@ The `.waitForEvent()` method pauses execution until an event is received.
 ## Usage example
 
 ```typescript copy
-workflow.waitForEvent('event-name', step1);
+workflow.waitForEvent("event-name", step1);
 ```
 
 ## Parameters
@@ -62,5 +62,5 @@ export const testWorkflow = createWorkflow({...})
 
 ## Related
 
-- [.sendEvent()](./sendEvent.mdx)
-- [Suspend & Resume](../../../docs/workflows/suspend-and-resume.mdx#sleep--events)
+- [.sendEvent()](./sendEvent)
+- [Suspend & Resume](/docs/workflows/suspend-and-resume#sleep--events)