@mastra/mcp-docs-server 1.0.0-beta.8 → 1.0.0

package/.docs/raw/reference/voice/sarvam.mdx

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Sarvam | Voice"
 description: "Documentation for the Sarvam class, providing text-to-speech and speech-to-text capabilities."
+packages:
+  - "@mastra/voice-sarvam"
 ---
 
 # Sarvam

package/.docs/raw/reference/voice/speechify.mdx

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Speechify | Voice"
 description: "Documentation for the Speechify voice implementation, providing text-to-speech capabilities."
+packages:
+  - "@mastra/voice-speechify"
 ---
 
 # Speechify

package/.docs/raw/reference/voice/voice.addInstructions.mdx

@@ -1,6 +1,9 @@
 ---
 title: "Reference: voice.addInstructions() | Voice"
 description: "Documentation for the addInstructions() method available in voice providers, which adds instructions to guide the voice model's behavior."
+packages:
+  - "@mastra/core"
+  - "@mastra/voice-openai-realtime"
 ---
 
 # voice.addInstructions()

package/.docs/raw/reference/voice/voice.addTools.mdx

@@ -1,6 +1,9 @@
 ---
 title: "Reference: voice.addTools() | Voice"
 description: "Documentation for the addTools() method available in voice providers, which equips voice models with function calling capabilities."
+packages:
+  - "@mastra/core"
+  - "@mastra/voice-openai-realtime"
 ---
 
 # voice.addTools()

package/.docs/raw/reference/voice/voice.answer.mdx

@@ -1,6 +1,10 @@
 ---
 title: "Reference: voice.answer() | Voice"
 description: "Documentation for the answer() method available in real-time voice providers, which triggers the voice provider to generate a response."
+packages:
+  - "@mastra/node-audio"
+  - "@mastra/node-speaker"
+  - "@mastra/voice-openai-realtime"
 ---
 
 # voice.answer()

package/.docs/raw/reference/voice/voice.close.mdx

@@ -1,6 +1,9 @@
 ---
 title: "Reference: voice.close() | Voice"
 description: "Documentation for the close() method available in voice providers, which disconnects from real-time voice services."
+packages:
+  - "@mastra/node-audio"
+  - "@mastra/voice-openai-realtime"
 ---
 
 # voice.close()

package/.docs/raw/reference/voice/voice.connect.mdx

@@ -1,6 +1,10 @@
 ---
 title: "Reference: voice.connect() | Voice"
 description: "Documentation for the connect() method available in real-time voice providers, which establishes a connection for speech-to-speech communication."
+packages:
+  - "@mastra/core"
+  - "@mastra/node-speaker"
+  - "@mastra/voice-openai-realtime"
 ---
 
 # voice.connect()
@@ -100,7 +104,7 @@ import { CompositeVoice } from "@mastra/core/voice";
 import { OpenAIRealtimeVoice } from "@mastra/voice-openai-realtime";
 const realtimeVoice = new OpenAIRealtimeVoice();
 const voice = new CompositeVoice({
-  realtimeProvider: realtimeVoice,
+  realtime: realtimeVoice,
 });
 // This will use the OpenAIRealtimeVoice provider
 await voice.connect();

package/.docs/raw/reference/voice/voice.events.mdx

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Voice Events | Voice"
 description: "Documentation for events emitted by voice providers, particularly for real-time voice interactions."
+packages:
+  - "@mastra/core"
 ---
 
 # Voice Events

package/.docs/raw/reference/voice/voice.getSpeakers.mdx

@@ -1,6 +1,9 @@
 ---
 title: "Reference: voice.getSpeakers() | Voice Providers"
 description: "Documentation for the getSpeakers() method available in voice providers, which retrieves available voice options."
+packages:
+  - "@mastra/voice-elevenlabs"
+  - "@mastra/voice-openai"
 ---
 
 import Tabs from "@theme/Tabs";

package/.docs/raw/reference/voice/voice.listen.mdx

@@ -1,6 +1,12 @@
 ---
 title: "Reference: voice.listen() | Voice"
 description: "Documentation for the listen() method available in all Mastra voice providers, which converts speech to text."
+packages:
+  - "@mastra/core"
+  - "@mastra/node-audio"
+  - "@mastra/voice-openai"
+  - "@mastra/voice-openai-realtime"
+  - "@mastra/voice-playai"
 ---
 
 # voice.listen()

package/.docs/raw/reference/voice/voice.off.mdx

@@ -1,6 +1,8 @@
 ---
 title: "Reference: voice.off() | Voice"
 description: "Documentation for the off() method available in voice providers, which removes event listeners for voice events."
+packages:
+  - "@mastra/voice-openai-realtime"
 ---
 
 # voice.off()

package/.docs/raw/reference/voice/voice.on.mdx

@@ -1,6 +1,10 @@
 ---
 title: "Reference: voice.on() | Voice"
 description: "Documentation for the on() method available in voice providers, which registers event listeners for voice events."
+packages:
+  - "@mastra/core"
+  - "@mastra/node-speaker"
+  - "@mastra/voice-openai-realtime"
 ---
 
 # voice.on()
@@ -109,7 +113,7 @@ const speaker = new Speaker({
 
 const realtimeVoice = new OpenAIRealtimeVoice();
 const voice = new CompositeVoice({
-  realtimeProvider: realtimeVoice,
+  realtime: realtimeVoice,
 });
 
 // Connect to the real-time service

package/.docs/raw/reference/voice/voice.send.mdx

@@ -1,6 +1,10 @@
 ---
 title: "Reference: voice.send() | Voice"
 description: "Documentation for the send() method available in real-time voice providers, which streams audio data for continuous processing."
+packages:
+  - "@mastra/node-audio"
+  - "@mastra/node-speaker"
+  - "@mastra/voice-openai-realtime"
 ---
 
 # voice.send()

package/.docs/raw/reference/voice/voice.speak.mdx

@@ -1,6 +1,12 @@
 ---
 title: "Reference: voice.speak() | Voice"
 description: "Documentation for the speak() method available in all Mastra voice providers, which converts text to speech."
+packages:
+  - "@mastra/core"
+  - "@mastra/node-speaker"
+  - "@mastra/voice-openai"
+  - "@mastra/voice-openai-realtime"
+  - "@mastra/voice-playai"
 ---
 
 # voice.speak()

package/.docs/raw/reference/voice/voice.updateConfig.mdx

@@ -1,6 +1,8 @@
 ---
 title: "Reference: voice.updateConfig() | Voice"
 description: "Documentation for the updateConfig() method available in voice providers, which updates the configuration of a voice provider at runtime."
+packages:
+  - "@mastra/voice-openai-realtime"
 ---
 
 # voice.updateConfig()

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

@@ -1,18 +1,23 @@
 ---
 title: "Reference: Run.cancel() | Workflows"
 description: Documentation for the `Run.cancel()` method in workflows, which cancels a workflow run.
+packages:
+  - "@mastra/core"
 ---
 
 # Run.cancel()
 
 The `.cancel()` method cancels a workflow run, stopping execution and cleaning up resources.
 
+This method aborts any running steps and updates the workflow status to 'canceled'. It works for both actively running workflows and suspended/waiting workflows.
+
 ## Usage example
 
-```typescript showLineNumbers copy
+```typescript
 const run = await workflow.createRun();
 
 await run.cancel();
+// Returns: { message: 'Workflow run canceled' }
 ```
 
 ## Parameters
@@ -34,16 +39,33 @@ await run.cancel();
   content={[
     {
       name: "result",
-      type: "Promise<void>",
+      type: "Promise<{ message: string }>",
       description:
-        "A promise that resolves when the workflow run has been cancelled",
+        "A promise that resolves with { message: 'Workflow run canceled' } when cancellation succeeds",
     },
   ]}
 />
 
-## Extended usage example
+## How cancellation works
+
+When called, the workflow will:
+1. **Trigger the abort signal** - Uses the standard Web API AbortSignal to notify running steps
+2. **Prevent subsequent steps** - No further steps will be executed
+
+## Abort signal behavior
+
+Steps that check the `abortSignal` parameter can respond to cancellation:
+- Steps can listen to the 'abort' event: `abortSignal.addEventListener('abort', callback)`
+- Steps can check if already aborted: `if (abortSignal.aborted) { ... }`
+- Useful for cancelling timeouts, network requests, or long-running operations
+
+**Note:** Steps must actively check the abort signal to be canceled mid-execution. Steps that don't check the signal will run to completion, but subsequent steps won't execute.
 
-```typescript showLineNumbers copy
+## Extended usage examples
+
+### Cancelling a workflow on error
+
+```typescript
 const run = await workflow.createRun();
 
 try {
@@ -53,6 +75,34 @@ try {
 }
 ```
 
+### Creating a step that responds to cancellation
+
+```typescript
+const step = createStep({
+  id: 'long-running-step',
+  execute: async ({ inputData, abortSignal, abort }) => {
+    const timeout = new Promise((resolve) => {
+      const timer = setTimeout(() => resolve('done'), 10000);
+      
+      // Clean up if canceled
+      abortSignal.addEventListener('abort', () => {
+        clearTimeout(timer);
+        resolve('canceled');
+      });
+    });
+    
+    const result = await timeout;
+    
+    // Check if aborted after async operation
+    if (abortSignal.aborted) {
+      return abort(); // Stop execution
+    }
+    
+    return { result };
+  }
+});
+```
+
 ## Related
 
 - [Workflows overview](/docs/v1/workflows/overview#running-workflows)

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

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Run.restart() | Workflows"
 description: Documentation for the `Run.restart()` method in workflows, which restarts an active workflow run that lost connection to the server.
+packages:
+  - "@mastra/core"
 ---
 
 # Run.restart()
@@ -9,13 +11,11 @@ The `.restart()` method restarts an active workflow run that lost connection to
 
 ## Usage example
 
-```typescript showLineNumbers copy
+```typescript
 const run = await workflow.createRun();
 
 const result = await run.start({ inputData: { value: "initial data" } });
 
-//.. server connection lost,
-
 const restartedResult = await run.restart();
 ```
 

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

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Run.resume() | Workflows"
 description: Documentation for the `Run.resume()` method in workflows, which resumes a suspended workflow run with new data.
+packages:
+  - "@mastra/core"
 ---
 
 # Run.resume()
@@ -9,7 +11,7 @@ The `.resume()` method resumes a suspended workflow run with new data, allowing
 
 ## Usage example
 
-```typescript showLineNumbers copy
+```typescript
 const run = await workflow.createRun();
 
 const result = await run.start({ inputData: { value: "initial data" } });
@@ -45,9 +47,9 @@ if (result.status === "suspended") {
       isOptional: true,
     },
     {
-      name: "runCount",
+      name: "retryCount",
       type: "number",
-      description: "Optional run count for nested workflow execution",
+      description: "Optional retry count for nested workflow execution",
       isOptional: true,
     },
     {
@@ -177,7 +179,7 @@ if (result.status === "suspended") {
 
 ## Extended usage example
 
-```typescript showLineNumbers copy
+```typescript
 if (result.status === "suspended") {
   const resumedResults = await run.resume({
     step: result.suspended[0],

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

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Run.start() | Workflows"
 description: Documentation for the `Run.start()` method in workflows, which starts a workflow run with input data.
+packages:
+  - "@mastra/core"
 ---
 
 # Run.start()
@@ -9,7 +11,7 @@ The `.start()` method starts a workflow run with input data, allowing you to exe
 
 ## Usage example
 
-```typescript showLineNumbers copy
+```typescript
 const run = await workflow.createRun();
 
 const result = await run.start({
@@ -36,9 +38,9 @@ const result = await run.start({
       isOptional: true,
     },
     {
-      name: "writableStream",
-      type: "WritableStream<ChunkType>",
-      description: "Optional writable stream for streaming workflow output",
+      name: "outputWriter",
+      type: "(chunk: TOutput) => Promise<void>",
+      description: "Optional asynchronous function to handle output chunks as they are produced",
       isOptional: true,
     },
     {
@@ -168,7 +170,7 @@ const result = await run.start({
 
 ## Extended usage example
 
-```typescript showLineNumbers copy
+```typescript
 import { RequestContext } from "@mastra/core/request-context";
 
 const run = await workflow.createRun();

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

@@ -0,0 +1,145 @@
+---
+title: "Reference: Run.startAsync() | Workflows"
+description: Documentation for the `Run.startAsync()` method in workflows, which starts a workflow run without waiting for completion (fire-and-forget).
+packages:
+  - "@mastra/core"
+---
+
+# Run.startAsync()
+
+The `.startAsync()` method starts a workflow run without waiting for completion. It returns immediately with the `runId`, allowing the workflow to execute in the background. This is useful for long-running workflows, scheduled tasks, or when you want to avoid blocking on workflow completion.
+
+## Usage example
+
+```typescript
+const run = await workflow.createRun();
+
+// Fire-and-forget - returns immediately
+const { runId } = await run.startAsync({
+  inputData: {
+    value: "initial data",
+  },
+});
+
+// Optionally poll for completion later
+const result = await workflow.getWorkflowRunExecutionResult(runId);
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "inputData",
+      type: "z.infer<TInput>",
+      description: "Input data that matches the workflow's input schema",
+      isOptional: true,
+    },
+    {
+      name: "requestContext",
+      type: "RequestContext",
+      description: "Request Context data to use during workflow execution",
+      isOptional: true,
+    },
+    {
+      name: "initialState",
+      type: "z.infer<TState>",
+      description: "Initial state to use for the workflow execution",
+      isOptional: true,
+    },
+    {
+      name: "tracingOptions",
+      type: "TracingOptions",
+      isOptional: true,
+      description: "Options for 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: "traceId",
+              type: "string",
+              isOptional: true,
+              description:
+                "Trace ID to use for this execution (1-32 hexadecimal characters). If provided, this trace will be part of the specified trace.",
+            },
+          ],
+        },
+      ],
+    },
+    {
+      name: "outputOptions",
+      type: "OutputOptions",
+      isOptional: true,
+      description: "Options for output configuration.",
+      properties: [
+        {
+          parameters: [
+            {
+              name: "includeState",
+              type: "boolean",
+              isOptional: true,
+              description:
+                "Whether to include the workflow run state in the result.",
+            },
+          ],
+        },
+      ],
+    },
+  ]}
+/>
+
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: "runId",
+      type: "string",
+      description:
+        "The unique identifier for this workflow run. Use this to check status or retrieve results later.",
+    },
+  ]}
+/>
+
+## When to use startAsync()
+
+Use `startAsync()` instead of `start()` when:
+
+- **Long-running workflows**: The workflow may take minutes or hours to complete
+- **Scheduled/cron triggers**: You want to trigger a workflow without blocking the scheduler
+- **Avoiding polling failures**: With Inngest workflows, `start()` polls for completion which can fail and cause retries. `startAsync()` avoids this issue
+- **Background processing**: You want to queue work and handle results asynchronously
+
+## Checking workflow status
+
+After calling `startAsync()`, you can check the workflow status using:
+
+```typescript
+// Get the execution result (including step outputs)
+const result = await workflow.getWorkflowRunExecutionResult(runId);
+
+if (result?.status === 'success') {
+  console.log('Workflow completed:', result.steps);
+} else if (result?.status === 'failed') {
+  console.log('Workflow failed:', result.error);
+} else if (result?.status === 'running') {
+  console.log('Workflow still running...');
+}
+```
+
+## Related
+
+- [Run.start()](./start) - Start a workflow and wait for completion
+- [Workflows overview](/docs/v1/workflows/overview)
+- [Workflow.createRun()](../workflow-methods/create-run)

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

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Run.timeTravel() | Workflows"
 description: Documentation for the `Run.timeTravel()` method in workflows, which re-executes a workflow from a specific step.
+packages:
+  - "@mastra/core"
 ---
 
 # Run.timeTravel()
@@ -9,7 +11,7 @@ The `.timeTravel()` method re-executes a workflow starting from any specific ste
 
 ## Usage example
 
-```typescript showLineNumbers copy
+```typescript
 const run = await workflow.createRun();
 
 const result = await run.timeTravel({
@@ -68,9 +70,9 @@ const result = await run.timeTravel({
       isOptional: true,
     },
     {
-      name: "writableStream",
-      type: "WritableStream<ChunkType>",
-      description: "Optional writable stream for streaming workflow output during time travel",
+      name: "outputWriter",
+      type: "(chunk: TOutput) => Promise<void>",
+      description: "Optional asynchronous function to handle output chunks as they are produced",
       isOptional: true,
     },
     {
@@ -213,7 +215,7 @@ const result = await run.timeTravel({
 
 ### Time travel with custom context
 
-```typescript showLineNumbers copy
+```typescript
 const result = await run.timeTravel({
   step: "step2",
   context: {
@@ -230,7 +232,7 @@ const result = await run.timeTravel({
 
 ### Time travel to nested workflow step
 
-```typescript showLineNumbers copy
+```typescript
 // Using dot notation
 const result = await run.timeTravel({
   step: "nestedWorkflow.step3",
@@ -246,7 +248,7 @@ const result = await run.timeTravel({
 
 ### Time travel with initial state
 
-```typescript showLineNumbers copy
+```typescript
 const result = await run.timeTravel({
   step: "step2",
   inputData: { value: 10 },
@@ -259,7 +261,7 @@ const result = await run.timeTravel({
 
 ### Time travel with nested workflows context
 
-```typescript showLineNumbers copy
+```typescript
 const result = await run.timeTravel({
   step: "nestedWorkflow.step3",
   context: {

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

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Run Class | Workflows"
 description: Documentation for the Run class in Mastra, which represents a workflow execution instance.
+packages:
+  - "@mastra/core"
 ---
 
 # Run Class
@@ -9,7 +11,7 @@ The `Run` class represents a workflow execution instance, providing methods to s
 
 ## Usage example
 
-```typescript showLineNumbers copy
+```typescript
 const run = await workflow.createRun();
 
 const result = await run.start({
@@ -53,8 +55,8 @@ if (result.status === "suspended") {
     },
     {
       name: "cancel",
-      type: "() => Promise<void>",
-      description: "Cancels the workflow execution",
+      type: "() => Promise<{ message: string }>",
+      description: "Cancels the workflow execution, stopping any running steps and preventing subsequent steps from executing",
       required: true,
     },
     {
@@ -102,6 +104,12 @@ A workflow run's `status` indicates its current execution state. The possible va
       description:
         "Workflow execution is paused waiting for resume, with suspended step information",
     },
+    {
+      name: "canceled",
+      type: "string",
+      description:
+        "Workflow execution was canceled via the cancel() method, stopping any running steps and preventing subsequent steps from executing",
+    },
   ]}
 />