@mastra/mcp-docs-server 1.0.0-beta.8 → 1.0.0

package/.docs/raw/reference/ai-sdk/to-ai-sdk-v5-messages.mdx

@@ -0,0 +1,110 @@
+---
+title: "Reference: toAISdkV5Messages() | AI SDK"
+description: API reference for toAISdkV5Messages(), a function to convert Mastra messages to AI SDK v5 UI messages.
+packages:
+  - "@mastra/ai-sdk"
+  - "@mastra/client-js"
+---
+
+import PropertiesTable from "@site/src/components/PropertiesTable";
+
+# toAISdkV5Messages()
+
+Converts messages from various input formats to AI SDK V5 (and later) UI message format. This function accepts messages in multiple formats (strings, AI SDK V4/V5 messages, Mastra DB messages, etc.) and normalizes them to the AI SDK V5+ `UIMessage` format, which is suitable for use with AI SDK UI components like `useChat()`.
+
+## Usage example
+
+```typescript title="app/chat/page.tsx"
+import { toAISdkV5Messages } from "@mastra/ai-sdk/ui";
+import { useChat } from "ai/react";
+
+// Stored messages from your database, memory or API
+const storedMessages = [
+  { id: "1", role: "user", content: "Hello", parts: [{ type: "text", text: "Hello" }] },
+  { id: "2", role: "assistant", content: "Hi there!", parts: [{ type: "text", text: "Hi there!" }] }
+];
+
+export default function Chat() {
+  const { messages } = useChat({
+    initialMessages: toAISdkV5Messages(storedMessages)
+  });
+
+  return (
+    <div>
+      {messages.map((message) => (
+        <div key={message.id}>
+          {message.role}: {message.parts.map(part => 
+            part.type === "text" ? part.text : null
+          )}
+        </div>
+      ))}
+    </div>
+  );
+}
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "messages",
+      type: "MessageListInput",
+      description: "Messages to convert. Can be a string, array of strings, a single message object, or an array of message objects in any supported format.",
+      isOptional: false,
+    },
+  ]}
+/>
+
+## Returns
+
+Returns an array of AI SDK V5+ `UIMessage` objects with the following structure:
+
+<PropertiesTable
+  content={[
+    {
+      name: "id",
+      type: "string",
+      description: "Unique message identifier.",
+    },
+    {
+      name: "role",
+      type: "'user' | 'assistant' | 'system'",
+      description: "The role of the message sender.",
+    },
+    {
+      name: "parts",
+      type: "UIMessagePart[]",
+      description: "Array of UI parts including text, tool results, files, reasoning, sources, and step markers.",
+    },
+    {
+      name: "metadata",
+      type: "Record<string, unknown>",
+      description: "Optional metadata including createdAt, threadId, resourceId, and custom fields.",
+      isOptional: true,
+    },
+  ]}
+/>
+
+## Examples
+
+### Converting simple text messages
+
+```typescript
+import { toAISdkV5Messages } from "@mastra/ai-sdk/ui";
+
+const messages = toAISdkV5Messages(["Hello", "How can I help you today?"]);
+// Returns array of UIMessage objects with user role
+```
+
+### Loading messages with Mastra client
+
+```typescript
+import { MastraClient } from "@mastra/client-js";
+import { toAISdkV5Messages } from "@mastra/ai-sdk/ui";
+
+const client = new MastraClient();
+
+const { messages } = await client.listThreadMessages("thread-id", { agentId: "myAgent" });
+const uiMessages = toAISdkV5Messages(messages);
+```

package/.docs/raw/reference/ai-sdk/with-mastra.mdx

@@ -0,0 +1,122 @@
+---
+title: "Reference: withMastra() | AI SDK"
+description: API reference for withMastra(), a function to use Mastra functionality in AI SDK.
+packages:
+  - "@mastra/ai-sdk"
+  - "@mastra/core"
+---
+
+import PropertiesTable from "@site/src/components/PropertiesTable";
+
+# withMastra()
+
+Wraps an AI SDK model with Mastra processors and/or memory.
+
+## Usage example
+
+```typescript title="src/example.ts"
+import { openai } from '@ai-sdk/openai';
+import { generateText } from 'ai';
+import { withMastra } from '@mastra/ai-sdk';
+import type { Processor } from '@mastra/core/processors';
+
+const loggingProcessor: Processor<'logger'> = {
+  id: 'logger',
+  async processInput({ messages }) {
+    console.log('Input:', messages.length, 'messages');
+    return messages;
+  },
+};
+
+const model = withMastra(openai('gpt-4o'), {
+  inputProcessors: [loggingProcessor],
+});
+
+const { text } = await generateText({
+  model,
+  prompt: 'What is 2 + 2?',
+});
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "model",
+      type: "LanguageModelV2",
+      description: "Any AI SDK language model (e.g., `openai('gpt-4o')`, `anthropic('claude-3-opus')`).",
+      isOptional: false,
+    },
+    {
+      name: "options",
+      type: "WithMastraOptions",
+      description: "Configuration object for processors and memory.",
+      isOptional: true,
+    },
+    {
+      name: "options.inputProcessors",
+      type: "InputProcessor[]",
+      description: "Input processors to run before the LLM call.",
+      isOptional: true,
+    },
+    {
+      name: "options.outputProcessors",
+      type: "OutputProcessor[]",
+      description: "Output processors to run on the LLM response.",
+      isOptional: true,
+    },
+    {
+      name: "options.memory",
+      type: "WithMastraMemoryOptions",
+      description: "Memory configuration - enables automatic message history persistence.",
+      isOptional: true,
+    },
+    {
+      name: "options.memory.storage",
+      type: "MemoryStorage",
+      description: "Storage adapter for message persistence (e.g., LibSQLStore, PostgresStore).",
+      isOptional: false,
+    },
+    {
+      name: "options.memory.threadId",
+      type: "string",
+      description: "Thread ID for conversation persistence.",
+      isOptional: false,
+    },
+    {
+      name: "options.memory.resourceId",
+      type: "string",
+      description: "Resource ID (user/session identifier).",
+      isOptional: true,
+    },
+    {
+      name: "options.memory.lastMessages",
+      type: "number | false",
+      description: "Number of recent messages to retrieve, or false to disable.",
+      isOptional: true,
+    },
+    {
+      name: "options.memory.semanticRecall",
+      type: "WithMastraSemanticRecallOptions",
+      description: "Semantic recall configuration (RAG-based memory retrieval).",
+      isOptional: true,
+    },
+    {
+      name: "options.memory.workingMemory",
+      type: "MemoryConfig['workingMemory']",
+      description: "Working memory configuration (persistent user data).",
+      isOptional: true,
+    },
+    {
+      name: "options.memory.readOnly",
+      type: "boolean",
+      description: "Read-only mode - prevents saving new messages.",
+      isOptional: true,
+    },
+  ]}
+/>
+
+## Returns
+
+A wrapped model compatible with `generateText`, `streamText`, `generateObject`, and `streamObject`.

package/.docs/raw/reference/ai-sdk/workflow-route.mdx

@@ -1,13 +1,16 @@
 ---
 title: "Reference: workflowRoute() | AI SDK"
 description: API reference for workflowRoute(), a function to create workflow route handlers for streaming workflow execution in AI SDK-compatible format.
+packages:
+  - "@mastra/ai-sdk"
+  - "@mastra/core"
 ---
 
 import PropertiesTable from "@site/src/components/PropertiesTable";
 
 # workflowRoute()
 
-Creates a workflow route handler for streaming workflow execution using the AI SDK format. This function registers an HTTP `POST` endpoint that accepts input data, executes a workflow, and streams the response back to the client in AI SDK-compatible format. You have to use it inside a [custom API route](/docs/v1/server-db/custom-api-routes).
+Creates a workflow route handler for streaming workflow execution using the AI SDK format. This function registers an HTTP `POST` endpoint that accepts input data, executes a workflow, and streams the response back to the client in AI SDK-compatible format. You have to use it inside a [custom API route](/docs/v1/server/custom-api-routes).
 
 Use [`handleWorkflowStream()`](/reference/v1/ai-sdk/handle-workflow-stream) if you need a framework-agnostic handler.
 
@@ -15,7 +18,7 @@ Use [`handleWorkflowStream()`](/reference/v1/ai-sdk/handle-workflow-stream) if y
 
 When a workflow step pipes an agent's stream to the workflow writer (e.g., `await response.fullStream.pipeTo(writer)`), the agent's text chunks and tool calls are forwarded to the UI stream in real time, even when the agent runs inside workflow steps.
 
-See [Workflow Streaming](/docs/v1/streaming/workflow-streaming#streaming-agent-text-chunks-to-ui) for more details.
+See [Workflow Streaming](/docs/v1/streaming/workflow-streaming) for more details.
 
 :::
 
@@ -23,7 +26,7 @@ See [Workflow Streaming](/docs/v1/streaming/workflow-streaming#streaming-agent-t
 
 This example shows how to set up a workflow route at the `/workflow` endpoint that uses a workflow with the ID `weatherWorkflow`.
 
-```typescript title="src/mastra/index.ts" copy
+```typescript title="src/mastra/index.ts"
 import { Mastra } from "@mastra/core";
 import { workflowRoute } from "@mastra/ai-sdk";
 
@@ -41,7 +44,7 @@ export const mastra = new Mastra({
 
 You can also use dynamic workflow routing based on a `workflowId`. The URL `/workflow/weatherWorkflow` will resolve to the workflow with the ID `weatherWorkflow`.
 
-```typescript title="src/mastra/index.ts" copy
+```typescript title="src/mastra/index.ts"
 import { Mastra } from "@mastra/core";
 import { workflowRoute } from "@mastra/ai-sdk";
 

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

@@ -1,6 +1,9 @@
 ---
 title: "Reference: MastraAuthAuth0 Class | Auth"
 description: "API reference for the MastraAuthAuth0 class, which authenticates Mastra applications using Auth0 authentication."
+packages:
+  - "@mastra/auth-auth0"
+  - "@mastra/core"
 ---
 
 # MastraAuthAuth0 Class
@@ -9,12 +12,11 @@ The `MastraAuthAuth0` class provides authentication for Mastra using Auth0. It v
 
 ## Usage example
 
-```typescript title="src/mastra/index.ts" showLineNumbers copy
+```typescript title="src/mastra/index.ts"
 import { Mastra } from "@mastra/core";
 import { MastraAuthAuth0 } from "@mastra/auth-auth0";
 
 export const mastra = new Mastra({
-  // ..
   server: {
     auth: new MastraAuthAuth0({
       domain: process.env.AUTH0_DOMAIN,
@@ -118,4 +120,4 @@ The exact properties available depend on your Auth0 configuration, scopes reques
 
 ## Related
 
-[MastraAuthAuth0 Class](/docs/v1/auth/auth0)
+[MastraAuthAuth0 Class](/docs/v1/server/auth/auth0)

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

@@ -1,6 +1,9 @@
 ---
 title: "Reference: MastraAuthClerk Class | Auth"
 description: "API reference for the MastraAuthClerk class, which authenticates Mastra applications using Clerk authentication."
+packages:
+  - "@mastra/auth-clerk"
+  - "@mastra/core"
 ---
 
 # MastraAuthClerk Class
@@ -9,12 +12,11 @@ The `MastraAuthClerk` class provides authentication for Mastra applications usin
 
 ## Usage example
 
-```typescript title="src/mastra/index.ts" showLineNumbers copy
+```typescript title="src/mastra/index.ts"
 import { Mastra } from "@mastra/core";
 import { MastraAuthClerk } from "@mastra/auth-clerk";
 
 export const mastra = new Mastra({
-  // ..
   server: {
     auth: new MastraAuthClerk({
       jwksUri: process.env.CLERK_JWKS_URI,
@@ -71,4 +73,4 @@ export const mastra = new Mastra({
 
 ## Related
 
-[MastraAuthClerk Class](/docs/v1/auth/clerk)
+[MastraAuthClerk Class](/docs/v1/server/auth/clerk)

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

@@ -1,6 +1,9 @@
 ---
 title: "Reference: MastraAuthFirebase Class | Auth"
 description: "API reference for the MastraAuthFirebase class, which authenticates Mastra applications using Firebase Authentication."
+packages:
+  - "@mastra/auth-firebase"
+  - "@mastra/core"
 ---
 
 # MastraAuthFirebase Class
@@ -11,13 +14,12 @@ The `MastraAuthFirebase` class provides authentication for Mastra using Firebase
 
 ### Basic usage with environment variables
 
-```typescript title="src/mastra/index.ts" showLineNumbers copy
+```typescript title="src/mastra/index.ts"
 import { Mastra } from "@mastra/core";
 import { MastraAuthFirebase } from "@mastra/auth-firebase";
 
 // Automatically uses FIREBASE_SERVICE_ACCOUNT and FIRESTORE_DATABASE_ID env vars
 export const mastra = new Mastra({
-  // ..
   server: {
     auth: new MastraAuthFirebase(),
   },
@@ -26,12 +28,11 @@ export const mastra = new Mastra({
 
 ### Custom configuration
 
-```typescript title="src/mastra/index.ts" showLineNumbers copy
+```typescript title="src/mastra/index.ts"
 import { Mastra } from "@mastra/core";
 import { MastraAuthFirebase } from "@mastra/auth-firebase";
 
 export const mastra = new Mastra({
-  // ..
   server: {
     auth: new MastraAuthFirebase({
       serviceAccount: "/path/to/service-account-key.json",
@@ -132,4 +133,4 @@ The `FirebaseUser` type used in the `authorizeUser` function corresponds to Fire
 
 ## Related
 
-[MastraAuthFirebase Class](/docs/v1/auth/firebase)
+[MastraAuthFirebase Class](/docs/v1/server/auth/firebase)

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

@@ -1,6 +1,9 @@
 ---
 title: "Reference: MastraJwtAuth Class | Auth"
 description: "API reference for the MastraJwtAuth class, which authenticates Mastra applications using JSON Web Tokens."
+packages:
+  - "@mastra/auth"
+  - "@mastra/core"
 ---
 
 # MastraJwtAuth Class
@@ -9,12 +12,11 @@ The `MastraJwtAuth` class provides a lightweight authentication mechanism for Ma
 
 ## Usage example
 
-```typescript title="src/mastra/index.ts" showLineNumbers copy
+```typescript title="src/mastra/index.ts"
 import { Mastra } from "@mastra/core";
 import { MastraJwtAuth } from "@mastra/auth";
 
 export const mastra = new Mastra({
-  // ..
   server: {
     auth: new MastraJwtAuth({
       secret: "<your-secret>",
@@ -39,4 +41,4 @@ export const mastra = new Mastra({
 
 ## Related
 
-[MastraJwtAuth](/docs/v1/auth/jwt)
+[MastraJwtAuth](/docs/v1/server/auth/jwt)

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

@@ -1,6 +1,9 @@
 ---
 title: "Reference: MastraAuthSupabase Class | Auth"
 description: "API reference for the MastraAuthSupabase class, which authenticates Mastra applications using Supabase Auth."
+packages:
+  - "@mastra/auth-supabase"
+  - "@mastra/core"
 ---
 
 # MastraAuthSupabase Class
@@ -9,12 +12,11 @@ The `MastraAuthSupabase` class provides authentication for Mastra using Supabase
 
 ## Usage example
 
-```typescript title="src/mastra/index.ts" showLineNumbers copy
+```typescript title="src/mastra/index.ts"
 import { Mastra } from "@mastra/core";
 import { MastraAuthSupabase } from "@mastra/auth-supabase";
 
 export const mastra = new Mastra({
-  // ..
   server: {
     auth: new MastraAuthSupabase({
       url: process.env.SUPABASE_URL,
@@ -62,4 +64,4 @@ export const mastra = new Mastra({
 
 ## Related
 
-[MastraAuthSupabase](/docs/v1/auth/supabase)
+[MastraAuthSupabase](/docs/v1/server/auth/supabase)

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

@@ -1,6 +1,9 @@
 ---
 title: "Reference: MastraAuthWorkos Class | Auth"
 description: "API reference for the MastraAuthWorkos class, which authenticates Mastra applications using WorkOS authentication."
+packages:
+  - "@mastra/auth-workos"
+  - "@mastra/core"
 ---
 
 # MastraAuthWorkos Class
@@ -9,12 +12,11 @@ The `MastraAuthWorkos` class provides authentication for Mastra using WorkOS. It
 
 ## Usage example
 
-```typescript title="src/mastra/index.ts" showLineNumbers copy
+```typescript title="src/mastra/index.ts"
 import { Mastra } from "@mastra/core";
 import { MastraAuthWorkos } from "@mastra/auth-workos";
 
 export const mastra = new Mastra({
-  // ..
   server: {
     auth: new MastraAuthWorkos({
       apiKey: process.env.WORKOS_API_KEY,
@@ -129,4 +131,4 @@ The properties with `urn:myapp:` prefixes are custom claims configured in your W
 
 ## Related
 
-[MastraAuthWorkos Class](/docs/v1/auth/workos)
+[MastraAuthWorkos Class](/docs/v1/server/auth/workos)

package/.docs/raw/reference/cli/create-mastra.mdx

@@ -1,6 +1,8 @@
 ---
 title: "Reference: create-mastra | CLI"
 description: Documentation for the create-mastra command, which creates a new Mastra project with interactive setup options.
+packages:
+  - "@mastra/create-mastra"
 ---
 
 import Tabs from "@theme/Tabs";
@@ -15,28 +17,28 @@ The `create-mastra` command **creates** a new standalone Mastra project. Use thi
 <Tabs>
 <TabItem value="npm" label="npm">
 
-```bash copy
+```bash
 npx create-mastra@beta
 ```
 
 </TabItem>
 <TabItem value="yarn" label="yarn">
 
-```bash copy
+```bash
 yarn dlx create-mastra@beta
 ```
 
 </TabItem>
 <TabItem value="pnpm" label="pnpm">
 
-```bash copy
+```bash
 pnpm create mastra@beta
 ```
 
 </TabItem>
 <TabItem value="bun" label="bun">
 
-```bash copy
+```bash
 bun create mastra@beta
 ```
 
@@ -48,28 +50,28 @@ bun create mastra@beta
 <Tabs>
 <TabItem value="npm" label="npm">
 
-```bash copy
+```bash
 npx create-mastra@beta my-mastra-project -- --template coding-agent
 ```
 
 </TabItem>
 <TabItem value="yarn" label="yarn">
 
-```bash copy
+```bash
 yarn dlx create-mastra@beta --template coding-agent
 ```
 
 </TabItem>
 <TabItem value="pnpm" label="pnpm">
 
-```bash copy
+```bash
 pnpm create mastra@beta --template coding-agent
 ```
 
 </TabItem>
 <TabItem value="bun" label="bun">
 
-```bash copy
+```bash
 bun create mastra@beta --template coding-agent
 ```
 
@@ -183,12 +185,12 @@ By default, Mastra collects anonymous information about your project like your O
 
 You can opt out of the CLI analytics by setting an environment variable:
 
-```bash copy
+```bash
 MASTRA_TELEMETRY_DISABLED=1
 ```
 
 You can also set this while using other `mastra` commands:
 
-```bash copy
+```bash
 MASTRA_TELEMETRY_DISABLED=1 npx create-mastra@beta
 ```