@mastra/mcp-docs-server 1.0.0-beta.9 → 1.0.1

package/.docs/raw/reference/streaming/agents/MastraModelOutput.mdx

@@ -1,6 +1,8 @@
 ---
 title: "Reference: MastraModelOutput | Streaming"
 description: "Complete reference for MastraModelOutput - the stream object returned by agent.stream() with streaming and promise-based access to model outputs."
+packages:
+  - "@mastra/core"
 ---
 
 import PropertiesTable from "@site/src/components/PropertiesTable";
@@ -49,7 +51,7 @@ These properties provide real-time access to model outputs as they're generated:
     },
     {
       name: "objectStream",
-      type: "ReadableStream<PartialSchemaOutput<OUTPUT>>",
+      type: "ReadableStream<Partial<OUTPUT>>",
       description:
         "Stream of progressive structured object updates when using output schemas. Emits partial objects as they're built up, allowing real-time visualization of structured data generation.",
       properties: [
@@ -58,7 +60,7 @@ These properties provide real-time access to model outputs as they're generated:
           parameters: [
             {
               name: "PartialSchemaOutput",
-              type: "PartialSchemaOutput<OUTPUT>",
+              type: "Partial<OUTPUT>",
               description:
                 "Partially completed object matching the defined schema",
             },
@@ -68,7 +70,7 @@ These properties provide real-time access to model outputs as they're generated:
     },
     {
       name: "elementStream",
-      type: "ReadableStream<InferSchemaOutput<OUTPUT> extends (infer T)[] ? T : never>",
+      type: "ReadableStream<OUTPUT extends (infer T)[] ? T : never>",
       description:
         "Stream of individual array elements when the output schema defines an array type. Each element is emitted as it's completed rather than waiting for the entire array.",
     },
@@ -89,7 +91,7 @@ These properties resolve to final values after the stream completes:
     },
     {
       name: "object",
-      type: "Promise<InferSchemaOutput<OUTPUT>>",
+      type: "Promise<OUTPUT>",
       description:
         "The complete structured object response when using output schemas. Validated against the schema before resolving. Rejects if validation fails.",
       properties: [
@@ -98,7 +100,7 @@ These properties resolve to final values after the stream completes:
           parameters: [
             {
               name: "InferSchemaOutput",
-              type: "InferSchemaOutput<OUTPUT>",
+              type: "OUTPUT",
               description:
                 "Fully typed object matching the exact schema definition",
             },
@@ -259,6 +261,55 @@ These properties resolve to final values after the stream completes:
         },
       ],
     },
+    {
+      name: "response",
+      type: "Promise<Response>",
+      description:
+        "Response metadata and messages from the model provider.",
+      properties: [
+        {
+          type: "Response",
+          parameters: [
+            {
+              name: "id",
+              type: "string",
+              isOptional: true,
+              description: "Response ID from the model provider",
+            },
+            {
+              name: "timestamp",
+              type: "Date",
+              isOptional: true,
+              description: "Response timestamp",
+            },
+            {
+              name: "modelId",
+              type: "string",
+              isOptional: true,
+              description: "Model identifier used for this response",
+            },
+            {
+              name: "headers",
+              type: "Record<string, string>",
+              isOptional: true,
+              description: "Response headers from the model provider",
+            },
+            {
+              name: "messages",
+              type: "ResponseMessage[]",
+              isOptional: true,
+              description: "Response messages in model format",
+            },
+            {
+              name: "uiMessages",
+              type: "UIMessage[]",
+              isOptional: true,
+              description: "Response messages in UI format, includes any metadata added by output processors",
+            },
+          ],
+        },
+      ],
+    },
   ]}
 />
 
@@ -295,7 +346,7 @@ These properties resolve to final values after the stream completes:
             },
             {
               name: "object",
-              type: "InferSchemaOutput<OUTPUT>",
+              type: "OUTPUT",
               isOptional: true,
               description: "Structured output if schema was provided",
             },
@@ -326,6 +377,11 @@ These properties resolve to final values after the stream completes:
               isOptional: true,
               description: "Why generation finished",
             },
+            {
+              name: "response",
+              type: "Response",
+              description: "Response metadata and messages from the model provider",
+            },
           ],
         },
       ],
@@ -441,6 +497,11 @@ for await (const chunk of stream.fullStream) {
       break;
     case "finish":
       console.log(`Done! Reason: ${chunk.payload.stepResult.reason}`);
+      // Access response messages with any metadata added by output processors
+      const uiMessages = chunk.payload.response?.uiMessages;
+      if (uiMessages) {
+        console.log("Response messages:", uiMessages);
+      }
       break;
   }
 }

package/.docs/raw/reference/streaming/agents/stream.mdx

@@ -1,24 +1,20 @@
 ---
 title: "Reference: Agent.stream() | Streaming"
 description: "Documentation for the `Agent.stream()` method in Mastra agents, which enables real-time streaming of responses with enhanced capabilities."
+packages:
+  - "@mastra/ai-sdk"
 ---
 
 import { MODEL_SETTINGS_OBJECT } from "@site/src/components/ModelSettingsProperties";
 
 # Agent.stream()
 
-The `.stream()` method enables real-time streaming of responses from an agent with enhanced capabilities and format flexibility. This method accepts messages and optional streaming options, providing a next-generation streaming experience with support for both Mastra's native format and AI SDK v5 compatibility.
+The `.stream()` method enables real-time streaming of responses from an agent with enhanced capabilities and format flexibility. This method accepts messages and optional streaming options, providing a next-generation streaming experience with support for both Mastra's native format and AI SDK v5+ compatibility.
 
 ## Usage example
 
-```ts title="index.ts" copy
-// Default Mastra format
-const mastraStream = await agent.stream("message for agent");
-
-// AI SDK v5 compatible format
-const aiSdkStream = await agent.stream("message for agent", {
-  format: "aisdk",
-});
+```ts title="index.ts"
+const stream = await agent.stream("message for agent");
 ```
 
 :::info
@@ -50,14 +46,6 @@ const aiSdkStream = await agent.stream("message for agent", {
 
 <PropertiesTable
   content={[
-    {
-      name: "format",
-      type: "'mastra' | 'aisdk'",
-      isOptional: true,
-      defaultValue: "'mastra'",
-      description:
-        "Determines the output stream format. Use 'mastra' for Mastra's native format (default) or 'aisdk' for AI SDK v5 compatibility.",
-    },
     {
       name: "maxSteps",
       type: "number",
@@ -336,7 +324,7 @@ const aiSdkStream = await agent.stream("message for agent", {
               type: "MemoryConfig",
               isOptional: true,
               description:
-                "Configuration for memory behavior, like message history and semantic recall.",
+                "Configuration for memory behavior including lastMessages, readOnly, semanticRecall, and workingMemory.",
             },
           ],
         },
@@ -356,13 +344,6 @@ const aiSdkStream = await agent.stream("message for agent", {
       description:
         "Callback function called after each execution step. Receives step details as a JSON string. Unavailable for structured output",
     },
-    {
-      name: "resourceId",
-      type: "string",
-      isOptional: true,
-      description:
-        "**Deprecated.** Use `memory.resource` instead. Identifier for the user or resource interacting with the agent. Must be provided if threadId is provided.",
-    },
     {
       name: "telemetry",
       type: "TelemetrySettings",
@@ -417,13 +398,6 @@ const aiSdkStream = await agent.stream("message for agent", {
       ],
     },
     MODEL_SETTINGS_OBJECT,
-    {
-      name: "threadId",
-      type: "string",
-      isOptional: true,
-      description:
-        "**Deprecated.** Use `memory.thread` instead. Identifier for the conversation thread. Allows for maintaining context across multiple interactions. Must be provided if resourceId is provided.",
-    },
     {
       name: "toolChoice",
       type: "'auto' | 'none' | 'required' | { type: 'tool'; toolName: string }",
@@ -491,6 +465,27 @@ const aiSdkStream = await agent.stream("message for agent", {
       description:
         "Save messages incrementally after each stream step completes (default: false).",
     },
+    {
+      name: "requireToolApproval",
+      type: "boolean",
+      isOptional: true,
+      description:
+        "When true, all tool calls require explicit approval before execution. The stream will emit `tool-call-approval` chunks and pause until `approveToolCall()` or `declineToolCall()` is called.",
+    },
+    {
+      name: "autoResumeSuspendedTools",
+      type: "boolean",
+      isOptional: true,
+      description:
+        "When true, automatically resumes suspended tools when the user sends a new message on the same thread. The agent extracts `resumeData` from the user's message based on the tool's `resumeSchema`. Requires memory to be configured.",
+    },
+    {
+      name: "toolCallConcurrency",
+      type: "number",
+      isOptional: true,
+      description:
+        "Maximum number of tool calls to execute concurrently. Defaults to 1 when approval may be required, otherwise 10.",
+    },
     {
       name: "providerOptions",
       type: "Record<string, Record<string, JSONValue>>",
@@ -650,9 +645,9 @@ const aiSdkStream = await agent.stream("message for agent", {
   content={[
     {
       name: "stream",
-      type: "MastraModelOutput<Output> | AISDKV5OutputStream<Output>",
+      type: "MastraModelOutput<Output>",
       description:
-        "Returns a streaming interface based on the format parameter. When format is 'mastra' (default), returns MastraModelOutput. When format is 'aisdk', returns AISDKV5OutputStream for AI SDK v5 compatibility.",
+        "Returns a MastraModelOutput instance that provides access to the streaming output.",
     },
     {
       name: "traceId",
@@ -668,7 +663,7 @@ const aiSdkStream = await agent.stream("message for agent", {
 
 ### Mastra Format (Default)
 
-```ts title="index.ts" showLineNumbers copy
+```ts title="index.ts"
 import { stepCountIs } from "ai-v5";
 
 const stream = await agent.stream("Tell me a story", {
@@ -683,39 +678,41 @@ for await (const chunk of stream.textStream) {
   console.log(chunk);
 }
 
+// or access full stream
+for await (const chunk of stream.fullStream) {
+  console.log(chunk);
+}
+
 // Get full text after streaming
 const fullText = await stream.text;
 ```
 
-### AI SDK v5 Format
+### AI SDK v5+ Format
 
-```ts title="index.ts" showLineNumbers copy
-import { stepCountIs } from "ai-v5";
+To use the stream with AI SDK v5 (and later), you can convert it using our utility function `toAISdkStream`.
+
+```ts title="index.ts"
+import { stepCountIs, createUIMessageStreamResponse } from "ai";
+import { toAISdkStream } from "@mastra/ai-sdk";
 
 const stream = await agent.stream("Tell me a story", {
-  format: "aisdk",
   stopWhen: stepCountIs(3), // Stop after 3 steps
   modelSettings: {
     temperature: 0.7,
   },
 });
 
-// Use with AI SDK v5 compatible interfaces
-for await (const part of stream.fullStream) {
-  if (part.type === "text-delta") {
-    console.log(part.text);
-  }
-}
-
 // In an API route for frontend integration
-return stream.toUIMessageStreamResponse();
+return createUIMessageStreamResponse({
+  stream: toAISdkStream(stream, { from: "agent" }),
+})
 ```
 
 ### Using Callbacks
 
 All callback functions are now available as top-level properties for a cleaner API experience.
 
-```ts title="index.ts" showLineNumbers copy
+```ts title="index.ts"
 const stream = await agent.stream("Tell me a story", {
   onFinish: (result) => {
     console.log("Streaming finished:", result);
@@ -742,12 +739,11 @@ for await (const chunk of stream.textStream) {
 
 ### Advanced Example with Options
 
-```ts title="index.ts" showLineNumbers copy
+```ts title="index.ts"
 import { z } from "zod";
-import { stepCountIs } from "ai-v5";
+import { stepCountIs } from "ai";
 
 await agent.stream("message for agent", {
-  format: "aisdk", // Enable AI SDK v5 compatibility
   stopWhen: stepCountIs(3), // Stop after 3 steps
   modelSettings: {
     temperature: 0.7,
@@ -778,3 +774,4 @@ await agent.stream("message for agent", {
 
 - [Generating responses](/docs/v1/agents/overview#generating-responses)
 - [Streaming responses](/docs/v1/agents/overview#generating-responses)
+- [Agent Approval](/docs/v1/agents/agent-approval)

package/.docs/raw/reference/streaming/agents/streamLegacy.mdx

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Agent.streamLegacy() (Legacy) | Streaming"
 description: "Documentation for the legacy `Agent.streamLegacy()` method in Mastra agents. This method is deprecated and will be removed in a future version."
+packages:
+  - "@mastra/core"
 ---
 
 # Agent.streamLegacy() (Legacy)
@@ -15,7 +17,7 @@ The `.streamLegacy()` method is the legacy version of the agent streaming API, u
 
 ## Usage example
 
-```typescript copy
+```typescript
 await agent.streamLegacy("message for agent");
 ```
 
@@ -534,7 +536,7 @@ await agent.streamLegacy("message for agent");
 
 ## Extended usage example
 
-```typescript showLineNumbers copy
+```typescript
 await agent.streamLegacy("message for agent", {
   temperature: 0.7,
   maxSteps: 3,
@@ -550,7 +552,7 @@ await agent.streamLegacy("message for agent", {
 
 :::info
 
-The new `.stream()` method offers enhanced capabilities including AI SDK v5 compatibility, better structured output handling, and improved callback system. See the [migration guide](/guides/v1/migrations/vnext-to-standard-apis) for detailed migration instructions.
+The new `.stream()` method offers enhanced capabilities including AI SDK v5+ compatibility, better structured output handling, and improved callback system. See the [migration guide](/guides/v1/migrations/vnext-to-standard-apis) for detailed migration instructions.
 
 :::
 

package/.docs/raw/reference/streaming/workflows/observeStream.mdx

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Run.observeStream() | Streaming"
 description: Documentation for the `Run.observeStream()` method in workflows, which enables reopening the stream of an already active workflow run.
+packages:
+  - "@mastra/core"
 ---
 
 # Run.observeStream()
@@ -9,7 +11,7 @@ The `.observeStream()` method opens a new `ReadableStream` to a workflow run tha
 
 ## Usage example
 
-```typescript showLineNumbers copy
+```typescript
 const run = await workflow.createRun();
 
 run.stream({

package/.docs/raw/reference/streaming/workflows/resumeStream.mdx

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Run.resumeStream() | Streaming"
 description: Documentation for the `Run.resumeStream()` method in workflows, which enables real-time resumption and streaming of suspended workflow runs.
+packages:
+  - "@mastra/core"
 ---
 
 # Run.resumeStream()
@@ -9,7 +11,7 @@ The `.resumeStream()` method resumes a suspended workflow run with new data, all
 
 ## Usage example
 
-```typescript showLineNumbers copy
+```typescript
 const run = await workflow.createRun();
 
 const stream = run.stream({

package/.docs/raw/reference/streaming/workflows/stream.mdx

@@ -1,22 +1,28 @@
 ---
 title: "Reference: Run.stream() | Streaming"
 description: Documentation for the `Run.stream()` method in workflows, which enables real-time streaming of responses.
+packages:
+  - "@mastra/core"
 ---
 
 # Run.stream()
 
-The `.stream()` method enables real-time streaming of responses from a workflow.
+The `.stream()` method enables real-time streaming of responses from a workflow. It returns a `ReadableStream` of events directly.
 
 ## Usage example
 
-```typescript showLineNumbers copy
+```typescript
 const run = await workflow.createRun();
 
-const stream = run.stream({
+const stream = await run.stream({
   inputData: {
     value: "initial data",
   },
 });
+
+for await (const chunk of stream) {
+  console.log(chunk);
+}
 ```
 
 ## Parameters
@@ -129,42 +135,37 @@ const stream = run.stream({
 
 ## Returns
 
+Returns a `WorkflowRunOutput` object that implements the async iterable interface (can be used directly in `for await...of` loops) and provides access to the stream and workflow execution results.
+
 <PropertiesTable
   content={[
     {
-      name: "stream",
-      type: "MastraWorkflowStream<ChunkType>",
+      name: "fullStream",
+      type: "ReadableStream<WorkflowStreamEvent>",
       description:
-        "A custom stream that extends ReadableStream<ChunkType> with additional workflow-specific properties",
+        "A ReadableStream of workflow events that you can iterate over to track progress in real-time. You can also iterate over the WorkflowRunOutput object directly.",
     },
     {
-      name: "stream.status",
-      type: "Promise<RunStatus>",
-      description: "A promise that resolves to the current workflow run status",
-    },
-    {
-      name: "stream.result",
-      type: "Promise<WorkflowResult<TState, TOutput, TSteps>>",
+      name: "result",
+      type: "Promise<WorkflowResult<TState, TInput, TOutput, TSteps>>",
       description: "A promise that resolves to the final workflow result",
     },
     {
-      name: "stream.usage",
-      type: "Promise<{ inputTokens: number; outputTokens: number; totalTokens: number, reasoningTokens?: number, cacheInputTokens?: number }>",
-      description: "A promise that resolves to token usage statistics",
+      name: "status",
+      type: "WorkflowRunStatus",
+      description: "The current workflow run status ('running', 'suspended', 'success', 'failed', 'canceled', or 'tripwire')",
     },
     {
-      name: "stream.traceId",
-      type: "string",
-      isOptional: true,
-      description:
-        "The trace ID associated with this execution when Tracing is enabled.",
+      name: "usage",
+      type: "Promise<{ inputTokens: number; outputTokens: number; totalTokens: number, reasoningTokens?: number, cachedInputTokens?: number }>",
+      description: "A promise that resolves to token usage statistics",
     },
   ]}
 />
 
 ## Extended usage example
 
-```typescript showLineNumbers copy
+```typescript
 const run = await workflow.createRun();
 
 const stream = run.stream({
@@ -173,7 +174,21 @@ const stream = run.stream({
   },
 });
 
+// Iterate over stream events (you can iterate over stream directly or use stream.fullStream)
+for await (const chunk of stream) {
+  console.log(chunk);
+}
+
+// Access the final result
 const result = await stream.result;
+console.log("Final result:", result);
+
+// Access token usage
+const usage = await stream.usage;
+console.log("Token usage:", usage);
+
+// Check current status
+console.log("Status:", stream.status);
 ```
 
 ## Stream Events

package/.docs/raw/reference/streaming/workflows/timeTravelStream.mdx

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Run.timeTravelStream() | Streaming"
 description: Documentation for the `Run.timeTravelStream()` method for streaming workflow time travel execution.
+packages:
+  - "@mastra/core"
 ---
 
 # Run.timeTravelStream()
@@ -9,7 +11,7 @@ The `.timeTravelStream()` method re-executes a workflow starting from any specif
 
 ## Usage example
 
-```typescript showLineNumbers copy
+```typescript
 const run = await workflow.createRun();
 
 const output = run.timeTravelStream({
@@ -76,7 +78,7 @@ The stream emits various workflow events during execution:
 
 ### Processing events during time travel
 
-```typescript showLineNumbers copy
+```typescript
 const run = await workflow.createRun();
 
 const output = run.timeTravelStream({
@@ -104,7 +106,7 @@ console.log("Time travel completed:", result);
 
 ### Time travel stream with context
 
-```typescript showLineNumbers copy
+```typescript
 const output = run.timeTravelStream({
   step: "step2",
   context: {
@@ -128,7 +130,7 @@ const result = await output.result;
 
 ### Time travel stream with nested workflows
 
-```typescript showLineNumbers copy
+```typescript
 const output = run.timeTravelStream({
   step: ["nestedWorkflow", "step3"],
   inputData: { value: 10 },

package/.docs/raw/reference/templates/overview.mdx

@@ -1,6 +1,8 @@
 ---
 title: "Reference: LLM provider API keys (choose one or more) | Templates"
 description: "Complete guide to creating, using, and contributing Mastra templates"
+packages:
+  - "@mastra/core"
 ---
 
 # Overview
@@ -20,7 +22,7 @@ Mastra templates are pre-built project structures that demonstrate specific use
 
 Install a template using the `create-mastra` command:
 
-```bash copy
+```bash
 npx create-mastra@beta --template template-name
 ```
 
@@ -123,7 +125,6 @@ const agent = new Agent({
   name: "example-agent",
   model: "openai/gpt-5.1", // or other provider strings
   instructions: "Your agent instructions here",
-  // ... other configuration
 });
 ```
 

package/.docs/raw/reference/tools/client.mdx

@@ -1,6 +1,9 @@
 ---
 title: "Reference: MastraMCPClient (Deprecated) | Tools & MCP"
 description: API Reference for MastraMCPClient - A client implementation for the Model Context Protocol.
+packages:
+  - "@mastra/core"
+  - "@mastra/mcp"
 ---
 
 # MastraMCPClient (Deprecated)