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

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",
@@ -138,18 +140,19 @@ const step1 = createStep({
       type: "RuntimeContext",
       isOptional: true,
       description:
-        "Runtime context for dependency injection and contextual information.",
+        "Runtime Context for dependency injection and contextual information.",
     },
     {
       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#looping-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,
     },
   ]}
@@ -38,6 +39,76 @@ workflow.map(async ({ inputData }) => `${inputData.value} - map`
   ]}
 />
 
-## Related
+## Using `inputData`
 
-- [Input data mapping](../../../docs/workflows/input-data-mapping.mdx)
+Use `inputData` to access the full output of the previous step.
+
+```typescript {3} filename="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
+  .then(step1)
+  .map(({ inputData }) => {
+    console.log(inputData);
+  })
+```
+
+## Using `getStepResult()`
+
+Use `getStepResult()` to access the full output of a specific step by referencing the step's instance.
+
+```typescript {3} filename="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
+  .then(step1)
+  .map(async ({ getStepResult }) => {
+    console.log(getStepResult(step1));
+  })
+```
+
+## Using `getInitData()`
+
+Use `getInitData()` to access the initial input data provided to the workflow.
+
+```typescript {3} filename="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
+  .then(step1)
+  .map(async ({ getInitData }) => {
+      console.log(getInitData());
+  })
+```
+
+## Using `mapVariable()`
+
+The object form of `.map()` provides an alternative declarative syntax for mapping fields. Instead of writing a function, you define an object where each key is a new field name and each value uses `mapVariable()` to extract data from previous steps or workflow input.
+Import `mapVariable()` from the workflows module:
+
+```typescript filename="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
+import { mapVariable } from "@mastra/core/workflows";
+```
+### Extracting fields from step outputs
+
+Use `mapVariable()` with `step` to extract a specific field from a step's output and map it to a new field name. The `path` parameter specifies which field to extract.
+In this example, the `value` field from `step1`'s output is extracted and mapped to a new field called `details`:
+
+```typescript {3-6} filename="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
+  .then(step1)
+  .map({
+    details: mapVariable({
+      step: step1,
+      path: "value"
+    })
+  })
+```
+
+### Extracting fields from workflow input
+
+Use `mapVariable()` with `initData` to extract a specific field from the workflow's initial input data. This is useful when you need to pass the original workflow input to a later step.
+In this example, the `value` field from the workflow's input is extracted and mapped to a field called `details`:
+
+```typescript {6-9} filename="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
+export const testWorkflow = createWorkflow({...});
+
+testWorkflow
+  .then(step1)
+  .map({
+    details: mapVariable({
+      initData: testWorkflow,
+      path: "value"
+    })
+  })
+```

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)

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

@@ -9,7 +9,7 @@ The `Workflow` class enables you to create state machines for complex sequences
 
 ## Usage example
 
-```typescript filename="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
+```typescript title="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
 import { createWorkflow } from "@mastra/core/workflows";
 import { z } from "zod";
 
@@ -20,8 +20,8 @@ export const workflow = createWorkflow({
   }),
   outputSchema: z.object({
     value: z.string(),
-  })
-})
+  }),
+});
 ```
 
 ## Constructor parameters
@@ -46,7 +46,8 @@ export const workflow = createWorkflow({
     {
       name: "stateSchema",
       type: "z.ZodObject<any>",
-      description: "Optional Zod schema for the workflow state. Automatically injected when using Mastra's state system. If not specified, type is 'any'.",
+      description:
+        "Optional Zod schema for the workflow state. Automatically injected when using Mastra's state system. If not specified, type is 'any'.",
       isOptional: true,
     },
     {
@@ -54,7 +55,7 @@ export const workflow = createWorkflow({
       type: "WorkflowOptions",
       description: "Optional options for the workflow",
       isOptional: true,
-    }
+    },
   ]}
 />
 
@@ -71,14 +72,16 @@ export const workflow = createWorkflow({
     {
       name: "validateInputs",
       type: "boolean",
-      description: "Optional flag to determine whether to validate the workflow inputs. This also applies default values from zodSchemas on the workflow/step input/resume data. If input/resume data validation fails on start/resume, the workflow will not start/resume, it throws an error instead. If input data validation fails on a step execution, the step fails, causing the workflow to fail and the error is returned.",
+      description:
+        "Optional flag to determine whether to validate the workflow inputs. This also applies default values from zodSchemas on the workflow/step input/resume data. If input/resume data validation fails on start/resume, the workflow will not start/resume, it throws an error instead. If input data validation fails on a step execution, the step fails, causing the workflow to fail and the error is returned.",
       isOptional: true,
       defaultValue: "false",
     },
     {
       name: "shouldPersistSnapshot",
       type: "(params: { stepResults: Record<string, StepResult<any, any, any, any>>; workflowStatus: WorkflowRunStatus }) => boolean",
-      description: "Optional flag to determine whether to persist the workflow snapshot",
+      description:
+        "Optional flag to determine whether to persist the workflow snapshot",
       isOptional: true,
       defaultValue: "() => true",
     },
@@ -112,21 +115,7 @@ A workflow's `status` indicates its current execution state. The possible values
   ]}
 />
 
-## Extended usage example
-
-```typescript filename="src/test-run.ts" showLineNumbers copy
-import { mastra } from "./mastra";
-
-const run = await mastra.getWorkflow("workflow").createRunAsync();
-
-const result = await run.start({...});
-
-if (result.status === "suspended") {
-  const resumedResult = await run.resume({...});
-}
-```
-
 ## Related
 
-- [Step Class](./step.mdx)
-- [Control flow](../../docs/workflows/control-flow.mdx)
+- [Step Class](./step)
+- [Control flow](/docs/workflows/control-flow)