@mastra/mcp-docs-server 0.13.37 → 0.13.38

package/.docs/raw/server-db/custom-api-routes.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Custom API Routes"
+title: "Custom API Routes | Server & DB | Mastra Docs"
 description: "Expose additional HTTP endpoints from your Mastra server."
 ---
 
@@ -9,7 +9,7 @@ By default Mastra automatically exposes registered agents and workflows via the
 
 Routes are provided with a helper `registerApiRoute` from `@mastra/core/server`. Routes can live in the same file as the `Mastra` instance but separating them helps keep configuration concise.
 
-```typescript filename="src/mastra/index.ts" copy showLineNumbers
+```typescript title="src/mastra/index.ts" copy showLineNumbers
 import { Mastra } from "@mastra/core/mastra";
 import { registerApiRoute } from "@mastra/core/server";
 
@@ -41,7 +41,7 @@ Each route's handler receives the Hono `Context`. Within the handler you can acc
 
 To add route-specific middleware pass a `middleware` array when calling `registerApiRoute`.
 
-```typescript filename="src/mastra/index.ts" copy showLineNumbers
+```typescript title="src/mastra/index.ts" copy showLineNumbers
 import { Mastra } from "@mastra/core/mastra";
 import { registerApiRoute } from "@mastra/core/server";
 
@@ -55,13 +55,13 @@ export const mastra = new Mastra({
           async (c, next) => {
             console.log(`${c.req.method} ${c.req.url}`);
             await next();
-          }
+          },
         ],
         handler: async (c) => {
           return c.json({ message: "Custom route with middleware" });
-        }
-      })
-    ]
-  }
+        },
+      }),
+    ],
+  },
 });
 ```

package/.docs/raw/server-db/mastra-client.mdx

@@ -1,13 +1,14 @@
 ---
-title: "Mastra Client SDK | Mastra Docs"
+title: "Mastra Client SDK | Server & DB | Mastra Docs"
 description: "Learn how to set up and use the Mastra Client SDK"
 ---
 
-import { Tabs } from "nextra/components";
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
 
 # Mastra Client SDK
 
-The Mastra Client SDK provides a simple and type-safe interface for interacting with your [Mastra Server](/docs/deployment/server) from your client environment.
+The Mastra Client SDK provides a simple and type-safe interface for interacting with your [Mastra Server](/docs/server-db/production-server) from your client environment.
 
 ## Prerequisites
 
@@ -25,46 +26,46 @@ The Mastra Client SDK is designed for browser environments and uses the native `
 
 To use the Mastra Client SDK, install the required dependencies:
 
-{/*
-LLM CONTEXT:
-This Tabs component shows installation commands for the Mastra Client SDK using different package managers.
-Each tab displays the installation command for that specific package manager (npm, yarn, pnpm).
-This helps users install the client SDK with their preferred package manager.
-All commands install the same @mastra/client-js package but use different package manager syntax.
-*/}
+<Tabs>
+  <TabItem value="npm" label="npm">
 
-<Tabs items={["npm", "yarn", "pnpm", "bun"]}>
-  <Tabs.Tab>
     ```bash copy
     npm install @mastra/client-js@latest
     ```
-  </Tabs.Tab>
-  <Tabs.Tab>
+
+  </TabItem>
+  <TabItem value="pnpm" label="pnpm">
+
     ```bash copy
-    yarn add @mastra/client-js@latest
+    pnpm add @mastra/client-js@latest
     ```
-  </Tabs.Tab>
-  <Tabs.Tab>
+
+  </TabItem>
+  <TabItem value="yarn" label="yarn">
+
     ```bash copy
-    pnpm add @mastra/client-js@latest
+    yarn add @mastra/client-js@latest
     ```
-  </Tabs.Tab>
-    <Tabs.Tab>
+
+  </TabItem>
+  <TabItem value="bun" label="bun">
+
     ```bash copy
     bun add @mastra/client-js@latest
     ```
-  </Tabs.Tab>
+
+  </TabItem>
 </Tabs>
 
 ### Initialize the `MastraClient`
 
 Once initialized with a `baseUrl`, `MastraClient` exposes a type-safe interface for calling agents, tools, and workflows.
 
-```typescript filename="lib/mastra-client.ts" showLineNumbers copy
+```typescript title="lib/mastra-client.ts" showLineNumbers copy
 import { MastraClient } from "@mastra/client-js";
 
 export const mastraClient = new MastraClient({
-  baseUrl: process.env.MASTRA_API_URL || "http://localhost:4111"
+  baseUrl: process.env.MASTRA_API_URL || "http://localhost:4111",
 });
 ```
 
@@ -72,13 +73,13 @@ export const mastraClient = new MastraClient({
 
 The Mastra Client SDK exposes all resources served by the Mastra Server
 
-- **[Agents](/reference/client-js/agents.mdx)**: Generate responses and stream conversations.
-- **[Memory](/reference/client-js/memory.mdx)**: Manage conversation threads and message history.
-- **[Tools](/reference/client-js/tools.mdx)**: Executed and managed tools.
-- **[Workflows](/reference/client-js/workflows.mdx)**: Trigger workflows and track their execution.
-- **[Vectors](/reference/client-js/vectors.mdx)**: Use vector embeddings for semantic search.
-- **[Logs](/reference/client-js/logs.mdx)**: View logs and debug system behavior.
-- **[Telemetry](/reference/client-js/telemetry.mdx)**: Monitor app performance and trace activity.
+- **[Agents](/reference/client-js/agents)**: Generate responses and stream conversations.
+- **[Memory](/reference/client-js/memory)**: Manage conversation threads and message history.
+- **[Tools](/reference/client-js/tools)**: Executed and managed tools.
+- **[Workflows](/reference/client-js/workflows)**: Trigger workflows and track their execution.
+- **[Vectors](/reference/client-js/vectors)**: Use vector embeddings for semantic search.
+- **[Logs](/reference/client-js/logs)**: View logs and debug system behavior.
+- **[Telemetry](/reference/client-js/telemetry)**: Monitor app performance and trace activity.
 
 ## Generating responses
 
@@ -95,9 +96,9 @@ const testAgent = async () => {
       messages: [
         {
           role: "user",
-          content: "Hello"
-        }
-      ]
+          content: "Hello",
+        },
+      ],
     });
 
     console.log(response.text);
@@ -107,7 +108,7 @@ const testAgent = async () => {
 };
 ```
 
-> See [.generate()](../../reference/client-js/agents.mdx#generate-response) for more information.
+> See [.generate()](/reference/client-js/agents#generate-response) for more information.
 
 ## Streaming responses
 
@@ -124,15 +125,15 @@ const testAgent = async () => {
       messages: [
         {
           role: "user",
-          content: "Hello"
-        }
-      ]
+          content: "Hello",
+        },
+      ],
     });
 
     stream.processDataStream({
       onTextPart: (text) => {
         console.log(text);
-      }
+      },
     });
   } catch (error) {
     return "Error occurred while generating response";
@@ -140,13 +141,13 @@ const testAgent = async () => {
 };
 ```
 
-> See [.stream()](../../reference/client-js/agents.mdx#stream-response) for more information.
+> See [.stream()](/reference/client-js/agents#stream-response) for more information.
 
 ## Configuration options
 
 `MastraClient` accepts optional parameters like `retries`, `backoffMs`, and `headers` to control request behavior. These parameters are useful for controlling retry behavior and including diagnostic metadata.
 
-```typescript filename="lib/mastra-client.ts" showLineNumbers copy
+```typescript title="lib/mastra-client.ts" showLineNumbers copy
 import { MastraClient } from "@mastra/client-js";
 
 export const mastraClient = new MastraClient({
@@ -160,7 +161,7 @@ export const mastraClient = new MastraClient({
 });
 ```
 
-  > See [MastraClient](../../reference/client-js/mastra-client.mdx) for more configuration options.
+> See [MastraClient](/reference/client-js/mastra-client) for more configuration options.
 
 ## Adding request cancelling
 
@@ -168,14 +169,14 @@ export const mastraClient = new MastraClient({
 
 Pass an `AbortSignal` to the client constructor to enable cancellation across all requests.
 
-```typescript {3,7} filename="lib/mastra-client.ts" showLineNumbers copy
+```typescript {3,7} title="lib/mastra-client.ts" showLineNumbers copy
 import { MastraClient } from "@mastra/client-js";
 
 export const controller = new AbortController();
 
 export const mastraClient = new MastraClient({
   baseUrl: process.env.MASTRA_API_URL || "http://localhost:4111",
-  abortSignal: controller.signal
+  abortSignal: controller.signal,
 });
 ```
 
@@ -198,8 +199,8 @@ Define tools directly in client-side applications using the `createTool()` funct
 This lets agents trigger browser-side functionality such as DOM manipulation, local storage access, or other Web APIs, enabling tool execution in the user's environment rather than on the server.
 
 ```typescript {27} showLineNumbers copy
-import { createTool } from '@mastra/client-js';
-import { z } from 'zod';
+import { createTool } from "@mastra/client-js";
+import { z } from "zod";
 
 const handleClientTool = async () => {
   try {
@@ -209,22 +210,22 @@ const handleClientTool = async () => {
       id: "color-change-tool",
       description: "Changes the HTML background color",
       inputSchema: z.object({
-        color: z.string()
+        color: z.string(),
       }),
       outputSchema: z.object({
-        success: z.boolean()
+        success: z.boolean(),
       }),
       execute: async ({ context }) => {
-        const { color } = context
+        const { color } = context;
 
         document.body.style.backgroundColor = color;
         return { success: true };
-      }
+      },
     });
 
     const response = await agent.generate({
       messages: "Change the background to blue",
-      clientTools: { colorChangeTool }
+      clientTools: { colorChangeTool },
     });
 
     console.log(response);
@@ -233,11 +234,12 @@ const handleClientTool = async () => {
   }
 };
 ```
+
 ### Client tool's agent
 
-This is a standard Mastra [agent](../agents/overview#creating-an-agent) configured to return hex color codes, intended to work with the browser-based client tool defined above.
+This is a standard Mastra [agent](../agents/overview#setting-up-agents) configured to return hex color codes, intended to work with the browser-based client tool defined above.
 
-```typescript filename="src/mastra/agents/color-agent" showLineNumbers copy
+```typescript title="src/mastra/agents/color-agent" showLineNumbers copy
 import { openai } from "@ai-sdk/openai";
 import { Agent } from "@mastra/core/agent";
 
@@ -246,7 +248,7 @@ export const colorAgent = new Agent({
   instructions: `You are a helpful CSS assistant.
   You can change the background color of web pages.
   Respond with a hex reference for the color requested by the user`,
-  model: openai("gpt-4o-mini")
+  model: openai("gpt-4o-mini"),
 });
 ```
 
@@ -259,7 +261,7 @@ export async function action() {
   const agent = mastraClient.getAgent("testAgent");
 
   const stream = await agent.stream({
-    messages: [{ role: "user", content: "Hello" }]
+    messages: [{ role: "user", content: "Hello" }],
   });
 
   return new Response(stream.body);

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

@@ -1,5 +1,5 @@
 ---
-title: "Middleware"
+title: "Middleware | Server & DB | Mastra Docs"
 description: "Apply custom middleware functions to intercept requests."
 ---
 
@@ -138,6 +138,7 @@ be inspected by middleware to tailor behaviour:
   },
 }
 ```
+
 - `x-mastra-cloud`: request originates from Mastra Cloud
 - `x-mastra-client-type`: identifies the client SDK, e.g. `js` or `python`
 - `x-mastra-dev-playground`: request triggered from a local playground
@@ -146,7 +147,7 @@ be inspected by middleware to tailor behaviour:
 
 You can populate `runtimeContext` dynamically in server middleware by extracting information from the request. In this example, the `temperature-unit` is set based on the Cloudflare `CF-IPCountry` header to ensure responses match the user's locale.
 
-```typescript filename="src/mastra/index.ts" showLineNumbers copy
+```typescript title="src/mastra/index.ts" showLineNumbers copy
 import { Mastra } from "@mastra/core/mastra";
 import { RuntimeContext } from "@mastra/core/runtime-context";
 import { testWeatherAgent } from "./agents/test-weather-agent";
@@ -159,15 +160,18 @@ export const mastra = new Mastra({
         const country = context.req.header("CF-IPCountry");
         const runtimeContext = context.get("runtimeContext");
 
-        runtimeContext.set("temperature-unit", country === "US" ? "fahrenheit" : "celsius");
+        runtimeContext.set(
+          "temperature-unit",
+          country === "US" ? "fahrenheit" : "celsius",
+        );
 
         await next();
-      }
-    ]
-  }
+      },
+    ],
+  },
 });
 ```
 
 # Related
 
-- [Runtime Context](./runtime-context.mdx)
+- [Runtime Context](./runtime-context)

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

@@ -1,5 +1,5 @@
 ---
-title: "Create A Mastra Production Server"
+title: "Create a Mastra Production Server | Server & DB | Mastra Docs"
 description: "Learn how to configure and deploy a production-ready Mastra server with custom settings for APIs, CORS, and more"
 ---
 
@@ -29,7 +29,7 @@ adding additional server behaviour.
 
 You can configure server `port` and `timeout` in the Mastra instance.
 
-```typescript filename="src/mastra/index.ts" copy showLineNumbers
+```typescript title="src/mastra/index.ts" copy showLineNumbers
 import { Mastra } from "@mastra/core/mastra";
 
 export const mastra = new Mastra({
@@ -49,7 +49,7 @@ invoked for any HTTP method that matches the path.
 
 Mastra requires `module` and `moduleResolution` values that support modern Node.js versions. Older settings like `CommonJS` or `node` are incompatible with Mastra’s packages and will cause resolution errors.
 
-```json {4-5} filename="tsconfig.json" copy
+```json {4-5} title="tsconfig.json" copy
 {
   "compilerOptions": {
     "target": "ES2022",
@@ -62,9 +62,7 @@ Mastra requires `module` and `moduleResolution` values that support modern Node.
     "noEmit": true,
     "outDir": "dist"
   },
-  "include": [
-    "src/**/*"
-  ]
+  "include": ["src/**/*"]
 }
 ```
 
@@ -74,7 +72,7 @@ Mastra requires `module` and `moduleResolution` values that support modern Node.
 
 Mastra allows you to configure CORS (Cross-Origin Resource Sharing) settings for your server.
 
-```typescript filename="src/mastra/index.ts" copy showLineNumbers
+```typescript title="src/mastra/index.ts" copy showLineNumbers
 import { Mastra } from "@mastra/core/mastra";
 
 export const mastra = new Mastra({

package/.docs/raw/server-db/runtime-context.mdx

@@ -1,10 +1,8 @@
 ---
-title: "Runtime Context | Agents | Mastra Docs"
+title: "Runtime Context | Server & DB | Mastra Docs"
 description: Learn how to use Mastra's RuntimeContext to provide dynamic, request-specific configuration to agents.
 ---
 
-import { Callout } from "nextra/components";
-
 # Runtime Context
 
 Agents, tools, and workflows can all accept `RuntimeContext` as a parameter, making request-specific values available to the underlying primitives.
@@ -13,11 +11,13 @@ Agents, tools, and workflows can all accept `RuntimeContext` as a parameter, mak
 
 Use `RuntimeContext` when a primitive’s behavior should change based on runtime conditions. For example, you might switch models or storage backends based on user attributes, or adjust instructions and tool selection based on language.
 
-<Callout>
-  **Note:** `RuntimeContext` is primarily used for passing data into specific
-  requests. It's distinct from agent memory, which handles conversation
-  history and state persistence across multiple calls.
-</Callout>
+:::note
+
+**Note:** `RuntimeContext` is primarily used for passing data into specific
+requests. It's distinct from agent memory, which handles conversation
+history and state persistence across multiple calls.
+
+:::
 
 ## Setting values
 
@@ -40,33 +40,33 @@ runtimeContext.set("user-tier", "enterprise");
 
 const agent = mastra.getAgent("weatherAgent");
 await agent.generate("What's the weather in London?", {
-  runtimeContext
-})
+  runtimeContext,
+});
 
 const routingAgent = mastra.getAgent("routingAgent");
 routingAgent.network("What's the weather in London?", {
-  runtimeContext
+  runtimeContext,
 });
 
 const run = await mastra.getWorkflow("weatherWorkflow").createRunAsync();
 await run.start({
   inputData: {
-    location: "London"
+    location: "London",
   },
-  runtimeContext
+  runtimeContext,
 });
 await run.resume({
   resumeData: {
-    city: "New York"
+    city: "New York",
   },
-  runtimeContext
+  runtimeContext,
 });
 
 await weatherTool.execute({
   context: {
-    location: "London"
+    location: "London",
   },
-  runtimeContext
+  runtimeContext,
 });
 ```
 
@@ -74,7 +74,7 @@ await weatherTool.execute({
 
 You can populate `runtimeContext` dynamically in server middleware by extracting information from the request. In this example, the `temperature-unit` is set based on the Cloudflare `CF-IPCountry` header to ensure responses match the user's locale.
 
-```typescript filename="src/mastra/index.ts" showLineNumbers copy
+```typescript title="src/mastra/index.ts" showLineNumbers copy
 import { Mastra } from "@mastra/core/mastra";
 import { RuntimeContext } from "@mastra/core/runtime-context";
 import { testWeatherAgent } from "./agents/test-weather-agent";
@@ -87,22 +87,25 @@ export const mastra = new Mastra({
         const country = context.req.header("CF-IPCountry");
         const runtimeContext = context.get("runtimeContext");
 
-        runtimeContext.set("temperature-unit", country === "US" ? "fahrenheit" : "celsius");
+        runtimeContext.set(
+          "temperature-unit",
+          country === "US" ? "fahrenheit" : "celsius",
+        );
 
         await next();
-      }
-    ]
-  }
+      },
+    ],
+  },
 });
 ```
 
-> See [Middleware](../server-db/middleware.mdx) for how to use server middleware.
+> See [Middleware](/docs/server-db/middleware) for how to use server middleware.
 
 ## Accessing values with agents
 
 You can access the `runtimeContext` argument from any supported configuration options in agents. These functions can be sync or `async`. Use the `.get()` method to read values from `runtimeContext`.
 
-```typescript {7-8,15,18,21} filename="src/mastra/agents/weather-agent.ts" showLineNumbers
+```typescript {7-8,15,18,21} title="src/mastra/agents/weather-agent.ts" showLineNumbers
 export type UserTier = {
   "user-tier": "enterprise" | "pro";
 };
@@ -131,13 +134,13 @@ export const weatherAgent = new Agent({
 
 You can also use `runtimeContext` with other options like `agents`, `workflows`, `scorers`, `inputProcessors`, and `outputProcessors`.
 
-> 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.
 
 ## Accessing values from workflow steps
 
 You can access the `runtimeContext` argument from a workflow step's `execute` function. This function can be sync or async. Use the `.get()` method to read values from `runtimeContext`.
 
-```typescript {7-8} filename="src/mastra/workflows/weather-workflow.ts" showLineNumbers copy
+```typescript {7-8} title="src/mastra/workflows/weather-workflow.ts" showLineNumbers copy
 export type UserTier = {
   "user-tier": "enterprise" | "pro";
 };
@@ -151,17 +154,17 @@ const stepOne = createStep({
       // ...
     }
     // ...
-  }
+  },
 });
 ```
 
-> See [createStep()](../../reference/workflows/step.mdx) for a full list of configuration options.
+> See [createStep()](/reference/workflows/step) for a full list of configuration options.
 
 ## Accessing values with tools
 
-You can access the `runtimeContext` argument from a tool’s `execute` function. This function is `async`.  Use the `.get()` method to read values from `runtimeContext`.
+You can access the `runtimeContext` argument from a tool’s `execute` function. This function is `async`. Use the `.get()` method to read values from `runtimeContext`.
 
-```typescript {7-8} filename="src/mastra/tools/weather-tool.ts" showLineNumbers
+```typescript {7-8} title="src/mastra/tools/weather-tool.ts" showLineNumbers
 export type UserTier = {
   "user-tier": "enterprise" | "pro";
 };
@@ -174,17 +177,17 @@ export const weatherTool = createTool({
     if (userTier === "enterprise") {
       // ...
     }
-   // ...
-  }
+    // ...
+  },
 });
 ```
 
-> See [createTool()](../../reference/tools/create-tool.mdx) for a full list of configuration options.
+> See [createTool()](/reference/tools/create-tool) for a full list of configuration options.
 
 ## Related
 
-- [Runtime Context Example](../../examples/agents/runtime-context.mdx)
-- [Agent Runtime Context](../agents/overview.mdx#using-runtimecontext)
-- [Workflow Runtime Context](../workflows/overview.mdx#using-runtimecontext)
-- [Tool Runtime Context](../tools-mcp/overview.mdx#using-runtimecontext)
-- [Server Middleware Runtime Context](../server-db/middleware.mdx)
+- [Runtime Context Example](/examples/agents/runtime-context)
+- [Agent Runtime Context](/docs/agents/overview#using-runtimecontext)
+- [Workflow Runtime Context](../workflows/overview#using-runtimecontext)
+- [Tool Runtime Context](../tools-mcp/overview#using-runtimecontext)
+- [Server Middleware Runtime Context](/docs/server-db/middleware)