@mastra/mcp-docs-server 0.13.37 → 0.13.38

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

@@ -1,13 +1,13 @@
 ---
-title: Storage in Mastra | Mastra Docs
+title: "MastraStorage | Server & DB | Mastra Docs"
 description: Overview of Mastra's storage system and data persistence capabilities.
 ---
 
-import { Tabs } from "nextra/components";
-
-import { PropertiesTable } from "@/components/properties-table";
-import { SchemaTable } from "@/components/schema-table";
-import { StorageOverviewImage } from "@/components/storage-overview-image";
+import PropertiesTable from "@site/src/components/PropertiesTable";
+import { SchemaTable } from "@site/src/components/SchemaTable";
+import { StorageOverviewImage } from "@site/src/components/StorageOverviewImage";
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
 
 # MastraStorage
 
@@ -47,16 +47,8 @@ configuration either on `Mastra` or directly within `new Memory()`.
 
 ## Data Schema
 
-{/*
-LLM CONTEXT: This Tabs component displays the database schema for different data types stored by Mastra.
-Each tab shows the table structure and column definitions for a specific data entity (Messages, Threads, Workflows, etc.).
-The tabs help users understand the data model and relationships between different storage entities.
-Each tab includes detailed column information with types, constraints, and example data structures.
-The data types include Messages, Threads, Workflows, Eval Datasets, and Traces.
-*/}
-
-<Tabs items={['Messages', 'Threads', 'Resources', 'Workflows', 'Eval Datasets', 'Traces']}>
-  <Tabs.Tab>
+<Tabs>
+  <TabItem value="messages" label="Messages">
 Stores conversation messages and their metadata. Each message belongs to a thread and contains the actual content along with metadata about the sender role and message type.
 
 <br />
@@ -65,11 +57,9 @@ Stores conversation messages and their metadata. Each message belongs to a threa
     {
       name: "id",
       type: "uuidv4",
-      description: "Unique identifier for the message (format: `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`)",
-      constraints: [
-        { type: "primaryKey" },
-        { type: "nullable", value: false }
-      ]
+      description:
+        "Unique identifier for the message (format: `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`)",
+      constraints: [{ type: "primaryKey" }, { type: "nullable", value: false }],
     },
     {
       name: "thread_id",
@@ -77,35 +67,34 @@ Stores conversation messages and their metadata. Each message belongs to a threa
       description: "Parent thread reference",
       constraints: [
         { type: "foreignKey", value: "threads.id" },
-        { type: "nullable", value: false }
-      ]
+        { type: "nullable", value: false },
+      ],
     },
     {
       name: "resourceId",
       type: "uuidv4",
       description: "ID of the resource that owns this message",
-      constraints: [
-        { type: "nullable", value: true }
-      ]
+      constraints: [{ type: "nullable", value: true }],
     },
     {
       name: "content",
       type: "text",
-      description: "JSON of the message content in V2 format. Example: `{ format: 2, parts: [...] }`",
-      constraints: [{ type: "nullable", value: false }]
+      description:
+        "JSON of the message content in V2 format. Example: `{ format: 2, parts: [...] }`",
+      constraints: [{ type: "nullable", value: false }],
     },
     {
       name: "role",
       type: "text",
       description: "Enum of `user | assistant`",
-      constraints: [{ type: "nullable", value: false }]
+      constraints: [{ type: "nullable", value: false }],
     },
     {
       name: "createdAt",
       type: "timestamp",
       description: "Used for thread message ordering",
-      constraints: [{ type: "nullable", value: false }]
-    }
+      constraints: [{ type: "nullable", value: false }],
+    },
   ]}
 />
 
@@ -117,52 +106,52 @@ The message `content` column contains a JSON object conforming to the `MastraMes
       name: "format",
       type: "integer",
       description: "Message format version (currently 2)",
-      constraints: [{ type: "nullable", value: false }]
+      constraints: [{ type: "nullable", value: false }],
     },
     {
       name: "parts",
       type: "array (JSON)",
-      description: "Array of message parts (text, tool-invocation, file, reasoning, etc.). The structure of items in this array varies by `type`.",
-      constraints: [{ type: "nullable", value: false }]
+      description:
+        "Array of message parts (text, tool-invocation, file, reasoning, etc.). The structure of items in this array varies by `type`.",
+      constraints: [{ type: "nullable", value: false }],
     },
     {
       name: "experimental_attachments",
       type: "array (JSON)",
       description: "Optional array of file attachments",
-      constraints: [{ type: "nullable", value: true }]
+      constraints: [{ type: "nullable", value: true }],
     },
     {
       name: "content",
       type: "text",
       description: "Optional main text content of the message",
-      constraints: [{ type: "nullable", value: true }]
+      constraints: [{ type: "nullable", value: true }],
     },
     {
       name: "toolInvocations",
       type: "array (JSON)",
       description: "Optional array summarizing tool calls and results",
-      constraints: [{ type: "nullable", value: true }]
+      constraints: [{ type: "nullable", value: true }],
     },
     {
       name: "reasoning",
       type: "object (JSON)",
-      description: "Optional information about the reasoning process behind the assistant's response",
-      constraints: [{ type: "nullable", value: true }]
+      description:
+        "Optional information about the reasoning process behind the assistant's response",
+      constraints: [{ type: "nullable", value: true }],
     },
     {
       name: "annotations",
       type: "object (JSON)",
       description: "Optional additional metadata or annotations",
-      constraints: [{ type: "nullable", value: true }]
-    }
+      constraints: [{ type: "nullable", value: true }],
+    },
   ]}
 />
 
+</TabItem>
 
-
-</Tabs.Tab>
-
-  <Tabs.Tab>
+  <TabItem value="threads" label="Threads">
 Groups related messages together and associates them with a resource. Contains metadata about the conversation.
 
 <br />
@@ -171,23 +160,22 @@ Groups related messages together and associates them with a resource. Contains m
     {
       name: "id",
       type: "uuidv4",
-      description: "Unique identifier for the thread (format: `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`)",
-      constraints: [
-        { type: "primaryKey" },
-        { type: "nullable", value: false }
-      ]
+      description:
+        "Unique identifier for the thread (format: `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`)",
+      constraints: [{ type: "primaryKey" }, { type: "nullable", value: false }],
     },
     {
       name: "resourceId",
       type: "text",
-      description: "Primary identifier of the external resource this thread is associated with. Used to group and retrieve related threads.",
-      constraints: [{ type: "nullable", value: false }]
+      description:
+        "Primary identifier of the external resource this thread is associated with. Used to group and retrieve related threads.",
+      constraints: [{ type: "nullable", value: false }],
     },
     {
       name: "title",
       type: "text",
       description: "Title of the conversation thread",
-      constraints: [{ type: "nullable", value: false }]
+      constraints: [{ type: "nullable", value: false }],
     },
     {
       name: "metadata",
@@ -195,25 +183,25 @@ Groups related messages together and associates them with a resource. Contains m
       description: "Custom thread metadata as stringified JSON. Example:",
       example: {
         category: "support",
-        priority: 1
-      }
+        priority: 1,
+      },
     },
     {
       name: "createdAt",
       type: "timestamp",
-      constraints: [{ type: "nullable", value: false }]
+      constraints: [{ type: "nullable", value: false }],
     },
     {
       name: "updatedAt",
       type: "timestamp",
       description: "Used for thread ordering history",
-      constraints: [{ type: "nullable", value: false }]
-    }
+      constraints: [{ type: "nullable", value: false }],
+    },
   ]}
 />
 
-</Tabs.Tab>
-  <Tabs.Tab>
+</TabItem>
+  <TabItem value="resources" label="Resources">
 Stores user-specific data for resource-scoped working memory. Each resource represents a user or entity, allowing working memory to persist across all conversation threads for that user.
 
 <br />
@@ -222,17 +210,16 @@ Stores user-specific data for resource-scoped working memory. Each resource repr
     {
       name: "id",
       type: "text",
-      description: "Resource identifier (user or entity ID) - same as resourceId used in threads and agent calls",
-      constraints: [
-        { type: "primaryKey" },
-        { type: "nullable", value: false }
-      ]
+      description:
+        "Resource identifier (user or entity ID) - same as resourceId used in threads and agent calls",
+      constraints: [{ type: "primaryKey" }, { type: "nullable", value: false }],
     },
     {
       name: "workingMemory",
       type: "text",
-      description: "Persistent working memory data as Markdown text. Contains user profile, preferences, and contextual information that persists across conversation threads.",
-      constraints: [{ type: "nullable", value: true }]
+      description:
+        "Persistent working memory data as Markdown text. Contains user profile, preferences, and contextual information that persists across conversation threads.",
+      constraints: [{ type: "nullable", value: true }],
     },
     {
       name: "metadata",
@@ -240,29 +227,29 @@ Stores user-specific data for resource-scoped working memory. Each resource repr
       description: "Additional resource metadata as JSON. Example:",
       example: {
         preferences: { language: "en", timezone: "UTC" },
-        tags: ["premium", "beta-user"]
+        tags: ["premium", "beta-user"],
       },
-      constraints: [{ type: "nullable", value: true }]
+      constraints: [{ type: "nullable", value: true }],
     },
     {
       name: "createdAt",
       type: "timestamp",
       description: "When the resource record was first created",
-      constraints: [{ type: "nullable", value: false }]
+      constraints: [{ type: "nullable", value: false }],
     },
     {
       name: "updatedAt",
       type: "timestamp",
       description: "When the working memory was last updated",
-      constraints: [{ type: "nullable", value: false }]
-    }
+      constraints: [{ type: "nullable", value: false }],
+    },
   ]}
 />
 
 **Note**: This table is only created and used by storage adapters that support resource-scoped working memory (LibSQL, PostgreSQL, Upstash). Other storage adapters will provide helpful error messages if resource-scoped memory is attempted.
 
-</Tabs.Tab>
-  <Tabs.Tab>
+</TabItem>
+  <TabItem value="workflows" label="Workflows">
 When `suspend` is called on a workflow, its state is saved in the following format. When `resume` is called, that state is rehydrated.
 
 <br />
@@ -310,8 +297,8 @@ When `suspend` is called on a workflow, its state is saved in the following form
     }
   ]}
 />
-  </Tabs.Tab>
-  <Tabs.Tab>
+  </TabItem>
+  <TabItem value="evals" label="Evals">
 Stores eval results from running metrics against agent outputs.
 
 <br />
@@ -384,8 +371,8 @@ Stores eval results from running metrics against agent outputs.
     }
   ]}
 />
-  </Tabs.Tab>
-  <Tabs.Tab>
+  </TabItem>
+  <TabItem value="traces" label="Traces">
 Captures OpenTelemetry traces for monitoring and debugging.
 
 <br />
@@ -482,7 +469,7 @@ Captures OpenTelemetry traces for monitoring and debugging.
     }
   ]}
 />
-  </Tabs.Tab>
+  </TabItem>
 </Tabs>
 
 ### Querying Messages
@@ -491,25 +478,33 @@ Messages are stored in a V2 format internally, which is roughly equivalent to th
 
 ```typescript copy
 // Get messages in the default V1 format (roughly equivalent to AI SDK's CoreMessage format)
-const messagesV1 = await mastra.getStorage().getMessages({ threadId: 'your-thread-id' });
+const messagesV1 = await mastra
+  .getStorage()
+  .getMessages({ threadId: "your-thread-id" });
 
 // Get messages in the V2 format (roughly equivalent to AI SDK's UIMessage format)
-const messagesV2 = await mastra.getStorage().getMessages({ threadId: 'your-thread-id', format: 'v2' });
+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 messagesV1 = await mastra
+  .getStorage()
+  .getMessagesById({ messageIds: messageIdArr, format: "v1" });
 
-const messagesV2 = await mastra.getStorage().getMessagesById({ messageIds: messageIdArr });
+const messagesV2 = await mastra
+  .getStorage()
+  .getMessagesById({ messageIds: messageIdArr });
 ```
 
 ## Storage Providers
 
 Mastra supports the following providers:
 
-- For local development, check out [LibSQL Storage](../../reference/storage/libsql.mdx)
-- For production, check out [PostgreSQL Storage](../../reference/storage/postgresql.mdx)
-- For serverless deployments, check out [Upstash Storage](../../reference/storage/upstash.mdx)
-- For document-based storage, check out [MongoDB Storage](../../reference/storage/mongodb.mdx)
+- For local development, check out [LibSQL Storage](/reference/storage/libsql)
+- For production, check out [PostgreSQL Storage](/reference/storage/postgresql)
+- For serverless deployments, check out [Upstash Storage](/reference/storage/upstash)
+- For document-based storage, check out [MongoDB Storage](/reference/storage/mongodb)

package/.docs/raw/streaming/events.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Streaming Events | Streaming | Mastra"
+title: "Streaming Events | Streaming | Mastra Docs"
 description: "Learn about the different types of streaming events in Mastra, including text deltas, tool calls, step events, and how to handle them in your applications."
 ---
 
@@ -56,7 +56,7 @@ for await (const chunk of stream) {
 }
 ```
 
-> See [Agent.stream()](../../reference/agents/stream.mdx) for more information.
+> See [Agent.stream()](/reference/streaming/agents/stream) for more information.
 
 ### Example agent output
 
@@ -98,8 +98,8 @@ const run = await testWorkflow.createRunAsync();
 
 const stream = await run.stream({
   inputData: {
-    value: "initial data"
-  }
+    value: "initial data",
+  },
 });
 
 for await (const chunk of stream) {
@@ -139,14 +139,16 @@ When using multi-agent collaboration with `agent.network()`, iterate over the st
 ```typescript {3,5} showLineNumbers copy
 const networkAgent = mastra.getAgent("networkAgent");
 
-const networkStream = await networkAgent.network("Research dolphins then write a report");
+const networkStream = await networkAgent.network(
+  "Research dolphins then write a report",
+);
 
 for await (const chunk of networkStream) {
   console.log(chunk);
 }
 ```
 
-> See [Agent.network()](../../reference/agents/network.mdx) for more information.
+> See [Agent.network()](/reference/agents/network) for more information.
 
 ### Example network output
 
@@ -201,23 +203,29 @@ Network streams emit events that track the orchestration flow. Each iteration be
 You can filter events by type to track specific aspects of the network execution:
 
 ```typescript {5-8,11-13,16-18} showLineNumbers copy
-const networkStream = await networkAgent.network("Analyze data and create visualization");
+const networkStream = await networkAgent.network(
+  "Analyze data and create visualization",
+);
 
 for await (const chunk of networkStream) {
   // Track routing decisions
-  if (chunk.type === 'routing-agent-end') {
-    console.log('Selected:', chunk.payload.resourceType, chunk.payload.resourceId);
-    console.log('Reason:', chunk.payload.selectionReason);
+  if (chunk.type === "routing-agent-end") {
+    console.log(
+      "Selected:",
+      chunk.payload.resourceType,
+      chunk.payload.resourceId,
+    );
+    console.log("Reason:", chunk.payload.selectionReason);
   }
-  
+
   // Track agent delegations
-  if (chunk.type === 'agent-execution-start') {
-    console.log('Delegating to agent:', chunk.payload.agentId);
+  if (chunk.type === "agent-execution-start") {
+    console.log("Delegating to agent:", chunk.payload.agentId);
   }
-  
+
   // Track workflow delegations
-  if (chunk.type === 'workflow-execution-start') {
-    console.log('Executing workflow:', chunk.payload.name);
+  if (chunk.type === "workflow-execution-start") {
+    console.log("Executing workflow:", chunk.payload.name);
   }
 }
 ```

package/.docs/raw/streaming/overview.mdx

@@ -1,12 +1,10 @@
 ---
-title: "Streaming Overview | Streaming | Mastra"
+title: "Streaming Overview | Streaming | Mastra Docs"
 description: "Streaming in Mastra enables real-time, incremental responses from both agents and workflows, providing immediate feedback as AI-generated content is produced."
 ---
 
-
 # Streaming Overview
 
-
 Mastra supports real-time, incremental responses from agents and workflows, allowing users to see output as it’s generated instead of waiting for completion. This is useful for chat, long-form content, multi-step workflows, or any scenario where immediate feedback matters.
 
 ## Getting started
@@ -22,7 +20,7 @@ You can pass a single string for simple prompts, an array of strings when provid
 
 ### Using `Agent.stream()`
 
-A `textStream` breaks the response into chunks as it's generated, allowing output to stream progressively instead of arriving all at once.  Iterate over the `textStream` using a `for await` loop to inspect each stream chunk.
+A `textStream` breaks the response into chunks as it's generated, allowing output to stream progressively instead of arriving all at once. Iterate over the `textStream` using a `for await` loop to inspect each stream chunk.
 
 ```typescript {3,7} showLineNumbers copy
 const testAgent = mastra.getAgent("testAgent");
@@ -36,7 +34,7 @@ for await (const chunk of stream.textStream) {
 }
 ```
 
-> See [Agent.stream()](../../reference/agents/stream.mdx) for more information.
+> See [Agent.stream()](/reference/streaming/agents/stream) for more information.
 
 ### Output from `Agent.stream()`
 
@@ -58,7 +56,6 @@ An agent stream provides access to various response properties:
 - **`stream.finishReason`**: The reason the agent stopped streaming.
 - **`stream.usage`**: Token usage information.
 
-
 ### AI SDK v5 Compatibility
 
 AI SDK v5 uses `LanguageModelV2` for the model providers. If you are getting an error that you are using an AI SDK v4 model you will need to upgrade your model package to the next major version.
@@ -70,7 +67,7 @@ const testAgent = mastra.getAgent("testAgent");
 
 const stream = await testAgent.stream(
   [{ role: "user", content: "Help me organize my day" }],
-  { format: "aisdk" }
+  { format: "aisdk" },
 );
 
 for await (const chunk of stream.textStream) {
@@ -94,7 +91,7 @@ for await (const chunk of networkStream) {
 }
 ```
 
-> See [Agent.network()](../../reference/agents/network.mdx) for more information.
+> See [Agent.network()](/reference/agents/network) for more information.
 
 #### Network stream properties
 
@@ -107,15 +104,17 @@ The network stream provides access to execution information:
 ```typescript {9-11} showLineNumbers copy
 const testAgent = mastra.getAgent("testAgent");
 
-const networkStream = await testAgent.network("Research dolphins then write a report");
+const networkStream = await testAgent.network(
+  "Research dolphins then write a report",
+);
 
 for await (const chunk of networkStream) {
   console.log(chunk);
 }
 
-console.log('Final status:', await networkStream.status);
-console.log('Final result:', await networkStream.result);
-console.log('Token usage:', await networkStream.usage);
+console.log("Final status:", await networkStream.status);
+console.log("Final result:", await networkStream.result);
+console.log("Token usage:", await networkStream.usage);
 ```
 
 ## Streaming with workflows
@@ -131,8 +130,8 @@ const run = await testWorkflow.createRunAsync();
 
 const stream = await run.streamVNext({
   inputData: {
-    value: "initial data"
-  }
+    value: "initial data",
+  },
 });
 
 for await (const chunk of stream) {
@@ -140,7 +139,7 @@ for await (const chunk of stream) {
 }
 ```
 
-> See [Run.streamVNext()](../../reference/workflows/run-methods/streamVNext.mdx) for more information.
+> See Run.streamVNext() method documentation for more information.
 
 ### Output from `Run.stream()`
 
@@ -172,6 +171,6 @@ A workflow stream provides access to various response properties:
 
 ## Related
 
-- [Streaming events](./events.mdx)
-- [Using Agents](../agents/overview.mdx)
-- [Workflows overview](../workflows/overview.mdx)
+- [Streaming events](./events)
+- [Using Agents](/docs/agents/overview)
+- [Workflows overview](../workflows/overview)

package/.docs/raw/streaming/tool-streaming.mdx

@@ -1,10 +1,8 @@
 ---
-title: "Tool Streaming | Streaming | Mastra"
+title: "Tool streaming | Streaming | Mastra Docs"
 description: "Learn how to use tool streaming in Mastra, including handling tool calls, tool results, and tool execution events during streaming."
 ---
 
-import { Callout } from "nextra/components";
-
 # Tool streaming
 
 Tool streaming in Mastra enables tools to send incremental results while they run, rather than waiting until execution finishes. This allows you to surface partial progress, intermediate states, or progressive data directly to users or upstream agents and workflows.
@@ -30,7 +28,7 @@ export const testAgent = new Agent({
   name: "test-agent",
   instructions: "You are a weather agent.",
   model: openai("gpt-4o-mini"),
-  tools: { testTool }
+  tools: { testTool },
 });
 ```
 
@@ -38,9 +36,11 @@ export const testAgent = new Agent({
 
 The `writer` argument is passed to a tool’s `execute` function and can be used to emit custom events, data, or values into the active stream. This enables tools to provide intermediate results or status updates while execution is still in progress.
 
-<Callout type="warning">
+:::warning
+
 You must `await` the call to `writer.write(...)` or else you will lock the stream and get a `WritableStream is locked` error.
-</Callout>
+
+:::
 
 ```typescript {5,8,15} showLineNumbers copy
 import { createTool } from "@mastra/core/tools";
@@ -106,7 +106,7 @@ Events written to the stream are included in the emitted chunks. These chunks ca
 ```typescript showLineNumbers copy
 const stream = await testAgent.stream([
   "What is the weather in London?",
-  "Use the testTool"
+  "Use the testTool",
 ]);
 
 for await (const chunk of stream) {
@@ -135,9 +135,8 @@ export const testTool = createTool({
     await stream!.textStream.pipeTo(writer!);
 
     return {
-      value: await stream!.text
+      value: await stream!.text,
     };
-  }
+  },
 });
 ```
-

package/.docs/raw/streaming/workflow-streaming.mdx

@@ -1,10 +1,8 @@
 ---
-title: "Workflow Streaming | Streaming | Mastra"
+title: "Workflow streaming | Streaming | Mastra Docs"
 description: "Learn how to use workflow streaming in Mastra, including handling workflow execution events, step streaming, and workflow integration with agents and tools."
 ---
 
-import { Callout } from "nextra/components";
-
 # Workflow streaming
 
 Workflow streaming in Mastra enables workflows to send incremental results while they execute, rather than waiting until completion. This allows you to surface partial progress, intermediate states, or progressive data directly to users or upstream agents and workflows.
@@ -18,15 +16,19 @@ By combining writable workflow streams with agent streaming, you gain fine-grain
 
 ### Using the `writer` argument
 
-<Callout type="warning">
+:::warning
+
 The writer is only available when using `streamVNext`.
-</Callout>
+
+:::
 
 The `writer` argument is passed to a workflow step's `execute` function and can be used to emit custom events, data, or values into the active stream. This enables workflow steps to provide intermediate results or status updates while execution is still in progress.
 
-<Callout type="warning">
+:::warning
+
 You must `await` the call to `writer.write(...)` or else you will lock the stream and get a `WritableStream is locked` error.
-</Callout>
+
+:::
 
 ```typescript {5,8,15} showLineNumbers copy
 import { createStep } from "@mastra/core/workflows";
@@ -66,8 +68,8 @@ const run = await testWorkflow.createRunAsync();
 
 const stream = await run.streamVNext({
   inputData: {
-    value: "initial data"
-  }
+    value: "initial data",
+  },
 });
 
 for await (const chunk of stream) {
@@ -77,7 +79,7 @@ for await (const chunk of stream) {
 if (result!.status === "suspended") {
   // if the workflow is suspended, we can resume it with the resumeStreamVNext method
   const resumedStream = await run.resumeStreamVNext({
-    resumeData: { value: "resume data" }
+    resumeData: { value: "resume data" },
   });
 
   for await (const chunk of resumedStream) {
@@ -108,8 +110,8 @@ import { z } from "zod";
 
 export const testStep = createStep({
   // ...
-  execute: async ({ inputData, mastra, writer  }) => {
-    const { city } = inputData
+  execute: async ({ inputData, mastra, writer }) => {
+    const { city } = inputData;
 
     const testAgent = mastra?.getAgent("testAgent");
     const stream = await testAgent?.stream(`What is the weather in ${city}$?`);