@mastra/mcp-docs-server 0.13.12 → 0.13.13-alpha.1

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

@@ -8,15 +8,21 @@ import { Callout } from "nextra/components";
 # Agent.streamVNext() (Experimental)
 
 <Callout type="warning">
-  **Experimental Feature**: This is a new streaming implementation that will replace the existing `stream()` method once battle-tested. The API may change as we refine the feature based on feedback.
+  **Experimental Feature**: This is a new streaming implementation with support for multiple output formats, including AI SDK v5 compatibility. It will replace the existing `stream()` method once battle-tested. The API may change as we refine the feature based on feedback.
 </Callout>
 
-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 that will eventually replace the current `stream()` method.
+The `.streamVNext()` method enables real-time streaming of responses from an agent with enhanced capabilities and format flexibility. This method accepts messages and optional streaming options, providing a next-generation streaming experience with support for both Mastra's native format and AI SDK v5 compatibility.
 
 ## Usage example
 
 ```typescript copy
-await agent.streamVNext("message for agent");
+// Default Mastra format
+const mastraStream = await agent.streamVNext("message for agent");
+
+// AI SDK v5 compatible format
+const aiSdkStream = await agent.streamVNext("message for agent", {
+  format: 'aisdk'
+});
 ```
 
 ## Parameters
@@ -30,7 +36,7 @@ await agent.streamVNext("message for agent");
     },
     {
       name: "options",
-      type: "AgentExecutionOptions<Output, StructuredOutput>",
+      type: "AgentExecutionOptions<Output, StructuredOutput, Format>",
       isOptional: true,
       description: "Optional configuration for the streaming process.",
     },
@@ -41,6 +47,13 @@ await agent.streamVNext("message for agent");
 
 <PropertiesTable
   content={[
+    {
+      name: "format",
+      type: "'mastra' | 'aisdk'",
+      isOptional: true,
+      defaultValue: "'mastra'",
+      description: "Determines the output stream format. Use 'mastra' for Mastra's native format (default) or 'aisdk' for AI SDK v5 compatibility.",
+    },
     {
       name: "abortSignal",
       type: "AbortSignal",
@@ -167,13 +180,6 @@ await agent.streamVNext("message for agent");
         }
       ]
     },
-    {
-      name: "maxSteps",
-      type: "number",
-      isOptional: true,
-      defaultValue: "5",
-      description: "Maximum number of execution steps allowed.",
-    },
     {
       name: "maxRetries",
       type: "number",
@@ -251,11 +257,77 @@ await agent.streamVNext("message for agent");
       ]
     },
     {
-      name: "temperature",
-      type: "number",
+      name: "modelSettings",
+      type: "CallSettings",
       isOptional: true,
       description:
-        "Controls randomness in the model's output. Higher values (e.g., 0.8) make the output more random, lower values (e.g., 0.2) make it more focused and deterministic.",
+        "Model-specific settings like temperature, maxTokens, topP, etc. These are passed to the underlying language model.",
+      properties: [
+        {
+          parameters: [{
+            name: "temperature",
+            type: "number",
+            isOptional: true,
+            description: "Controls randomness in the model's output. Higher values (e.g., 0.8) make the output more random, lower values (e.g., 0.2) make it more focused and deterministic."
+          }]
+        },
+        {
+          parameters: [{
+            name: "maxTokens",
+            type: "number",
+            isOptional: true,
+            description: "Maximum number of tokens to generate."
+          }]
+        },
+        {
+          parameters: [{
+            name: "topP",
+            type: "number",
+            isOptional: true,
+            description: "Nucleus sampling. This is a number between 0 and 1. It is recommended to set either temperature or topP, but not both."
+          }]
+        },
+        {
+          parameters: [{
+            name: "topK",
+            type: "number",
+            isOptional: true,
+            description: "Only sample from the top K options for each subsequent token. Used to remove 'long tail' low probability responses."
+          }]
+        },
+        {
+          parameters: [{
+            name: "presencePenalty",
+            type: "number",
+            isOptional: true,
+            description: "Presence penalty setting. It affects the likelihood of the model to repeat information that is already in the prompt. A number between -1 (increase repetition) and 1 (maximum penalty, decrease repetition)."
+          }]
+        },
+        {
+          parameters: [{
+            name: "frequencyPenalty",
+            type: "number",
+            isOptional: true,
+            description: "Frequency penalty setting. It affects the likelihood of the model to repeatedly use the same words or phrases. A number between -1 (increase repetition) and 1 (maximum penalty, decrease repetition)."
+          }]
+        },
+        {
+          parameters: [{
+            name: "stopSequences",
+            type: "string[]",
+            isOptional: true,
+            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."
+          }]
+        }
+      ]
     },
     {
       name: "threadId",
@@ -380,64 +452,16 @@ await agent.streamVNext("message for agent");
       description: "Generate a unique ID for each message.",
     },
     {
-      name: "maxTokens",
-      type: "number",
+      name: "stopWhen",
+      type: "StopCondition | StopCondition[]",
       isOptional: true,
-      description: "Maximum number of tokens to generate.",
-    },
-    {
-      name: "topP",
-      type: "number",
-      isOptional: true,
-      description: "Nucleus sampling. This is a number between 0 and 1. It is recommended to set either `temperature` or `topP`, but not both.",
-    },
-    {
-      name: "topK",
-      type: "number",
-      isOptional: true,
-      description: "Only sample from the top K options for each subsequent token. Used to remove 'long tail' low probability responses.",
-    },
-    {
-      name: "presencePenalty",
-      type: "number",
-      isOptional: true,
-      description: "Presence penalty setting. It affects the likelihood of the model to repeat information that is already in the prompt. A number between -1 (increase repetition) and 1 (maximum penalty, decrease repetition).",
-    },
-    {
-      name: "frequencyPenalty",
-      type: "number",
-      isOptional: true,
-      description: "Frequency penalty setting. It affects the likelihood of the model to repeatedly use the same words or phrases. A number between -1 (increase repetition) and 1 (maximum penalty, decrease repetition).",
-    },
-    {
-      name: "stopSequences",
-      type: "string[]",
-      isOptional: true,
-      description: "Stop sequences. If set, the model will stop generating text when one of the stop sequences is generated.",
-    },
-    {
-      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.",
+      description: "Condition(s) that determine when to stop the agent's execution. Can be a single condition or array of conditions.",
     },
     {
       name: "headers",
       type: "Record<string, string | undefined>",
       isOptional: true,
       description: "Additional HTTP headers to be sent with the request. Only applicable for HTTP-based providers.",
-    },
-    {
-      name: "system",
-      type: "string",
-      isOptional: true,
-      description: "System message to include in the prompt. Can be used with `prompt` or `messages`.",
-    },
-    {
-      name: "prompt",
-      type: "string",
-      isOptional: true,
-      description: "A simple text prompt. You can either use `prompt` or `messages` but not both.",
     }
   ]}
 />
@@ -448,25 +472,78 @@ await agent.streamVNext("message for agent");
   content={[
     {
       name: "stream",
-      type: "MastraAgentStream<Output extends ZodSchema ? z.infer<Output> : StructuredOutput extends ZodSchema ? z.infer<StructuredOutput> : unknown>",
-      description: "A streaming interface that provides enhanced streaming capabilities for text and structured output.",
+      type: "MastraModelOutput<Output> | AISDKV5OutputStream<Output>",
+      description: "Returns a streaming interface based on the format parameter. When format is 'mastra' (default), returns MastraModelOutput. When format is 'aisdk', returns AISDKV5OutputStream for AI SDK v5 compatibility.",
     },
   ]}
 />
 
 ## Extended usage example
 
+### Mastra Format (Default)
+
+```typescript showLineNumbers copy
+import { stepCountIs } from 'ai-v5';
+
+const stream = await agent.streamVNext("Tell me a story", {
+  stopWhen: stepCountIs(3), // Stop after 3 steps
+  modelSettings: {
+    temperature: 0.7,
+  },
+});
+
+// Access text stream
+for await (const chunk of stream.textStream) {
+  console.log(chunk);
+}
+
+// Get full text after streaming
+const fullText = await stream.text;
+```
+
+### AI SDK v5 Format
+
+```typescript showLineNumbers copy
+import { stepCountIs } from 'ai-v5';
+
+const stream = await agent.streamVNext("Tell me a story", {
+  format: 'aisdk',
+  stopWhen: stepCountIs(3), // Stop after 3 steps
+  modelSettings: {
+    temperature: 0.7,
+  },
+});
+
+// Use with AI SDK v5 compatible interfaces
+for await (const part of stream.fullStream) {
+  if (part.type === 'text-delta') {
+    console.log(part.text);
+  }
+}
+
+// In an API route for frontend integration
+return stream.toUIMessageStreamResponse();
+```
+
+### Advanced Example with Options
+
 ```typescript showLineNumbers copy
 import { z } from "zod";
-import { ModerationProcessor, BatchPartsProcessor } from "@mastra/core/processors";
+import { stepCountIs } from 'ai-v5';
 
 await agent.streamVNext("message for agent", {
-  temperature: 0.7,
-  maxSteps: 3,
+  format: 'aisdk', // Enable AI SDK v5 compatibility
+  stopWhen: stepCountIs(3), // Stop after 3 steps
+  modelSettings: {
+    temperature: 0.7,
+  modelSettings: {
+    temperature: 0.7,
+  },
   memory: {
     thread: "user-123",
     resource: "test-app"
   },
+  },
   toolChoice: "auto",
   // Structured output with better DX
   structuredOutput: {

package/.docs/raw/server-db/storage.mdx

@@ -497,6 +497,14 @@ const messagesV1 = await mastra.getStorage().getMessages({ threadId: 'your-threa
 const messagesV2 = await mastra.getStorage().getMessages({ threadId: 'your-thread-id', format: 'v2' });
 ```
 
+You can also retrieve messages using an array of message IDs. Note that unlike `getMessages`, this defaults to the V2 format:
+
+```typescript copy
+const messagesV1 = await mastra.getStorage().getMessagesById({ messageIds: messageIdArr, format: 'v1' });
+
+const messagesV2 = await mastra.getStorage().getMessagesById({ messageIds: messageIdArr });
+```
+
 ## Storage Providers
 
 Mastra supports the following providers:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/mcp-docs-server",
-  "version": "0.13.12",
+  "version": "0.13.13-alpha.1",
   "description": "MCP server for accessing Mastra.ai documentation, changelogs, and news.",
   "type": "module",
   "main": "dist/index.js",
@@ -32,7 +32,7 @@
     "uuid": "^11.1.0",
     "zod": "^3.25.67",
     "zod-to-json-schema": "^3.24.5",
-    "@mastra/core": "0.14.0",
+    "@mastra/core": "0.14.1-alpha.1",
     "@mastra/mcp": "^0.10.12"
   },
   "devDependencies": {
@@ -48,8 +48,8 @@
     "tsx": "^4.19.4",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4",
-    "@mastra/core": "0.14.0",
-    "@internal/lint": "0.0.30"
+    "@internal/lint": "0.0.30",
+    "@mastra/core": "0.14.1-alpha.1"
   },
   "scripts": {
     "prepare-docs": "cross-env PREPARE=true node dist/prepare-docs/prepare.js",