@mastra/mcp-docs-server 0.13.39 → 1.0.0-beta.1

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

@@ -0,0 +1,69 @@
+---
+title: "Reference: Agent.getDefaultOptions() | Agents | Mastra Docs"
+description: "Documentation for the `Agent.getDefaultOptions()` method in Mastra agents, which retrieves the default options used for stream and generate calls."
+---
+
+# Agent.getDefaultOptions()
+
+Agents can be configured with default options for memory usage, output format, and iteration steps. The `.getDefaultOptions()` method returns these defaults, resolving them if they are functions. These options apply to all `stream()` and `generate()` calls unless overridden and are useful for inspecting an agent’s unknown defaults.
+
+## Usage example
+
+```typescript copy
+await agent.getDefaultOptions();
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "options",
+      type: "{ requestContext?: RequestContext }",
+      isOptional: true,
+      defaultValue: "{}",
+      description: "Optional configuration object containing request context.",
+    },
+  ]}
+/>
+
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: "defaultOptions",
+      type: "AgentExecutionOptions<Output> | Promise<AgentExecutionOptions<Output>>",
+      description:
+        "The default streaming options configured for the agent, either as a direct object or a promise that resolves to the options.",
+    },
+  ]}
+/>
+
+## Extended usage example
+
+```typescript copy
+await agent.getDefaultOptions({
+  requestContext: new RequestContext(),
+});
+```
+
+### Options parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "requestContext",
+      type: "RequestContext",
+      isOptional: true,
+      defaultValue: "new RequestContext()",
+      description:
+        "Request Context for dependency injection and contextual information.",
+    },
+  ]}
+/>
+
+## Related
+
+- [Streaming with agents](/docs/v1/streaming/overview#streaming-with-agents)
+- [Request Context](/docs/v1/server-db/request-context)

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

@@ -1,16 +1,22 @@
 ---
-title: "Reference: Agent.getDefaultStreamOptions() | Agents | Mastra Docs"
-description: "Documentation for the `Agent.getDefaultStreamOptions()` method in Mastra agents, which retrieves the default options used for stream calls."
+title: "Reference: Agent.getDefaultStreamOptionsLegacy() | Agents | Mastra Docs"
+description: "Documentation for the `Agent.getDefaultStreamOptionsLegacy()` method in Mastra agents, which retrieves the default options used for streamLegacy calls."
 ---
 
-# Agent.getDefaultStreamOptions()
+# Agent.getDefaultStreamOptionsLegacy()
 
-Agents can be configured with default streaming options for memory usage, output format, and iteration steps. The `.getDefaultStreamOptions()` method returns these defaults, resolving them if they are functions. These options apply to all `stream()` calls unless overridden and are useful for inspecting an agent’s unknown defaults.
+:::warning
+
+**Deprecated**: This method is deprecated and only works with V1 models. For V2 models, use the new [`.getDefaultOptions()`](./getDefaultOptions) method instead.
+
+:::
+
+Agents can be configured with default streaming options for memory usage, output format, and iteration steps. The `.getDefaultStreamOptionsLegacy()` method returns these defaults, resolving them if they are functions. These options apply to all `streamLegacy()` calls unless overridden and are useful for inspecting an agent’s unknown defaults.
 
 ## Usage example
 
 ```typescript copy
-await agent.getDefaultStreamOptions();
+await agent.getDefaultStreamOptionsLegacy();
 ```
 
 ## Parameters
@@ -19,10 +25,10 @@ await agent.getDefaultStreamOptions();
   content={[
     {
       name: "options",
-      type: "{ runtimeContext?: RuntimeContext }",
+      type: "{ requestContext?: RequestContext }",
       isOptional: true,
       defaultValue: "{}",
-      description: "Optional configuration object containing runtime context.",
+      description: "Optional configuration object containing request context.",
     },
   ]}
 />
@@ -33,7 +39,7 @@ await agent.getDefaultStreamOptions();
   content={[
     {
       name: "defaultOptions",
-      type: "AgentExecutionOptions<Output> | Promise<AgentExecutionOptions<Output>>",
+      type: "AgentStreamOptions | Promise<AgentStreamOptions>",
       description:
         "The default vNext streaming options configured for the agent, either as a direct object or a promise that resolves to the options.",
     },
@@ -43,8 +49,8 @@ await agent.getDefaultStreamOptions();
 ## Extended usage example
 
 ```typescript copy
-await agent.getDefaultStreamOptions({
-  runtimeContext: new RuntimeContext(),
+await agent.getDefaultStreamOptionsLegacy({
+  requestContext: new RequestContext(),
 });
 ```
 
@@ -53,17 +59,17 @@ await agent.getDefaultStreamOptions({
 <PropertiesTable
   content={[
     {
-      name: "runtimeContext",
-      type: "RuntimeContext",
+      name: "requestContext",
+      type: "RequestContext",
       isOptional: true,
-      defaultValue: "new RuntimeContext()",
+      defaultValue: "new RequestContext()",
       description:
-        "Runtime context for dependency injection and contextual information.",
+        "Request Context for dependency injection and contextual information.",
     },
   ]}
 />
 
 ## Related
 
-- [Streaming with agents](/docs/streaming/overview#streaming-with-agents)
-- [Runtime Context](/docs/server-db/runtime-context)
+- [Streaming with agents](/docs/v1/streaming/overview#streaming-with-agents)
+- [Request Context](/docs/v1/server-db/request-context)

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

@@ -32,4 +32,4 @@ This method takes no parameters.
 
 ## Related
 
-- [Agents overview](/docs/agents/overview)
+- [Agents overview](/docs/v1/agents/overview)

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

@@ -19,10 +19,10 @@ await agent.getInstructions();
   content={[
     {
       name: "options",
-      type: "{ runtimeContext?: RuntimeContext }",
+      type: "{ requestContext?: RequestContext }",
       isOptional: true,
       defaultValue: "{}",
-      description: "Optional configuration object containing runtime context.",
+      description: "Optional configuration object containing request context.",
     },
   ]}
 />
@@ -44,7 +44,7 @@ await agent.getInstructions();
 
 ```typescript copy
 await agent.getInstructions({
-  runtimeContext: new RuntimeContext(),
+  requestContext: new RequestContext(),
 });
 ```
 
@@ -53,17 +53,17 @@ await agent.getInstructions({
 <PropertiesTable
   content={[
     {
-      name: "runtimeContext",
-      type: "RuntimeContext",
+      name: "requestContext",
+      type: "RequestContext",
       isOptional: true,
       defaultValue: "undefined",
       description:
-        "Runtime context for dependency injection and contextual information.",
+        "Request Context for dependency injection and contextual information.",
     },
   ]}
 />
 
 ## Related
 
-- [Agents overview](/docs/agents/overview)
-- [Runtime Context](/docs/server-db/runtime-context)
+- [Agents overview](/docs/v1/agents/overview)
+- [Request Context](/docs/v1/server-db/request-context)

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

@@ -19,11 +19,11 @@ await agent.getLLM();
   content={[
     {
       name: "options",
-      type: "{ runtimeContext?: RuntimeContext; model?: MastraLanguageModel | DynamicArgument<MastraLanguageModel> }",
+      type: "{ requestContext?: RequestContext; model?: MastraLanguageModel | DynamicArgument<MastraLanguageModel> }",
       isOptional: true,
       defaultValue: "{}",
       description:
-        "Optional configuration object containing runtime context and optional model override.",
+        "Optional configuration object containing request context and optional model override.",
     },
   ]}
 />
@@ -45,7 +45,7 @@ await agent.getLLM();
 
 ```typescript copy
 await agent.getLLM({
-  runtimeContext: new RuntimeContext(),
+  requestContext: new RequestContext(),
   model: openai("gpt-4"),
 });
 ```
@@ -55,12 +55,12 @@ await agent.getLLM({
 <PropertiesTable
   content={[
     {
-      name: "runtimeContext",
-      type: "RuntimeContext",
+      name: "requestContext",
+      type: "RequestContext",
       isOptional: true,
-      defaultValue: "new RuntimeContext()",
+      defaultValue: "new RequestContext()",
       description:
-        "Runtime context for dependency injection and contextual information.",
+        "Request Context for dependency injection and contextual information.",
     },
     {
       name: "model",
@@ -74,5 +74,5 @@ await agent.getLLM({
 
 ## Related
 
-- [Agents overview](/docs/agents/overview)
-- [Runtime Context](/docs/server-db/runtime-context)
+- [Agents overview](/docs/v1/agents/overview)
+- [Request Context](/docs/v1/server-db/request-context)

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

@@ -19,10 +19,10 @@ await agent.getMemory();
   content={[
     {
       name: "options",
-      type: "{ runtimeContext?: RuntimeContext }",
+      type: "{ requestContext?: RequestContext }",
       isOptional: true,
       defaultValue: "{}",
-      description: "Optional configuration object containing runtime context.",
+      description: "Optional configuration object containing request context.",
     },
   ]}
 />
@@ -44,7 +44,7 @@ await agent.getMemory();
 
 ```typescript copy
 await agent.getMemory({
-  runtimeContext: new RuntimeContext(),
+  requestContext: new RequestContext(),
 });
 ```
 
@@ -53,17 +53,17 @@ await agent.getMemory({
 <PropertiesTable
   content={[
     {
-      name: "runtimeContext",
-      type: "RuntimeContext",
+      name: "requestContext",
+      type: "RequestContext",
       isOptional: true,
-      defaultValue: "new RuntimeContext()",
+      defaultValue: "new RequestContext()",
       description:
-        "Runtime context for dependency injection and contextual information.",
+        "Request Context for dependency injection and contextual information.",
     },
   ]}
 />
 
 ## Related
 
-- [Agent memory](/docs/agents/agent-memory)
-- [Runtime Context](/docs/server-db/runtime-context)
+- [Agent memory](/docs/v1/agents/agent-memory)
+- [Request Context](/docs/v1/server-db/request-context)

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

@@ -18,11 +18,11 @@ await agent.getModel();
 <PropertiesTable
   content={[
     {
-      name: "{ runtimeContext = new RuntimeContext() }",
-      type: "{ runtimeContext?: RuntimeContext }",
+      name: "{ requestContext = new RequestContext() }",
+      type: "{ requestContext?: RequestContext }",
       isOptional: true,
-      defaultValue: "new RuntimeContext()",
-      description: "Optional configuration object containing runtime context.",
+      defaultValue: "new RequestContext()",
+      description: "Optional configuration object containing request context.",
     },
   ]}
 />
@@ -44,7 +44,7 @@ await agent.getModel();
 
 ```typescript copy
 await agent.getModel({
-  runtimeContext: new RuntimeContext(),
+  requestContext: new RequestContext(),
 });
 ```
 
@@ -53,17 +53,17 @@ await agent.getModel({
 <PropertiesTable
   content={[
     {
-      name: "runtimeContext",
-      type: "RuntimeContext",
+      name: "requestContext",
+      type: "RequestContext",
       isOptional: true,
       defaultValue: "undefined",
       description:
-        "Runtime context for dependency injection and contextual information.",
+        "Request Context for dependency injection and contextual information.",
     },
   ]}
 />
 
 ## Related
 
-- [Agents overview](/docs/agents/overview)
-- [Runtime Context](/docs/server-db/runtime-context)
+- [Agents overview](/docs/v1/agents/overview)
+- [Request Context](/docs/v1/server-db/request-context)

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

@@ -19,10 +19,10 @@ await agent.getVoice();
   content={[
     {
       name: "options",
-      type: "{ runtimeContext?: RuntimeContext }",
+      type: "{ requestContext?: RequestContext }",
       isOptional: true,
       defaultValue: "{}",
-      description: "Optional configuration object containing runtime context.",
+      description: "Optional configuration object containing request context.",
     },
   ]}
 />
@@ -44,7 +44,7 @@ await agent.getVoice();
 
 ```typescript copy
 await agent.getVoice({
-  runtimeContext: new RuntimeContext(),
+  requestContext: new RequestContext(),
 });
 ```
 
@@ -53,17 +53,17 @@ await agent.getVoice({
 <PropertiesTable
   content={[
     {
-      name: "runtimeContext",
-      type: "RuntimeContext",
+      name: "requestContext",
+      type: "RequestContext",
       isOptional: true,
-      defaultValue: "new RuntimeContext()",
+      defaultValue: "new RequestContext()",
       description:
-        "Runtime context for dependency injection and contextual information.",
+        "Request Context for dependency injection and contextual information.",
     },
   ]}
 />
 
 ## Related
 
-- [Adding voice to agents](/docs/agents/adding-voice)
+- [Adding voice to agents](/docs/v1/agents/adding-voice)
 - [Voice providers](../voice/mastra-voice)

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

@@ -19,10 +19,10 @@ await agent.listAgents();
   content={[
     {
       name: "options",
-      type: "{ runtimeContext?: RuntimeContext }",
+      type: "{ requestContext?: RequestContext }",
       isOptional: true,
       defaultValue: "{}",
-      description: "Optional configuration object containing runtime context.",
+      description: "Optional configuration object containing request context.",
     },
   ]}
 />
@@ -43,10 +43,10 @@ await agent.listAgents();
 ## Extended usage example
 
 ```typescript copy
-import { RuntimeContext } from "@mastra/core/runtime-context";
+import { RequestContext } from "@mastra/core/request-context";
 
 await agent.listAgents({
-  runtimeContext: new RuntimeContext(),
+  requestContext: new RequestContext(),
 });
 ```
 
@@ -55,16 +55,16 @@ await agent.listAgents({
 <PropertiesTable
   content={[
     {
-      name: "runtimeContext",
-      type: "RuntimeContext",
+      name: "requestContext",
+      type: "RequestContext",
       isOptional: true,
-      defaultValue: "new RuntimeContext()",
+      defaultValue: "new RequestContext()",
       description:
-        "Runtime context for dependency injection and contextual information.",
+        "Request Context for dependency injection and contextual information.",
     },
   ]}
 />
 
 ## Related
 
-- [Agents overview](/docs/agents/overview)
+- [Agents overview](/docs/v1/agents/overview)

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

@@ -19,7 +19,7 @@ await agent.listScorers();
   content={[
     {
       name: "options",
-      type: "{ runtimeContext?: RuntimeContext }",
+      type: "{ requestContext?: RequestContext }",
       isOptional: true,
       defaultValue: "{}",
       description: "Optional configuration object containing request context.",
@@ -44,7 +44,7 @@ await agent.listScorers();
 
 ```typescript copy
 await agent.listScorers({
-  runtimeContext: new RuntimeContext(),
+  requestContext: new RequestContext(),
 });
 ```
 
@@ -53,10 +53,10 @@ await agent.listScorers({
 <PropertiesTable
   content={[
     {
-      name: "runtimeContext",
-      type: "RuntimeContext",
+      name: "requestContext",
+      type: "RequestContext",
       isOptional: true,
-      defaultValue: "new RuntimeContext()",
+      defaultValue: "new RequestContext()",
       description:
         "Request Context for dependency injection and contextual information.",
     },
@@ -65,5 +65,5 @@ await agent.listScorers({
 
 ## Related
 
-- [Agents overview](/docs/agents/overview)
-- [Runtime Context](/docs/server-db/runtime-context)
+- [Agents overview](/docs/v1/agents/overview)
+- [Request Context](/docs/v1/server-db/request-context)

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

@@ -19,7 +19,7 @@ await agent.listTools();
   content={[
     {
       name: "options",
-      type: "{ runtimeContext?: RuntimeContext }",
+      type: "{ requestContext?: RequestContext }",
       isOptional: true,
       defaultValue: "{}",
       description: "Optional configuration object containing request context.",
@@ -44,7 +44,7 @@ await agent.listTools();
 
 ```typescript copy
 await agent.listTools({
-  runtimeContext: new RuntimeContext(),
+  requestContext: new RequestContext(),
 });
 ```
 
@@ -53,10 +53,10 @@ await agent.listTools({
 <PropertiesTable
   content={[
     {
-      name: "runtimeContext",
-      type: "RuntimeContext",
+      name: "requestContext",
+      type: "RequestContext",
       isOptional: true,
-      defaultValue: "new RuntimeContext()",
+      defaultValue: "new RequestContext()",
       description:
         "Request Context for dependency injection and contextual information.",
     },
@@ -65,5 +65,5 @@ await agent.listTools({
 
 ## Related
 
-- [Using tools with agents](/docs/agents/using-tools)
-- [Creating tools](/docs/tools-mcp/overview)
+- [Using tools with agents](/docs/v1/agents/using-tools)
+- [Creating tools](/docs/v1/tools-mcp/overview)

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

@@ -19,7 +19,7 @@ await agent.listWorkflows();
   content={[
     {
       name: "options",
-      type: "{ runtimeContext?: RuntimeContext }",
+      type: "{ requestContext?: RequestContext }",
       isOptional: true,
       defaultValue: "{}",
       description: "Optional configuration object containing request context.",
@@ -44,7 +44,7 @@ await agent.listWorkflows();
 
 ```typescript copy
 await agent.listWorkflows({
-  runtimeContext: new RuntimeContext(),
+  requestContext: new RequestContext(),
 });
 ```
 
@@ -53,10 +53,10 @@ await agent.listWorkflows({
 <PropertiesTable
   content={[
     {
-      name: "runtimeContext",
-      type: "RuntimeContext",
+      name: "requestContext",
+      type: "RequestContext",
       isOptional: true,
-      defaultValue: "new RuntimeContext()",
+      defaultValue: "new RequestContext()",
       description:
         "Request Context for dependency injection and contextual information.",
     },
@@ -65,5 +65,5 @@ await agent.listWorkflows({
 
 ## Related
 
-- [Agents overview](/docs/agents/overview)
-- [Workflows overview](/docs/workflows/overview)
+- [Agents overview](/docs/v1/agents/overview)
+- [Workflows overview](/docs/v1/workflows/overview)

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

@@ -21,7 +21,8 @@ import { workflow1 } from "./workflows";
 import { tool1, tool2 } from "./tools";
 
 const agent = new Agent({
-  name: "network-agent",
+  id: "network-agent",
+  name: "Network Agent",
   instructions:
     "You are a network agent that can help users with a variety of tasks.",
   model: openai("gpt-4o"),
@@ -120,16 +121,16 @@ await agent.network(`
       type: "TracingContext",
       isOptional: true,
       description:
-        "AI tracing context for creating child spans and adding metadata. Automatically injected when using Mastra's tracing system.",
+        "Tracing context for creating child spans and adding metadata. Automatically injected when using Mastra's tracing system.",
       properties: [
         {
           parameters: [
             {
               name: "currentSpan",
-              type: "AISpan",
+              type: "Span",
               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.",
+                "Current span for creating child spans and adding metadata. Use this to create custom child spans or update span attributes during execution.",
             },
           ],
         },
@@ -139,7 +140,7 @@ await agent.network(`
       name: "tracingOptions",
       type: "TracingOptions",
       isOptional: true,
-      description: "Options for AI tracing configuration.",
+      description: "Options for Tracing configuration.",
       properties: [
         {
           parameters: [
@@ -159,7 +160,7 @@ await agent.network(`
       type: "TelemetrySettings",
       isOptional: true,
       description:
-        "Settings for OTLP telemetry collection during streaming (not AI tracing).",
+        "Settings for OTLP telemetry collection during streaming (not Tracing).",
       properties: [
         {
           parameters: [
@@ -300,18 +301,18 @@ await agent.network(`
         "Unique ID for this generation run. Useful for tracking and debugging purposes.",
     },
     {
-      name: "runtimeContext",
-      type: "RuntimeContext",
+      name: "requestContext",
+      type: "RequestContext",
       isOptional: true,
       description:
-        "Runtime context for dependency injection and contextual information.",
+        "Request Context for dependency injection and contextual information.",
     },
     {
       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.",
+        "The trace ID associated with this execution when Tracing is enabled. Use this to correlate logs and debug execution flow.",
     },
   ]}
 />

package/.docs/raw/reference/auth/auth0.mdx

@@ -5,18 +5,18 @@ description: "API reference for the MastraAuthAuth0 class, which authenticates M
 
 # MastraAuthAuth0 Class
 
-The `MastraAuthAuth0` class provides authentication for Mastra using Auth0. It verifies incoming requests using Auth0-issued JWT tokens and integrates with the Mastra server using the `experimental_auth` option.
+The `MastraAuthAuth0` class provides authentication for Mastra using Auth0. It verifies incoming requests using Auth0-issued JWT tokens and integrates with the Mastra server using the `auth` option.
 
 ## Usage example
 
 ```typescript title="src/mastra/index.ts" showLineNumbers copy
-import { Mastra } from "@mastra/core/mastra";
+import { Mastra } from "@mastra/core";
 import { MastraAuthAuth0 } from "@mastra/auth-auth0";
 
 export const mastra = new Mastra({
   // ..
   server: {
-    experimental_auth: new MastraAuthAuth0({
+    auth: new MastraAuthAuth0({
       domain: process.env.AUTH0_DOMAIN,
       audience: process.env.AUTH0_AUDIENCE,
     }),
@@ -118,4 +118,4 @@ The exact properties available depend on your Auth0 configuration, scopes reques
 
 ## Related
 
-[MastraAuthAuth0 Class](/docs/auth/auth0)
+[MastraAuthAuth0 Class](/docs/v1/auth/auth0)