@mastra/mcp-docs-server 0.13.37 → 0.13.38

package/.docs/raw/workflows/human-in-the-loop.mdx

@@ -1,9 +1,9 @@
 ---
-title: "Human in the Loop | Workflows | Mastra Docs"
+title: "Human-in-the-loop | Workflows | Mastra Docs"
 description: Example of using Mastra to create workflows with multi-turn human/agent interaction points using suspend/resume and dountil methods.
 ---
 
-import { GithubLink } from "@/components/github-link";
+import GithubLink from "@site/src/components/GithubLink";
 
 # Human-in-the-loop
 
@@ -21,7 +21,7 @@ This example consists of three main components:
 
 This example uses the `openai` model. Make sure to add the following to your `.env` file:
 
-```bash filename=".env" copy
+```bash title=".env" copy
 OPENAI_API_KEY=<your-api-key>
 ```
 
@@ -29,7 +29,7 @@ OPENAI_API_KEY=<your-api-key>
 
 The `famousPersonAgent` generates a unique name each time the game is played, using semantic memory to avoid repeating suggestions.
 
-```typescript filename="src/mastra/agents/example-famous-person-agent.ts" showLineNumbers copy
+```typescript title="src/mastra/agents/example-famous-person-agent.ts" showLineNumbers copy
 import { openai } from "@ai-sdk/openai";
 import { Agent } from "@mastra/core/agent";
 import { Memory } from "@mastra/memory";
@@ -53,27 +53,27 @@ Return only the person's name, nothing else.`,
   model: openai("gpt-4o"),
   memory: new Memory({
     vector: new LibSQLVector({
-      connectionUrl: "file:../mastra.db"
+      connectionUrl: "file:../mastra.db",
     }),
     embedder: openai.embedding("text-embedding-3-small"),
     options: {
       lastMessages: 5,
       semanticRecall: {
         topK: 10,
-        messageRange: 1
-      }
-    }
-  })
+        messageRange: 1,
+      },
+    },
+  }),
 });
 ```
 
-> See [Agent](../../reference/agents/agent.mdx) for a full list of configuration options.
+> See [Agent](/reference/agents/agent) for a full list of configuration options.
 
 ## Game agent
 
 The `gameAgent` handles user interactions by responding to questions and validating guesses.
 
-```typescript filename="src/mastra/agents/example-game-agent.ts" showLineNumbers copy
+```typescript title="src/mastra/agents/example-game-agent.ts" showLineNumbers copy
 import { openai } from "@ai-sdk/openai";
 import { Agent } from "@mastra/core/agent";
 
@@ -102,24 +102,23 @@ Encourage players to make a guess when they seem to have enough information.
 You must return a JSON object with:
 - response: Your response to the user
 - gameWon: true if they guessed correctly, false otherwise`,
-  model: openai("gpt-4o")
+  model: openai("gpt-4o"),
 });
 ```
 
-
 ## Multi-turn workflow
 
 The workflow coordinates the full interaction using `suspend`/`resume` to pause for human input and `dountil` to repeat the game loop until a condition is met.
 
 The `startStep` generates a name using the `famousPersonAgent`, while the `gameStep` runs the interaction through the `gameAgent`, which handles both questions and guesses and produces structured output that includes a `gameWon` boolean.
 
-```typescript filename="src/mastra/workflows/example-heads-up-workflow.ts" showLineNumbers copy
-import { createWorkflow, createStep } from '@mastra/core/workflows';
-import { z } from 'zod';
+```typescript title="src/mastra/workflows/example-heads-up-workflow.ts" showLineNumbers copy
+import { createWorkflow, createStep } from "@mastra/core/workflows";
+import { z } from "zod";
 
 const startStep = createStep({
-  id: 'start-step',
-  description: 'Get the name of a famous person',
+  id: "start-step",
+  description: "Get the name of a famous person",
   inputSchema: z.object({
     start: z.boolean(),
   }),
@@ -128,13 +127,13 @@ const startStep = createStep({
     guessCount: z.number(),
   }),
   execute: async ({ mastra }) => {
-    const agent = mastra.getAgent('famousPersonAgent');
+    const agent = mastra.getAgent("famousPersonAgent");
     const response = await agent.generate("Generate a famous person's name", {
       temperature: 1.2,
       topP: 0.9,
       memory: {
-        resource: 'heads-up-game',
-        thread: 'famous-person-generator',
+        resource: "heads-up-game",
+        thread: "famous-person-generator",
       },
     });
     const famousPerson = response.text.trim();
@@ -143,8 +142,8 @@ const startStep = createStep({
 });
 
 const gameStep = createStep({
-  id: 'game-step',
-  description: 'Handles the question-answer-continue loop',
+  id: "game-step",
+  description: "Handles the question-answer-continue loop",
   inputSchema: z.object({
     famousPerson: z.string(),
     guessCount: z.number(),
@@ -167,11 +166,12 @@ const gameStep = createStep({
 
     if (!userMessage) {
       return await suspend({
-        suspendResponse: "I'm thinking of a famous person. Ask me yes/no questions to figure out who it is!",
+        suspendResponse:
+          "I'm thinking of a famous person. Ask me yes/no questions to figure out who it is!",
       });
     }
 
-    const agent = mastra.getAgent('gameAgent');
+    const agent = mastra.getAgent("gameAgent");
     const response = await agent.generate(
       `
         The famous person is: ${famousPerson}
@@ -183,7 +183,7 @@ const gameStep = createStep({
           schema: z.object({
             response: z.string(),
             gameWon: z.boolean(),
-          })
+          }),
         },
       },
     );
@@ -197,8 +197,8 @@ const gameStep = createStep({
 });
 
 const winStep = createStep({
-  id: 'win-step',
-  description: 'Handle game win logic',
+  id: "win-step",
+  description: "Handle game win logic",
   inputSchema: z.object({
     famousPerson: z.string(),
     gameWon: z.boolean(),
@@ -213,16 +213,16 @@ const winStep = createStep({
   execute: async ({ inputData }) => {
     const { famousPerson, gameWon, guessCount } = inputData;
 
-    console.log('famousPerson: ', famousPerson);
-    console.log('gameWon: ', gameWon);
-    console.log('guessCount: ', guessCount);
+    console.log("famousPerson: ", famousPerson);
+    console.log("gameWon: ", gameWon);
+    console.log("guessCount: ", guessCount);
 
     return { famousPerson, gameWon, guessCount };
   },
 });
 
 export const headsUpWorkflow = createWorkflow({
-  id: 'heads-up-workflow',
+  id: "heads-up-workflow",
   inputSchema: z.object({
     start: z.boolean(),
   }),
@@ -236,15 +236,15 @@ export const headsUpWorkflow = createWorkflow({
   .dountil(gameStep, async ({ inputData: { gameWon } }) => gameWon)
   .then(winStep)
   .commit();
-
 ```
-> See [Workflow](../../reference/workflows/workflow.mdx) for a full list of configuration options.
+
+> See [Workflow](/reference/workflows/workflow) for a full list of configuration options.
 
 ## Registering the agents and workflow
 
 To use a workflow or an agent, register them in your main Mastra instance.
 
-```typescript filename="src/mastra/index.ts" showLineNumbers copy
+```typescript title="src/mastra/index.ts" showLineNumbers copy
 import { Mastra } from "@mastra/core/mastra";
 
 import { headsUpWorkflow } from "./workflows/example-heads-up-workflow";
@@ -253,16 +253,16 @@ import { gameAgent } from "./agents/example-game-agent";
 
 export const mastra = new Mastra({
   workflows: { headsUpWorkflow },
-  agents: { famousPersonAgent, gameAgent }
+  agents: { famousPersonAgent, gameAgent },
 });
 ```
 
 <GithubLink
-  marginTop='mt-16'
+  marginTop="mt-16"
   link="https://github.com/mastra-ai/mastra/blob/main/examples/heads-up-game/"
 />
 
 ## Related
 
-- [Running Workflows](./running-workflows.mdx)
-- [Control Flow](../../docs/workflows/control-flow.mdx)
+- [Running Workflows](./overview#running-workflows)
+- [Control Flow](/docs/workflows/control-flow)

package/.docs/raw/workflows/inngest-workflow.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Inngest Workflows | Workflows | Mastra Docs"
+title: "Inngest Workflow | Workflows | Mastra Docs"
 description: "Inngest workflow allows you to run Mastra workflows with Inngest"
 ---
 
@@ -33,13 +33,13 @@ Initialize the Inngest integration to obtain Mastra-compatible workflow helpers.
 
 In development
 
-```ts showLineNumbers copy filename="src/mastra/inngest/index.ts"
+```ts showLineNumbers copy title="src/mastra/inngest/index.ts"
 import { Inngest } from "inngest";
 import { realtimeMiddleware } from "@inngest/realtime";
 
 export const inngest = new Inngest({
   id: "mastra",
-  baseUrl:"http://localhost:8288",
+  baseUrl: "http://localhost:8288",
   isDev: true,
   middleware: [realtimeMiddleware()],
 });
@@ -47,7 +47,7 @@ export const inngest = new Inngest({
 
 In production
 
-```ts showLineNumbers copy filename="src/mastra/inngest/index.ts"
+```ts showLineNumbers copy title="src/mastra/inngest/index.ts"
 import { Inngest } from "inngest";
 import { realtimeMiddleware } from "@inngest/realtime";
 
@@ -61,7 +61,7 @@ export const inngest = new Inngest({
 
 Define the individual steps that will compose your workflow:
 
-```ts showLineNumbers copy filename="src/mastra/workflows/index.ts"
+```ts showLineNumbers copy title="src/mastra/workflows/index.ts"
 import { z } from "zod";
 import { inngest } from "../inngest";
 import { init } from "@mastra/inngest";
@@ -88,7 +88,7 @@ const incrementStep = createStep({
 
 Compose the steps into a workflow using the `dountil` loop pattern. The createWorkflow function creates a function on inngest server that is invocable.
 
-```ts showLineNumbers copy filename="src/mastra/workflows/index.ts"
+```ts showLineNumbers copy title="src/mastra/workflows/index.ts"
 // workflow that is registered as a function on inngest server
 const workflow = createWorkflow({
   id: "increment-workflow",
@@ -109,7 +109,7 @@ export { workflow as incrementWorkflow };
 
 Register the workflow with Mastra and configure the Inngest API endpoint:
 
-```ts showLineNumbers copy filename="src/mastra/index.ts"
+```ts showLineNumbers copy title="src/mastra/index.ts"
 import { Mastra } from "@mastra/core/mastra";
 import { serve as inngestServe } from "@mastra/inngest";
 import { incrementWorkflow } from "./workflows";
@@ -180,7 +180,7 @@ docker run --rm -p 8288:8288 \
 - Visit [http://localhost:8288](http://localhost:8288) in your browser.
 - Go to the **Apps** section in the sidebar.
 - You should see your Mastra workflow registered.
-  ![Inngest Dashboard](/inngest-apps-dashboard.png)
+  ![Inngest Dashboard](/img/inngest-apps-dashboard.png)
 
 4. Invoke the Workflow
 
@@ -198,13 +198,13 @@ docker run --rm -p 8288:8288 \
 }
 ```
 
-![Inngest Function](/inngest-function-dashboard.png)
+![Inngest Function](/img/inngest-function-dashboard.png)
 
 5. **Monitor the Workflow Execution**
 
 - Go to the **Runs** tab in the sidebar.
 - Click on the latest run to see step-by-step execution progress.
-  ![Inngest Function Run](/inngest-runs-dashboard.png)
+  ![Inngest Function Run](/img/inngest-runs-dashboard.png)
 
 ### Running the Workflow in Production
 
@@ -216,7 +216,7 @@ docker run --rm -p 8288:8288 \
 
 1. Add Vercel Deployer to Mastra instance
 
-```ts showLineNumbers copy filename="src/mastra/index.ts"
+```ts showLineNumbers copy title="src/mastra/index.ts"
 import { VercelDeployer } from "@mastra/deployer-vercel";
 
 export const mastra = new Mastra({
@@ -257,7 +257,7 @@ vercel --prod
 - Go to the [Inngest dashboard](https://app.inngest.com/env/production/apps).
 - Click **Sync new app with Vercel** and follow the instructions.
 - You should see your Mastra workflow registered as an app.
-  ![Inngest Dashboard](/inngest-apps-dashboard-prod.png)
+  ![Inngest Dashboard](/img/inngest-apps-dashboard-prod.png)
 
 5. Invoke the Workflow
 
@@ -275,13 +275,13 @@ vercel --prod
 }
 ```
 
-![Inngest Function Run](/inngest-function-dashboard-prod.png)
+![Inngest Function Run](/img/inngest-function-dashboard-prod.png)
 
 6.  Monitor Execution
 
 - Go to the **Runs** tab.
 - Click the latest run to see step-by-step execution progress.
-  ![Inngest Function Run](/inngest-runs-dashboard-prod.png)
+  ![Inngest Function Run](/img/inngest-runs-dashboard-prod.png)
 
 ## Advanced Usage: Adding Custom Inngest Functions
 
@@ -291,28 +291,28 @@ You can serve additional Inngest functions alongside your Mastra workflows by us
 
 First, create your custom Inngest functions:
 
-```ts showLineNumbers copy filename="src/inngest/custom-functions.ts"
+```ts showLineNumbers copy title="src/inngest/custom-functions.ts"
 import { inngest } from "./inngest";
 
 // Define custom Inngest functions
 export const customEmailFunction = inngest.createFunction(
-  { id: 'send-welcome-email' },
-  { event: 'user/registered' },
+  { id: "send-welcome-email" },
+  { event: "user/registered" },
   async ({ event }) => {
     // Custom email logic here
     console.log(`Sending welcome email to ${event.data.email}`);
-    return { status: 'email_sent' };
-  }
+    return { status: "email_sent" };
+  },
 );
 
 export const customWebhookFunction = inngest.createFunction(
-  { id: 'process-webhook' },
-  { event: 'webhook/received' },
+  { id: "process-webhook" },
+  { event: "webhook/received" },
   async ({ event }) => {
     // Custom webhook processing
     console.log(`Processing webhook: ${event.data.type}`);
     return { processed: true };
-  }
+  },
 );
 ```
 
@@ -320,12 +320,15 @@ export const customWebhookFunction = inngest.createFunction(
 
 Update your Mastra configuration to include the custom functions:
 
-```ts showLineNumbers copy filename="src/mastra/index.ts"
+```ts showLineNumbers copy title="src/mastra/index.ts"
 import { Mastra } from "@mastra/core/mastra";
 import { serve as inngestServe } from "@mastra/inngest";
 import { incrementWorkflow } from "./workflows";
 import { inngest } from "./inngest";
-import { customEmailFunction, customWebhookFunction } from "./inngest/custom-functions";
+import {
+  customEmailFunction,
+  customWebhookFunction,
+} from "./inngest/custom-functions";
 
 export const mastra = new Mastra({
   workflows: {
@@ -337,11 +340,12 @@ export const mastra = new Mastra({
       {
         path: "/api/inngest",
         method: "ALL",
-        createHandler: async ({ mastra }) => inngestServe({
-          mastra,
-          inngest,
-          functions: [customEmailFunction, customWebhookFunction] // Add your custom functions
-        }),
+        createHandler: async ({ mastra }) =>
+          inngestServe({
+            mastra,
+            inngest,
+            functions: [customEmailFunction, customWebhookFunction], // Add your custom functions
+          }),
       },
     ],
   },

package/.docs/raw/workflows/input-data-mapping.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Input Data Mapping with Workflow | Mastra Docs"
+title: "Input Data Mapping | Workflows | Mastra Docs"
 description: "Learn how to use workflow input mapping to create more dynamic data flows in your Mastra workflows."
 ---
 
@@ -16,9 +16,9 @@ Input data mapping allows explicit mapping of values for the inputs of the next
 
 In this example the `output` from `step1` is transformed to match the `inputSchema` required for the `step2`. The value from `step1` is available using the `inputData` parameter of the `.map` function.
 
-![Mapping with .map()](/image/workflows/workflows-data-mapping-map.jpg)
+![Mapping with .map()](/img/workflows/workflows-data-mapping-map.jpg)
 
-```typescript {9} filename="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
+```typescript {9} title="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
 const step1 = createStep({...});
 const step2 = createStep({...});
 
@@ -38,7 +38,7 @@ export const testWorkflow = createWorkflow({...})
 
 Use `inputData` to access the full output of the previous step:
 
-```typescript {3} filename="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
+```typescript {3} title="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
   .then(step1)
   .map(({ inputData }) => {
     console.log(inputData);
@@ -49,7 +49,7 @@ Use `inputData` to access the full output of the previous step:
 
 Use `getStepResult` to access the full output of a specific step by referencing the step's instance:
 
-```typescript {3} filename="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
+```typescript {3} title="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
   .then(step1)
   .map(async ({ getStepResult }) => {
     console.log(getStepResult(step1));
@@ -60,7 +60,7 @@ Use `getStepResult` to access the full output of a specific step by referencing
 
 Use `getInitData` to access the initial input data provided to the workflow:
 
-```typescript {3} filename="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
+```typescript {3} title="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
   .then(step1)
   .map(async ({ getInitData }) => {
       console.log(getInitData());
@@ -71,7 +71,7 @@ Use `getInitData` to access the initial input data provided to the workflow:
 
 To use `mapVariable` import the necessary function from the workflows module:
 
-```typescript filename="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
+```typescript title="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
 import { mapVariable } from "@mastra/core/workflows";
 ```
 
@@ -79,7 +79,7 @@ import { mapVariable } from "@mastra/core/workflows";
 
 You can rename step outputs using the object syntax in `.map()`. In the example below, the `value` output from `step1` is renamed to `details`:
 
-```typescript {3-6} filename="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
+```typescript {3-6} title="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
   .then(step1)
   .map({
     details: mapVariable({
@@ -93,7 +93,7 @@ You can rename step outputs using the object syntax in `.map()`. In the example
 
 You can rename workflow outputs by using **referential composition**. This involves passing the workflow instance as the `initData`.
 
-```typescript {6-9} filename="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
+```typescript {6-9} title="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
 export const testWorkflow = createWorkflow({...});
 
 testWorkflow