@mastra/mcp-docs-server 0.13.4 → 0.13.5

package/.docs/raw/reference/agents/stream.mdx

@@ -271,10 +271,11 @@ Configuration options for memory management:
           parameters: [
             {
               name: "generateTitle",
-              type: "boolean | { model: LanguageModelV1 | ((ctx: RuntimeContext) => LanguageModelV1 | Promise<LanguageModelV1>) }",
+              type: "boolean | { model: LanguageModelV1 | ((ctx: RuntimeContext) => LanguageModelV1 | Promise<LanguageModelV1>), instructions: string | ((ctx: RuntimeContext) => string | Promise<string>) }",
               isOptional: true,
               description:
-                "Controls automatic thread title generation from the user's first message. Can be a boolean to enable/disable using the agent's model, or an object with a custom model for title generation (useful for cost optimization). Example: { model: openai('gpt-4.1-nano') }",
+                `Controls automatic thread title generation from the user's first message. Can be a boolean to enable/disable using the agent's model, or an object specifying a custom model and/or custom instructions for title generation (useful for cost optimization or title customization).
+Example: { model: openai('gpt-4.1-nano'), instructions: 'Generate a concise title based on the initial user message.' }`,
             },
           ],
         },

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

@@ -48,6 +48,18 @@ mastra dev [options]
       description: "Path to custom environment file",
       isOptional: true,
     },
+    {
+      name: "--inspect",
+      type: "boolean", 
+      description: "Start the dev server in inspect mode for debugging (cannot be used with --inspect-brk)",
+      isOptional: true,
+    },
+    {
+      name: "--inspect-brk",
+      type: "boolean",
+      description: "Start the dev server in inspect mode and break at the beginning of the script (cannot be used with --inspect)",
+      isOptional: true,
+    },
     {
       name: "--help",
       type: "boolean",

package/.docs/raw/reference/legacyWorkflows/createRun.mdx

@@ -74,7 +74,3 @@ try {
 - [Workflow Class Reference](./workflow.mdx)
 - [Step Class Reference](./step-class.mdx)
 - See the [Creating a Workflow](../../examples/workflows_legacy/creating-a-workflow.mdx) example for complete usage
-
-```
-
-```

package/.docs/raw/reference/memory/Memory.mdx

@@ -63,6 +63,7 @@ const memory = new Memory({
       // Or use a different model for title generation
       // generateTitle: {
       //   model: openai("gpt-4.1-nano"), // Use cheaper model for titles
+      //   instructions: "Generate a concise title based on the initial user message.", // Custom instructions for title
       // },
     },
   },
@@ -109,9 +110,9 @@ const memory = new Memory({
 });
 ```
 
-#### Cost Optimization with Custom Models
+#### Cost Optimization with Custom Models and Instructions
 
-You can specify a different (typically cheaper) model for title generation while using a high-quality model for the main conversation:
+You can specify a different (typically cheaper) model and custom instructions for title generation while using a high-quality model for the main conversation:
 
 ```typescript copy showLineNumbers
 import { openai } from "@ai-sdk/openai";
@@ -121,6 +122,7 @@ const memory = new Memory({
     threads: {
       generateTitle: {
         model: openai("gpt-4.1-nano"), // Cheaper model for titles
+        instructions: "Generate a concise, friendly title based on the initial user message.", // Custom title instructions
       },
     },
   },
@@ -132,9 +134,9 @@ const agent = new Agent({
 });
 ```
 
-#### Dynamic Model Selection
+#### Dynamic Model Selection and Instructions
 
-You can also use a function to dynamically determine the model based on runtime context:
+You can also use a function to dynamically determine the model and instructions based on runtime context:
 
 ```typescript copy showLineNumbers
 const memory = new Memory({
@@ -148,6 +150,10 @@ const memory = new Memory({
             ? openai("gpt-4.1")
             : openai("gpt-4.1-nano");
         },
+        instructions: (ctx: RuntimeContext) => {
+          const language = ctx.get("userLanguage") || "English";
+          return `Generate a concise, engaging title in ${language} based on the user's first message.`;
+        },
       },
     },
   },
@@ -285,9 +291,9 @@ Mastra supports many embedding models through the [Vercel AI SDK](https://sdk.ve
     },
     {
       name: "threads",
-      type: "{ generateTitle?: boolean | { model: LanguageModelV1 | ((ctx: RuntimeContext) => LanguageModelV1 | Promise<LanguageModelV1>) } }",
+      type: "{ generateTitle?: boolean | { model: LanguageModelV1 | ((ctx: RuntimeContext) => LanguageModelV1 | Promise<LanguageModelV1>), instructions?: string | ((ctx: RuntimeContext) => string | Promise<string>) } }",
       description:
-        "Settings related to memory thread creation. `generateTitle` controls automatic thread title generation from the user's first message. Can be a boolean to enable/disable using the agent's model, or an object with a custom model for title generation (useful for cost optimization). Example: { generateTitle: { model: openai('gpt-4.1-nano') } }",
+        "Settings related to memory thread creation. `generateTitle` controls automatic thread title generation from the user's first message. Can be a boolean to enable/disable using the agent's model, or an object specifying a custom model or custom instructions for title generation (useful for cost optimization or title customization). Example: { generateTitle: { model: openai('gpt-4.1-nano'), instructions: 'Concise title based on the initial user message.' } }",
       isOptional: true,
       defaultValue: "{ generateTitle: false }",
     },

package/.docs/raw/reference/rag/rerankWithScorer.mdx

@@ -0,0 +1,213 @@
+---
+title: "Reference: Rerank | Document Retrieval | RAG | Mastra Docs"
+description: Documentation for the rerank function in Mastra, which provides advanced reranking capabilities for vector search results.
+---
+
+# rerankWithScorer()
+
+The `rerankWithScorer()` function provides advanced reranking capabilities for vector search results by combining semantic relevance, vector similarity, and position-based scoring.
+
+```typescript
+function rerankWithScorer({
+  results: QueryResult[],
+  query: string,
+  scorer: RelevanceScoreProvider,
+  options?: RerankerFunctionOptions,
+}): Promise<RerankResult[]>;
+```
+
+## Usage Example
+
+```typescript
+import { openai } from "@ai-sdk/openai";
+import { rerankWithScorer as rerank, CohereRelevanceScorer } from "@mastra/rag";
+
+const scorer = new CohereRelevanceScorer('rerank-v3.5');
+
+const rerankedResults = await rerank({
+  results: vectorSearchResults,
+  query: "How do I deploy to production?",
+  scorer,
+  options: {
+    weights: {
+      semantic: 0.5,
+      vector: 0.3,
+      position: 0.2,
+    },
+    topK: 3,
+  },
+});
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "results",
+      type: "QueryResult[]",
+      description: "The vector search results to rerank",
+      isOptional: false,
+    },
+    {
+      name: "query",
+      type: "string",
+      description: "The search query text used to evaluate relevance",
+      isOptional: false,
+    },
+    {
+      name: "scorer",
+      type: "RelevanceScoreProvider",
+      description: "The relevance scorer to use for reranking",
+      isOptional: false,
+    },
+    {
+      name: "options",
+      type: "RerankerFunctionOptions",
+      description: "Options for the reranking model",
+      isOptional: true,
+    },
+  ]}
+/>
+
+The `rerankWithScorer` function accepts any `RelevanceScoreProvider` from @mastra/rag.
+
+> **Note:** For semantic scoring to work properly during re-ranking, each result must include the text content in its `metadata.text` field.
+
+### RerankerFunctionOptions
+
+<PropertiesTable
+  content={[
+    {
+      name: "weights",
+      type: "WeightConfig",
+      description:
+        "Weights for different scoring components (must add up to 1)",
+      isOptional: true,
+      properties: [
+        {
+          type: "number",
+          parameters: [
+            {
+              name: "semantic",
+              description: "Weight for semantic relevance",
+              isOptional: true,
+              type: "number (default: 0.4)",
+            },
+          ],
+        },
+        {
+          type: "number",
+          parameters: [
+            {
+              name: "vector",
+              description: "Weight for vector similarity",
+              isOptional: true,
+              type: "number (default: 0.4)",
+            },
+          ],
+        },
+        {
+          type: "number",
+          parameters: [
+            {
+              name: "position",
+              description: "Weight for position-based scoring",
+              isOptional: true,
+              type: "number (default: 0.2)",
+            },
+          ],
+        },
+      ],
+    },
+    {
+      name: "queryEmbedding",
+      type: "number[]",
+      description: "Embedding of the query",
+      isOptional: true,
+    },
+    {
+      name: "topK",
+      type: "number",
+      description: "Number of top results to return",
+      isOptional: true,
+      defaultValue: "3",
+    },
+  ]}
+/>
+
+## Returns
+
+The function returns an array of `RerankResult` objects:
+
+<PropertiesTable
+  content={[
+    {
+      name: "result",
+      type: "QueryResult",
+      description: "The original query result",
+    },
+    {
+      name: "score",
+      type: "number",
+      description: "Combined reranking score (0-1)",
+    },
+    {
+      name: "details",
+      type: "ScoringDetails",
+      description: "Detailed scoring information",
+    },
+  ]}
+/>
+
+### ScoringDetails
+
+<PropertiesTable
+  content={[
+    {
+      name: "semantic",
+      type: "number",
+      description: "Semantic relevance score (0-1)",
+    },
+    {
+      name: "vector",
+      type: "number",
+      description: "Vector similarity score (0-1)",
+    },
+    {
+      name: "position",
+      type: "number",
+      description: "Position-based score (0-1)",
+    },
+    {
+      name: "queryAnalysis",
+      type: "object",
+      description: "Query analysis details",
+      isOptional: true,
+      properties: [
+        {
+          type: "number",
+          parameters: [
+            {
+              name: "magnitude",
+              description: "Magnitude of the query",
+            },
+          ],
+        },
+        {
+          type: "number[]",
+          parameters: [
+            {
+              name: "dominantFeatures",
+              description: "Dominant features of the query",
+            },
+          ],
+        },
+      ],
+    },
+  ]}
+/>
+
+## Related
+
+- [createVectorQueryTool](../tools/vector-query-tool)

package/.docs/raw/reference/workflows/create-run.mdx

@@ -1,11 +1,11 @@
 ---
-title: "Reference: Workflow.createRun() | Building Workflows | Mastra Docs"
-description: Documentation for the `.createRun()` method in workflows, which creates a new workflow run instance.
+title: "Reference: Workflow.createRunAsync() | Building Workflows | Mastra Docs"
+description: Documentation for the `.createRunAsync()` method in workflows, which creates a new workflow run instance.
 ---
 
-# Workflow.createRun()
+# Workflow.createRunAsync()
 
-The `.createRun()` method creates a new workflow run instance, allowing you to execute the workflow with specific input data.
+The `.createRunAsync()` method creates a new workflow run instance, allowing you to execute the workflow with specific input data.
 
 ## Usage
 

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

@@ -0,0 +1,49 @@
+---
+title: "Reference: Workflow.sendEvent() | Building Workflows | Mastra Docs"
+description: Documentation for the `.sendEvent()` method in workflows, which resumes execution when an event is sent.
+---
+
+# Workflow.sendEvent()
+
+The `.sendEvent()` resumes execution when an event is sent.
+
+## Usage
+
+```typescript
+workflow.sendEvent('my-event-name', step1);
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "eventName",
+      type: "string",
+      description: "The name of the event to send",
+      isOptional: false,
+    },
+    {
+      name: "step",
+      type: "Step",
+      description: "The step to resume after the event is sent",
+      isOptional: false,
+    },
+  ]}
+/>
+
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: "workflow",
+      type: "Workflow",
+      description: "The workflow instance for method chaining",
+    },
+  ]}
+/>
+
+## Related
+
+- [Sleep & Events](../../docs/workflows/pausing-execution.mdx)

package/.docs/raw/{local-dev/mastra-dev.mdx → server-db/local-dev-playground.mdx}

@@ -4,6 +4,7 @@ description: Documentation for the Mastra local development environment for Mast
 ---
 
 import YouTube from "@/components/youtube";
+import { VideoPlayer } from "@/components/video-player"
 import { Tabs, Tab } from "@/components/tabs";
 
 # Playground
@@ -42,7 +43,9 @@ The Playground lets you interact with your agents, workflows, and tools. It prov
 
 Quickly test and debug your agents during development using the interactive chat interface in the Agent Playground.
 
-![Agents Playground](/image/local-dev/local-dev-agents-playground.jpg)
+<VideoPlayer
+  src="https://res.cloudinary.com/dygi6femd/video/upload/v1751406022/local-dev-agents-playground_100_m3begx.mp4"
+/>
 
 Key features:
 
@@ -56,7 +59,9 @@ Key features:
 
 Validate workflows by supplying defined inputs and visualizing each step within the Workflow Playground.
 
-![Workflows Playground](/image/local-dev/local-dev-workflow-playground.jpg)
+<VideoPlayer
+  src="https://res.cloudinary.com/dygi6femd/video/upload/v1751406027/local-dev-workflows-playground_100_rbc466.mp4"
+/>
 
 Key features:
 
@@ -70,7 +75,9 @@ Key features:
 
 Quickly test and debug custom tools in isolation using the Tools Playground, without running a full agent or workflow.
 
-![Tools Playground](/image/local-dev/local-dev-tools-playground.jpg)
+<VideoPlayer
+  src="https://res.cloudinary.com/dygi6femd/video/upload/v1751406316/local-dev-agents-tools_100_fe1jdt.mp4"
+/>
 
 Key features:
 

package/.docs/raw/{client-js/overview.mdx → server-db/mastra-client.mdx}

@@ -78,6 +78,22 @@ const client = new MastraClient({
 });
 ```
 
+## AbortSignal
+
+The Mastra Client SDK supports request cancellation using the standard Web API `AbortSignal`. Pass an `AbortSignal` to the client constructor to enable cancellation for all requests:
+
+```typescript
+const controller = new AbortController();
+
+const client = new MastraClient({
+  baseUrl: "http://localhost:4111",
+  abortSignal: controller.signal,
+});
+
+// Cancel all requests from this client
+controller.abort();
+```
+
 ## Example
 
 Once your MastraClient is initialized you can start making client calls via the type-safe

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

@@ -0,0 +1,66 @@
+---
+title: "Create A Mastra Production Server"
+description: "Learn how to configure and deploy a production-ready Mastra server with custom settings for APIs, CORS, and more"
+---
+
+# Create a Mastra Production Server
+
+When deploying your Mastra application to production, it runs as an HTTP server that exposes your agents, workflows, and other functionality as API endpoints. This page covers how to configure and customize the server for a production environment.
+
+## Server Architecture
+
+Mastra uses [Hono](https://hono.dev) as its underlying HTTP server framework. When you build a Mastra application using `mastra build`, it generates a Hono-based HTTP server in the `.mastra` directory.
+
+The server provides:
+
+- API endpoints for all registered agents
+- API endpoints for all registered workflows
+- Custom API route support
+- Custom middleware support
+- Configuration of timeout
+- Configuration of port
+- Configuration of body limit
+
+See the [Middleware](/docs/server-db/middleware) and
+[Custom API Routes](/docs/server-db/custom-api-routes) pages for details on
+adding additional server behaviour.
+
+## Server configuration
+
+You can configure server `port` and `timeout` in the Mastra instance.
+
+```typescript filename="src/mastra/index.ts" copy showLineNumbers
+import { Mastra } from "@mastra/core/mastra";
+
+export const mastra = new Mastra({
+  // ...
+  server: {
+    port: 3000, // Defaults to 4111
+    timeout: 10000, // Defaults to 30000 (30s)
+  },
+});
+```
+
+The `method` option can be one of `"GET"`, `"POST"`, `"PUT"`,
+`"DELETE"` or `"ALL"`. Using `"ALL"` will cause the handler to be
+invoked for any HTTP method that matches the path.
+
+## Custom CORS Config
+
+Mastra allows you to configure CORS (Cross-Origin Resource Sharing) settings for your server.
+
+```typescript filename="src/mastra/index.ts" copy showLineNumbers
+import { Mastra } from "@mastra/core/mastra";
+
+export const mastra = new Mastra({
+  // ...
+  server: {
+    cors: {
+      origin: ["https://example.com"], // Allow specific origins or '*' for all
+      allowMethods: ["GET", "POST", "PUT", "DELETE", "OPTIONS"],
+      allowHeaders: ["Content-Type", "Authorization"],
+      credentials: false,
+    },
+  },
+});
+```

package/.docs/raw/tools-mcp/mcp-overview.mdx

@@ -313,7 +313,7 @@ Workflows will use their `inputSchema` for the tool's input.
 
 You can define an `outputSchema` for your tools to enforce a specific structure for the tool's output. This is useful for ensuring that the tool returns data in a consistent and predictable format, which can then be validated by the client.
 
-When a tool includes an `outputSchema`, its `execute` function **must** return an object containing a `structuredContent` property. The value of `structuredContent` must conform to the `outputSchema`. Mastra will automatically validate this output on both the server and client sides.
+When a tool includes an `outputSchema`, its `execute` function **must** return an object. The value of the object must conform to the `outputSchema`. Mastra will automatically validate this output on both the server and client sides.
 
 Here's an example of a tool with an `outputSchema`:
 
@@ -331,12 +331,10 @@ export const structuredTool = createTool({
     timestamp: z.string().describe('An ISO timestamp.'),
   }),
   execute: async ({ input }) => {
-    // When outputSchema is defined, you must return a structuredContent object
+    // When outputSchema is defined, you must return an object
     return {
-      structuredContent: {
-        processedInput: `processed: ${input}`,
-        timestamp: new Date().toISOString(),
-      },
+      processedInput: `processed: ${input}`,
+      timestamp: new Date().toISOString(),
     };
   },
 });