@mastra/mcp-docs-server 0.13.37-alpha.1 → 0.13.38

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

@@ -1,5 +1,5 @@
 ---
-title: "MastraAuthFirebase Class"
+title: "Reference: MastraAuthFirebase Class | Auth | Mastra Docs"
 description: "API reference for the MastraAuthFirebase class, which authenticates Mastra applications using Firebase Authentication."
 ---
 
@@ -11,9 +11,9 @@ The `MastraAuthFirebase` class provides authentication for Mastra using Firebase
 
 ### Basic usage with environment variables
 
-```typescript filename="src/mastra/index.ts" showLineNumbers copy
+```typescript title="src/mastra/index.ts" showLineNumbers copy
 import { Mastra } from "@mastra/core/mastra";
-import { MastraAuthFirebase } from '@mastra/auth-firebase';
+import { MastraAuthFirebase } from "@mastra/auth-firebase";
 
 // Automatically uses FIREBASE_SERVICE_ACCOUNT and FIRESTORE_DATABASE_ID env vars
 export const mastra = new Mastra({
@@ -26,16 +26,16 @@ export const mastra = new Mastra({
 
 ### Custom configuration
 
-```typescript filename="src/mastra/index.ts" showLineNumbers copy
+```typescript title="src/mastra/index.ts" showLineNumbers copy
 import { Mastra } from "@mastra/core/mastra";
-import { MastraAuthFirebase } from '@mastra/auth-firebase';
+import { MastraAuthFirebase } from "@mastra/auth-firebase";
 
 export const mastra = new Mastra({
   // ..
   server: {
     experimental_auth: new MastraAuthFirebase({
       serviceAccount: "/path/to/service-account-key.json",
-      databaseId: "your-database-id"
+      databaseId: "your-database-id",
     }),
   },
 });
@@ -48,28 +48,32 @@ export const mastra = new Mastra({
     {
       name: "serviceAccount",
       type: "string",
-      description: "Path to the Firebase service account JSON file. This file contains the credentials needed to verify Firebase ID tokens on the server side.",
+      description:
+        "Path to the Firebase service account JSON file. This file contains the credentials needed to verify Firebase ID tokens on the server side.",
       isOptional: true,
-      defaultValue: "process.env.FIREBASE_SERVICE_ACCOUNT"
+      defaultValue: "process.env.FIREBASE_SERVICE_ACCOUNT",
     },
     {
       name: "databaseId",
       type: "string",
-      description: "The Firestore database ID to use. Typically '(default)' for the default database.",
+      description:
+        "The Firestore database ID to use. Typically '(default)' for the default database.",
       isOptional: true,
-      defaultValue: "process.env.FIRESTORE_DATABASE_ID || process.env.FIREBASE_DATABASE_ID"
+      defaultValue:
+        "process.env.FIRESTORE_DATABASE_ID || process.env.FIREBASE_DATABASE_ID",
     },
     {
       name: "name",
       type: "string",
       description: "Custom name for the auth provider instance.",
       isOptional: true,
-      defaultValue: '"firebase"'
+      defaultValue: '"firebase"',
     },
     {
       name: "authorizeUser",
       type: "(user: FirebaseUser) => Promise<boolean> | boolean",
-      description: "Custom authorization function to determine if a user should be granted access. Called after token verification. By default, checks for the presence of a document in the 'user_access' collection keyed by the user's UID.",
+      description:
+        "Custom authorization function to determine if a user should be granted access. Called after token verification. By default, checks for the presence of a document in the 'user_access' collection keyed by the user's UID.",
       isOptional: true,
     },
   ]}
@@ -84,19 +88,22 @@ The following environment variables are automatically used when constructor opti
     {
       name: "FIREBASE_SERVICE_ACCOUNT",
       type: "string",
-      description: "Path to Firebase service account JSON file. Used if serviceAccount option is not provided.",
+      description:
+        "Path to Firebase service account JSON file. Used if serviceAccount option is not provided.",
       isOptional: true,
     },
     {
       name: "FIRESTORE_DATABASE_ID",
       type: "string",
-      description: "Firestore database ID. Primary environment variable for database configuration.",
+      description:
+        "Firestore database ID. Primary environment variable for database configuration.",
       isOptional: true,
     },
     {
       name: "FIREBASE_DATABASE_ID",
       type: "string",
-      description: "Alternative environment variable for Firestore database ID. Used if FIRESTORE_DATABASE_ID is not set.",
+      description:
+        "Alternative environment variable for Firestore database ID. Used if FIRESTORE_DATABASE_ID is not set.",
       isOptional: true,
     },
   ]}
@@ -125,4 +132,4 @@ The `FirebaseUser` type used in the `authorizeUser` function corresponds to Fire
 
 ## Related
 
-[MastraAuthFirebase Class](/docs/auth/firebase.mdx)
+[MastraAuthFirebase Class](/docs/auth/firebase)

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

@@ -1,5 +1,5 @@
 ---
-title: "MastraJwtAuth Class"
+title: "Reference: MastraJwtAuth Class | Auth | Mastra Docs"
 description: "API reference for the MastraJwtAuth class, which authenticates Mastra applications using JSON Web Tokens."
 ---
 
@@ -9,15 +9,15 @@ The `MastraJwtAuth` class provides a lightweight authentication mechanism for Ma
 
 ## Usage example
 
-```typescript filename="src/mastra/index.ts" showLineNumbers copy
+```typescript title="src/mastra/index.ts" showLineNumbers copy
 import { Mastra } from "@mastra/core/mastra";
-import { MastraJwtAuth } from '@mastra/auth';
+import { MastraJwtAuth } from "@mastra/auth";
 
 export const mastra = new Mastra({
   // ..
   server: {
     experimental_auth: new MastraJwtAuth({
-        secret: "<your-secret>"
+      secret: "<your-secret>",
     }),
   },
 });
@@ -30,7 +30,8 @@ export const mastra = new Mastra({
     {
       name: "secret",
       type: "string",
-      description: "A unique string used to sign and verify JSON Web Tokens (JWTs) for authenticating incoming requests.",
+      description:
+        "A unique string used to sign and verify JSON Web Tokens (JWTs) for authenticating incoming requests.",
       isOptional: false,
     },
   ]}
@@ -38,4 +39,4 @@ export const mastra = new Mastra({
 
 ## Related
 
-[MastraJwtAuth](/docs/auth/jwt.mdx)
+[MastraJwtAuth](/docs/auth/jwt)

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

@@ -1,5 +1,5 @@
 ---
-title: "MastraAuthSupabase Class"
+title: "Reference: MastraAuthSupabase Class | Auth | Mastra Docs"
 description: "API reference for the MastraAuthSupabase class, which authenticates Mastra applications using Supabase Auth."
 ---
 
@@ -9,16 +9,16 @@ The `MastraAuthSupabase` class provides authentication for Mastra using Supabase
 
 ## Usage example
 
-```typescript filename="src/mastra/index.ts" showLineNumbers copy
+```typescript title="src/mastra/index.ts" showLineNumbers copy
 import { Mastra } from "@mastra/core/mastra";
-import { MastraAuthSupabase } from '@mastra/auth-supabase';
+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
+      anonKey: process.env.SUPABASE_ANON_KEY,
     }),
   },
 });
@@ -31,16 +31,18 @@ export const mastra = new Mastra({
     {
       name: "url",
       type: "string",
-      description: "The URL of your Supabase project. Can be found in your Supabase project settings.",
+      description:
+        "The URL of your Supabase project. Can be found in your Supabase project settings.",
       isOptional: true,
-      defaultValue: "process.env.SUPABASE_URL"
+      defaultValue: "process.env.SUPABASE_URL",
     },
     {
       name: "anonKey",
       type: "string",
-      description: "The anonymous/public key for your Supabase project. Used for client-side authentication.",
+      description:
+        "The anonymous/public key for your Supabase project. Used for client-side authentication.",
       isOptional: true,
-      defaultValue: "process.env.SUPABASE_ANON_KEY"
+      defaultValue: "process.env.SUPABASE_ANON_KEY",
     },
     {
       name: "name",
@@ -51,7 +53,8 @@ export const mastra = new Mastra({
     {
       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.",
+      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,
     },
   ]}
@@ -59,4 +62,4 @@ export const mastra = new Mastra({
 
 ## Related
 
-[MastraAuthSupabase](/docs/auth/supabase.mdx)
+[MastraAuthSupabase](/docs/auth/supabase)

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

@@ -1,5 +1,5 @@
 ---
-title: "MastraAuthWorkos Class"
+title: "Reference: MastraAuthWorkos Class | Auth | Mastra Docs"
 description: "API reference for the MastraAuthWorkos class, which authenticates Mastra applications using WorkOS authentication."
 ---
 
@@ -9,16 +9,16 @@ The `MastraAuthWorkos` class provides authentication for Mastra using WorkOS. It
 
 ## Usage example
 
-```typescript filename="src/mastra/index.ts" showLineNumbers copy
+```typescript title="src/mastra/index.ts" showLineNumbers copy
 import { Mastra } from "@mastra/core/mastra";
-import { MastraAuthWorkos } from '@mastra/auth-workos';
+import { MastraAuthWorkos } from "@mastra/auth-workos";
 
 export const mastra = new Mastra({
   // ..
   server: {
     experimental_auth: new MastraAuthWorkos({
       apiKey: process.env.WORKOS_API_KEY,
-      clientId: process.env.WORKOS_CLIENT_ID
+      clientId: process.env.WORKOS_CLIENT_ID,
     }),
   },
 });
@@ -33,28 +33,31 @@ export const mastra = new Mastra({
     {
       name: "apiKey",
       type: "string",
-      description: "Your WorkOS API key. This is used to authenticate with the WorkOS API for user verification and organization management.",
+      description:
+        "Your WorkOS API key. This is used to authenticate with the WorkOS API for user verification and organization management.",
       isOptional: true,
-      defaultValue: "process.env.WORKOS_API_KEY"
+      defaultValue: "process.env.WORKOS_API_KEY",
     },
     {
       name: "clientId",
       type: "string",
-      description: "Your WorkOS Client ID. This identifies your application when exchanging authorization codes for access tokens.",
+      description:
+        "Your WorkOS Client ID. This identifies your application when exchanging authorization codes for access tokens.",
       isOptional: true,
-      defaultValue: "process.env.WORKOS_CLIENT_ID"
+      defaultValue: "process.env.WORKOS_CLIENT_ID",
     },
     {
       name: "name",
       type: "string",
       description: "Custom name for the auth provider instance.",
       isOptional: true,
-      defaultValue: '"workos"'
+      defaultValue: '"workos"',
     },
     {
       name: "authorizeUser",
       type: "(user: WorkosUser) => Promise<boolean> | boolean",
-      description: "Custom authorization function to determine if a user should be granted access. Called after token verification. By default, checks if the user has an 'admin' role in any organization membership.",
+      description:
+        "Custom authorization function to determine if a user should be granted access. Called after token verification. By default, checks if the user has an 'admin' role in any organization membership.",
       isOptional: true,
     },
   ]}
@@ -69,13 +72,15 @@ The following environment variables are automatically used when constructor opti
     {
       name: "WORKOS_API_KEY",
       type: "string",
-      description: "Your WorkOS API key. Can be found in your WorkOS Dashboard under API Keys.",
+      description:
+        "Your WorkOS API key. Can be found in your WorkOS Dashboard under API Keys.",
       isOptional: true,
     },
     {
       name: "WORKOS_CLIENT_ID",
       type: "string",
-      description: "Your WorkOS Client ID. Can be found in your WorkOS Dashboard under Applications.",
+      description:
+        "Your WorkOS Client ID. Can be found in your WorkOS Dashboard under Applications.",
       isOptional: true,
     },
   ]}
@@ -125,4 +130,3 @@ The properties with `urn:myapp:` prefixes are custom claims configured in your W
 ## Related
 
 [MastraAuthWorkos Class](/docs/auth/workos)
-

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

@@ -1,9 +1,10 @@
 ---
-title: "Reference: create-mastra | CLI"
+title: "Reference: create-mastra | CLI | Mastra Docs"
 description: Documentation for the create-mastra command, which creates a new Mastra project with interactive setup options.
 ---
 
-import { Tabs, Tab } from "@/components/tabs";
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
 
 # create-mastra
 
@@ -11,52 +12,68 @@ The `create-mastra` command **creates** a new standalone Mastra project. Use thi
 
 ## Usage
 
-<Tabs items={["npm", "yarn", "pnpm", "bun"]}>
-  <Tab>
-    ```bash copy
-    npx create-mastra@latest
-    ```
-  </Tab>
-  <Tab>
-    ```bash copy
-    yarn dlx create-mastra@latest
-    ```
-  </Tab>
-  <Tab>
-    ```bash copy
-    pnpm create mastra@latest
-    ```
-  </Tab>
-  <Tab>
-    ```bash copy
-    bun create mastra@latest
-    ```
-  </Tab>
+<Tabs>
+<TabItem value="npm" label="npm">
+
+```bash copy
+npx create-mastra@latest
+```
+
+</TabItem>
+<TabItem value="yarn" label="yarn">
+
+```bash copy
+yarn dlx create-mastra@latest
+```
+
+</TabItem>
+<TabItem value="pnpm" label="pnpm">
+
+```bash copy
+pnpm create mastra@latest
+```
+
+</TabItem>
+<TabItem value="bun" label="bun">
+
+```bash copy
+bun create mastra@latest
+```
+
+</TabItem>
 </Tabs>
 
 `create-mastra` automatically runs in _interactive_ mode, but you can also specify your project name and template with command line arguments.
 
-<Tabs items={["npm", "yarn", "pnpm", "bun"]}>
-  <Tab>
-    ```bash copy
-    npx create-mastra@latest my-mastra-project -- --template coding-agent
-    ```
-  </Tab>
-  <Tab>
-    ```bash copy
-    yarn dlx create-mastra@latest --template coding-agent
-    ```
-  </Tab>
-  <Tab>
-    ```bash copy
-    pnpm create mastra@latest --template coding-agent
-    ```
-  </Tab>
-  <Tab>
-    ```bash copy
-    bun create mastra@latest --template coding-agent
-    ```
-  </Tab>
+<Tabs>
+<TabItem value="npm" label="npm">
+
+```bash copy
+npx create-mastra@latest my-mastra-project -- --template coding-agent
+```
+
+</TabItem>
+<TabItem value="yarn" label="yarn">
+
+```bash copy
+yarn dlx create-mastra@latest --template coding-agent
+```
+
+</TabItem>
+<TabItem value="pnpm" label="pnpm">
+
+```bash copy
+pnpm create mastra@latest --template coding-agent
+```
+
+</TabItem>
+<TabItem value="bun" label="bun">
+
+```bash copy
+bun create mastra@latest --template coding-agent
+```
+
+</TabItem>
 </Tabs>
 
 Check out the [full list](https://mastra.ai/api/templates.json) of templates and use the `slug` as input to the `--template` CLI flag.

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

@@ -1,19 +1,17 @@
 ---
-title: "Reference: CLI Commands"
+title: "Reference: CLI Commands | CLI | Mastra Docs"
 description: Documentation for the Mastra CLI to develop, build, and start your project.
 ---
 
-import { Callout } from "nextra/components";
-
 # CLI Commands
 
 You can use the Command-Line Interface (CLI) provided by Mastra to develop, build, and start your Mastra project.
 
 ## `mastra dev`
 
-Starts a server which exposes a [local dev playground](/docs/server-db/local-dev-playground) and REST endpoints for your agents, tools, and workflows. You can visit [http://localhost:4111/swagger-ui](http://localhost:4111/swagger-ui) for an overview of all available endpoints once `mastra dev` is running.
+Starts a server which exposes a [local dev playground](/docs/getting-started/studio) and REST endpoints for your agents, tools, and workflows. You can visit [http://localhost:4111/swagger-ui](http://localhost:4111/swagger-ui) for an overview of all available endpoints once `mastra dev` is running.
 
-You can also [configure the server](/docs/server-db/local-dev-playground#configuration).
+You can also [configure the server](/docs/getting-started/studio#configuration).
 
 ### Flags
 
@@ -21,7 +19,7 @@ The command accepts [common flags][common-flags] and the following additional fl
 
 #### `--https`
 
-Enable local HTTPS support. [Learn more](/docs/server-db/local-dev-playground#local-https).
+Enable local HTTPS support. [Learn more](/docs/getting-started/studio#local-https).
 
 #### `--inspect`
 
@@ -105,11 +103,13 @@ MASTRA_CONCURRENCY=2 mastra build
 
 ## `mastra start`
 
-<Callout type="info">
+:::info
+
 You need to run `mastra build` before using `mastra start`.
-</Callout>
 
-Starts a local server to serve your built Mastra application in production mode. By default, [OTEL Tracing](/docs/observability/otel-tracing) is enabled.
+:::
+
+Starts a local server to serve your built Mastra application in production mode. By default, [OTEL Tracing](/docs/observability/ai-tracing/overview) is enabled.
 
 ### Flags
 
@@ -121,7 +121,7 @@ The path to your built Mastra output directory. Defaults to `.mastra/output`.
 
 #### `--no-telemetry`
 
-Disable the [OTEL Tracing](/docs/observability/otel-tracing).
+Disable the [OTEL Tracing](/docs/observability/ai-tracing/overview).
 
 ## `mastra lint`
 
@@ -255,4 +255,4 @@ You can also set this while using other `mastra` commands:
 MASTRA_TELEMETRY_DISABLED=1 mastra dev
 ```
 
-[common-flags]: #common-flags
+[common-flags]: #common-flags

package/.docs/raw/reference/client-js/agents.mdx

@@ -1,5 +1,5 @@
 ---
-title: Mastra Client Agents API
+title: "Reference: Agents API | Client SDK | Mastra Docs"
 description: Learn how to interact with Mastra AI agents, including generating responses, streaming interactions, and managing agent tools using the client-js SDK.
 ---
 
@@ -67,12 +67,11 @@ const response = await agent.stream({
 
 // Process data stream with the processDataStream util
 response.processDataStream({
-  onChunk: async(chunk) => {
+  onChunk: async (chunk) => {
     console.log(chunk);
   },
 });
 
-
 // You can also read from response body directly
 const reader = response.body.getReader();
 while (true) {
@@ -89,40 +88,41 @@ Client-side tools allow you to execute custom functions on the client side when
 #### Basic Usage
 
 ```typescript
-import { createTool } from '@mastra/client-js';
-import { z } from 'zod';
+import { createTool } from "@mastra/client-js";
+import { z } from "zod";
 
 const colorChangeTool = createTool({
-  id: 'changeColor',
-  description: 'Changes the background color',
+  id: "changeColor",
+  description: "Changes the background color",
   inputSchema: z.object({
     color: z.string(),
   }),
   execute: async ({ context }) => {
     document.body.style.backgroundColor = context.color;
     return { success: true };
-  }
-})
-
+  },
+});
 
 // Use with generate
 const response = await agent.generate({
-  messages: 'Change the background to blue',
-  clientTools: {colorChangeTool},
+  messages: "Change the background to blue",
+  clientTools: { colorChangeTool },
 });
 
 // Use with stream
 const response = await agent.stream({
-  messages: 'Change the background to green',
-  clientTools: {colorChangeTool},
+  messages: "Change the background to green",
+  clientTools: { colorChangeTool },
 });
 
 response.processDataStream({
   onChunk: async (chunk) => {
-    if (chunk.type === 'text-delta') {
+    if (chunk.type === "text-delta") {
       console.log(chunk.payload.text);
-    } else if (chunk.type === 'tool-call') {
-      console.log(`calling tool ${chunk.payload.toolName} with args ${JSON.stringify(chunk.payload.args, null, 2)}`);
+    } else if (chunk.type === "tool-call") {
+      console.log(
+        `calling tool ${chunk.payload.toolName} with args ${JSON.stringify(chunk.payload.args, null, 2)}`,
+      );
     }
   },
 });
@@ -148,25 +148,20 @@ const evals = await agent.evals();
 const liveEvals = await agent.liveEvals();
 ```
 
-
 ### Stream
 
-
 Stream responses using the enhanced API with improved method signatures. This method provides enhanced capabilities and format flexibility, with support for Mastra's native format.
 
 ```typescript
-const response = await agent.stream(
-  "Tell me a story",
-  {
-    threadId: "thread-1",
-    clientTools: { colorChangeTool },
-  }
-);
+const response = await agent.stream("Tell me a story", {
+  threadId: "thread-1",
+  clientTools: { colorChangeTool },
+});
 
 // Process the stream
 response.processDataStream({
   onChunk: async (chunk) => {
-    if (chunk.type === 'text-delta') {
+    if (chunk.type === "text-delta") {
       console.log(chunk.payload.text);
     }
   },
@@ -177,24 +172,29 @@ response.processDataStream({
 
 To stream AI SDK-formatted parts on the client from an `agent.stream(...)` response, wrap `response.processDataStream` into a `ReadableStream<ChunkType>` and use `toAISdkFormat`:
 
-```typescript filename="client-ai-sdk-transform.ts" copy
-import { createUIMessageStream } from 'ai';
-import { toAISdkFormat } from '@mastra/ai-sdk';
-import type { ChunkType, MastraModelOutput } from '@mastra/core/stream';
+```typescript title="client-ai-sdk-transform.ts" copy
+import { createUIMessageStream } from "ai";
+import { toAISdkFormat } from "@mastra/ai-sdk";
+import type { ChunkType, MastraModelOutput } from "@mastra/core/stream";
 
-const response = await agent.stream({ messages: 'Tell me a story' });
+const response = await agent.stream({ messages: "Tell me a story" });
 
 const chunkStream: ReadableStream<ChunkType> = new ReadableStream<ChunkType>({
   start(controller) {
-    response.processDataStream({
-      onChunk: async (chunk) => controller.enqueue(chunk as ChunkType),
-    }).finally(() => controller.close());
+    response
+      .processDataStream({
+        onChunk: async (chunk) => controller.enqueue(chunk as ChunkType),
+      })
+      .finally(() => controller.close());
   },
 });
 
 const uiMessageStream = createUIMessageStream({
   execute: async ({ writer }) => {
-    for await (const part of toAISdkFormat(chunkStream as unknown as MastraModelOutput, { from: 'agent' })) {
+    for await (const part of toAISdkFormat(
+      chunkStream as unknown as MastraModelOutput,
+      { from: "agent" },
+    )) {
       writer.write(part);
     }
   },
@@ -210,11 +210,8 @@ for await (const part of uiMessageStream) {
 Generate a response using the enhanced API with improved method signatures and AI SDK v5 compatibility:
 
 ```typescript
-const response = await agent.generate(
-  "Hello, how are you?",
-  {
-    threadId: "thread-1",
-    resourceId: "resource-1",
-  }
-);
+const response = await agent.generate("Hello, how are you?", {
+  threadId: "thread-1",
+  resourceId: "resource-1",
+});
 ```

package/.docs/raw/reference/client-js/error-handling.mdx

@@ -1,5 +1,5 @@
 ---
-title: Mastra Client Error Handling
+title: "Reference: Error Handling | Client SDK | Mastra Docs"
 description: Learn about the built-in retry mechanism and error handling capabilities in the Mastra client-js SDK.
 ---
 

package/.docs/raw/reference/client-js/logs.mdx

@@ -1,5 +1,5 @@
 ---
-title: Mastra Client Logs API
+title: "Reference: Logs API | Client SDK | Mastra Docs"
 description: Learn how to access and query system logs and debugging information in Mastra using the client-js SDK.
 ---