@mastra/mcp-docs-server 0.0.0-error-handler-fix-20251020202607 → 0.0.0-execa-dynamic-import-20260304221256

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

@@ -1,118 +0,0 @@
----
-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,
-    },
-    {
-      name: "tracingOptions",
-      type: "TracingOptions",
-      isOptional: true,
-      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."
-          }]
-        }
-      ]
-    },
-  ]}
-/>
-
-## 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<TState, 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()](../../../reference/workflows/workflow-methods/create-run.mdx)
-- [Run.streamVNext()](./streamVNext.mdx)

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

@@ -1,125 +0,0 @@
----
-title: "Reference: Run.stream() | Workflows | Mastra Docs"
-description: Documentation for the `Run.stream()` method in workflows, which allows you to monitor the execution of a workflow run as a stream.
----
-
-# Run.stream()
-
-The `.stream()` method allows you to monitor the execution of a workflow run, providing real-time updates on the status of steps.
-
-## Usage example
-
-```typescript showLineNumbers copy
-const run = await workflow.createRunAsync();
-
-const { stream } = await run.stream({
-  inputData: {
-    value: "initial data",
-  },
-});
-```
-
-## Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "inputData",
-      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: "tracingContext",
-      type: "TracingContext",
-      isOptional: true,
-      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."
-          }]
-        }
-      ]
-    },
-    {
-      name: "tracingOptions",
-      type: "TracingOptions",
-      isOptional: true,
-      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."
-          }]
-        }
-      ]
-    },
-  ]}
-/>
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "stream",
-      type: "ReadableStream<StreamEvent>",
-      description: "A readable stream that emits workflow execution events in real-time",
-    },
-    {
-      name: "getWorkflowState",
-      type: "() => Promise<WorkflowResult<TState, TOutput, TSteps>>",
-      description: "A function that returns a promise resolving to the final workflow result",
-    },
-    {
-      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.",
-    },
-  ]}
-/>
-
-## 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
-
-
-## Related
-
-- [Workflows overview](../../../docs/workflows/overview.mdx#run-workflow)
-- [Workflow.createRunAsync()](../../../reference/workflows/workflow-methods/create-run.mdx)

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

@@ -1,144 +0,0 @@
----
-title: "Reference: Run.streamVNext() | Workflows | Mastra Docs"
-description: Documentation for the `Run.streamVNext()` method in workflows, which enables real-time streaming of responses.
----
-
-import { StreamVNextCallout } from "@/components/streamVNext-callout.tsx"
-
-# Run.streamVNext() (Experimental)
-
-<StreamVNextCallout />
-
-The `.streamVNext()` method enables real-time streaming of responses from a workflow. This enhanced streaming capability will eventually replace the current `stream()` method.
-
-## Usage example
-
-```typescript showLineNumbers copy
-const run = await workflow.createRunAsync();
-
-const stream = run.streamVNext({
-  inputData: {
-    value: "initial data",
-  },
-});
-```
-
-## Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "inputData",
-      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: "tracingContext",
-      type: "TracingContext",
-      isOptional: true,
-      description: "AI tracing context for creating child spans and adding metadata.",
-      properties: [
-        {
-          parameters: [{
-            name: "currentSpan",
-            type: "AISpan",
-            isOptional: true,
-            description: "Current AI span for creating child spans and adding metadata."
-          }]
-        }
-      ]
-    },
-    {
-      name: "tracingOptions",
-      type: "TracingOptions",
-      isOptional: true,
-      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."
-          }]
-        }
-      ]
-    },
-    {
-      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,
-    },
-  ]}
-/>
-
-## 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<TState, 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",
-    },
-    {
-      name: "stream.traceId",
-      type: "string",
-      isOptional: true,
-      description: "The trace ID associated with this execution when AI tracing is enabled.",
-    },
-  ]}
-/>
-
-## Extended usage example
-
-```typescript showLineNumbers copy
-const run = await workflow.createRunAsync();
-
-const stream = run.streamVNext({
-  inputData: {
-    value: "initial data",
-  },
-});
-
-const result = await stream.result;
-```
-
-## 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()](../../../reference/workflows/workflow-methods/create-run.mdx)
-- [Run.resumeStreamVNext()](./resumeStreamVNext.mdx)

package/.docs/raw/reference/templates/overview.mdx

@@ -1,228 +0,0 @@
----
-title: "Templates Reference"
-description: "Complete guide to creating, using, and contributing Mastra templates"
----
-
-import { FileTree, Tabs, Callout } from 'nextra/components'
-
-## Overview
-
-This reference provides comprehensive information about Mastra templates, including how to use existing templates, create your own, and contribute to the community ecosystem.
-
-Mastra templates are pre-built project structures that demonstrate specific use cases and patterns. They provide:
-
-- **Working examples** - Complete, functional Mastra applications
-- **Best practices** - Proper project structure and coding conventions
-- **Educational resources** - Learn Mastra patterns through real implementations
-- **Quick starts** - Bootstrap projects faster than building from scratch
-
-## Using Templates
-
-### Installation
-
-Install a template using the `create-mastra` command:
-
-```bash copy
-npx create-mastra@latest --template template-name
-```
-
-This creates a complete project with all necessary code and configuration.
-
-### Setup Process
-
-After installation:
-
-1. **Navigate to project directory**:
-
-   ```bash copy
-   cd your-project-name
-   ```
-
-2. **Configure environment variables**:
-
-   ```bash copy
-   cp .env.example .env
-   ```
-
-   Edit `.env` with required API keys as documented in the template's README.
-
-3. **Install dependencies** (if not done automatically):
-
-   ```bash copy
-   npm install
-   ```
-
-4. **Start development server**:
-
-   ```bash copy
-   npm run dev
-   ```
-
-### Template Structure
-
-All templates follow this standardized structure:
-
-<FileTree>
-  <FileTree.Folder name="template-name" defaultOpen>
-    <FileTree.Folder name="src" defaultOpen>
-      <FileTree.Folder name="mastra" defaultOpen>
-        <FileTree.Folder name="agents">
-          <FileTree.File name="example-agent.ts" />
-        </FileTree.Folder>
-        <FileTree.Folder name="tools">
-          <FileTree.File name="example-tool.ts" />
-        </FileTree.Folder>
-        <FileTree.Folder name="workflows">
-          <FileTree.File name="example-workflow.ts" />
-        </FileTree.Folder>
-        <FileTree.File name="index.ts" />
-      </FileTree.Folder>
-    </FileTree.Folder>
-    <FileTree.File name=".env.example" />
-    <FileTree.File name="package.json" />
-    <FileTree.File name="README.md" />
-    <FileTree.File name="tsconfig.json" />
-  </FileTree.Folder>
-</FileTree>
-
-## Creating Templates
-
-### Requirements
-
-Templates must meet these technical requirements:
-
-#### Project Structure
-
-- **Mastra code location**: All Mastra code must be in `src/mastra/` directory
-- **Component organization**:
-  - Agents: `src/mastra/agents/`
-  - Tools: `src/mastra/tools/`
-  - Workflows: `src/mastra/workflows/`
-  - Main config: `src/mastra/index.ts`
-
-#### TypeScript Configuration
-
-Use the standard Mastra TypeScript configuration:
-
-```json filename="tsconfig.json"
-{
-  "compilerOptions": {
-    "target": "ES2022",
-    "module": "ES2022",
-    "moduleResolution": "bundler",
-    "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": true,
-    "strict": true,
-    "skipLibCheck": true,
-    "noEmit": true,
-    "outDir": "dist"
-  },
-  "include": ["src/**/*"]
-}
-```
-
-#### Environment Configuration
-
-Include a `.env.example` file with all required environment variables:
-
-```bash filename=".env.example"
-# LLM provider API keys (choose one or more)
-OPENAI_API_KEY=your_openai_api_key_here
-ANTHROPIC_API_KEY=your_anthropic_api_key_here
-GOOGLE_GENERATIVE_AI_API_KEY=your_google_api_key_here
-
-# Other service API keys as needed
-OTHER_SERVICE_API_KEY=your_api_key_here
-```
-
-### Code Standards
-
-#### LLM Provider
-
-We recommend using OpenAI, Anthropic, or Google model providers for templates. Choose the provider that best fits your use case:
-
-```typescript filename="src/mastra/agents/example-agent.ts"
-import { Agent } from '@mastra/core/agent';
-import { openai } from '@ai-sdk/openai';
-// Or use: import { anthropic } from '@ai-sdk/anthropic';
-// Or use: import { google } from '@ai-sdk/google';
-
-const agent = new Agent({
-  name: 'example-agent',
-  model: openai('gpt-4'), // or anthropic('') or google('')
-  instructions: 'Your agent instructions here',
-  // ... other configuration
-});
-```
-
-#### Compatibility Requirements
-
-Templates must be:
-
-- **Single projects** - Not monorepos with multiple applications
-- **Framework-free** - No Next.js, Express, or other web framework boilerplate
-- **Mastra-focused** - Demonstrate Mastra functionality without additional layers
-- **Mergeable** - Structure code for easy integration into existing projects
-- **Node.js compatible** - Support Node.js 18 and higher
-- **ESM modules** - Use ES modules (`"type": "module"` in package.json)
-
-### Documentation Requirements
-
-#### README Structure
-
-Every template must include a comprehensive README:
-
-```markdown filename="README.md"
-# Template Name
-
-Brief description of what the template demonstrates.
-
-## Overview
-
-Detailed explanation of the template's functionality and use case.
-
-## Setup
-
-1. Copy `.env.example` to `.env` and fill in your API keys
-2. Install dependencies: `npm install`
-3. Run the project: `npm run dev`
-
-## Environment Variables
-
-- `OPENAI_API_KEY`: Your OpenAI API key. Get one at [OpenAI Platform](https://platform.openai.com/api-keys)
-- `ANTHROPIC_API_KEY`: Your Anthropic API key. Get one at [Anthropic Console](https://console.anthropic.com/settings/keys)
-- `GOOGLE_GENERATIVE_AI_API_KEY`: Your Google AI API key. Get one at [Google AI Studio](https://makersuite.google.com/app/apikey)
-- `OTHER_API_KEY`: Description of what this key is for
-
-## Usage
-
-Instructions on how to use the template and examples of expected behavior.
-
-## Customization
-
-Guidelines for modifying the template for different use cases.
-```
-
-#### Code Comments
-
-Include clear comments explaining:
-
-- Complex logic or algorithms
-- API integrations and their purpose
-- Configuration options and their effects
-- Example usage patterns
-
-### Quality Standards
-
-Templates must demonstrate:
-
-- **Code quality** - Clean, well-commented, maintainable code
-- **Error handling** - Proper handling for external APIs and user inputs
-- **Type safety** - Full TypeScript typing with Zod validation
-- **Testing** - Verified functionality with fresh installations
-
-For information on contributing your own templates to the Mastra ecosystem, see the [Contributing Templates](/docs/community/contributing-templates) guide in the community section.
-
-<Callout type="info">
-  Templates provide an excellent way to learn Mastra patterns and accelerate development. Contributing templates helps the entire community build better AI applications.
-</Callout>