@mastra/mcp-docs-server 0.13.37 → 0.13.38

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

@@ -1,13 +1,13 @@
 ---
-title: "Reference: Run.resumeStreamVNext() | Workflows | Mastra Docs"
+title: "Reference: Run.resumeStreamVNext() (Experimental) | Streaming | 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 />
+:::caution Experimental Feature
+This is an experimental API that may change in future versions. The `resumeStreamVNext()` method is part of the enhanced streaming system that will eventually replace the current streaming methods. Use with caution in production environments.
+:::
 
 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.
 
@@ -18,8 +18,8 @@ const run = await workflow.createRunAsync();
 
 const stream = run.streamVNext({
   inputData: {
-    value: "initial data"
-  }
+    value: "initial data",
+  },
 });
 
 const result = await stream.result;
@@ -27,8 +27,8 @@ const result = await stream.result;
 if (result!.status === "suspended") {
   const resumedStream = await run.resumeStreamVNext({
     resumeData: {
-      value: "resume data"
-    }
+      value: "resume data",
+    },
   });
 }
 ```
@@ -62,14 +62,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.",
+            },
+          ],
+        },
+      ],
     },
   ]}
 />
@@ -81,7 +84,8 @@ if (result!.status === "suspended") {
     {
       name: "stream",
       type: "MastraWorkflowStream<ChunkType>",
-      description: "A custom stream that extends ReadableStream<ChunkType> with additional workflow-specific properties",
+      description:
+        "A custom stream that extends ReadableStream<ChunkType> with additional workflow-specific properties",
     },
     {
       name: "stream.status",
@@ -113,6 +117,6 @@ The stream emits various event types during workflow execution. Each event has a
 
 ## Related
 
-- [Workflows overview](../../../docs/workflows/overview.mdx#run-workflow)
-- [Workflow.createRunAsync()](../../../reference/workflows/workflow-methods/create-run.mdx)
-- [Run.streamVNext()](./streamVNext.mdx)
+- [Workflows overview](/docs/workflows/overview#running-workflows)
+- [Workflow.createRunAsync()](/reference/workflows/workflow-methods/create-run)
+- [Run.streamVNext()](./streamVNext)

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Run.stream() | Workflows | Mastra Docs"
+title: "Reference: Run.stream() | Streaming | 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.
 ---
 
@@ -39,17 +39,21 @@ const { stream } = await run.stream({
       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",
@@ -58,14 +62,17 @@ const { stream } = await run.stream({
       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.",
+            },
+          ],
+        },
+      ],
     },
   ]}
 />
@@ -77,18 +84,21 @@ const { stream } = await run.stream({
     {
       name: "stream",
       type: "ReadableStream<StreamEvent>",
-      description: "A readable stream that emits workflow execution events in real-time",
+      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",
+      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.",
+      description:
+        "The trace ID associated with this execution when AI tracing is enabled. Use this to correlate logs and debug execution flow.",
     },
   ]}
 />
@@ -98,8 +108,8 @@ const { stream } = await run.stream({
 ```typescript showLineNumbers copy
 const { getWorkflowState } = await run.stream({
   inputData: {
-    value: "initial data"
-  }
+    value: "initial data",
+  },
 });
 
 const result = await getWorkflowState();
@@ -118,8 +128,7 @@ The stream emits various event types during workflow execution. Each event has a
 - **`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)
+- [Workflows overview](/docs/workflows/overview#running-workflows)
+- [Workflow.createRunAsync()](/reference/workflows/workflow-methods/create-run)

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

@@ -1,13 +1,13 @@
 ---
-title: "Reference: Run.streamVNext() | Workflows | Mastra Docs"
+title: "Reference: Run.streamVNext() (Experimental) | Streaming | 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 />
+:::caution Experimental Feature
+This is an experimental API that may change in future versions. The `streamVNext()` method will eventually replace the current `stream()` method. Use with caution in production environments.
+:::
 
 The `.streamVNext()` method enables real-time streaming of responses from a workflow. This enhanced streaming capability will eventually replace the current `stream()` method.
 
@@ -43,17 +43,21 @@ const stream = run.streamVNext({
       name: "tracingContext",
       type: "TracingContext",
       isOptional: true,
-      description: "AI tracing context for creating child spans and adding metadata.",
+      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."
-          }]
-        }
-      ]
+          parameters: [
+            {
+              name: "currentSpan",
+              type: "AISpan",
+              isOptional: true,
+              description:
+                "Current AI span for creating child spans and adding metadata.",
+            },
+          ],
+        },
+      ],
     },
     {
       name: "tracingOptions",
@@ -62,19 +66,22 @@ const stream = run.streamVNext({
       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."
-          }]
-        }
-      ]
+          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.",
+      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,
     },
   ]}
@@ -87,7 +94,8 @@ const stream = run.streamVNext({
     {
       name: "stream",
       type: "MastraWorkflowStream<ChunkType>",
-      description: "A custom stream that extends ReadableStream<ChunkType> with additional workflow-specific properties",
+      description:
+        "A custom stream that extends ReadableStream<ChunkType> with additional workflow-specific properties",
     },
     {
       name: "stream.status",
@@ -108,7 +116,8 @@ const stream = run.streamVNext({
       name: "stream.traceId",
       type: "string",
       isOptional: true,
-      description: "The trace ID associated with this execution when AI tracing is enabled.",
+      description:
+        "The trace ID associated with this execution when AI tracing is enabled.",
     },
   ]}
 />
@@ -139,6 +148,6 @@ The stream emits various event types during workflow execution. Each event has a
 
 ## Related
 
-- [Workflows overview](../../../docs/workflows/overview.mdx#run-workflow)
-- [Workflow.createRunAsync()](../../../reference/workflows/workflow-methods/create-run.mdx)
-- [Run.resumeStreamVNext()](./resumeStreamVNext.mdx)
+- [Workflows overview](/docs/workflows/overview#running-workflows)
+- [Workflow.createRunAsync()](/reference/workflows/workflow-methods/create-run)
+- [Run.resumeStreamVNext()](./resumeStreamVNext)

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

@@ -1,11 +1,9 @@
 ---
-title: "Templates Reference"
+title: "Reference: LLM provider API keys (choose one or more) | Templates | Mastra Docs"
 description: "Complete guide to creating, using, and contributing Mastra templates"
 ---
 
-import { FileTree, Tabs, Callout } from 'nextra/components'
-
-## Overview
+# Overview
 
 This reference provides comprehensive information about Mastra templates, including how to use existing templates, create your own, and contribute to the community ecosystem.
 
@@ -62,29 +60,6 @@ After installation:
 
 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
@@ -104,7 +79,7 @@ Templates must meet these technical requirements:
 
 Use the standard Mastra TypeScript configuration:
 
-```json filename="tsconfig.json"
+```json title="tsconfig.json"
 {
   "compilerOptions": {
     "target": "ES2022",
@@ -125,7 +100,7 @@ Use the standard Mastra TypeScript configuration:
 
 Include a `.env.example` file with all required environment variables:
 
-```bash filename=".env.example"
+```bash title=".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
@@ -141,16 +116,16 @@ OTHER_SERVICE_API_KEY=your_api_key_here
 
 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';
+```typescript title="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',
+  name: "example-agent",
+  model: openai("gpt-4"), // or anthropic('') or google('')
+  instructions: "Your agent instructions here",
   // ... other configuration
 });
 ```
@@ -172,7 +147,7 @@ Templates must be:
 
 Every template must include a comprehensive README:
 
-```markdown filename="README.md"
+```markdown title="README.md"
 # Template Name
 
 Brief description of what the template demonstrates.
@@ -223,6 +198,8 @@ Templates must demonstrate:
 
 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>
+:::info
+
+Templates provide an excellent way to learn Mastra patterns and accelerate development. Contributing templates helps the entire community build better AI applications.
+
+:::

package/.docs/raw/reference/tools/client.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: MastraMCPClient | Tool Discovery | Mastra Docs"
+title: "Reference: MastraMCPClient (Deprecated) | Tools & MCP | Mastra Docs"
 description: API Reference for MastraMCPClient - A client implementation for the Model Context Protocol.
 ---
 

package/.docs/raw/reference/tools/create-tool.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: createTool() | Tools | Mastra Docs"
+title: "Reference: createTool() | Tools & MCP | Mastra Docs"
 description: Documentation for the `createTool()` function in Mastra, used to define custom tools for agents.
 ---
 
@@ -9,7 +9,7 @@ The `createTool()` function is used to define custom tools that your Mastra agen
 
 ## Usage example
 
-```typescript filename="src/mastra/tools/reverse-tool.ts" showLineNumbers copy
+```typescript title="src/mastra/tools/reverse-tool.ts" showLineNumbers copy
 import { createTool } from "@mastra/core/tools";
 import { z } from "zod";
 
@@ -17,19 +17,19 @@ export const tool = createTool({
   id: "test-tool",
   description: "Reverse the input string",
   inputSchema: z.object({
-    input: z.string()
+    input: z.string(),
   }),
   outputSchema: z.object({
-    output: z.string()
+    output: z.string(),
   }),
   execute: async ({ context }) => {
     const { input } = context;
     const reversed = input.split("").reverse().join("");
 
     return {
-      output: reversed
+      output: reversed,
     };
-  }
+  },
 });
 ```
 
@@ -72,37 +72,47 @@ export const tool = createTool({
       isOptional: false,
       properties: [
         {
-          parameters: [{
-            name: "context",
-            type: "z.infer<TInput>",
-            description: "The parsed input based on inputSchema"
-          }]
+          parameters: [
+            {
+              name: "context",
+              type: "z.infer<TInput>",
+              description: "The parsed input based on inputSchema",
+            },
+          ],
         },
         {
-          parameters: [{
-            name: "runtimeContext",
-            type: "RuntimeContext",
-            isOptional: true,
-            description: "Runtime context for accessing shared state and dependencies"
-          }]
+          parameters: [
+            {
+              name: "runtimeContext",
+              type: "RuntimeContext",
+              isOptional: true,
+              description:
+                "Runtime context for accessing shared state and dependencies",
+            },
+          ],
         },
         {
-          parameters: [{
-            name: "tracingContext",
-            type: "TracingContext",
-            isOptional: true,
-            description: "AI tracing context for creating child spans and adding metadata. Automatically injected when the tool is called within a traced operation."
-          }]
+          parameters: [
+            {
+              name: "tracingContext",
+              type: "TracingContext",
+              isOptional: true,
+              description:
+                "AI tracing context for creating child spans and adding metadata. Automatically injected when the tool is called within a traced operation.",
+            },
+          ],
         },
         {
-          parameters: [{
-            name: "abortSignal",
-            type: "AbortSignal",
-            isOptional: true,
-            description: "Signal for aborting the tool execution"
-          }]
-        }
-      ]
+          parameters: [
+            {
+              name: "abortSignal",
+              type: "AbortSignal",
+              isOptional: true,
+              description: "Signal for aborting the tool execution",
+            },
+          ],
+        },
+      ],
     },
   ]}
 />
@@ -124,7 +134,7 @@ The `createTool()` function returns a `Tool` object.
 
 ## Related
 
-- [Tools Overview](/docs/tools-mcp/overview.mdx)
-- [Using Tools with Agents](/docs/agents/using-tools-and-mcp.mdx)
-- [Tool Runtime Context](/docs/tools-mcp/overview.mdx#using-runtimecontext)
-- [Advanced Tool Usage](/docs/tools-mcp/advanced-usage.mdx)
+- [Tools Overview](/docs/tools-mcp/overview)
+- [Using Tools with Agents](/docs/agents/using-tools)
+- [Tool Runtime Context](/docs/tools-mcp/overview#using-runtimecontext)
+- [Advanced Tool Usage](/docs/tools-mcp/advanced-usage)

package/.docs/raw/reference/tools/document-chunker-tool.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: createDocumentChunkerTool() | Tools | Mastra Docs"
+title: "Reference: createDocumentChunkerTool() | Tools & MCP | Mastra Docs"
 description: Documentation for the Document Chunker Tool in Mastra, which splits documents into smaller chunks for efficient processing and retrieval.
 ---
 
@@ -137,5 +137,5 @@ The chunker is created as a Mastra tool with the following properties:
 
 ## Related
 
-- [MDocument](../rag/document.mdx)
+- [MDocument](../rag/document)
 - [createVectorQueryTool](./vector-query-tool)

package/.docs/raw/reference/tools/graph-rag-tool.mdx

@@ -1,10 +1,8 @@
 ---
-title: "Reference: createGraphRAGTool() | RAG | Mastra Tools Docs"
+title: "Reference: createGraphRAGTool() | Tools & MCP | Mastra Docs"
 description: Documentation for the Graph RAG Tool in Mastra, which enhances RAG by building a graph of semantic relationships between documents.
 ---
 
-import { Callout } from "nextra/components";
-
 # createGraphRAGTool()
 
 The `createGraphRAGTool()` creates a tool that enhances RAG by building a graph of semantic relationships between documents. It uses the `GraphRAG` system under the hood to provide graph-based retrieval, finding relevant content through both direct similarity and connected relationships.
@@ -30,13 +28,15 @@ const graphTool = createGraphRAGTool({
 
 ## Parameters
 
-<Callout>
-  **Parameter Requirements:** Most fields can be set at creation as defaults.
-  Some fields can be overridden at runtime via the runtime context or input. If
-  a required field is missing from both creation and runtime, an error will be
-  thrown. Note that `model`, `id`, and `description` can only be set at creation
-  time.
-</Callout>
+:::note
+
+**Parameter Requirements:** Most fields can be set at creation as defaults.
+Some fields can be overridden at runtime via the runtime context or input. If
+a required field is missing from both creation and runtime, an error will be
+thrown. Note that `model`, `id`, and `description` can only be set at creation
+time.
+
+:::
 
 <PropertiesTable
   content={[
@@ -253,8 +253,8 @@ const response = await agent.generate(
 
 For more information on runtime context, please see:
 
-- [Agent Runtime Context](../../docs/server-db/runtime-context.mdx)
-- [Tool Runtime Context](../../docs/tools-mcp/overview.mdx#using-runtimecontext)
+- [Agent Runtime Context](/docs/server-db/runtime-context)
+- [Tool Runtime Context](/docs/tools-mcp/overview#using-runtimecontext)
 
 ## Related