@mastra/mcp-docs-server 1.0.0-beta.11 → 1.0.0-beta.14

package/.docs/raw/reference/workflows/workflow-methods/sleep.mdx

@@ -9,7 +9,7 @@ The `.sleep()` method pauses execution for a specified number of milliseconds. I
 
 ## Usage example
 
-```typescript copy
+```typescript
 workflow.sleep(5000);
 ```
 
@@ -41,7 +41,7 @@ workflow.sleep(5000);
 
 ## Extended usage example
 
-```typescript showLineNumbers copy
+```typescript
 import { createWorkflow, createStep } from "@mastra/core/workflows";
 
 const step1 = createStep({...});

package/.docs/raw/reference/workflows/workflow-methods/sleepUntil.mdx

@@ -9,7 +9,7 @@ The `.sleepUntil()` method pauses execution until a specified date.
 
 ## Usage example
 
-```typescript copy
+```typescript
 workflow.sleepUntil(new Date(Date.now() + 5000));
 ```
 
@@ -41,7 +41,7 @@ workflow.sleepUntil(new Date(Date.now() + 5000));
 
 ## Extended usage example
 
-```typescript showLineNumbers copy
+```typescript
 import { createWorkflow, createStep } from "@mastra/core/workflows";
 
 const step1 = createStep({...});

package/.docs/raw/reference/workflows/workflow-methods/then.mdx

@@ -9,7 +9,7 @@ The `.then()` method creates a sequential dependency between workflow steps, ens
 
 ## Usage example
 
-```typescript copy
+```typescript
 workflow.then(step1).then(step2);
 ```
 

package/.docs/raw/reference/workflows/workflow-methods/waitForEvent.mdx

@@ -9,7 +9,7 @@ The `.waitForEvent()` method pauses execution until an event is received.
 
 ## Usage example
 
-```typescript copy
+```typescript
 workflow.waitForEvent("event-name", step1);
 ```
 
@@ -46,7 +46,7 @@ workflow.waitForEvent("event-name", step1);
 
 ## Extended usage example
 
-```typescript showLineNumbers copy
+```typescript
 import { createWorkflow, createStep } from "@mastra/core/workflows";
 
 const step1 = createStep({...});

package/.docs/raw/reference/workflows/workflow.mdx

@@ -9,7 +9,7 @@ The `Workflow` class enables you to create state machines for complex sequences
 
 ## Usage example
 
-```typescript title="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
+```typescript title="src/mastra/workflows/test-workflow.ts"
 import { createWorkflow } from "@mastra/core/workflows";
 import { z } from "zod";
 
@@ -85,6 +85,20 @@ export const workflow = createWorkflow({
       isOptional: true,
       defaultValue: "() => true",
     },
+    {
+      name: "onFinish",
+      type: "(result: WorkflowFinishCallbackResult) => void | Promise<void>",
+      description:
+        "Callback invoked when workflow completes with any status (success, failed, suspended, tripwire). Receives the workflow result including status, output, error, and step results. Errors thrown in this callback are caught and logged, not propagated.",
+      isOptional: true,
+    },
+    {
+      name: "onError",
+      type: "(errorInfo: WorkflowErrorCallbackInfo) => void | Promise<void>",
+      description:
+        "Callback invoked only when workflow fails (failed or tripwire status). Receives error details and step results. Errors thrown in this callback are caught and logged, not propagated.",
+      isOptional: true,
+    },
   ]}
 />
 
@@ -92,7 +106,7 @@ export const workflow = createWorkflow({
 
 When starting a workflow run, you can pass `initialState` to set the starting values for the workflow's state:
 
-```typescript showLineNumbers copy
+```typescript
 const run = await workflow.createRun();
 
 const result = await run.start({
@@ -143,7 +157,7 @@ A workflow's `status` indicates its current execution state. The possible values
 
 When a workflow contains an agent step that triggers a tripwire, the workflow returns with `status: 'tripwire'` and includes tripwire details:
 
-```typescript showLineNumbers copy
+```typescript
 const run = await workflow.createRun();
 const result = await run.start({ inputData: { message: "Hello" } });
 

package/.docs/raw/{auth → server/auth}/auth0.mdx

@@ -19,7 +19,7 @@ This example uses Auth0 authentication. Make sure to:
 3. Configure an API in your Auth0 Dashboard with an identifier (audience)
 4. Configure your application's allowed callback URLs, web origins, and logout URLs
 
-```env title=".env" copy
+```env title=".env"
 AUTH0_DOMAIN=your-tenant.auth0.com
 AUTH0_AUDIENCE=your-api-identifier
 ```
@@ -32,7 +32,7 @@ AUTH0_AUDIENCE=your-api-identifier
 
 Before you can use the `MastraAuthAuth0` class you have to install the `@mastra/auth-auth0` package.
 
-```bash copy
+```bash
 npm install @mastra/auth-auth0@beta
 ```
 
@@ -40,12 +40,11 @@ npm install @mastra/auth-auth0@beta
 
 ### Basic usage with environment variables
 
-```typescript {2,7} title="src/mastra/index.ts" showLineNumbers copy
+```typescript {2,6} 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(),
   },
@@ -54,12 +53,11 @@ export const mastra = new Mastra({
 
 ### Custom configuration
 
-```typescript {2,7-10} title="src/mastra/index.ts" showLineNumbers copy
+```typescript {2,6-9} 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,
@@ -82,7 +80,7 @@ By default, `MastraAuthAuth0` allows all authenticated users who have valid Auth
 
 To customize user authorization, provide a custom `authorizeUser` function:
 
-```typescript title="src/mastra/auth.ts" showLineNumbers copy
+```typescript title="src/mastra/auth.ts"
 import { MastraAuthAuth0 } from "@mastra/auth-auth0";
 
 const auth0Provider = new MastraAuthAuth0({
@@ -93,7 +91,11 @@ const auth0Provider = new MastraAuthAuth0({
 });
 ```
 
-> See the [MastraAuthAuth0](/reference/v1/auth/auth0) API reference for all available configuration options.
+:::info
+
+Visit [MastraAuthAuth0](/reference/v1/auth/auth0) for all available configuration options.
+
+:::
 
 ## Client-side setup
 
@@ -103,11 +105,11 @@ When using Auth0 auth, you'll need to set up the Auth0 React SDK, authenticate u
 
 First, install and configure the Auth0 React SDK in your application:
 
-```bash copy
+```bash
 npm install @auth0/auth0-react
 ```
 
-```typescript title="src/auth0-provider.tsx" showLineNumbers copy
+```typescript title="src/auth0-provider.tsx"
 import React from 'react';
 import { Auth0Provider } from '@auth0/auth0-react';
 
@@ -134,7 +136,7 @@ export default Auth0ProviderWithHistory;
 
 Use the Auth0 React SDK to authenticate users and retrieve their access tokens:
 
-```typescript title="lib/auth.ts" showLineNumbers copy
+```typescript title="lib/auth.ts"
 import { useAuth0 } from "@auth0/auth0-react";
 
 export const useAuth0Token = () => {
@@ -155,7 +157,7 @@ export const useAuth0Token = () => {
 
 When `auth` is enabled, all requests made with `MastraClient` must include a valid Auth0 access token in the `Authorization` header:
 
-```typescript title="lib/mastra/mastra-client.ts" showLineNumbers copy
+```typescript title="lib/mastra/mastra-client.ts"
 import { MastraClient } from "@mastra/client-js";
 
 export const createMastraClient = (accessToken: string) => {
@@ -170,7 +172,11 @@ export const createMastraClient = (accessToken: string) => {
 
 > **Note:** The access token must be prefixed with `Bearer` in the Authorization header.
 
-> See [Mastra Client SDK](/docs/v1/server-db/mastra-client) for more configuration options.
+:::info
+
+Visit [Mastra Client SDK](/docs/v1/server/mastra-client) for more configuration options.
+
+:::
 
 ### Making authenticated requests
 
@@ -178,7 +184,7 @@ Once `MastraClient` is configured with the Auth0 access token, you can send auth
 
 <Tabs>
   <TabItem value="react" label="React">
-    ```tsx title="src/components/mastra-api-test.tsx" showLineNumbers copy
+    ```tsx title="src/components/mastra-api-test.tsx" copy
     import React, { useState } from 'react';
     import { useAuth0 } from '@auth0/auth0-react';
     import { MastraClient } from '@mastra/client-js';

package/.docs/raw/{auth → server/auth}/clerk.mdx

@@ -14,7 +14,7 @@ The `MastraAuthClerk` class provides authentication for Mastra using Clerk. It v
 
 This example uses Clerk authentication. Make sure to add your Clerk credentials to your `.env` file and ensure your Clerk project is properly configured.
 
-```env title=".env" copy
+```env title=".env"
 CLERK_PUBLISHABLE_KEY=pk_test_...
 CLERK_SECRET_KEY=sk_test_...
 CLERK_JWKS_URI=https://your-clerk-domain.clerk.accounts.dev/.well-known/jwks.json
@@ -26,18 +26,17 @@ CLERK_JWKS_URI=https://your-clerk-domain.clerk.accounts.dev/.well-known/jwks.jso
 
 Before you can use the `MastraAuthClerk` class you have to install the `@mastra/auth-clerk` package.
 
-```bash copy
+```bash
 npm install @mastra/auth-clerk@beta
 ```
 
 ## Usage example
 
-```typescript {2,7-11} title="src/mastra/index.ts" showLineNumbers copy
+```typescript {2,6-10} 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({
       publishableKey: process.env.CLERK_PUBLISHABLE_KEY,
@@ -50,7 +49,11 @@ export const mastra = new Mastra({
 
 > **Note:** The default `authorizeUser` method allows all authenticated users. To customize user authorization, provide a custom `authorizeUser` function when constructing the provider.
 
-> See the [MastraAuthClerk](/reference/v1/auth/clerk) API reference for all available configuration options.
+:::info
+
+Visit [MastraAuthClerk](/reference/v1/auth/clerk) for all available configuration options.
+
+:::
 
 ## Client-side setup
 
@@ -60,7 +63,7 @@ When using Clerk auth, you'll need to retrieve the access token from Clerk on th
 
 Use the Clerk React hooks to authenticate users and retrieve their access token:
 
-```typescript title="lib/auth.ts" showLineNumbers copy
+```typescript title="lib/auth.ts"
 import { useAuth } from "@clerk/nextjs";
 
 export const useClerkAuth = () => {
@@ -81,7 +84,7 @@ export const useClerkAuth = () => {
 
 When `auth` is enabled, all requests made with `MastraClient` must include a valid Clerk access token in the `Authorization` header:
 
-```typescript {6} title="lib/mastra/mastra-client.ts" showLineNumbers copy
+```typescript {6} title="lib/mastra/mastra-client.ts"
 import { MastraClient } from "@mastra/client-js";
 
 export const mastraClient = new MastraClient({
@@ -93,7 +96,11 @@ export const mastraClient = new MastraClient({
 ```
 
 > **Note:** The access token must be prefixed with `Bearer` in the Authorization header.
-> See [Mastra Client SDK](/docs/v1/server-db/mastra-client) for more configuration options.
+:::info
+
+Visit [Mastra Client SDK](/docs/v1/server/mastra-client) for more configuration options.
+
+:::
 
 ### Making authenticated requests
 
@@ -101,7 +108,7 @@ Once `MastraClient` is configured with the Clerk access token, you can send auth
 
 <Tabs>
   <TabItem value="react" label="React">
-    ```tsx title="src/components/test-agent.tsx" showLineNumbers copy
+    ```tsx title="src/components/test-agent.tsx" copy
     "use client";
 
     import { useAuth } from "@clerk/nextjs";

package/.docs/raw/{auth → server/auth}/firebase.mdx

@@ -19,7 +19,7 @@ This example uses Firebase Authentication. Make sure to:
 3. Generate a service account key from Project Settings > Service Accounts
 4. Download the service account JSON file
 
-```env title=".env" copy
+```env title=".env"
 FIREBASE_SERVICE_ACCOUNT=/path/to/your/service-account-key.json
 FIRESTORE_DATABASE_ID=(default)
 # Alternative environment variable names:
@@ -32,7 +32,7 @@ FIRESTORE_DATABASE_ID=(default)
 
 Before you can use the `MastraAuthFirebase` class you have to install the `@mastra/auth-firebase` package.
 
-```bash copy
+```bash
 npm install @mastra/auth-firebase@beta
 ```
 
@@ -42,13 +42,12 @@ npm install @mastra/auth-firebase@beta
 
 If you set the required environment variables (`FIREBASE_SERVICE_ACCOUNT` and `FIRESTORE_DATABASE_ID`), you can initialize `MastraAuthFirebase` without any constructor arguments. The class will automatically read these environment variables as configuration:
 
-```typescript {2,7} title="src/mastra/index.ts" showLineNumbers copy
+```typescript {2,7} 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(),
   },
@@ -57,12 +56,11 @@ export const mastra = new Mastra({
 
 ### Custom configuration
 
-```typescript {2,7-10} title="src/mastra/index.ts" showLineNumbers copy
+```typescript {2,6-9} 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.json",
@@ -87,7 +85,7 @@ The `MastraAuthFirebase` class can be configured through constructor options or
 
 By default, `MastraAuthFirebase` uses Firestore to manage user access. It expects a collection named `user_access` with documents keyed by user UIDs. The presence of a document in this collection determines whether a user is authorized.
 
-```typescript title="firestore-structure.txt" copy
+```typescript title="firestore-structure.txt"
 user_access/
   {user_uid_1}/     // Document exists = user authorized
   {user_uid_2}/     // Document exists = user authorized
@@ -95,7 +93,7 @@ user_access/
 
 To customize user authorization, provide a custom `authorizeUser` function:
 
-```typescript title="src/mastra/auth.ts" showLineNumbers copy
+```typescript title="src/mastra/auth.ts"
 import { MastraAuthFirebase } from "@mastra/auth-firebase";
 
 const firebaseAuth = new MastraAuthFirebase({
@@ -106,7 +104,11 @@ const firebaseAuth = new MastraAuthFirebase({
 });
 ```
 
-> See the [MastraAuthFirebase](/reference/v1/auth/firebase) API reference for all available configuration options.
+:::info
+
+Visit [MastraAuthFirebase](/reference/v1/auth/firebase) for all available configuration options.
+
+:::
 
 ## Client-side setup
 
@@ -116,7 +118,7 @@ When using Firebase auth, you'll need to initialize Firebase on the client side,
 
 First, initialize Firebase in your client application:
 
-```typescript title="lib/firebase.ts" showLineNumbers copy
+```typescript title="lib/firebase.ts"
 import { initializeApp } from "firebase/app";
 import { getAuth, GoogleAuthProvider } from "firebase/auth";
 
@@ -135,7 +137,7 @@ export const googleProvider = new GoogleAuthProvider();
 
 Use Firebase authentication to sign in users and retrieve their ID tokens:
 
-```typescript title="lib/auth.ts" showLineNumbers copy
+```typescript title="lib/auth.ts"
 import { signInWithPopup, signOut, User } from "firebase/auth";
 import { auth, googleProvider } from "./firebase";
 
@@ -175,7 +177,7 @@ export const signOutUser = async () => {
 
 When `auth` is enabled, all requests made with `MastraClient` must include a valid Firebase ID token in the `Authorization` header:
 
-```typescript {6} title="lib/mastra/mastra-client.ts" showLineNumbers copy
+```typescript {6} title="lib/mastra/mastra-client.ts"
 import { MastraClient } from "@mastra/client-js";
 
 export const createMastraClient = (idToken: string) => {
@@ -190,7 +192,11 @@ export const createMastraClient = (idToken: string) => {
 
 > **Note:** The ID token must be prefixed with `Bearer` in the Authorization header.
 
-> See [Mastra Client SDK](/docs/v1/server-db/mastra-client) for more configuration options.
+:::info
+
+Visit [Mastra Client SDK](/docs/v1/server/mastra-client) for more configuration options.
+
+:::
 
 ### Making authenticated requests
 
@@ -198,7 +204,7 @@ Once `MastraClient` is configured with the Firebase ID token, you can send authe
 
 <Tabs>
   <TabItem value="react" label="React">
-    ```tsx title="src/components/test-agent.tsx" showLineNumbers copy
+    ```tsx title="src/components/test-agent.tsx" copy
     "use client";
 
     import { useAuthState } from 'react-firebase-hooks/auth';
@@ -233,7 +239,7 @@ Once `MastraClient` is configured with the Firebase ID token, you can send authe
 
   </TabItem>
   <TabItem value="nodejs" label="Node.js">
-    ```typescript title="server.js" showLineNumbers copy
+    ```typescript title="server.js" copy
     const express = require('express');
     const admin = require('firebase-admin');
     const { MastraClient } = require('@mastra/client-js');

package/.docs/raw/{auth → server/auth}/index.mdx

@@ -11,9 +11,9 @@ You can start with simple shared secret JWT authentication and switch to provide
 
 ## Available providers
 
-- [JSON Web Token (JWT)](/docs/v1/auth/jwt)
-- [Clerk](/docs/v1/auth/clerk)
-- [Supabase](/docs/v1/auth/supabase)
-- [Firebase](/docs/v1/auth/firebase)
-- [WorkOS](/docs/v1/auth/workos)
-- [Auth0](/docs/v1/auth/auth0)
+- [JSON Web Token (JWT)](/docs/v1/server/auth/jwt)
+- [Clerk](/docs/v1/server/auth/clerk)
+- [Supabase](/docs/v1/server/auth/supabase)
+- [Firebase](/docs/v1/server/auth/firebase)
+- [WorkOS](/docs/v1/server/auth/workos)
+- [Auth0](/docs/v1/server/auth/auth0)

package/.docs/raw/{auth → server/auth}/jwt.mdx

@@ -14,18 +14,17 @@ The `MastraJwtAuth` class provides a lightweight authentication mechanism for Ma
 
 Before you can use the `MastraJwtAuth` class you have to install the `@mastra/auth` package.
 
-```bash copy
+```bash
 npm install @mastra/auth@beta
 ```
 
 ## Usage example
 
-```typescript {2,7-9} title="src/mastra/index.ts" showLineNumbers copy
+```typescript {2,6-8} 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: process.env.MASTRA_JWT_SECRET,
@@ -34,13 +33,17 @@ export const mastra = new Mastra({
 });
 ```
 
-> See the [MastraJwtAuth](/reference/v1/auth/jwt) API reference for all available configuration options.
+:::info
+
+Visit [MastraJwtAuth](/reference/v1/auth/jwt) for all available configuration options.
+
+:::
 
 ## Configuring `MastraClient`
 
 When `auth` is enabled, all requests made with `MastraClient` must include a valid JWT in the `Authorization` header:
 
-```typescript {6} title="lib/mastra/mastra-client.ts" showLineNumbers copy
+```typescript {6} title="lib/mastra/mastra-client.ts"
 import { MastraClient } from "@mastra/client-js";
 
 export const mastraClient = new MastraClient({
@@ -51,7 +54,11 @@ export const mastraClient = new MastraClient({
 });
 ```
 
-> See [Mastra Client SDK](/docs/v1/server-db/mastra-client) for more configuration options.
+:::info
+
+Visit [Mastra Client SDK](/docs/v1/server/mastra-client) for more configuration options.
+
+:::
 
 ### Making authenticated requests
 
@@ -59,7 +66,7 @@ Once `MastraClient` is configured, you can send authenticated requests from your
 
 <Tabs>
   <TabItem value="react" label="React">
-    ```tsx title="src/components/test-agent.tsx" showLineNumbers copy
+    ```tsx title="src/components/test-agent.tsx" copy
     import { mastraClient } from "../../lib/mastra-client";
 
     export const TestAgent = () => {

package/.docs/raw/{auth → server/auth}/supabase.mdx

@@ -14,7 +14,7 @@ The `MastraAuthSupabase` class provides authentication for Mastra using Supabase
 
 This example uses Supabase Auth. Make sure to add your Supabase credentials to your `.env` file and ensure your Supabase project is properly configured.
 
-```env title=".env" copy
+```env title=".env"
 SUPABASE_URL=https://your-project.supabase.co
 SUPABASE_ANON_KEY=your-anon-key
 ```
@@ -25,18 +25,17 @@ SUPABASE_ANON_KEY=your-anon-key
 
 Before you can use the `MastraAuthSupabase` class you have to install the `@mastra/auth-supabase` package.
 
-```bash copy
+```bash
 npm install @mastra/auth-supabase@beta
 ```
 
 ## Usage example
 
-```typescript {2,7-9} title="src/mastra/index.ts" showLineNumbers copy
+```typescript {2,6-9} 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,
@@ -48,7 +47,11 @@ export const mastra = new Mastra({
 
 > **Note:** The default `authorizeUser` method checks the `isAdmin` column in the `users` table in the `public` schema. To customize user authorization, provide a custom `authorizeUser` function when constructing the provider.
 
-> See the [MastraAuthSupabase](/reference/v1/auth/supabase) API reference for all available configuration options.
+:::info
+
+Visit [MastraAuthSupabase](/reference/v1/auth/supabase) for all available configuration options.
+
+:::
 
 ## Client-side setup
 
@@ -58,7 +61,7 @@ When using Supabase auth, you'll need to retrieve the access token from Supabase
 
 Use the Supabase client to authenticate users and retrieve their access token:
 
-```typescript title="lib/auth.ts" showLineNumbers copy
+```typescript title="lib/auth.ts"
 import { createClient } from "@supabase/supabase-js";
 
 const supabase = createClient("<supabase-url>", "<supabase-key>");
@@ -77,7 +80,7 @@ const accessToken = authTokenResponse.data?.session?.access_token;
 
 When `auth` is enabled, all requests made with `MastraClient` must include a valid Supabase access token in the `Authorization` header:
 
-```typescript {6} title="lib/mastra/mastra-client.ts" showLineNumbers copy
+```typescript {6} title="lib/mastra/mastra-client.ts"
 import { MastraClient } from "@mastra/client-js";
 
 export const mastraClient = new MastraClient({
@@ -90,7 +93,11 @@ export const mastraClient = new MastraClient({
 
 > **Note:** The access token must be prefixed with `Bearer` in the Authorization header.
 
-> See [Mastra Client SDK](/docs/v1/server-db/mastra-client) for more configuration options.
+:::info
+
+Visit [Mastra Client SDK](/docs/v1/server/mastra-client) for more configuration options.
+
+:::
 
 ### Making authenticated requests
 
@@ -98,7 +105,7 @@ Once `MastraClient` is configured with the Supabase access token, you can send a
 
 <Tabs>
     <TabItem value="react" label="React">
-    ```tsx title="src/components/test-agent.tsx" showLineNumbers copy
+    ```tsx title="src/components/test-agent.tsx" copy
     import { mastraClient } from "../../lib/mastra-client";
 
     export const TestAgent = () => {