@mastra/mcp-docs-server 0.13.2-alpha.1 → 0.13.2-alpha.3

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

@@ -157,12 +157,12 @@ With the Mastra Dev Server running you can run the workflow from the Mastra Play
 
 #### Command line
 
-Create a run instance of any Mastra workflow using `createRun` and `start`:
+Create a run instance of any Mastra workflow using `createRunAsync` and `start`:
 
 ```typescript {3,5} filename="src/test-workflow.ts" showLineNumbers copy
 import { mastra } from "./mastra";
 
-const run = mastra.getWorkflow("testWorkflow").createRun();
+const run = await mastra.getWorkflow("testWorkflow").createRunAsync();
 
 const result = await run.start({
   inputData: {
@@ -172,7 +172,7 @@ const result = await run.start({
 
 console.log(JSON.stringify(result, null, 2));
 ```
-> see [createRun](/reference/workflows/create-run) and [start](/reference/workflows/start) for more information.
+> see [createRunAsync](/reference/workflows/create-run-async) and [start](/reference/workflows/start) for more information.
 
 To trigger this workflow, run the following:
 
@@ -182,6 +182,74 @@ npx tsx src/test-workflow.ts
 
 </Steps>
 
+#### Run Workflow Results
+
+The result of running a workflow using either `start()` or `resume()` will look like one of the following, depending on the outcome.
+
+##### Status success
+
+```json
+{
+  "status": "success",
+  "steps": {
+    // ...
+    "step-1": {
+      // ...
+      "status": "success",
+    }
+  },
+  "result": {
+    "output": "London + step-1"
+  }
+}
+```
+
+- **status**: Shows the final state of the workflow execution, either: `success`, `suspended`, or `error`
+- **steps**: Lists each step in the workflow, including inputs and outputs
+- **status**: Shows the outcome of each individual step
+- **result**: Includes the final output of the workflow, typed according to the `outputSchema`
+
+
+##### Status suspended
+
+```json
+{
+  "status": "suspended",
+  "steps": {
+    // ...
+    "step-1": {
+      // ...
+      "status": "suspended",
+    }
+  },
+  "suspended": [
+    [
+      "step-1"
+    ]
+  ]
+}
+```
+
+- **suspended**: An optional array listing any steps currently awaiting input before continuing
+
+##### Status failed
+
+```json
+{
+  "status": "failed",
+  "steps": {
+    // ...
+    "step-1": {
+      // ...
+      "status": "failed",
+      "error": "Test error",
+    }
+  },
+  "error": "Test error"
+}
+```
+- **error**: An optional field that includes the error message if the workflow fails
+
 ### Stream Workflow
 
 Similar to the run method shown above, workflows can also be streamed:
@@ -189,7 +257,7 @@ Similar to the run method shown above, workflows can also be streamed:
 ```typescript {5} filename="src/test-workflow.ts" showLineNumbers copy
 import { mastra } from "./mastra";
 
-const run = mastra.getWorkflow("testWorkflow").createRun();
+const run = await mastra.getWorkflow("testWorkflow").createRunAsync();
 
 const result = await run.stream({
   inputData: {
@@ -211,7 +279,7 @@ A workflow can also be watched, allowing you to inspect each event that is emitt
 ```typescript {5} filename="src/test-workflow.ts" showLineNumbers copy
 import { mastra } from "./mastra";
 
-const run = mastra.getWorkflow("testWorkflow").createRun();
+const run = await mastra.getWorkflow("testWorkflow").createRunAsync();
 
 run.watch((event) => {
   console.log(event);

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

@@ -46,7 +46,7 @@ workflow
     .then(step3)
     .commit();
 
-const run = await workflow.createRun()
+const run = await workflow.createRunAsync()
 run.start({})
 
 setTimeout(() => {

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

@@ -27,29 +27,26 @@ When running a workflow, its `status` can be one of the following:
 
 ## Suspend
 
-When the state is `suspended`, you can identify any and all steps that have been suspended by looking at the `suspended` array of the workflow.
+When the state is `suspended`, you can identify any and all steps that have been suspended by looking at the `suspended` array of the workflow result output.
 
 ```typescript {17} filename="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
 const step1 = createStep({
   id: "step-1",
   description: "Test suspend",
   inputSchema: z.object({
-    input: z.array(z.string())
-  }),
-  resumeSchema: z.object({
-    city: z.string()
+    input: z.string()
   }),
   outputSchema: z.object({
     output: z.string()
   }),
+  suspendSchema: z.object({}),
+  resumeSchema: z.object({
+    city: z.string()
+  }),
   execute: async ({ resumeData, suspend }) => {
-    const { city } = resumeData ?? {};
-
-    if (!city) {
+    if (!(resumeData ?? {}).city) {
       await suspend({});
-      return {
-        outcome: ""
-      };
+      return { output: "" };
     }
 
     return {
@@ -65,17 +62,69 @@ export const testWorkflow = createWorkflow({})
 
 > See [Define Suspendable workflow](/examples/workflows/human-in-the-loop#define-suspendable-workflow) for more information.
 
+### Identifying Suspended steps
+
+To resume a suspended workflow, inspect the `suspended` array in the result to determine which step needs input:
+
+```typescript {15} filename="src/test-workflow.ts" showLineNumbers copy
+import { mastra } from "./mastra";
+
+const run = await mastra.getWorkflow("testWorkflow").createRunAsync();
+
+const result = await run.start({
+  inputData: {
+    city: "London"
+  }
+});
+
+console.log(JSON.stringify(result, null, 2));
+
+if (result.status === "suspended") {
+  const resumedResult = await run.resume({
+    step: result.suspended[0],
+    resumeData: {
+      city: "Berlin"
+    }
+  });
+}
+
+```
+
+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 [Run Workflow Results](/workflows/overview#run-workflow-results) for more details.
+
 ## Resume
 
 A workflow can be resumed by calling `resume` and providing the required `resumeData`.
 
-```typescript {6,12,13,14} filename="src/test-workflow.ts" showLineNumbers copy
+```typescript {16-18} filename="src/test-workflow.ts" showLineNumbers copy
 import { mastra } from "./mastra";
 
-const run = mastra.getWorkflow("testWorkflow").createRun();
+const run = await mastra.getWorkflow("testWorkflow").createRunAsync();
 
 const result = await run.start({
-  inputData: { suggestions: ["London", "Paris", "New York"] }
+   inputData: {
+    city: "London"
+  }
 });
 
 console.log(JSON.stringify(result, null, 2));
@@ -83,19 +132,15 @@ console.log(JSON.stringify(result, null, 2));
 if (result.status === "suspended") {
   const resumedResult = await run.resume({
     step: 'step-1',
-    resumeData: { city: "New York" }
+    resumeData: {
+      city: "Berlin"
+    }
   });
 
   console.log(JSON.stringify(resumedResult, null, 2));
 }
 ```
 
-To execute this run from your terminal:
-
-```bash copy
-npx tsx src/test-workflow.ts
-```
-
 ### Nested Workflow
 
 To resume a suspended nested workflow pass the workflow instance to the `step` parameter of the `resume` function.
@@ -128,7 +173,7 @@ const dowhileWorkflow = createWorkflow({
   )
   .commit();
 
-const run = dowhileWorkflow.createRun();
+const run = await dowhileWorkflow.createRunAsync();
 const result = await run.start({ inputData: { value: 0 } });
 
 if (result.status === "suspended") {
@@ -151,7 +196,7 @@ import { RuntimeContext } from "@mastra/core/di";
 import { mastra } from "./mastra";
 
 const runtimeContext = new RuntimeContext();
-const run = mastra.getWorkflow("testWorkflow").createRun();
+const run = await mastra.getWorkflow("testWorkflow").createRunAsync();
 
 const result = await run.start({
   inputData: { suggestions: ["London", "Paris", "New York"] },

package/.docs/raw/workflows/using-with-agents-and-tools.mdx

@@ -238,7 +238,7 @@ export const cityCoordinatesTool = createTool({
 
     const workflow = mastra?.getWorkflow("cityStringWorkflow");
 
-    const run = workflow?.createRun();
+    const run = await workflow?.createRunAsync();
 
     const { result } = await run?.start({
       inputData: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/mcp-docs-server",
-  "version": "0.13.2-alpha.1",
+  "version": "0.13.2-alpha.3",
   "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-alpha.1"
+    "@mastra/mcp": "^0.10.5-alpha.2"
   },
   "devDependencies": {
     "@hono/node-server": "^1.14.4",
@@ -48,7 +48,7 @@
     "typescript": "^5.8.3",
     "vitest": "^3.2.3",
     "@internal/lint": "0.0.13",
-    "@mastra/core": "0.10.7-alpha.2"
+    "@mastra/core": "0.10.7-alpha.4"
   },
   "peerDependencies": {
     "@mastra/core": "^0.10.0-alpha.0"