@mastra/mcp-docs-server 0.13.4-alpha.0 → 0.13.5-alpha.0

package/.docs/raw/frameworks/agentic-uis/assistant-ui.mdx

@@ -69,6 +69,40 @@ You now have a basic Mastra server project ready. You should have the following
 Ensure that you have set the appropriate environment variables for your LLM provider in the `.env` file.
 </Callout>
 
+### Compatibility Fix
+
+Currently, to ensure proper compatibility between Mastra and Assistant UI, you need to setup server middleware. Update your `/mastra/index.ts` file with the following configuration:
+
+```typescript showLineNumbers copy filename="src/mastra/index.ts"
+export const mastra = new Mastra({
+  //mastra server middleware
+  server:{
+  middleware: [{
+    path: '/api/agents/*/stream',
+    handler: async (c,next)=>{
+    
+      const body = await c.req.json();
+  
+      if ('state' in body && body.state == null) {
+        delete body.state;
+        delete body.tools;
+      }
+  
+       c.req.json = async() => body;
+  
+      return next()
+    }
+  }]
+ },
+});
+```
+
+This middleware ensures that when Assistant UI sends a request with `state: null` and `tools: {}` in the request body, we remove those properties to make the request work properly with Mastra.
+
+<Callout type="info">
+The `state: null` property can cause errors like `Cannot use 'in' operator to search for 'input' in null` in Mastra. Additionally, passing `tools: {}` overrides Mastra's built-in tools. Mastra only supports `clientTools` via the Mastra client SDK from the client side. For more information about client tools, see the [Client Tools documentation](/reference/client-js/agents#client-tools).
+</Callout>
+
 ### Run the Mastra Server
 
 Run the Mastra server using the following command:

package/.docs/raw/local-dev/mastra-dev.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/memory/overview.mdx

@@ -96,7 +96,7 @@ const memory = new Memory({
 });
 ```
 
-By default, title generation uses the same model as your agent. For cost optimization, you can specify a cheaper model specifically for title generation:
+By default, title generation uses the same model and default instructions as your agent. For customization or cost optimization, you can specify a different model or provide custom instructions specifically for title generation:
 
 ```typescript {5-7}
 const memory = new Memory({
@@ -104,6 +104,7 @@ const memory = new Memory({
     threads: {
       generateTitle: {
         model: openai("gpt-4.1-nano"), // Use cheaper model for titles
+        instructions: "Generate a concise title for this conversation based on the first user message.",
       },
     },
   },

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

@@ -265,10 +265,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/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/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/workflows/overview.mdx

@@ -176,7 +176,7 @@ console.log(JSON.stringify(result, null, 2));
 
 To trigger this workflow, run the following:
 
-```bash
+```bash copy
 npx tsx src/test-workflow.ts
 ```
 

package/.docs/raw/workflows/pausing-execution.mdx

@@ -5,56 +5,93 @@ description: "Pausing execution in Mastra workflows allows you to pause executio
 
 # Sleep & Events
 
-Pausing execution in Mastra workflows allows you to pause execution while waiting for external input or resources via `sleep()`, `sleepUntil()` and `waitForEvent()`.
+Mastra lets you pause workflow execution when waiting for external input or timing conditions. This can be useful for things like polling, delayed retries, or waiting on user actions.
 
-This sets the workflow status to `waiting`.
+You can pause execution using:
 
-## sleep()
+- `sleep()`: Pause for a set number of milliseconds
+- `sleepUntil()`: Pause until a specific timestamp
+- `waitForEvent()`: Pause until an external event is received
+- `sendEvent()`: Send an event to resume a waiting workflow
 
-`sleep()` pauses execution for a specified number of milliseconds.
+When using any of these methods, the workflow status is set to `waiting` until execution resumes.
 
-```typescript
-workflow
-    .then(step1)
-    .sleep(1000)
-    .then(step2)
-    .commit();
+## sleep
+
+The `sleep()` method pauses execution between steps for a specified number of milliseconds.
+
+```typescript {9} filename="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
+import { createWorkflow, createStep } from "@mastra/core/workflows";
+import { z } from "zod";
+
+const step1 = createStep({...});
+const step2 = createStep({...});
+
+export const testWorkflow = createWorkflow({...})
+  .then(step1)
+  .sleep(1000)
+  .then(step2)
+  .commit();
 ```
 
-## sleepUntil()
+## sleepUntil
 
-`sleepUntil()` pauses execution until a specified date.
+The `sleepUntil()` method pauses execution between steps until a specified date.
 
-```typescript
-workflow
-    .then(step1)
-    .sleepUntil(new Date(Date.now() + 1000))
-    .then(step2)
-    .commit();
+```typescript {9} filename="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
+import { createWorkflow, createStep } from "@mastra/core/workflows";
+import { z } from "zod";
+
+const step1 = createStep({...});
+const step2 = createStep({...});
+
+export const testWorkflow = createWorkflow({...})
+  .then(step1)
+  .sleepUntil(new Date(Date.now() + 5000))
+  .then(step2)
+  .commit();
 ```
 
-## waitForEvent()
+> `Date.now()` is evaluated when the workflow starts, not at the moment the `sleepUntil()` method is called.
 
-`waitForEvent()` pauses execution until an event is received. Events can be sent to the workflow using `run.sendEvent()`. The event name and the step to resume after the event is received are provided as arguments to `waitForEvent()`.
+## waitForEvent
 
-`.sendEvent()` takes as arguments the event name and the event data. The event data is optional and can be any JSON-serializable value.
+The `waitForEvent()` method pauses execution until a specific event is received. Use `run.sendEvent()` to send the event. You must provide both the event name and the step to resume.
 
-```typescript
-workflow
-    .then(step1)
-    .waitForEvent('my-event-name', step2)
-    .then(step3)
-    .commit();
+```typescript {10} filename="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
+import { createWorkflow, createStep } from "@mastra/core/workflows";
+import { z } from "zod";
 
-const run = await workflow.createRunAsync()
-run.start({})
+const step1 = createStep({...});
+const step2 = createStep({...});
+const step3 = createStep({...});
+
+export const testWorkflow = createWorkflow({...})
+  .then(step1)
+  .waitForEvent("my-event-name", step2)
+  .then(step3)
+  .commit();
+```
+## sendEvent
+
+The `.sendEvent()` method sends an event to the workflow. It accepts the event name and optional event data, which can be any JSON-serializable value.
+
+```typescript {5,12,15} filename="src/test-workflow.ts" showLineNumbers copy
+import { mastra } from "./mastra";
+
+const run = await mastra.getWorkflow("testWorkflow").createRunAsync();
+
+const result = run.start({
+  inputData: {
+    value: "hello"
+  }
+});
 
 setTimeout(() => {
-    run.sendEvent('my-event-name', {
-        data1: 'hello',
-        data2: {
-            anyData: 12
-        }
-    })
-}, 2e3)
-```
+  run.sendEvent("my-event-name", { value: "from event" });
+}, 3000);
+
+console.log(JSON.stringify(await result, null, 2));
+```
+
+> In this example, avoid using `await run.start()` directly, it would block sending the event before the workflow reaches its waiting state.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/mcp-docs-server",
-  "version": "0.13.4-alpha.0",
+  "version": "0.13.5-alpha.0",
   "description": "MCP server for accessing Mastra.ai documentation, changelogs, and news.",
   "type": "module",
   "main": "dist/index.js",
@@ -32,7 +32,7 @@
     "uuid": "^11.1.0",
     "zod": "^3.25.67",
     "zod-to-json-schema": "^3.24.5",
-    "@mastra/mcp": "^0.10.5"
+    "@mastra/mcp": "^0.10.6-alpha.0"
   },
   "devDependencies": {
     "@hono/node-server": "^1.14.4",
@@ -42,13 +42,13 @@
     "@wong2/mcp-cli": "^1.10.0",
     "cross-env": "^7.0.3",
     "eslint": "^9.29.0",
-    "hono": "^4.8.3",
+    "hono": "^4.8.4",
     "tsup": "^8.5.0",
     "tsx": "^4.19.4",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4",
-    "@internal/lint": "0.0.16",
-    "@mastra/core": "0.10.10-alpha.0"
+    "@internal/lint": "0.0.17",
+    "@mastra/core": "0.10.11-alpha.2"
   },
   "peerDependencies": {
     "@mastra/core": "^0.10.0-alpha.0"