@mastra/mcp-docs-server 0.13.19-alpha.0 → 0.13.19-alpha.2

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

@@ -41,7 +41,7 @@ const aiSdkStream = await agent.streamVNext("message for agent", {
   ]}
 />
 
-### Options parameters
+### Options
 
 <PropertiesTable
   content={[
@@ -52,16 +52,99 @@ const aiSdkStream = await agent.streamVNext("message for agent", {
       defaultValue: "'mastra'",
       description: "Determines the output stream format. Use 'mastra' for Mastra's native format (default) or 'aisdk' for AI SDK v5 compatibility.",
     },
+    {
+      name: "maxSteps",
+      type: "number",
+      isOptional: true,
+      description: "Maximum number of steps to run during execution.",
+    },
+    {
+      name: "scorers",
+      type: "MastraScorers | Record<string, { scorer: MastraScorer['name']; sampling?: ScoringSamplingConfig }>",
+      isOptional: true,
+      description: "Evaluation scorers to run on the execution results.",
+      properties: [
+        {
+          parameters: [{
+            name: "scorer",
+            type: "string",
+            isOptional: false,
+            description: "Name of the scorer to use."
+          }]
+        },
+        {
+          parameters: [{
+            name: "sampling",
+            type: "ScoringSamplingConfig",
+            isOptional: true,
+            description: "Sampling configuration for the scorer.",
+            properties: [
+              {
+                parameters: [{
+                  name: "type",
+                  type: "'none' | 'ratio'",
+                  isOptional: false,
+                  description: "Type of sampling strategy. Use 'none' to disable sampling or 'ratio' for percentage-based sampling."
+                }]
+              },
+              {
+                parameters: [{
+                  name: "rate",
+                  type: "number",
+                  isOptional: true,
+                  description: "Sampling rate (0-1). Required when type is 'ratio'."
+                }]
+              }
+            ]
+          }]
+        }
+      ]
+    },
+    {
+      name: "tracingContext",
+      type: "TracingContext",
+      isOptional: true,
+      description: "AI tracing context for span hierarchy and metadata.",
+    },
+    {
+      name: "returnScorerData",
+      type: "boolean",
+      isOptional: true,
+      description: "Whether to return detailed scoring data in the response.",
+    },
+    {
+      name: "onChunk",
+      type: "(chunk: ChunkType) => Promise<void> | void",
+      isOptional: true,
+      description: "Callback function called for each chunk during streaming."
+    },
+    {
+      name: "onError",
+      type: "({ error }: { error: Error | string }) => Promise<void> | void",
+      isOptional: true,
+      description: "Callback function called when an error occurs during streaming."
+    },
+    {
+      name: "onAbort",
+      type: "(event: any) => Promise<void> | void",
+      isOptional: true,
+      description: "Callback function called when the stream is aborted."
+    },
     {
       name: "abortSignal",
       type: "AbortSignal",
       isOptional: true,
-      description:
-        "Signal object that allows you to abort the agent's execution. When the signal is aborted, all ongoing operations will be terminated.",
+      description: "Signal object that allows you to abort the agent's execution. When the signal is aborted, all ongoing operations will be terminated."
+    },
+    {
+      name: "activeTools",
+      type: "Array<keyof ToolSet> | undefined",
+      isOptional: true,
+      description: "Array of active tool names that can be used during execution."
     },
     {
       name: "context",
-      type: "CoreMessage[]",
+      type: "ModelMessage[]",
       isOptional: true,
       description: "Additional context messages to provide to the agent.",
     },
@@ -83,8 +166,8 @@ const aiSdkStream = await agent.streamVNext("message for agent", {
           parameters: [{
             name: "model",
             type: "MastraLanguageModel",
-            isOptional: false,
-            description: "Model to use for the internal structuring agent."
+            isOptional: true,
+            description: "Model to use for the internal structuring agent. If not provided, falls back to the agent's model."
           }]
         },
         {
@@ -178,13 +261,6 @@ const aiSdkStream = await agent.streamVNext("message for agent", {
         }
       ]
     },
-    {
-      name: "maxRetries",
-      type: "number",
-      isOptional: true,
-      defaultValue: "2",
-      description: "Maximum number of retries. Set to 0 to disable retries.",
-    },
     {
       name: "memoryOptions",
       type: "MemoryConfig",
@@ -271,10 +347,10 @@ const aiSdkStream = await agent.streamVNext("message for agent", {
         },
         {
           parameters: [{
-            name: "maxTokens",
+            name: "maxRetries",
             type: "number",
             isOptional: true,
-            description: "Maximum number of tokens to generate."
+            description: "Maximum number of retries for failed requests."
           }]
         },
         {
@@ -317,14 +393,6 @@ const aiSdkStream = await agent.streamVNext("message for agent", {
             description: "Stop sequences. If set, the model will stop generating text when one of the stop sequences is generated."
           }]
         },
-        {
-          parameters: [{
-            name: "seed",
-            type: "number",
-            isOptional: true,
-            description: "The seed (integer) to use for random sampling. If set and supported by the model, calls will generate deterministic results."
-          }]
-        }
       ]
     },
     {
@@ -443,12 +511,6 @@ const aiSdkStream = await agent.streamVNext("message for agent", {
       isOptional: true,
       description: "Runtime context for dependency injection and contextual information.",
     },
-    {
-      name: "experimental_generateMessageId",
-      type: "IDGenerator",
-      isOptional: true,
-      description: "Generate a unique ID for each message.",
-    },
     {
       name: "stopWhen",
       type: "StopCondition | StopCondition[]",
@@ -523,6 +585,35 @@ for await (const part of stream.fullStream) {
 return stream.toUIMessageStreamResponse();
 ```
 
+### Using Callbacks
+
+All callback functions are now available as top-level properties for a cleaner API experience.
+
+```typescript showLineNumbers copy
+const stream = await agent.streamVNext("Tell me a story", {
+  onFinish: (result) => {
+    console.log('Streaming finished:', result);
+  },
+  onStepFinish: (step) => {
+    console.log('Step completed:', step);
+  },
+  onChunk: (chunk) => {
+    console.log('Received chunk:', chunk);
+  },
+  onError: ({ error }) => {
+    console.error('Streaming error:', error);
+  },
+  onAbort: (event) => {
+    console.log('Stream aborted:', event);
+  },
+});
+
+// Process the stream
+for await (const chunk of stream.textStream) {
+  console.log(chunk);
+}
+```
+
 ### Advanced Example with Options
 
 ```typescript showLineNumbers copy

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

@@ -1,9 +1,9 @@
 ---
-title: "MastraJwtAuth"
+title: "MastraJwtAuth Class"
 description: "API reference for the MastraJwtAuth class, which authenticates Mastra applications using JSON Web Tokens."
 ---
 
-# MastraJwtAuth
+# MastraJwtAuth Class
 
 The `MastraJwtAuth` class provides a lightweight authentication mechanism for Mastra using JSON Web Tokens (JWTs). It verifies incoming requests based on a shared secret and integrates with the Mastra server using the `experimental_auth` option.
 
@@ -36,7 +36,6 @@ export const mastra = new Mastra({
   ]}
 />
 
-
 ## Related
 
 [MastraJwtAuth](/docs/auth/jwt.mdx)

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

@@ -0,0 +1,62 @@
+---
+title: "MastraAuthSupabase Class"
+description: "API reference for the MastraAuthSupabase class, which authenticates Mastra applications using Supabase Auth."
+---
+
+# MastraAuthSupabase Class
+
+The `MastraAuthSupabase` class provides authentication for Mastra using Supabase Auth. It verifies incoming requests using Supabase's authentication system and integrates with the Mastra server using the `experimental_auth` option.
+
+## Usage example
+
+```typescript filename="src/mastra/index.ts" showLineNumbers copy
+import { Mastra } from "@mastra/core/mastra";
+import { MastraAuthSupabase } from '@mastra/auth-supabase';
+
+export const mastra = new Mastra({
+  // ..
+  server: {
+    experimental_auth: new MastraAuthSupabase({
+      url: process.env.SUPABASE_URL,
+      anonKey: process.env.SUPABASE_ANON_KEY
+    }),
+  },
+});
+```
+
+## Constructor parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "url",
+      type: "string",
+      description: "The URL of your Supabase project. Can be found in your Supabase project settings.",
+      isOptional: true,
+      defaultValue: "process.env.SUPABASE_URL"
+    },
+    {
+      name: "anonKey",
+      type: "string",
+      description: "The anonymous/public key for your Supabase project. Used for client-side authentication.",
+      isOptional: true,
+      defaultValue: "process.env.SUPABASE_ANON_KEY"
+    },
+    {
+      name: "name",
+      type: "string",
+      description: "Custom name for the auth provider instance.",
+      isOptional: true,
+    },
+    {
+      name: "authorizeUser",
+      type: "(user: User, request: HoneRequest) => Promise<boolean> | boolean",
+      description: "Custom authorization function to determine if a user should be granted access. Called after token verification. By default, checks the 'isAdmin' column in the 'users' table.",
+      isOptional: true,
+    },
+  ]}
+/>
+
+## Related
+
+[MastraAuthSupabase](/docs/auth/supabase.mdx)

package/.docs/raw/reference/{agents → core}/getAgent.mdx

@@ -3,7 +3,7 @@ title: "Reference: Agent.getAgent() | Agents | Mastra Docs"
 description: "Documentation for the `Agent.getAgent()` method in Mastra, which retrieves an agent by name."
 ---
 
-# Agent.getAgent()
+# Mastra.getAgent()
 
 The `.getAgent()` method is used to retrieve an agent. The method accepts a single `string` parameter for the agent's name.
 
@@ -13,7 +13,6 @@ The `.getAgent()` method is used to retrieve an agent. The method accepts a sing
 mastra.getAgent("testAgent");
 ```
 
-
 ## Parameters
 
 <PropertiesTable

package/.docs/raw/reference/core/getAgentById.mdx

@@ -0,0 +1,43 @@
+---
+title: "Reference: Mastra.getAgentById() | Core | Mastra Docs"
+description: "Documentation for the `Mastra.getAgentById()` method in Mastra, which retrieves an agent by its ID."
+---
+
+# Mastra.getAgentById()
+
+The `.getAgentById()` method is used to retrieve an agent by its ID. The method accepts a single `string` parameter for the agent's ID.
+
+## Usage example
+
+```typescript copy
+mastra.getAgentById("test-agent-123");
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "id",
+      type: "string",
+      description: "The ID of the agent to retrieve. The method will first search for an agent with this ID, and if not found, will attempt to use it as a name to call getAgent().",
+    },
+  ]}
+/>
+
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: "agent",
+      type: "Agent",
+      description: "The agent instance with the specified ID. Throws an error if the agent is not found.",
+    },
+  ]}
+/>
+
+## Related
+
+- [Agents overview](../../docs/agents/overview.mdx)
+- [Dynamic agents](../../docs/agents/dynamic-agents.mdx)

package/.docs/raw/reference/core/getAgents.mdx

@@ -0,0 +1,35 @@
+---
+title: "Reference: Mastra.getAgents() | Core | Mastra Docs"
+description: "Documentation for the `Mastra.getAgents()` method in Mastra, which retrieves all configured agents."
+---
+
+# Mastra.getAgents()
+
+The `.getAgents()` method is used to retrieve all agents that have been configured in the Mastra instance.
+
+## Usage example
+
+```typescript copy
+mastra.getAgents();
+```
+
+## Parameters
+
+This method does not accept any parameters.
+
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: "agents",
+      type: "TAgents",
+      description: "A record of all configured agents, where keys are agent names and values are agent instances.",
+    },
+  ]}
+/>
+
+## Related
+
+- [Agents overview](../../docs/agents/overview.mdx)
+- [Dynamic agents](../../docs/agents/dynamic-agents.mdx)

package/.docs/raw/reference/core/getDeployer.mdx

@@ -0,0 +1,35 @@
+---
+title: "Reference: Mastra.getDeployer() | Core | Mastra Docs"
+description: "Documentation for the `Mastra.getDeployer()` method in Mastra, which retrieves the configured deployer instance."
+---
+
+# Mastra.getDeployer()
+
+The `.getDeployer()` method is used to retrieve the deployer instance that has been configured in the Mastra instance.
+
+## Usage example
+
+```typescript copy
+mastra.getDeployer();
+```
+
+## Parameters
+
+This method does not accept any parameters.
+
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: "deployer",
+      type: "MastraDeployer | undefined",
+      description: "The configured deployer instance, or undefined if no deployer has been configured.",
+    },
+  ]}
+/>
+
+## Related
+
+- [Deployment overview](../../docs/deployment/overview.mdx)
+- [Deployer reference](../../reference/deployer/deployer.mdx)

package/.docs/raw/reference/core/getLogger.mdx

@@ -0,0 +1,35 @@
+---
+title: "Reference: Mastra.getLogger() | Core | Mastra Docs"
+description: "Documentation for the `Mastra.getLogger()` method in Mastra, which retrieves the configured logger instance."
+---
+
+# Mastra.getLogger()
+
+The `.getLogger()` method is used to retrieve the logger instance that has been configured in the Mastra instance.
+
+## Usage example
+
+```typescript copy
+mastra.getLogger();
+```
+
+## Parameters
+
+This method does not accept any parameters.
+
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: "logger",
+      type: "TLogger",
+      description: "The configured logger instance used for logging across all components (agents, workflows, etc.).",
+    },
+  ]}
+/>
+
+## Related
+
+- [Logging overview](../../docs/observability/logging.mdx)
+- [Logger reference](../../reference/observability/logger.mdx)

package/.docs/raw/reference/core/getLogs.mdx

@@ -0,0 +1,92 @@
+---
+title: "Reference: Mastra.getLogs() | Core | Mastra Docs"
+description: "Documentation for the `Mastra.getLogs()` method in Mastra, which retrieves all logs for a specific transport ID."
+---
+
+# Mastra.getLogs()
+
+The `.getLogs()` method is used to retrieve all logs for a specific transport ID. This method requires a configured logger that supports the `getLogs` operation.
+
+## Usage example
+
+```typescript copy
+mastra.getLogs("456");
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "transportId",
+      type: "string",
+      description: "The transport ID to retrieve logs from.",
+    },
+    {
+      name: "options",
+      type: "object",
+      description: "Optional parameters for filtering and pagination. See Options section below for details.",
+      optional: true,
+    },
+  ]}
+/>
+
+### Options
+
+<PropertiesTable
+  content={[
+    {
+      name: "fromDate",
+      type: "Date",
+      description: "Optional start date for filtering logs. e.g., new Date('2024-01-01').",
+      optional: true,
+    },
+    {
+      name: "toDate",
+      type: "Date",
+      description: "Optional end date for filtering logs. e.g., new Date('2024-01-31').",
+      optional: true,
+    },
+    {
+      name: "logLevel",
+      type: "LogLevel",
+      description: "Optional log level to filter by.",
+      optional: true,
+    },
+    {
+      name: "filters",
+      type: "Record<string, any>",
+      description: "Optional additional filters to apply to the log query.",
+      optional: true,
+    },
+    {
+      name: "page",
+      type: "number",
+      description: "Optional page number for pagination.",
+      optional: true,
+    },
+    {
+      name: "perPage",
+      type: "number",
+      description: "Optional number of logs per page for pagination.",
+      optional: true,
+    },
+  ]}
+/>
+
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: "logs",
+      type: "Promise<any>",
+      description: "A promise that resolves to the logs for the specified transport ID.",
+    },
+  ]}
+/>
+
+## Related
+
+- [Logging overview](../../docs/observability/logging.mdx)
+- [Logger reference](../../reference/observability/logger.mdx)

package/.docs/raw/reference/core/getLogsByRunId.mdx

@@ -0,0 +1,84 @@
+---
+title: "Reference: Mastra.getLogsByRunId() | Core | Mastra Docs"
+description: "Documentation for the `Mastra.getLogsByRunId()` method in Mastra, which retrieves logs for a specific run ID and transport ID."
+---
+
+# Mastra.getLogsByRunId()
+
+The `.getLogsByRunId()` method is used to retrieve logs for a specific run ID and transport ID. This method requires a configured logger that supports the `getLogsByRunId` operation.
+
+## Usage example
+
+```typescript copy
+mastra.getLogsByRunId({ runId: "123", transportId: "456" });
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "runId",
+      type: "string",
+      description: "The run ID to retrieve logs for.",
+    },
+    {
+      name: "transportId",
+      type: "string",
+      description: "The transport ID to retrieve logs from.",
+    },
+    {
+      name: "fromDate",
+      type: "Date",
+      description: "Optional start date for filtering logs. e.g., new Date('2024-01-01').",
+      optional: true,
+    },
+    {
+      name: "toDate",
+      type: "Date",
+      description: "Optional end date for filtering logs. e.g., new Date('2024-01-31').",
+      optional: true,
+    },
+    {
+      name: "logLevel",
+      type: "LogLevel",
+      description: "Optional log level to filter by.",
+      optional: true,
+    },
+    {
+      name: "filters",
+      type: "Record<string, any>",
+      description: "Optional additional filters to apply to the log query.",
+      optional: true,
+    },
+    {
+      name: "page",
+      type: "number",
+      description: "Optional page number for pagination.",
+      optional: true,
+    },
+    {
+      name: "perPage",
+      type: "number",
+      description: "Optional number of logs per page for pagination.",
+      optional: true,
+    },
+  ]}
+/>
+
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: "logs",
+      type: "Promise<any>",
+      description: "A promise that resolves to the logs for the specified run ID and transport ID.",
+    },
+  ]}
+/>
+
+## Related
+
+- [Logging overview](../../docs/observability/logging.mdx)
+- [Logger reference](../../reference/observability/logger.mdx)

package/.docs/raw/reference/core/getMCPServer.mdx

@@ -0,0 +1,49 @@
+---
+title: "Reference: Mastra.getMCPServer() | Core | Mastra Docs"
+description: "Documentation for the `Mastra.getMCPServer()` method in Mastra, which retrieves a specific MCP server instance by ID and optional version."
+---
+
+# Mastra.getMCPServer()
+
+The `.getMCPServer()` method is used to retrieve a specific MCP server instance by its logical ID and optional version. If a version is provided, it attempts to find the server with that exact logical ID and version. If no version is provided, it returns the server with the specified logical ID that has the most recent releaseDate.
+
+## Usage example
+
+```typescript copy
+mastra.getMCPServer("1.2.0");
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "serverId",
+      type: "string",
+      description: "The logical ID of the MCP server to retrieve. Should match the `id` property of the MCPServer instance.",
+    },
+    {
+      name: "version",
+      type: "string",
+      description: "Optional specific version of the MCP server to retrieve. If not provided, returns the server with the most recent releaseDate.",
+      optional: true,
+    },
+  ]}
+/>
+
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: "server",
+      type: "MCPServerBase | undefined",
+      description: "The MCP server instance with the specified ID and version, or undefined if not found or if the specific version is not found.",
+    },
+  ]}
+/>
+
+## Related
+
+- [MCP overview](../../docs/tools-mcp/mcp-overview.mdx)
+- [MCP server reference](../../reference/tools/mcp-server.mdx)