@mastra/mcp-docs-server 0.13.39 → 0.13.40-alpha.0

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

@@ -1,281 +1,133 @@
 ---
-title: "Suspend & Resume | Workflows | Mastra Docs"
+title: "Suspend & Resume | Workflows"
 description: "Suspend and resume in Mastra workflows allows you to pause execution while waiting for external input or resources."
 ---
 
 # Suspend & Resume
 
-Workflows can be paused at any step to collect additional data, wait for API callbacks, throttle expensive operations, or wait for [Human in the Loop](./human-in-the-loop) input. When a workflow is suspended, its current state can be persisted as a [snapshot](./snapshots) and later resumed from the same point. Snapshots are stored in the configured storage system and persist across deployments and application restarts.
+Workflows can be paused at any step to collect additional data, wait for API callbacks, throttle costly operations, or request [human-in-the-loop](/docs/workflows/human-in-the-loop) input. When a workflow is suspended, its current execution state is saved as a snapshot. You can later resume the workflow from a [specific step ID](/docs/workflows/snapshots#retrieving-snapshots), restoring the exact state captured in that snapshot. [Snapshots](/docs/workflows/snapshots) are stored in your configured storage provider and across deployments and application restarts.
 
-> **New to suspend and resume?** Watch these official video tutorials:
->
-> - **[Mastering Human-in-the-Loop with Suspend & Resume](https://youtu.be/aORuNG8Tq_k)** - Learn how to suspend workflows and accept user inputs
-> - **[Building Multi-Turn Chat Interfaces with React](https://youtu.be/UMVm8YZwlxc)** - Implement multi-turn human-involved interactions with a React chat interface
+## Pausing a workflow with `suspend()`
 
-## Workflow status types
+Use `suspend()` to pause workflow execution at a specific step. You can define a suspend condition in the step’s `execute` block using values from `resumeData`.
 
-When running a workflow, its `status` can be one of the following:
+- If the condition isn’t met, the workflow pauses and returns `suspend()`.
+- If the condition is met, the workflow continues with the remaining logic in the step.
 
-- `running` - The workflow is currently running
-- `suspended` - The workflow is suspended
-- `success` - The workflow has completed
-- `failed` - The workflow has failed
+![Pausing a workflow with suspend()](/img/workflows/workflows-suspend-resume-suspend.jpg)
 
-## Suspending a workflow with `suspend()`
-
-To pause execution at a specific step until user input is received, use the `⁠suspend` function to temporarily halt the workflow, allowing it to resume only when the necessary data is provided.
-
-![Suspending a workflow with suspend()](/img/workflows/workflows-suspend-resume-suspend.jpg)
-
-```typescript {16} title="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
+```typescript {9-11,16-18} title="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
 const step1 = createStep({
   id: "step-1",
   inputSchema: z.object({
-    input: z.string(),
+    userEmail: z.string()
   }),
   outputSchema: z.object({
-    output: z.string(),
+    output: z.string()
   }),
   resumeSchema: z.object({
-    city: z.string(),
+    approved: z.boolean()
   }),
-  execute: async ({ resumeData, suspend }) => {
-    const { city } = resumeData ?? {};
+  execute: async ({ inputData, resumeData, suspend }) => {
+    const { userEmail } = inputData;
+    const { approved } = resumeData ?? {};
 
-    if (!city) {
+    if (!approved) {
       return await suspend({});
     }
 
-    return { output: "" };
-  },
+    return {
+      output: `Email sent to ${userEmail}`
+    };
+  }
 });
 
 export const testWorkflow = createWorkflow({
-  // ...
+  id: "test-workflow",
+  inputSchema: z.object({
+    userEmail: z.string()
+  }),
+  outputSchema: z.object({
+    output: z.string()
+  })
 })
   .then(step1)
   .commit();
 ```
 
-> For more details, check out the [Suspend workflow example](/examples/workflows_legacy/suspend-and-resume).
-
-### Identifying suspended steps
+## Restarting a workflow with `resume()`
 
-To resume a suspended workflow, inspect the `suspended` array in the result to determine which step needs input:
+Use `resume()` to restart a suspended workflow from the step where it paused. To satisfy the step’s suspend condition, pass a value using `resumeData` that matches the step's `resumeSchema`, allowing execution to continue from the suspended step.
 
-```typescript {15} title="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
-import { mastra } from "./mastra";
+![Restarting a workflow with resume()](/img/workflows/workflows-suspend-resume-resume.jpg)
 
-const run = await mastra.getWorkflow("testWorkflow").createRunAsync();
+```typescript {13} showLineNumbers copy
+const workflow = mastra.getWorkflow("testWorkflow");
+const run = await workflow.createRunAsync();
 
-const result = await run.start({
+await run.start({
   inputData: {
-    city: "London",
-  },
+    userEmail: "alex@example.com"
+  }
 });
 
-console.log(JSON.stringify(result, null, 2));
-
-if (result.status === "suspended") {
-  const resumedResult = await run.resume({
-    step: result.suspended[0],
-    resumeData: {
-      city: "Berlin",
-    },
+const handleResume = async () => {
+  const result = await run.resume({
+    step: 'step-1',
+    resumeData: { approved: true }
   });
-}
-```
-
-In this case, the logic resumes the first step listed in the `suspended` array. A `step` can also be defined using it's `id`, for example: 'step-1'.
-
-```json
-{
-  "status": "suspended",
-  "steps": {
-    // ...
-    "step-1": {
-      // ...
-      "status": "suspended"
-    }
-  },
-  "suspended": [["step-1"]]
-}
+};
 ```
 
-> See [Workflow Output](./overview#workflow-output) for more details.
-
-## Providing user feedback with suspend
+You can resume a suspended workflow using different triggers, including [human input](/docs/workflows/human-in-the-loop), external events from your application, or time-based conditions.
 
-When a workflow is suspended, feedback can be surfaced to the user through the `suspendSchema`. Include a reason in the `suspend` payload to explain why the workflow paused.
-
-```typescript {13,23} title="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
-import { createWorkflow, createStep } from "@mastra/core/workflows";
-import { z } from "zod";
-
-const step1 = createStep({
-  id: "step-1",
-  inputSchema: z.object({
-    value: z.string(),
-  }),
-  resumeSchema: z.object({
-    confirm: z.boolean(),
-  }),
-  suspendSchema: z.object({
-    reason: z.string(),
-  }),
-  outputSchema: z.object({
-    value: z.string(),
-  }),
-  execute: async ({ resumeData, suspend }) => {
-    const { confirm } = resumeData ?? {};
-
-    if (!confirm) {
-      return await suspend({
-        reason: "Confirm to continue",
-      });
-    }
-
-    return { value: "" };
-  },
-});
-
-export const testWorkflow = createWorkflow({
-  // ...
-})
-  .then(step1)
-  .commit();
-```
-
-In this case, the reason provided explains that the user must confirm to continue.
+```typescript {10} showLineNumbers copy
+const handleResume = async () => {
+  const result = await run.resume({
+    step: 'step-1',
+    resumeData: { approved: true }
+  });
+};
 
-```json
-{
-  "step-1": {
-    // ...
-    "status": "suspended",
-    "suspendPayload": {
-      "reason": "Confirm to continue"
-    }
-  }
-}
+const midnight = new Date();
+midnight.setUTCHours(24, 0, 0, 0);
+setTimeout(handleResume, midnight.getTime() - Date.now());
 ```
 
-> See [Workflow Output](./overview#workflow-output) for more details.
-
-## Resuming a workflow with `resume()`
+## Identifying suspended executions
 
-A workflow can be resumed by calling `resume` and providing the required `resumeData`. You can either explicitly specify which step to resume from, or when exactly one step is suspended, omit the `step` parameter and the workflow will automatically resume that step.
+When a workflow is suspended, it restarts from the step where it paused. You can check the workflow’s `status` to confirm it's suspended, and use `suspended` to identify the paused step or [nested workflow](/docs/workflows/overview#workflows-as-steps).
 
-```typescript {16-18} title="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
-import { mastra } from "./mastra";
-
-const run = await mastra.getWorkflow("testWorkflow").createRunAsync();
+```typescript {11} showLineNumbers copy
+const workflow = mastra.getWorkflow("testWorkflow");
+const run = await workflow.createRunAsync();
 
 const result = await run.start({
   inputData: {
-    city: "London",
-  },
+    userEmail: "alex@example.com"
+  }
 });
 
-console.log(JSON.stringify(result, null, 2));
-
 if (result.status === "suspended") {
-  const resumedResult = await run.resume({
-    step: "step-1",
-    resumeData: {
-      city: "Berlin",
-    },
+  console.log(result.suspended[0]);
+  await run.resume({
+    step: result.suspended[0],
+    resumeData: { approved: true }
   });
-
-  console.log(JSON.stringify(resumedResult, null, 2));
 }
 ```
 
-You can also omit the `step` parameter when exactly one step is suspended:
-
-```typescript {5} title="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
-const resumedResult = await run.resume({
-  resumeData: {
-    city: "Berlin",
-  },
-  // step parameter omitted - automatically resumes the single suspended step
-});
-```
-
-You can pass `runtimeContext` as an argument to both the `start` and `resume` commands.
-
-```typescript title="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](/docs/server-db/runtime-context) for more information.
+**Example output**
 
-### Resuming nested workflows
+The `suspended` array contains the IDs of any suspended workflows and steps from the run. These can be passed to the `step` parameter when calling `resume()` to target and resume the suspended execution path.
 
-To resume a suspended nested workflow pass the workflow instance to the `step` parameter of the `resume` function.
-
-```typescript {33-34} title="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
-const dowhileWorkflow = createWorkflow({
-  id: "dowhile-workflow",
-  inputSchema: z.object({ value: z.number() }),
-  outputSchema: z.object({ value: z.number() }),
-})
-  .dountil(
-    createWorkflow({
-      id: "simple-resume-workflow",
-      inputSchema: z.object({ value: z.number() }),
-      outputSchema: z.object({ value: z.number() }),
-      steps: [incrementStep, resumeStep],
-    })
-      .then(incrementStep)
-      .then(resumeStep)
-      .commit(),
-    async ({ inputData }) => inputData.value >= 10,
-  )
-  .then(
-    createStep({
-      id: "final",
-      inputSchema: z.object({ value: z.number() }),
-      outputSchema: z.object({ value: z.number() }),
-      execute: async ({ inputData }) => ({ value: inputData.value }),
-    }),
-  )
-  .commit();
-
-const run = await dowhileWorkflow.createRunAsync();
-const result = await run.start({ inputData: { value: 0 } });
-
-if (result.status === "suspended") {
-  const resumedResult = await run.resume({
-    resumeData: { value: 2 },
-    step: ["simple-resume-workflow", "resume"],
-  });
-
-  console.log(JSON.stringify(resumedResult, null, 2));
-}
+```typescript
+[ 'nested-workflow', 'step-1' ]
 ```
 
 ## Sleep & Events
 
-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.
+Sleep and event methods can be used to pause execution at the workflow level, which sets the status to `waiting`. By comparison, `suspend()` pauses execution within a specific step and sets the status to `suspended`.
 
 **Available methods:**
 
@@ -283,3 +135,8 @@ Workflows can also pause execution for timed delays or external events. These me
 - [`.sleepUntil()`](/reference/workflows/workflow-methods/sleepUntil) : Pause until a specific date
 - [`.waitForEvent()`](/reference/workflows/workflow-methods/waitForEvent): Pause until an external event is received
 - [`.sendEvent()`](/reference/workflows/workflow-methods/sendEvent) : Send an event to resume a waiting workflow
+
+## Related
+
+- [Control Flow](/docs/workflows/control-flow)
+- [Human-in-the-loop](/docs/workflows/human-in-the-loop)

package/.docs/raw/workflows-legacy/control-flow.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Control Flow in Legacy Workflows: Branching, Merging, and Conditions | Workflows (Legacy) | Mastra Docs"
+title: "Control Flow in Legacy Workflows: Branching, Merging, and Conditions | Workflows (Legacy)"
 sidebar_position: 7
 sidebar_label: "Control Flow"
 description: "Control flow in Mastra legacy workflows allows you to manage branching, merging, and conditions to construct legacy workflows that meet your logic requirements."

package/.docs/raw/workflows-legacy/dynamic-workflows.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Dynamic Workflows (Legacy) | Workflows (Legacy) | Mastra Docs"
+title: "Dynamic Workflows (Legacy) | Workflows (Legacy)"
 sidebar_position: 3
 sidebar_label: "Dynamic Workflows"
 description: "Learn how to create dynamic workflows within legacy workflow steps, allowing for flexible workflow creation based on runtime conditions."

package/.docs/raw/workflows-legacy/error-handling.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Error Handling in Workflows (Legacy) | Workflows (Legacy) | Mastra Docs"
+title: "Error Handling in Workflows (Legacy) | Workflows (Legacy)"
 sidebar_position: 8
 sidebar_label: "Error Handling"
 description: "Learn how to handle errors in Mastra legacy workflows using step retries, conditional branching, and monitoring."

package/.docs/raw/workflows-legacy/nested-workflows.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Nested Workflows (Legacy) | Workflows (Legacy) | Mastra Docs"
+title: "Nested Workflows (Legacy) | Workflows (Legacy)"
 sidebar_position: 4
 sidebar_label: "Nested Workflows"
 ---

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

@@ -1,5 +1,5 @@
 ---
-title: "Handling Complex LLM Operations with Workflows (Legacy) | Workflows (Legacy) | Mastra Docs"
+title: "Handling Complex LLM Operations with Workflows (Legacy) | Workflows (Legacy)"
 sidebar_position: 1
 sidebar_label: "Overview"
 description: "Workflows in Mastra help you orchestrate complex sequences of operations with features like branching, parallel execution, resource suspension, and more."

package/.docs/raw/workflows-legacy/runtime-variables.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Workflow Runtime Variables (Legacy) | Workflows (Legacy) | Mastra Docs"
+title: "Workflow Runtime Variables (Legacy) | Workflows (Legacy)"
 sidebar_position: 6
 sidebar_label: "Runtime/Dynamic Variables"
 description: Learn how to use Mastra's dependency injection system to provide runtime configuration to workflows and steps.

package/.docs/raw/workflows-legacy/steps.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Defining Steps in a Workflow (Legacy) | Workflows (Legacy) | Mastra Docs"
+title: "Defining Steps in a Workflow (Legacy) | Workflows (Legacy)"
 sidebar_position: 2
 sidebar_label: "Steps"
 description: "Steps in Mastra workflows provide a structured way to manage operations by defining inputs, outputs, and execution logic."

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

@@ -1,5 +1,5 @@
 ---
-title: "Suspend and Resume in Workflows (Legacy) | Workflows (Legacy) | Mastra Docs"
+title: "Suspend and Resume in Workflows (Legacy) | Workflows (Legacy)"
 sidebar_position: 9
 sidebar_label: "Suspend & Resume"
 description: "Suspend and resume in Mastra workflows allows you to pause execution while waiting for external input or resources."

package/.docs/raw/workflows-legacy/variables.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Data Mapping with Workflow Variables | Workflows (Legacy) | Mastra Docs"
+title: "Data Mapping with Workflow Variables | Workflows (Legacy)"
 sidebar_position: 5
 sidebar_label: "Variables"
 description: "Learn how to use workflow variables to map data between steps and create dynamic data flows in your Mastra workflows."

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @mastra/mcp-docs-server
 
+## 0.13.40-alpha.0
+
+### Patch Changes
+
+- Updated dependencies [[`0a0aa87`](https://github.com/mastra-ai/mastra/commit/0a0aa87910dd9234ae11e8146fbf54d71f0b1516), [`56bbbd0`](https://github.com/mastra-ai/mastra/commit/56bbbd0eb4510455ff03d6bf2827fdbd307938be), [`d576fd8`](https://github.com/mastra-ai/mastra/commit/d576fd8f2a3c61bcf2f7d5d2bdfb496d442c46c2), [`5e48406`](https://github.com/mastra-ai/mastra/commit/5e48406766fa94e2b7c56b70fb7d6068cf7f3989), [`7fcce62`](https://github.com/mastra-ai/mastra/commit/7fcce62880c3525fbf752d59c0ac2c478cffe024), [`16a324f`](https://github.com/mastra-ai/mastra/commit/16a324f8c30a07d0d899bc2e4e7998c6b40a4cb6), [`26aee16`](https://github.com/mastra-ai/mastra/commit/26aee160149e7acb84a533bf45631aaed6dd7077), [`b063a81`](https://github.com/mastra-ai/mastra/commit/b063a8144176915a766ea15888e1e8a06a020776), [`5ff9462`](https://github.com/mastra-ai/mastra/commit/5ff9462691c80a6841b014bcc68f6a85c3fd3fbf)]:
+  - @mastra/core@0.24.1-alpha.0
+
 ## 0.13.39
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/mcp-docs-server",
-  "version": "0.13.39",
+  "version": "0.13.40-alpha.0",
   "description": "MCP server for accessing Mastra.ai documentation, changelogs, and news.",
   "type": "module",
   "main": "dist/index.js",
@@ -33,8 +33,8 @@
     "uuid": "^11.1.0",
     "zod": "^3.25.76",
     "zod-to-json-schema": "^3.24.6",
-    "@mastra/core": "0.24.0",
-    "@mastra/mcp": "^0.14.2"
+    "@mastra/mcp": "^0.14.2",
+    "@mastra/core": "0.24.1-alpha.0"
   },
   "devDependencies": {
     "@hono/node-server": "^1.19.5",
@@ -50,7 +50,7 @@
     "typescript": "^5.8.3",
     "vitest": "^3.2.4",
     "@internal/lint": "0.0.58",
-    "@mastra/core": "0.24.0"
+    "@mastra/core": "0.24.1-alpha.0"
   },
   "homepage": "https://mastra.ai",
   "repository": {

package/.docs/raw/deployment/serverless-platforms/index.mdx

@@ -1,55 +0,0 @@
----
-title: "Serverless Deployment | Deployment | Mastra Docs"
-description: "Build and deploy Mastra applications using platform-specific deployers or standard HTTP servers"
----
-
-# Serverless Deployment
-
-Standalone Mastra applications can be deployed to popular serverless platforms using one of our deployer packages:
-
-- [Cloudflare](/docs/deployment/serverless-platforms/cloudflare-deployer)
-- [Netlify](/docs/deployment/serverless-platforms/netlify-deployer)
-- [Vercel](/docs/deployment/serverless-platforms/vercel-deployer)
-
-Deployers **aren't** required when integrating Mastra with a framework. See [Web Framework Integration](/docs/deployment/web-framework) for more information.
-
-For self-hosted Node.js server deployment, see the [Creating A Mastra Server](/docs/deployment/server-deployment) guide.
-
-## Prerequisites
-
-Before you begin, ensure you have:
-
-- Node.js `v20.0` or higher
-- If using a platform-specific deployer:
-  - An account with your chosen platform
-  - Required API keys or credentials
-
-## LibSQLStore
-
-`LibSQLStore` writes to the local filesystem, which is not supported in serverless environments due to their ephemeral nature. If you're deploying to a platform like Vercel, Netlify or Cloudflare, you **must remove** all usage of `LibSQLStore`.
-
-Specifically, ensure you've removed it from both `src/mastra/index.ts` and `src/mastra/agents/weather-agent.ts`:
-
-```typescript title="src/mastra/index.ts" showLineNumbers
-export const mastra = new Mastra({
-  // ...
-  storage: new LibSQLStore({
-    // [!code --]
-    // stores telemetry, evals, ... into memory storage, if it needs to persist, change to file:../mastra.db // [!code --]
-    url: ":memory:", // [!code --]
-  }), //[!code --]
-});
-```
-
-```typescript title="src/mastra/agents/weather-agent.ts" showLineNumbers
-export const weatherAgent = new Agent({
-  // ..
-  memory: new Memory({
-    // [!code --]
-    storage: new LibSQLStore({
-      // [!code --]
-      url: "file:../mastra.db", // path is relative to the .mastra/output directory // [!code --]
-    }), // [!code --]
-  }), //  [!code --]
-});
-```

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

@@ -1,69 +0,0 @@
----
-title: "Reference: Agent.listTools() | Agents | Mastra Docs"
-description: "Documentation for the `Agent.listTools()` method in Mastra agents, which retrieves the tools that the agent can use."
----
-
-# Agent.listTools()
-
-The `.listTools()` method retrieves the tools configured for an agent, resolving them if they're a function. These tools extend the agent's capabilities, allowing it to perform specific actions or access external systems.
-
-## Usage example
-
-```typescript copy
-await agent.listTools();
-```
-
-## Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "options",
-      type: "{ runtimeContext?: RuntimeContext }",
-      isOptional: true,
-      defaultValue: "{}",
-      description: "Optional configuration object containing request context.",
-    },
-  ]}
-/>
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "tools",
-      type: "TTools | Promise<TTools>",
-      description:
-        "The tools configured for the agent, either as a direct object or a promise that resolves to the tools.",
-    },
-  ]}
-/>
-
-## Extended usage example
-
-```typescript copy
-await agent.listTools({
-  runtimeContext: new RuntimeContext(),
-});
-```
-
-### Options parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "runtimeContext",
-      type: "RuntimeContext",
-      isOptional: true,
-      defaultValue: "new RuntimeContext()",
-      description:
-        "Request Context for dependency injection and contextual information.",
-    },
-  ]}
-/>
-
-## Related
-
-- [Using tools with agents](/docs/agents/using-tools)
-- [Creating tools](/docs/tools-mcp/overview)

package/.docs/raw/reference/core/listAgents.mdx

@@ -1,35 +0,0 @@
----
-title: "Reference: Mastra.listAgents() | Core | Mastra Docs"
-description: "Documentation for the `Mastra.listAgents()` method in Mastra, which retrieves all configured agents."
----
-
-# Mastra.listAgents()
-
-The `.listAgents()` method is used to retrieve all agents that have been configured in the Mastra instance.
-
-## Usage example
-
-```typescript copy
-mastra.listAgents();
-```
-
-## Parameters
-
-This method does not accept any parameters.
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "agents",
-      type: "TAgents",
-      description:
-        "A record of all configured agents, where keys are agent names and values are agent instances.",
-    },
-  ]}
-/>
-
-## Related
-
-- [Agents overview](/docs/agents/overview)