@mastra/mcp-docs-server 0.13.11-alpha.0 → 0.13.11-alpha.2

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

@@ -1,215 +1,96 @@
 ---
-title: "Reference: Workflow.streamVNext() | Streaming | Workflows | Mastra Docs"
-description: Documentation for the `.streamVNext()` method in Mastra workflows, which enables real-time streaming of responses.
+title: "Reference: WorkflowRun.streamVNext() | Workflows | Mastra Docs"
+description: Documentation for the `WorkflowRun.streamVNext()` method in workflows, which enables real-time streaming of responses.
 ---
 
-# `streamVNext()`
+# WorkflowRun.streamVNext()
 
-The `streamVNext()` method enables real-time streaming of responses from a workflow.
+The `.streamVNext()` method enables real-time streaming of responses from a workflow.
 
-## Usage
+## Usage example
 
-```typescript
-const run = await myWorkflow.createRunAsync();
-
-// Add a stream to monitor execution
-const stream = run.streamVNext({ inputData: {...} });
-
-
-for (const chunk of stream) {
-  // do something with the chunk
-}
+```typescript showLineNumbers copy
+const run = await workflow.createRunAsync();
 
+const stream = run.streamVNext({
+  inputData: {
+    value: "initial data",
+  },
+});
 ```
 
-## Protocol
+## Parameters
 
 <PropertiesTable
   content={[
     {
-      name: "start",
-      type: "object",
-      description: "The workflow starts",
-      isOptional: false,
-      properties: [
-        {
-          type: "object",
-          parameters: [
-            {
-              name: "example",
-              type: "{ type: 'start', runId: '1', from: 'WORKFLOW', payload: { runId: '1' } }",
-              description: "Example message structure",
-              isOptional: false,
-            },
-          ],
-        },
-      ],
-    },
-    {
-      name: "step-start",
-      type: "object",
-      description: "The start of a step",
-      isOptional: false,
-      properties: [
-        {
-          type: "object",
-          parameters: [
-            {
-              name: "example",
-              type: "{ type: 'step-start', runId: '1', from: 'WORKFLOW', payload: { id: 'fetch-weather' } }",
-              description: "Example message structure",
-              isOptional: false,
-            },
-          ],
-        },
-      ],
-    },
-    {
-      name: "step-output",
-      type: "object",
-      description: "Custom output from a step",
-      isOptional: false,
-      properties: [
-        {
-          type: "object",
-          parameters: [
-            {
-              name: "example",
-              type: "{ type: 'step-output', runId: '1', from: 'WORKFLOW', payload: { stepName: 'my step', args: { ... }, stepCallId: 'uuid', startedAt: 1717000000000, status: 'running' } }",
-              description: "Example message structure",
-              isOptional: false,
-            },
-          ],
-        },
-      ],
-    },
-    {
-      name: "step-result",
-      type: "object",
-      description: "The result of a step",
-      isOptional: false,
-      properties: [
-        {
-          type: "object",
-          parameters: [
-            {
-              name: "example",
-              type: "{ type: 'step-result', runId: '1', from: 'WORKFLOW', payload: { stepName: 'my step', result: { ... }, stepCallId: 'uuid', endedAt: 1717000000000, status: 'success', output: [Object] } }",
-              description: "Example message structure",
-              isOptional: false,
-            },
-          ],
-        },
-      ],
+      name: "inputData",
+      type: "z.infer<TInput>",
+      description: "Input data that matches the workflow's input schema",
+      isOptional: true,
     },
     {
-      name: "finish",
-      type: "object",
-      description: "The end of the workflow",
-      isOptional: false,
-      properties: [
-        {
-          type: "object",
-          parameters: [
-            {
-              name: "example",
-              type: "{ type: 'finish', runId: '1', from: 'WORKFLOW', payload: { totalUsage: { promptTokens: 100, completionTokens: 100, totalTokens: 200 } } }",
-              description: "Example message structure",
-              isOptional: false,
-            },
-          ],
-        },
-      ],
+      name: "runtimeContext",
+      type: "RuntimeContext",
+      description: "Runtime context data to use during workflow execution",
+      isOptional: true,
     },
   ]}
 />
 
 ## Returns
 
-### PropertiesTable for Return Values
-
 <PropertiesTable
   content={[
     {
-      name: "usage",
-      type: "Promise<object>",
-      isOptional: true,
-      description:
-        "Total usage of the workflow, including sub agents/workflows as a step.",
-      properties: [
-        {
-          type: "number",
-          parameters: [
-            {
-              name: "promptTokens",
-              type: "number",
-              isOptional: true,
-              description: "The number of prompt tokens used by the agent.",
-            },
-          ],
-        },
-        {
-          type: "number",
-          parameters: [
-            {
-              name: "completionTokens",
-              type: "number",
-              isOptional: true,
-              description: "The number of completion tokens used by the agent.",
-            },
-          ],
-        },
-        {
-          type: "number",
-          parameters: [
-            {
-              name: "totalTokens",
-              type: "number", 
-              isOptional: true,
-              description: "The total number of tokens used by the agent.",
-            },
-          ],
-        },
-      ],
+      name: "stream",
+      type: "MastraWorkflowStream<ChunkType>",
+      description: "A custom stream that extends ReadableStream<ChunkType> with additional workflow-specific properties",
     },
     {
-      name: "status",
-      type: "Promise<string>",
-      isOptional: true,
-      description:
-        "The status of the workflow run.",
+      name: "stream.status",
+      type: "Promise<WorkflowRunStatus>",
+      description: "A promise that resolves to the current workflow run status",
     },
     {
-      name: "result",
-      type: "Promise<object>",
-      isOptional: true,
-      description:
-        "The result of the workflow run.",
+      name: "stream.result",
+      type: "Promise<WorkflowResult<TOutput, TSteps>>",
+      description: "A promise that resolves to the final workflow result",
+    },
+    {
+      name: "stream.usage",
+      type: "Promise<{ promptTokens: number; completionTokens: number; totalTokens: number }>",
+      description: "A promise that resolves to token usage statistics",
     },
   ]}
 />
 
-## Examples
+## Extended usage example
 
-### Basic Streaming
+```typescript showLineNumbers copy
+const run = await workflow.createRunAsync();
 
-```typescript
-const run = await myWorkflow.createRunAsync();
-const stream = run.streamVNext({ inputData: {...} });
+const stream = run.streamVNext({
+  inputData: {
+    value: "initial data",
+  },
+});
 
-for await (const chunk of stream) {
-  process.stdout.write(chunk);
-}
+const result = await stream.result;
 ```
 
-### Structured Output Streaming
+## Stream Events
+
+The stream emits various event types during workflow execution. Each event has a `type` field and a `payload` containing relevant data:
+
+- **`start`**: Workflow execution begins
+- **`step-start`**: A step begins execution
+- **`step-output`**: Custom output from a step
+- **`step-result`**: A step completes with results
+- **`finish`**: Workflow execution completes with usage statistics
+
+
 
-```typescript
-const run = await myWorkflow.createRunAsync();
-const stream = run.streamVNext({ inputData: {...} });
 
 
-const result = await stream.result;
-console.log("Final structured result:", result);
-```
 

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

@@ -1,16 +1,16 @@
 ---
-title: "Reference: Workflow.then() | Building Workflows | Mastra Docs"
-description: Documentation for the `.then()` method in workflows, which creates sequential dependencies between steps.
+title: "Reference: Workflow.then() | Workflows | Mastra Docs"
+description: Documentation for the `Workflow.then()` method in workflows, which creates sequential dependencies between steps.
 ---
 
 # Workflow.then()
 
 The `.then()` method creates a sequential dependency between workflow steps, ensuring steps execute in a specific order.
 
-## Usage
+## Usage example
 
-```typescript
-workflow.then(stepOne).then(stepTwo);
+```typescript copy
+workflow.then(step1).then(step2);
 ```
 
 ## Parameters

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

@@ -1,16 +1,16 @@
 ---
-title: "Reference: Workflow.waitForEvent() | Building Workflows | Mastra Docs"
-description: Documentation for the `.waitForEvent()` method in workflows, which pauses execution until an event is received.
+title: "Reference: Workflow.waitForEvent() | Workflows | Mastra Docs"
+description: Documentation for the `Workflow.waitForEvent()` method in workflows, which pauses execution until an event is received.
 ---
 
 # Workflow.waitForEvent()
 
 The `.waitForEvent()` method pauses execution until an event is received.
 
-## Usage
+## Usage example
 
-```typescript
-workflow.waitForEvent('my-event-name', step1);
+```typescript copy
+workflow.waitForEvent('event-name', step1);
 ```
 
 ## Parameters

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

@@ -1,24 +1,22 @@
 ---
-title: "Reference: Workflow.watch() | Building Workflows | Mastra Docs"
-description: Documentation for the `.watch()` method in workflows, which allows you to monitor the execution of a workflow run.
+title: "Reference: WorkflowRun.watch() | Workflows | Mastra Docs"
+description: Documentation for the `WorkflowRun.watch()` method in workflows, which allows you to monitor the execution of a workflow run.
 ---
 
-# Workflow.watch()
+# WorkflowRun.watch()
 
 The `.watch()` method allows you to monitor the execution of a workflow run, providing real-time updates on the status of steps.
 
-## Usage
+## Usage example
 
-```typescript
-const run = await myWorkflow.createRunAsync();
+```typescript showLineNumbers copy
+const run = await workflow.createRunAsync();
 
-// Add a watcher to monitor execution
 run.watch(event => {
-  console.log('Step completed:', event.payload.currentStep.id);
+  console.log('Step completed:', event?.payload?.currentStep?.id);
 });
 
-// Start the workflow
-const result = await run.start({ inputData: {...} });
+const result = await run.start({ inputData: { value: "initial data" } });
 ```
 
 ## Parameters
@@ -26,15 +24,22 @@ const result = await run.start({ inputData: {...} });
 <PropertiesTable
   content={[
     {
-      name: "cb",
+      name: "callback",
       type: "(event: WatchEvent) => void",
-      description:
-        "A callback function that is called whenever a step is completed or the workflow state changes",
+      description: "A callback function that is called whenever a step is completed or the workflow state changes. The event parameter contains: type ('watch'), payload (currentStep and workflowState), and eventTimestamp",
       isOptional: false,
     },
+    {
+      name: "type",
+      type: "'watch' | 'watch-v2'",
+      description: "The type of watch events to listen for. 'watch' for step completion events, 'watch-v2' for data stream events",
+      isOptional: true,
+      defaultValue: "'watch'",
+    },
   ]}
 />
 
+
 ## Returns
 
 <PropertiesTable
@@ -48,6 +53,19 @@ const result = await run.start({ inputData: {...} });
   ]}
 />
 
+## Extended usage example
+
+```typescript showLineNumbers copy
+const run = await workflow.createRunAsync();
+
+run.watch((event) => {
+  console.log("Step completed:", event?.payload?.currentStep?.id);
+}, 'watch');
+
+
+const result = await run.start({ inputData: { value: "initial data" } });
+```
+
 ## Related
 
 - [Suspend and resume](../../docs/workflows/suspend-and-resume.mdx)

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

@@ -1,42 +1,30 @@
 ---
-title: "Reference: Workflow Class | Building Workflows | Mastra Docs"
-description: Documentation for the Workflow class in Mastra, which enables you to create state machines for complex sequences of operations with conditional branching and data validation.
+title: "Reference: Workflow Class | Workflows | Mastra Docs"
+description: Documentation for the `Workflow` class in Mastra, which enables you to create state machines for complex sequences of operations with conditional branching and data validation.
 ---
 
 # Workflow Class
 
-The Workflow class enables you to create state machines for complex sequences of operations with conditional branching and data validation.
+The `Workflow` class enables you to create state machines for complex sequences of operations with conditional branching and data validation.
 
-## Usage
+## Usage example
 
-```typescript
-const myWorkflow = createWorkflow({
-  id: "my-workflow",
+```typescript filename="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
+import { createWorkflow } from "@mastra/core/workflows";
+import { z } from "zod";
+
+const workflow = createWorkflow({
+  id: "test-workflow",
   inputSchema: z.object({
-    startValue: z.string(),
+    value: z.string(),
   }),
   outputSchema: z.object({
-    result: z.string(),
-  }),
-  steps: [step1, step2, step3], // Declare steps used in this workflow
+    value: z.string(),
+  })
 })
-  .then(step1)
-  .then(step2)
-  .then(step3)
-  .commit();
-
-const mastra = new Mastra({
-  workflows: {
-    myWorkflow,
-  },
-});
-
-const run = await mastra.getWorkflow("myWorkflow").createRunAsync();
 ```
 
-## API Reference
-
-### Constructor
+## Constructor parameters
 
 <PropertiesTable
   content={[
@@ -54,64 +42,13 @@ const run = await mastra.getWorkflow("myWorkflow").createRunAsync();
       name: "outputSchema",
       type: "z.ZodType<any>",
       description: "Zod schema defining the output structure for the workflow",
-    },
-    {
-      name: "steps",
-      type: "Step[]",
-      description: "Array of steps to include in the workflow",
-    },
+    }
   ]}
 />
 
-### Core Methods
-
-#### `then()`
-
-Adds a step to the workflow sequentially. Returns the workflow instance for chaining.
-
-#### `parallel()`
-
-Executes multiple steps concurrently. Takes an array of steps and returns the workflow instance.
-
-#### `branch()`
-
-Creates conditional branching logic. Takes an array of tuples containing condition functions and steps to execute when conditions are met.
-
-#### `dowhile()`
-
-Creates a loop that executes a step repeatedly while a condition remains true. The condition is checked after each execution.
-
-#### `dountil()`
-
-Creates a loop that executes a step repeatedly until a condition becomes true. The condition is checked after each execution.
-
-#### `foreach()`
+## Workflow status
 
-Iterates over an array and executes a step for each element. Accepts optional concurrency configuration.
-
-#### `map()`
-
-Maps data between steps using either a mapping configuration object or a mapping function. Useful for transforming data between steps.
-
-#### `commit()`
-
-Validates and finalizes the workflow configuration. Must be called after adding all steps.
-
-#### `createRun()`
-
-Deprecated. Creates a new workflow run instance, allowing you to execute the workflow with specific input data. Accepts optional run ID.
-
-#### `createRunAsync()`
-
-Creates a new workflow run instance, allowing you to execute the workflow with specific input data. Accepts optional run ID. Stores a pending workflow run snapshot into storage.
-
-#### `execute()`
-
-Executes the workflow with provided input data. Handles workflow suspension, resumption and emits events during execution.
-
-## Workflow Status
-
-A workflow's status indicates its current execution state. The possible values are:
+A workflow's `status` indicates its current execution state. The possible values are:
 
 <PropertiesTable
   content={[
@@ -136,28 +73,18 @@ A workflow's status indicates its current execution state. The possible values a
   ]}
 />
 
-## Passing Context Between Steps
+## Extended usage example
 
-Steps can access data from previous steps in the workflow through the context object. Each step receives the accumulated context from all previous steps that have executed.
+```typescript filename="src/test-run.ts" showLineNumbers copy
+import { mastra } from "./mastra";
 
-```typescript
-workflow
-  .then({
-    id: "getData",
-    execute: async ({ inputData }) => {
-      return {
-        data: { id: "123", value: "example" },
-      };
-    },
-  })
-  .then({
-    id: "processData",
-    execute: async ({ inputData }) => {
-      // Access data from previous step through context.steps
-      const previousData = inputData.data;
-      // Process previousData.id and previousData.value
-    },
-  });
+const run = await mastra.getWorkflow("workflow").createRunAsync();
+
+const result = await run.start({...});
+
+if (result.status === "suspended") {
+  const resumedResult = await run.resume({...});
+}
 ```
 
 ## Related

package/.docs/raw/scorers/overview.mdx

@@ -48,6 +48,14 @@ This modular structure enables both simple single-step evaluations and complex m
 
 To learn how to create your own Scorers, see [Creating Custom Scorers](/docs/scorers/custom-scorers).
 
+## Installation
+
+To access Mastra's scorers feature install the `@mastra/evals` package.
+
+```bash copy
+npm install @mastra/evals@latest
+```
+
 ## Live evaluations
 
 **Live evaluations** allow you to automatically score AI outputs in real-time as your agents and workflows operate. Instead of running evaluations manually or in batches, scorers run asynchronously alongside your AI systems, providing continuous quality monitoring.

package/.docs/raw/server-db/local-dev-playground.mdx

@@ -13,12 +13,27 @@ Mastra provides a local development environment where you can test your agents,
 
 Start the local development server by running:
 
-<Tabs items={["npm", "Mastra CLI"]}>
+<Tabs items={["npm", "yarn", "pnpm", "bun", "Mastra CLI"]}>
   <Tab>
     ```bash copy
     npm run dev
     ```
   </Tab>
+  <Tab>
+    ```bash copy
+    yarn run dev
+    ```
+  </Tab>
+  <Tab>
+    ```bash copy
+    pnpm run dev
+    ```
+  </Tab>
+  <Tab>
+    ```bash copy
+    bun run dev
+    ```
+  </Tab>
   <Tab>
     ```bash copy
     mastra dev

package/dist/tools/__tests__/test-setup.d.ts

@@ -1,5 +1,5 @@
 import { MCPClient } from '@mastra/mcp';
 export declare const server: import("@hono/node-server").ServerType;
 export declare const mcp: MCPClient;
-export declare function callTool(tool: any, args: any): Promise<string>;
+export declare function callTool(tool: any, args: any): Promise<any>;
 //# sourceMappingURL=test-setup.d.ts.map

package/dist/tools/__tests__/test-setup.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"test-setup.d.ts","sourceRoot":"","sources":["../../../src/tools/__tests__/test-setup.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAuCxC,eAAO,MAAM,MAAM,wCAGjB,CAAC;AAKH,eAAO,MAAM,GAAG,WAWd,CAAC;AAEH,wBAAsB,QAAQ,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,mBAsBlD"}
+{"version":3,"file":"test-setup.d.ts","sourceRoot":"","sources":["../../../src/tools/__tests__/test-setup.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAuCxC,eAAO,MAAM,MAAM,wCAGjB,CAAC;AAKH,eAAO,MAAM,GAAG,WAWd,CAAC;AAEH,wBAAsB,QAAQ,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,gBA2BlD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/mcp-docs-server",
-  "version": "0.13.11-alpha.0",
+  "version": "0.13.11-alpha.2",
   "description": "MCP server for accessing Mastra.ai documentation, changelogs, and news.",
   "type": "module",
   "main": "dist/index.js",
@@ -32,8 +32,8 @@
     "uuid": "^11.1.0",
     "zod": "^3.25.67",
     "zod-to-json-schema": "^3.24.5",
-    "@mastra/core": "0.13.2-alpha.0",
-    "@mastra/mcp": "^0.10.10"
+    "@mastra/core": "0.13.2-alpha.2",
+    "@mastra/mcp": "^0.10.11-alpha.0"
   },
   "devDependencies": {
     "@hono/node-server": "^1.17.1",
@@ -49,7 +49,7 @@
     "typescript": "^5.8.3",
     "vitest": "^3.2.4",
     "@internal/lint": "0.0.28",
-    "@mastra/core": "0.13.2-alpha.0"
+    "@mastra/core": "0.13.2-alpha.2"
   },
   "scripts": {
     "prepare-docs": "cross-env PREPARE=true node dist/prepare-docs/prepare.js",