@mastra/mcp-docs-server 0.13.11-alpha.1 → 0.13.11-alpha.2

package/.docs/raw/reference/agents/stream.mdx

@@ -1,16 +1,16 @@
 ---
-title: "Reference: stream() | Agents | Mastra Docs"
-description: "Documentation for the `.stream()` method in Mastra agents, which enables real-time streaming of responses."
+title: "Reference: Agent.stream() | Agents | Mastra Docs"
+description: "Documentation for the `Agent.stream()` method in Mastra agents, which enables real-time streaming of responses."
 ---
 
-# stream()
+# Agent.stream()
 
 The `.stream()` method enables real-time streaming of responses from an agent. This method accepts messages and optional streaming options.
 
 ## Usage example
 
-```typescript showLineNumbers copy
-const response = await agent.stream("message for agent");
+```typescript copy
+await agent.stream("message for agent");
 ```
 
 ## Parameters
@@ -31,20 +31,6 @@ const response = await agent.stream("message for agent");
   ]}
 />
 
-## Extended usage example
-
-```typescript showLineNumbers copy
-const response = await agent.stream("message for agent", {
-  temperature: 0.7,
-  maxSteps: 3,
-  memory: {
-    thread: "user-123",
-    resource: "test-app"
-  },
-  toolChoice: "auto"
-});
-```
-
 ### Options parameters
 
 <PropertiesTable
@@ -472,3 +458,22 @@ const response = await agent.stream("message for agent", {
     },
   ]}
 />
+
+## Extended usage example
+
+```typescript showLineNumbers copy
+await agent.stream("message for agent", {
+  temperature: 0.7,
+  maxSteps: 3,
+  memory: {
+    thread: "user-123",
+    resource: "test-app"
+  },
+  toolChoice: "auto"
+});
+```
+
+## Related
+
+- [Agent streaming](../../docs/agents/streaming.mdx)
+- [Agent generation](../../docs/agents/overview.mdx#generate)

package/.docs/raw/reference/agents/streamVNext.mdx

@@ -1,16 +1,16 @@
 ---
-title: "Reference: streamVNext() | Agents | Mastra Docs"
-description: "Documentation for the `.streamVNext()` method in Mastra agents, which enables real-time streaming of responses with enhanced capabilities."
+title: "Reference: Agent.streamVNext() | Agents | Mastra Docs"
+description: "Documentation for the `Agent.streamVNext()` method in Mastra agents, which enables real-time streaming of responses with enhanced capabilities."
 ---
 
-# streamVNext()
+# Agent.streamVNext()
 
 The `.streamVNext()` method enables real-time streaming of responses from an agent with enhanced capabilities. This method accepts messages and optional streaming options, providing a next-generation streaming experience.
 
 ## Usage example
 
-```typescript showLineNumbers copy
-const response = await agent.streamVNext("message for agent");
+```typescript copy
+await agent.streamVNext("message for agent");
 ```
 
 ## Parameters
@@ -31,20 +31,6 @@ const response = await agent.streamVNext("message for agent");
   ]}
 />
 
-## Extended usage example
-
-```typescript showLineNumbers copy
-const response = await agent.streamVNext("message for agent", {
-  temperature: 0.7,
-  maxSteps: 3,
-  memory: {
-    thread: "user-123",
-    resource: "test-app"
-  },
-  toolChoice: "auto"
-});
-```
-
 ### Options parameters
 
 <PropertiesTable
@@ -402,3 +388,16 @@ const response = await agent.streamVNext("message for agent", {
   ]}
 />
 
+## Extended usage example
+
+```typescript showLineNumbers copy
+await agent.streamVNext("message for agent", {
+  temperature: 0.7,
+  maxSteps: 3,
+  memory: {
+    thread: "user-123",
+    resource: "test-app"
+  },
+  toolChoice: "auto"
+});
+```

package/.docs/raw/reference/storage/upstash.mdx

@@ -2,11 +2,16 @@
 title: "Upstash Storage | Storage System | Mastra Core"
 description: Documentation for the Upstash storage implementation in Mastra.
 ---
+import { Callout } from 'nextra/components'
 
 # Upstash Storage
 
 The Upstash storage implementation provides a serverless-friendly storage solution using Upstash's Redis-compatible key-value store.
 
+<Callout type="warning">
+  **Important:** When using Mastra with Upstash, the pay-as-you-go model can result in unexpectedly high costs due to the high volume of Redis commands generated during agent conversations. We strongly recommend using a **fixed pricing plan** for predictable costs. See [Upstash pricing](https://upstash.com/pricing/redis) for details and [GitHub issue #5850](https://github.com/mastra-ai/mastra/issues/5850) for context.
+</Callout>
+
 ## Installation
 
 ```bash copy

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

@@ -1,38 +1,40 @@
 ---
 title: "Reference: createTool() | Tools | Mastra Docs"
-description: Documentation for the createTool function in Mastra, used to define custom tools for agents.
+description: Documentation for the `createTool()` function in Mastra, used to define custom tools for agents.
 ---
 
 # createTool()
 
 The `createTool()` function is used to define custom tools that your Mastra agents can execute. Tools extend an agent's capabilities by allowing it to interact with external systems, perform calculations, or access specific data.
 
-## Basic Usage
+## Usage example
 
-Here is a basic example of creating a tool that fetches weather information:
-
-```typescript filename="src/mastra/tools/weatherInfo.ts" copy
+```typescript filename="src/mastra/tools/reverse-tool.ts" showLineNumbers copy
 import { createTool } from "@mastra/core/tools";
 import { z } from "zod";
 
-export const weatherInfo = createTool({
-  id: "Get Weather Information",
+export const reverseTool = createTool({
+  id: "reverse-tool",
+  description: "Reverse the input string",
   inputSchema: z.object({
-    city: z.string(),
+    input: z.string()
+  }),
+  outputSchema: z.object({
+    output: z.string()
   }),
-  description: `Fetches the current weather information for a given city`,
-  execute: async ({ context: { city } }) => {
-    // Tool logic here (e.g., API call)
-    console.log("Using tool to fetch weather information for", city);
-    return { temperature: 20, conditions: "Sunny" }; // Example return
-  },
+  execute: async ({ context }) => {
+    const { input } = context;
+    const reversed = input.split("").reverse().join("");
+
+    return {
+      output: reversed
+    };
+  }
 });
 ```
 
 ## Parameters
 
-The `createTool()` function accepts an object with the following parameters:
-
 <PropertiesTable
   content={[
     {
@@ -87,18 +89,9 @@ The `createTool()` function returns a `Tool` object.
   ]}
 />
 
-## Tool Details
-
-The `Tool` object returned by `createTool()` has the following key properties:
-
-- **ID**: The unique identifier provided in the `id` parameter.
-- **Description**: The description provided in the `description` parameter.
-- **Parameters**: Derived from the `inputSchema`, defining the structure of inputs the tool expects.
-- **Execute Function**: The logic defined in the `execute` parameter, which is called when the agent decides to use the tool.
-
 ## Related
 
-- [Tools Overview](/docs/tools-mcp/overview)
-- [Using Tools with Agents](/docs/agents/using-tools-and-mcp)
-- [Dynamic Tool Context](/docs/tools-mcp/dynamic-context)
-- [Advanced Tool Usage](/docs/tools-mcp/advanced-usage)
+- [Tools Overview](/docs/tools-mcp/overview.mdx)
+- [Using Tools with Agents](/docs/agents/using-tools-and-mcp.mdx)
+- [Dynamic Tool Context](/docs/tools-mcp/dynamic-context.mdx)
+- [Advanced Tool Usage](/docs/tools-mcp/advanced-usage.mdx)

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

@@ -246,8 +246,8 @@ const response = await agent.generate(
 
 For more information on runtime context, please see:
 
-- [Runtime Variables](../../docs/agents/runtime-variables)
-- [Dynamic Context](../../docs/tools-mcp/dynamic-context)
+- [Runtime Variables](../../docs/agents/runtime-variables.mdx)
+- [Dynamic Context](../../docs/tools-mcp/dynamic-context.mdx)
 
 ## Related
 

package/.docs/raw/reference/tools/vector-query-tool.mdx

@@ -314,7 +314,7 @@ This agent-driven approach:
 
 For detailed filter syntax and store-specific capabilities, see the [Metadata Filters](../rag/metadata-filters) documentation.
 
-For an example of how agent-driven filtering works, see the [Agent-Driven Metadata Filtering](../../../examples/rag/usage/filter-rag) example.
+For an example of how agent-driven filtering works, see the [Agent-Driven Metadata Filtering](../../../examples/rag/usage/filter-rag.mdx) example.
 
 ## Example with Reranking
 
@@ -551,8 +551,8 @@ const response = await agent.generate(
 
 For more information on runtime context, please see:
 
-- [Runtime Variables](../../docs/agents/runtime-variables)
-- [Dynamic Context](../../docs/tools-mcp/dynamic-context)
+- [Runtime Variables](../../docs/agents/runtime-variables.mdx)
+- [Dynamic Context](../../docs/tools-mcp/dynamic-context.mdx)
 
 ## Usage Without a Mastra Server
 

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

@@ -1,18 +1,18 @@
 ---
-title: "Reference: Workflow.branch() | Building Workflows | Mastra Docs"
-description: Documentation for the `.branch()` method in workflows, which creates conditional branches between steps.
+title: "Reference: Workflow.branch() | Workflows | Mastra Docs"
+description: Documentation for the `Workflow.branch()` method in workflows, which creates conditional branches between steps.
 ---
 
 # Workflow.branch()
 
 The `.branch()` method creates conditional branches between workflow steps, allowing for different paths to be taken based on the result of a previous step.
 
-## Usage
+## Usage example
 
-```typescript
+```typescript copy
 workflow.branch([
-  [async ({ context }) => true, stepOne],
-  [async ({ context }) => false, stepTwo],
+  [async ({ context }) => true, step1],
+  [async ({ context }) => false, step2],
 ]);
 ```
 

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

@@ -1,16 +1,16 @@
 ---
-title: "Reference: Workflow.commit() | Building Workflows | Mastra Docs"
-description: Documentation for the `.commit()` method in workflows, which finalizes the workflow and returns the final result.
+title: "Reference: Workflow.commit() | Workflows | Mastra Docs"
+description: Documentation for the `Workflow.commit()` method in workflows, which finalizes the workflow and returns the final result.
 ---
 
 # Workflow.commit()
 
 The `.commit()` method finalizes the workflow and returns the final result.
 
-## Usage
+## Usage example
 
-```typescript
-workflow.then(stepOne).commit();
+```typescript copy
+workflow.then(step1).commit();
 ```
 
 ## Returns

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

@@ -1,37 +1,22 @@
 ---
-title: "Reference: Workflow.createRunAsync() | Building Workflows | Mastra Docs"
-description: Documentation for the `.createRunAsync()` method in workflows, which creates a new workflow run instance.
+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.
-
-## Usage
-
-```typescript
-const myWorkflow = createWorkflow({
-  id: "my-workflow",
-  inputSchema: z.object({
-    startValue: z.string(),
-  }),
-  outputSchema: z.object({
-    result: z.string(),
-  }),
-  steps: [step1, step2, step3], // Declare steps used in this workflow
-})
-  .then(step1)
-  .then(step2)
-  .then(step3)
-  .commit();
-
-const mastra = new Mastra({
-  workflows: {
-    myWorkflow,
-  },
-});
+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.
 
-const run = await mastra.getWorkflow("myWorkflow").createRunAsync();
+<Callout>
+For the legacy `createRun()` method that returns an object with methods, see the [Legacy Workflows](../legacyWorkflows/createRun.mdx) section.
+</Callout>
+
+## Usage example
+
+```typescript copy
+await workflow.createRunAsync();
 ```
 
 ## Parameters
@@ -61,6 +46,20 @@ const run = await mastra.getWorkflow("myWorkflow").createRunAsync();
   ]}
 />
 
+## Extended usage example
+
+```typescript showLineNumbers copy
+const workflow = mastra.getWorkflow("workflow");
+
+const run = await workflow.createRunAsync();
+
+const result = await run.start({
+  inputData: {
+    value: 10,
+  },
+});
+```
+
 ## Related
 
-- [Running workflows](../../docs/workflows/overview.mdx#running-workflows)
+- [Running workflows](../../examples/workflows/running-workflows.mdx)

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

@@ -1,16 +1,16 @@
 ---
-title: "Reference: Workflow.dountil() | Building Workflows | Mastra Docs"
-description: Documentation for the `.dountil()` method in workflows, which creates a loop that executes a step until a condition is met.
+title: "Reference: Workflow.dountil() | Workflows | Mastra Docs"
+description: Documentation for the `Workflow.dountil()` method in workflows, which creates a loop that executes a step until a condition is met.
 ---
 
 # Workflow.dountil()
 
 The `.dountil()` method creates a loop that executes a step until a condition is met.
 
-## Usage
+## Usage example
 
-```typescript
-workflow.dountil(stepOne, async ({ inputData }) => true);
+```typescript copy
+workflow.dountil(step1, async ({ inputData }) => true);
 ```
 
 ## Parameters

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

@@ -1,16 +1,16 @@
 ---
-title: "Reference: Workflow.dowhile() | Building Workflows | Mastra Docs"
-description: Documentation for the `.dowhile()` method in workflows, which creates a loop that executes a step while a condition is met.
+title: "Reference: Workflow.dowhile() | Workflows | Mastra Docs"
+description: Documentation for the `Workflow.dowhile()` method in workflows, which creates a loop that executes a step while a condition is met.
 ---
 
 # Workflow.dowhile()
 
 The `.dowhile()` method creates a loop that executes a step while a condition is met.
 
-## Usage
+## Usage example
 
-```typescript
-workflow.dowhile(stepOne, async ({ inputData }) => true);
+```typescript copy
+workflow.dowhile(step1, async ({ inputData }) => true);
 ```
 
 ## Parameters

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

@@ -1,45 +1,19 @@
 ---
-title: "Reference: Workflow.execute() | Building Workflows | Mastra Docs"
-description: Documentation for the `.execute()` method in workflows, which executes a step with input data and returns the output.
+title: "Reference: Workflow.execute() | Workflows | Mastra Docs"
+description: Documentation for the `Workflow.execute()` method in workflows, which executes a workflow directly and returns the output.
 ---
 
 # Workflow.execute()
 
-The `.execute()` method executes a step with input data and returns the output, allowing you to process data within a workflow.
+The `.execute()` method executes a workflow directly and returns the output, allowing you to run a workflow without creating a separate run instance.
 
-## Usage
+## Usage example
 
-```typescript
-const inputSchema = z.object({
-  inputValue: z.string(),
-});
-
-const myStep = createStep({
-  id: "my-step",
-  description: "Does something useful",
-  inputSchema,
-  outputSchema: z.object({
-    outputValue: z.string(),
-  }),
-  resumeSchema: z.object({
-    resumeValue: z.string(),
-  }),
-  suspendSchema: z.object({
-    suspendValue: z.string(),
-  }),
-  execute: async ({
-    inputData,
-    mastra,
-    getStepResult,
-    getInitData,
-    runtimeContext,
-  }) => {
-    const otherStepOutput = getStepResult(step2);
-    const initData = getInitData<typeof inputSchema>(); // typed as the input schema variable (zod schema)
-    return {
-      outputValue: `Processed: ${inputData.inputValue}, ${initData.startValue} (runtimeContextValue: ${runtimeContext.get("runtimeContextValue")})`,
-    };
-  },
+```typescript showLineNumbers copy
+await workflow.execute({
+  inputData: {
+    value: "hello world"
+  }
 });
 ```
 
@@ -48,77 +22,93 @@ const myStep = createStep({
 <PropertiesTable
   content={[
     {
-      name: "params",
-      type: "object",
-      description: "Configuration object for executing the step",
+      name: "inputData",
+      type: "z.infer<TInput>",
+      description: "Input data that matches the workflow's input schema",
       isOptional: false,
+    },
+    {
+      name: "resumeData",
+      type: "any",
+      description: "Data for resuming a suspended workflow",
+      isOptional: true,
+    },
+    {
+      name: "suspend",
+      type: "(suspendPayload: any) => Promise<any>",
+      description: "Function to suspend workflow execution",
+      isOptional: false,
+    },
+    {
+      name: "resume",
+      type: "object",
+      description: "Configuration for resuming workflow execution",
+      isOptional: true,
       properties: [
         {
-          name: "inputData",
-          type: "z.infer<TInput>",
-          description: "Input data matching the step's input schema",
+          name: "steps",
+          type: "string[]",
+          description: "Steps to resume",
           isOptional: false,
         },
         {
-          name: "resumeData",
-          type: "ResumeSchema",
-          description: "Data for resuming a suspended step",
-          isOptional: true,
-        },
-        {
-          name: "suspend",
-          type: "(suspendPayload: any) => Promise<void>",
-          description: "Function to suspend step execution",
+          name: "resumePayload",
+          type: "any",
+          description: "Payload data for resuming",
           isOptional: false,
         },
         {
-          name: "resume",
-          type: "object",
-          description: "Configuration for resuming execution",
+          name: "runId",
+          type: "string",
+          description: "ID of the run to resume",
           isOptional: true,
-          properties: [
-            {
-              name: "steps",
-              type: "string[]",
-              description: "Steps to resume",
-              isOptional: false,
-            },
-            {
-              name: "resumePayload",
-              type: "any",
-              description: "Payload data for resuming",
-              isOptional: false,
-            },
-            {
-              name: "runId",
-              type: "string",
-              description: "ID of the run to resume",
-              isOptional: true,
-            },
-          ],
-        },
-        {
-          name: "emitter",
-          type: "object",
-          description: "Event emitter object",
-          isOptional: false,
-          properties: [
-            {
-              name: "emit",
-              type: "(event: string, data: any) => void",
-              description: "Function to emit events",
-              isOptional: false,
-            },
-          ],
         },
+      ],
+    },
+    {
+      name: "emitter",
+      type: "object",
+      description: "Event emitter object for workflow events",
+      isOptional: false,
+      properties: [
         {
-          name: "mastra",
-          type: "Mastra",
-          description: "Mastra instance",
+          name: "emit",
+          type: "(event: string, data: any) => void",
+          description: "Function to emit events",
           isOptional: false,
         },
       ],
     },
+    {
+      name: "mastra",
+      type: "Mastra",
+      description: "Mastra instance",
+      isOptional: false,
+    },
+    {
+      name: "runtimeContext",
+      type: "RuntimeContext",
+      description: "Runtime context data to use during workflow execution",
+      isOptional: true,
+    },
+    {
+      name: "abort",
+      type: "() => any",
+      description: "Function to abort workflow execution",
+      isOptional: false,
+    },
+    {
+      name: "abortSignal",
+      type: "AbortSignal",
+      description: "Abort signal for workflow execution",
+      isOptional: false,
+    },
+    {
+      name: "runCount",
+      type: "number",
+      description: "Number of times the workflow has been run",
+      isOptional: true,
+    },
   ]}
 />
 
@@ -129,11 +119,13 @@ const myStep = createStep({
     {
       name: "result",
       type: "Promise<z.infer<TOutput>>",
-      description: "A promise that resolves to the output of the executed step",
+      description: "A promise that resolves to the output of the executed workflow",
     },
   ]}
 />
 
 ## Related
 
+- [Workflow.createRunAsync()](./create-run.mdx) - Alternative method for creating workflow runs
+- [WorkflowRun.start()](./start.mdx) - Starting workflow execution
 - [Running workflows](../../docs/workflows/overview.mdx#running-workflows)

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

@@ -1,16 +1,16 @@
 ---
-title: "Reference: Workflow.foreach() | Building Workflows | Mastra Docs"
-description: Documentation for the `.foreach()` method in workflows, which creates a loop that executes a step for each item in an array.
+title: "Reference: Workflow.foreach() | Workflows | Mastra Docs"
+description: Documentation for the `Workflow.foreach()` method in workflows, which creates a loop that executes a step for each item in an array.
 ---
 
 # Workflow.foreach()
 
 The `.foreach()` method creates a loop that executes a step for each item in an array.
 
-## Usage
+## Usage example
 
-```typescript
-workflow.foreach(stepOne, { concurrency: 2 });
+```typescript copy
+workflow.foreach(step1, { concurrency: 2 });
 ```
 
 ## Parameters