@mastra/mcp-docs-server 0.13.31 → 0.13.32-alpha.0

package/.docs/raw/reference/scorers/toxicity.mdx

@@ -124,10 +124,9 @@ A toxicity score between 0 and 1:
 In this example, the response contains explicit personal attacks and harmful language, resulting in a high toxicity score.
 
 ```typescript filename="src/example-high-toxicity.ts" showLineNumbers copy
-import { openai } from "@ai-sdk/openai";
 import { createToxicityScorer } from "@mastra/evals/scorers/llm";
 
-const scorer = createToxicityScorer({ model: openai("gpt-4o-mini") });
+const scorer = createToxicityScorer({ model: 'openai/gpt-4o-mini' });
 
 const query = 'What do you think about the new team member?';
 const response = 'That incompetent fool is a complete waste of space. They clearly bought their degree and have no business being here. Everyone hates working with them.';
@@ -157,10 +156,9 @@ The scorer returns a high score indicating severe toxic content. The `reason` fi
 In this example, the response combines toxic and professional elements. The scorer identifies the problematic language while acknowledging the constructive feedback, resulting in a moderate toxicity score.
 
 ```typescript filename="src/example-mixed-toxicity.ts" showLineNumbers copy
-import { openai } from "@ai-sdk/openai";
 import { createToxicityScorer } from "@mastra/evals/scorers/llm";
 
-const scorer = createToxicityScorer({ model: openai("gpt-4o-mini") });
+const scorer = createToxicityScorer({ model: 'openai/gpt-4o-mini' });
 
 const query = 'How was the meeting discussion?';
 const response = [
@@ -193,10 +191,9 @@ The scorer returns a moderate score reflecting a combination of dismissive langu
 In this example, the response is professional and constructive, with no toxic or harmful language detected.
 
 ```typescript filename="src/example-no-toxicity.ts" showLineNumbers copy
-import { openai } from "@ai-sdk/openai";
 import { createToxicityScorer } from "@mastra/evals/scorers/llm";
 
-const scorer = createToxicityScorer({ model: openai("gpt-4o-mini") });
+const scorer = createToxicityScorer({ model: 'openai/gpt-4o-mini' });
 
 const query = 'Can you provide feedback on the project proposal?';
 const response = 'The proposal has strong points in its technical approach but could benefit from more detailed market analysis. I suggest we collaborate with the research team to strengthen these sections.';

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

@@ -120,7 +120,7 @@ const step1 = createStep({
     },
     {
       name: "suspend",
-      type: "() => Promise<void>",
+      type: "(suspendPayload: any, suspendOptions?: { resumeLabel?: string }) => Promise<void>",
       description: "Function to pause workflow execution",
     },
     {

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

@@ -10,7 +10,7 @@ The `.sendEvent()` resumes execution when an event is sent.
 ## Usage example
 
 ```typescript copy
-workflow.sendEvent('event-name', step1);
+run.sendEvent('event-name', { value: "data" });
 ```
 
 ## Parameters
@@ -44,6 +44,27 @@ workflow.sendEvent('event-name', step1);
   ]}
 />
 
+## Extended usage example
+
+```typescript showLineNumbers copy
+import { mastra } from "./mastra";
+
+const run = await mastra.getWorkflow("testWorkflow").createRunAsync();
+
+const result = run.start({
+  inputData: {
+    value: "hello"
+  }
+});
+
+setTimeout(() => {
+  run.sendEvent("event-name", { value: "from event" });
+}, 3000);
+```
+
+> In this example, avoid using `await run.start()` directly, as it would block sending the event before the workflow reaches its waiting state.
+
 ## Related
 
-- [Sleep & Events](../../../docs/workflows/pausing-execution.mdx)
+- [.waitForEvent()](./waitForEvent.mdx)
+- [Suspend & Resume](../../../docs/workflows/suspend-and-resume.mdx#sleep--events)

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

@@ -5,7 +5,7 @@ description: Documentation for the `Workflow.sleep()` method in workflows, which
 
 # Workflow.sleep()
 
-The `.sleep()` method pauses execution for a specified number of milliseconds.
+The `.sleep()` method pauses execution for a specified number of milliseconds. It accepts either a static number or a callback function for dynamic delays.
 
 ## Usage example
 
@@ -19,8 +19,8 @@ workflow.sleep(5000);
   content={[
     {
       name: "milliseconds",
-      type: "number",
-      description: "The number of milliseconds to pause execution",
+      type: "number | ((context: { inputData: any }) => number | Promise<number>)",
+      description: "The number of milliseconds to pause execution, or a callback that returns the delay",
       isOptional: false,
     },
   ]}
@@ -38,6 +38,24 @@ workflow.sleep(5000);
   ]}
 />
 
+## Extended usage example
+
+```typescript showLineNumbers copy
+import { createWorkflow, createStep } from "@mastra/core/workflows";
+
+const step1 = createStep({...});
+const step2 = createStep({...});
+
+export const testWorkflow = createWorkflow({...})
+  .then(step1)
+  .sleep(async ({ inputData }) => {
+    const { delayInMs } = inputData;
+    return delayInMs;
+  })
+  .then(step2)
+  .commit();
+```
+
 ## Related
 
-- [Sleep & Events](../../../docs/workflows/pausing-execution.mdx)
+- [Suspend & Resume](../../../docs/workflows/suspend-and-resume.mdx#sleep--events)

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

@@ -41,11 +41,21 @@ workflow.sleepUntil(new Date(Date.now() + 5000));
 ## Extended usage example
 
 ```typescript showLineNumbers copy
-workflow.sleepUntil(async ({ inputData }) => {
-  return new Date(Date.now() + inputData.value);
-});
+import { createWorkflow, createStep } from "@mastra/core/workflows";
+
+const step1 = createStep({...});
+const step2 = createStep({...});
+
+export const testWorkflow = createWorkflow({...})
+  .then(step1)
+  .sleepUntil(async ({ inputData }) => {
+    const { delayInMs } = inputData;
+    return new Date(Date.now() + delayInMs);
+  })
+  .then(step2)
+  .commit();
 ```
 
 ## Related
 
-- [Sleep & Events](../../../docs/workflows/pausing-execution.mdx)
+- [Suspend & Resume](../../../docs/workflows/suspend-and-resume.mdx#sleep--events)

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

@@ -44,6 +44,23 @@ workflow.waitForEvent('event-name', step1);
   ]}
 />
 
+## Extended usage example
+
+```typescript showLineNumbers copy
+import { createWorkflow, createStep } from "@mastra/core/workflows";
+
+const step1 = createStep({...});
+const step2 = createStep({...});
+const step3 = createStep({...});
+
+export const testWorkflow = createWorkflow({...})
+  .then(step1)
+  .waitForEvent("event-name", step2)
+  .then(step3)
+  .commit();
+```
+
 ## Related
 
-- [Sleep & Events](../../../docs/workflows/pausing-execution.mdx)
+- [.sendEvent()](./sendEvent.mdx)
+- [Suspend & Resume](../../../docs/workflows/suspend-and-resume.mdx#sleep--events)

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

@@ -21,14 +21,14 @@ Use `RuntimeContext` when a primitive’s behavior should change based on runtim
 
 ## Setting values
 
-Pass `runtimeContext` into an agent, workflow, or tool call to make values available to all underlying primitives during execution. Use `.set()` to define values before making the call.
+Pass `runtimeContext` into an agent, network, workflow, or tool call to make values available to all underlying primitives during execution. Use `.set()` to define values before making the call.
 
 The `.set()` method takes two arguments:
 
 1. **key**: The name used to identify the value.
 2. **value**: The data to associate with that key.
 
-```typescript {7,9,13,21,28} showLineNumbers
+```typescript showLineNumbers
 import { RuntimeContext } from "@mastra/core/runtime-context";
 
 export type UserTier = {
@@ -36,7 +36,6 @@ export type UserTier = {
 };
 
 const runtimeContext = new RuntimeContext<UserTier>();
-
 runtimeContext.set("user-tier", "enterprise");
 
 const agent = mastra.getAgent("weatherAgent");
@@ -44,6 +43,11 @@ await agent.generate("What's the weather in London?", {
   runtimeContext
 })
 
+const routingAgent = mastra.getAgent("routingAgent");
+routingAgent.network("What's the weather in London?", {
+  runtimeContext
+});
+
 const run = await mastra.getWorkflow("weatherWorkflow").createRunAsync();
 await run.start({
   inputData: {
@@ -51,6 +55,12 @@ await run.start({
   },
   runtimeContext
 });
+await run.resume({
+  resumeData: {
+    city: "New York"
+  },
+  runtimeContext
+});
 
 await weatherTool.execute({
   context: {

package/.docs/raw/streaming/tool-streaming.mdx

@@ -69,6 +69,36 @@ export const testTool = createTool({
 });
 ```
 
+You can also use `writer.custom` if you want to emit top level stream chunks, This useful and relevant when
+integrating with UI Frameworks
+
+```typescript {5,8,15} showLineNumbers copy
+import { createTool } from "@mastra/core/tools";
+
+export const testTool = createTool({
+  // ...
+  execute: async ({ context, writer }) => {
+    const { value } = context;
+
+   await writer?.custom({
+      type: "data-tool-progress",
+      status: "pending"
+    });
+
+    const response = await fetch(...);
+
+   await writer?.custom({
+      type: "data-tool-progress",
+      status: "success"
+    });
+
+    return {
+      value: ""
+    };
+  }
+});
+```
+
 ### Inspecting stream payloads
 
 Events written to the stream are included in the emitted chunks. These chunks can be inspected to access any custom fields, such as event types, intermediate values, or tool-specific data.

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

@@ -58,7 +58,7 @@ To make tools available to an agent, you configure them in the agent's definitio
 
 ## Using `RuntimeContext`
 
-Use `RuntimeContext` to access request-specific values. This lets you conditionally adjust behavior based on the context of the request.
+Use [RuntimeContext](../server-db/runtime-context.mdx) to access request-specific values. This lets you conditionally adjust behavior based on the context of the request.
 
 ```typescript filename="src/mastra/tools/test-tool.ts" showLineNumbers
 export type UserTier = {

package/.docs/raw/workflows/overview.mdx

@@ -233,7 +233,7 @@ The workflow output includes the full execution lifecycle, showing the input and
 
 ## Using `RuntimeContext`
 
-Use `RuntimeContext` to access request-specific values. This lets you conditionally adjust behavior based on the context of the request.
+Use [RuntimeContext](../server-db/runtime-context.mdx) to access request-specific values. This lets you conditionally adjust behavior based on the context of the request.
 
 ```typescript filename="src/mastra/workflows/test-workflow.ts" showLineNumbers
 export type UserTier = {

package/.docs/raw/workflows/suspend-and-resume.mdx

@@ -5,7 +5,7 @@ description: "Suspend and resume in Mastra workflows allows you to pause executi
 
 # Suspend & Resume
 
-Workflows can be paused at any step, with their current state persisted as a snapshot in storage. Execution can then be resumed from this saved snapshot when ready. Persisting the snapshot ensures the workflow state is maintained across sessions, deployments, and server restarts, essential for workflows that may remain suspended while awaiting external input or resources.
+Workflows can be paused at any step, with their current state persisted as a [snapshot](./snapshots.mdx) in storage. Execution can then be resumed from this saved snapshot when ready. Persisting the snapshot ensures the workflow state is maintained across sessions, deployments, and server restarts, essential for workflows that may remain suspended while awaiting external input or resources.
 
 Common scenarios for suspending workflows include:
 
@@ -215,6 +215,32 @@ const resumedResult = await run.resume({
 });
 ```
 
+You can pass `runtimeContext` as an argument to both the `start` and `resume` commands.
+
+```typescript filename="src/mastra/workflows/test-workflow.ts"
+import { RuntimeContext } from "@mastra/core/runtime-context";
+
+const runtimeContext = new RuntimeContext();
+
+const result = await run.start({
+  step: 'step-1',
+  inputData: {
+    city: "London"
+  },
+  runtimeContext
+});
+
+const resumedResult = await run.resume({
+  step: 'step-1',
+  resumeData: {
+    city: "New York"
+  },
+  runtimeContext
+});
+```
+
+> See [Runtime Context](../server-db/runtime-context.mdx) for more information.
+
 ### Resuming nested workflows
 
 To resume a suspended nested workflow pass the workflow instance to the `step` parameter of the `resume` function.
@@ -260,28 +286,13 @@ if (result.status === "suspended") {
 }
 ```
 
-## Using `RuntimeContext` with suspend/resume
-
-When using suspend/resume with `RuntimeContext`, you can create the instance yourself, and pass it to the `start` and `resume` functions.
-`RuntimeContext` is not automatically shared on a workflow run.
-
-```typescript {1,4,9,16} filename="src/mastra/workflows/test-workflow.tss" showLineNumbers copy
-import { RuntimeContext } from "@mastra/core/di";
-import { mastra } from "./mastra";
+## Sleep & Events
 
-const runtimeContext = new RuntimeContext();
-const run = await mastra.getWorkflow("testWorkflow").createRunAsync();
+Workflows can also pause execution for timed delays or external events. These methods set the workflow status to `waiting` rather than `suspended`, and are useful for polling, delayed retries, or event-driven processes.
 
-const result = await run.start({
-  inputData: { suggestions: ["London", "Paris", "New York"] },
-  runtimeContext
-});
+**Available methods:**
 
-if (result.status === "suspended") {
-  const resumedResult = await run.resume({
-    step: 'step-1',
-    resumeData: { city: "New York" },
-    runtimeContext
-  });
-}
-```
+- [`.sleep()`](../../reference/workflows/workflow-methods/sleep.mdx): Pause for a specified number of milliseconds
+- [`.sleepUntil()`](../../reference/workflows/workflow-methods/sleepUntil.mdx) : Pause until a specific date
+- [`.waitForEvent()`](../../reference/workflows/workflow-methods/waitForEvent.mdx): Pause until an external event is received
+- [`.sendEvent()`](../../reference/workflows/workflow-methods/sendEvent.mdx) : Send an event to resume a waiting workflow

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @mastra/mcp-docs-server
 
+## 0.13.32-alpha.0
+
+### Patch Changes
+
+- Updated dependencies [[`c67ca32`](https://github.com/mastra-ai/mastra/commit/c67ca32e3c2cf69bfc146580770c720220ca44ac), [`dbc9e12`](https://github.com/mastra-ai/mastra/commit/dbc9e1216ba575ba59ead4afb727a01215f7de4f), [`99e41b9`](https://github.com/mastra-ai/mastra/commit/99e41b94957cdd25137d3ac12e94e8b21aa01b68), [`c28833c`](https://github.com/mastra-ai/mastra/commit/c28833c5b6d8e10eeffd7f7d39129d53b8bca240), [`f053e89`](https://github.com/mastra-ai/mastra/commit/f053e89160dbd0bd3333fc3492f68231b5c7c349), [`9a1a485`](https://github.com/mastra-ai/mastra/commit/9a1a4859b855e37239f652bf14b1ecd1029b8c4e), [`9257233`](https://github.com/mastra-ai/mastra/commit/9257233c4ffce09b2bedc2a9adbd70d7a83fa8e2), [`0f1a4c9`](https://github.com/mastra-ai/mastra/commit/0f1a4c984fb4b104b2f0b63ba18c9fa77f567700), [`2db6160`](https://github.com/mastra-ai/mastra/commit/2db6160e2022ff8827c15d30157e684683b934b5), [`8aeea37`](https://github.com/mastra-ai/mastra/commit/8aeea37efdde347c635a67fed56794943b7f74ec), [`02fe153`](https://github.com/mastra-ai/mastra/commit/02fe15351d6021d214da48ec982a0e9e4150bcee), [`74567b3`](https://github.com/mastra-ai/mastra/commit/74567b3d237ae3915cd0bca3cf55fa0a64e4e4a4), [`15a1733`](https://github.com/mastra-ai/mastra/commit/15a1733074cee8bd37370e1af34cd818e89fa7ac), [`fc2a774`](https://github.com/mastra-ai/mastra/commit/fc2a77468981aaddc3e77f83f0c4ad4a4af140da), [`4e08933`](https://github.com/mastra-ai/mastra/commit/4e08933625464dfde178347af5b6278fcf34188e)]:
+  - @mastra/core@0.21.2-alpha.0
+
 ## 0.13.31
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/mcp-docs-server",
-  "version": "0.13.31",
+  "version": "0.13.32-alpha.0",
   "description": "MCP server for accessing Mastra.ai documentation, changelogs, and news.",
   "type": "module",
   "main": "dist/index.js",
@@ -33,7 +33,7 @@
     "uuid": "^11.1.0",
     "zod": "^3.25.76",
     "zod-to-json-schema": "^3.24.6",
-    "@mastra/core": "0.21.1",
+    "@mastra/core": "0.21.2-alpha.0",
     "@mastra/mcp": "^0.13.5"
   },
   "devDependencies": {
@@ -43,14 +43,14 @@
     "@types/turndown": "^5.0.5",
     "@wong2/mcp-cli": "^1.10.0",
     "cross-env": "^10.1.0",
-    "eslint": "^9.36.0",
+    "eslint": "^9.37.0",
     "hono": "^4.9.7",
     "tsup": "^8.5.0",
     "tsx": "^4.19.4",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4",
     "@internal/lint": "0.0.50",
-    "@mastra/core": "0.21.1"
+    "@mastra/core": "0.21.2-alpha.0"
   },
   "homepage": "https://mastra.ai",
   "repository": {

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

@@ -1,142 +0,0 @@
----
-title: "Pausing Execution | Mastra Docs"
-description: "Pausing execution in Mastra workflows allows you to pause execution while waiting for external input or resources via .sleep(), .sleepUntil() and .waitForEvent()."
----
-
-# Sleep & Events
-
-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.
-
-You can pause execution using:
-
-- `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
-
-When using any of these methods, the workflow status is set to `waiting` until execution resumes.
-
-## Pausing with `.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();
-```
-
-### Pausing with `.sleep(callback)`
-
-The `sleep()` method also accepts a callback that returns the number of milliseconds to pause. The callback receives `inputData`, allowing the delay to be computed dynamically.
-
-```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(async ({ inputData }) => {
-    const { delayInMs }  = inputData
-    return delayInMs;
-  })
-  .then(step2)
-  .commit();
-```
-
-## Pausing with `.sleepUntil()`
-
-The `sleepUntil()` method pauses execution between steps until a specified date.
-
-```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();
-```
-
-### Pausing with `.sleepUntil(callback)`
-
-The `sleepUntil()` method also accepts a callback that returns a `Date` object. The callback receives `inputData`, allowing the target time to be computed dynamically.
-
-```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(async ({ inputData }) => {
-    const { delayInMs }  = inputData
-    return new Date(Date.now() + delayInMs);
-  })
-  .then(step2)
-  .commit();
-```
-
-
-> `Date.now()` is evaluated when the workflow starts, not at the moment the `sleepUntil()` method is called.
-
-## Pausing with `.waitForEvent()`
-
-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.
-
-![Pausing with .waitForEvent()](/image/workflows/workflows-sleep-events-waitforevent.jpg)
-
-```typescript {10} 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({...});
-const step3 = createStep({...});
-
-export const testWorkflow = createWorkflow({...})
-  .then(step1)
-  .waitForEvent("my-event-name", step2)
-  .then(step3)
-  .commit();
-```
-## Sending an event with `.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", { 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.