@mastra/mcp-docs-server 0.13.17-alpha.2 → 0.13.17-alpha.4

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

@@ -1,154 +0,0 @@
----
-title: "Using Agent Streaming | Agents | Mastra Docs"
-description: Documentation on how to stream agents
----
-
-import { Callout } from "nextra/components";
-
-# Agent Streaming (VNext)
-
-Agents in Mastra support streaming responses for real-time interaction with clients. This enables progressive rendering of responses and better user experience.
-
-<Callout type="info">
-  **Experimental API**: The `streamVNext` method shown in this guide is an experimental feature with enhanced streaming format support. It will replace the current `stream()` method after additional testing and refinement. For production use, consider using the stable [`stream()` method](/docs/agents/overview#streaming-responses) until `streamVNext` is finalized.
-</Callout>
-
-## Usage
-
-The experimental streaming protocol uses the `streamVNext` method on an agent. This method now supports multiple output stream formats, for Mastra (default) and AI SDK v5.
-
-
-## Format Parameter
-
-The `format` parameter determines the output stream type:
-
-- **`'mastra'` (default)**: Returns `MastraModelOutput` - Mastra's native streaming format
-- **`'aisdk'`**: Returns `AISDKV5OutputStream` - Compatible with AI SDK v5 interfaces like useChat.
-
-```typescript
-// Mastra format (default)
-const mastraStream = await agent.streamVNext("Hello");
-
-// AI SDK v5 format
-const aiSdkStream = await agent.streamVNext("Hello", { 
-  format: 'aisdk' 
-});
-```
-
-### Default Mastra Format
-
-By default, `streamVNext` returns a `MastraModelOutput` stream:
-
-```typescript
-const stream = await agent.streamVNext("Tell me a story.");
-
-// Access the text stream
-for await (const chunk of stream.textStream) {
-  console.log(chunk);
-}
-
-// Or get the full text after streaming
-const fullText = await stream.text;
-```
-
-### AI SDK v5 Compatibility
-
-For integration with AI SDK v5, use the `format: 'aisdk'` parameter to get an `AISDKV5OutputStream`:
-
-```typescript
-const stream = await agent.streamVNext("Tell me a story.", {
-  format: 'aisdk'
-});
-
-// The stream is now compatible with AI SDK v5 interfaces
-for await (const chunk of stream.fullStream) {
-  // Process AI SDK v5 formatted chunks
-  console.log(chunk);
-}
-```
-
-## Stream Properties
-
-Both stream formats provide access to various response properties:
-
-- `stream.textStream` - A readable stream that emits text chunks
-- `stream.text` - Promise that resolves to the full text response
-- `stream.finishReason` - The reason the agent stopped streaming
-- `stream.usage` - Token usage information
-
-### How to use the stream in a tool
-
-Each tool gets a `writer` argument, which is a writable stream with a custom write function. This write function is used to write the tool's response to the stream.
-
-```typescript filename="src/mastra/tools/test-tool.ts" showLineNumbers copy
-import { createTool } from "@mastra/core/tools";
-import { z } from "zod";
-
-export const weatherInfo = createTool({
-  id: "Get Weather Information",
-  inputSchema: z.object({
-    city: z.string(),
-  }),
-  outputSchema: z.object({
-    conditions: z.string(),
-    temperature: z.number(),
-  }),
-  description: `Fetches the current weather information for a given city`,
-  execute: async ({ context: { city }, writer }) => {
-    writer.write({
-      type: "weather-data",
-      args: {
-        city
-      },
-      status: "pending"
-    })
-    // Tool logic here (e.g., API call)
-    console.log("Using tool to fetch weather information for", city);
-
-    writer.write({
-      type: "weather-data",
-      args: {
-        city
-      },
-      status: "success",
-      result: {
-        temperature: 20,
-        conditions: "Sunny"
-      }
-    })
-
-    return { temperature: 20, conditions: "Sunny" }; // Example return
-  },
-});
-```
-
-To use streaming within an agent-based tool, call `streamVNext` on the agent and pipe it to the writer:
-
-```typescript filename="src/mastra/tools/test-tool.ts" showLineNumbers copy
-import { createTool } from "@mastra/core/tools";
-import { z } from "zod";
-
-export const weatherInfo = createTool({
-  id: "Get Weather Information",
-  description: `Fetches the current weather information for a given city`,
-  inputSchema: z.object({
-    city: z.string(),
-  }),
-  outputSchema: z.object({
-    text: z.string(),
-  }),
-  execute: async ({ context: { city }, writer, mastra }) => {
-    const agent = mastra.getAgent('weatherAgent')
-    const stream = await agent.streamVNext(`What is the weather in ${city}?`);
-
-    await stream.pipeTo(writer);
-
-    return {
-      text: await stream.text,
-    }
-  },
-});
-```
-
-Piping the stream to the writer enables automatic aggregation of token usage across nested agent calls.
-

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

@@ -1,115 +0,0 @@
----
-title: "Using Workflow Streaming | Workflows | Mastra Docs"
-description: Documentation on how to stream workflows
----
-
-# Workflow Streaming
-
-Workflows in Mastra have access to a powerful streaming protocol! With seamless integration into tools or agents as a step, you can stream responses directly back to your clients, creating a more interactive and engaging experience.
-
-## Usage
-
-To use the new protocol, you can use the `streamVNext` method on an workflow. This method will return a custom MatraWorkflowStream. This stream extends a ReadableStream, so all basic stream methods are available.
-
-```typescript
-const run = await myWorkflow.createRunAsync();
-const stream = await run.streamVNext({ inputData: { city: 'New York' } });
-
-for await (const chunk of stream) {
-  console.log(chunk);
-}
-```
-
-Each chunk is a JSON object with the following properties:
-
-```json
-{
-  type: string;
-  runId: string;
-  from: string;
-  payload: Record<string, any>;
-}
-```
-
-We have a couple of utility functions on the stream to help you with the streaming process.
-
-- `stream.status` - The status of the workflow run.
-- `stream.result` - The result of the workflow run.
-- `stream.usage` - The total token usage of the workflow run.
-
-### How to use the stream in a tool
-
-Each tool gets a `writer` argument, which is a writable stream with a custom write function. This write function is used to write the tool's response to the stream.
-
-```typescript filename="src/mastra/workflows/weather.ts" showLineNumbers copy
-import { createStep } from "@mastra/core/workflows";
-import { z } from "zod";
-
-export const weatherInfo = createStep({
-  id: "weather-info",
-  inputSchema: z.object({
-    city: z.string(),
-  }),
-  outputSchema: z.object({
-    conditions: z.string(),
-    temperature: z.number(),
-  }),
-  description: `Fetches the current weather information for a given city`,
-  execute: async ({ inputData: { city }, writer }) => {
-    writer.write({
-      type: "weather-data",
-      args: {
-        city
-      },
-      status: "pending"
-    })
-    // Tool logic here (e.g., API call)
-    console.log("Using tool to fetch weather information for", city);
-
-    writer.write({
-      type: "weather-data",
-      args: {
-        city
-      },
-      status: "success",
-      result: {
-        temperature: 20,
-        conditions: "Sunny"
-      }
-    })
-
-    return { temperature: 20, conditions: "Sunny" }; // Example return
-  },
-});
-```
-
-If you want to use the stream in an agent, you can use the `streamVNext` method on the agent and pipe it to the agent's input stream.
-
-```typescript filename="src/mastra/workflows/weather.ts" showLineNumbers copy
-import { createStep } from "@mastra/core/workflows";
-import { z } from "zod";
-
-export const weatherInfo = createStep({
-  id: "weather-info",
-  inputSchema: z.object({
-    city: z.string(),
-  }),
-  outputSchema: z.object({
-    text: z.string(),
-  }),
-  description: `Fetches the current weather information for a given city`,
-  execute: async ({ inputData: { city }, writer, mastra }) => {
-    const agent = mastra.getAgent('weatherAgent')
-    const stream = await agent.streamVNext(`What is the weather in ${city}?`);
-
-    await stream.pipeTo(writer);
-
-    return {
-      text: await stream.text,
-    }
-  },
-});
-```
-
-Piping the stream to the agent's input stream will allow us to automatically sum up the usage of the agent so the total usage count can be calculated.
-