@mastra/mcp-docs-server 0.13.7-alpha.4 → 0.13.7

package/.docs/organized/changelogs/mastra.md

@@ -1,5 +1,16 @@
 # mastra
 
+## 0.10.16-alpha.3
+
+### Patch Changes
+
+- f42c4c2: update peer deps for packages to latest core range
+- Updated dependencies [f42c4c2]
+  - @mastra/deployer@0.12.0-alpha.5
+  - @mastra/loggers@0.10.5-alpha.0
+  - @mastra/mcp@0.10.8-alpha.0
+  - @mastra/core@0.12.0-alpha.5
+
 ## 0.10.16-alpha.2
 
 ### Patch Changes
@@ -287,16 +298,5 @@
 - Updated dependencies [626b0f4]
 - Updated dependencies [c22a91f]
 - Updated dependencies [f7403ab]
-- Updated dependencies [6c89d7f]
-  - @mastra/deployer@0.10.15-alpha.0
-  - @mastra/core@0.10.15-alpha.0
-
-## 0.10.12
-
-### Patch Changes
-
-- 640f47e: move agent model settings into agent settings
-- 5d0c163: Scaffold create-mastra projects with zod@^3 to prevent package version conflicts during install
-- 53e3f58: Add support for custom instrumentation files
 
-... 4594 more lines hidden. See full changelog in package directory.
+... 4605 more lines hidden. See full changelog in package directory.

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

@@ -0,0 +1,118 @@
+---
+title: "Using Agent Streaming | Agents | Mastra Docs"
+description: Documentation on how to stream agents
+---
+
+# Agent Streaming
+
+Agents in Mastra have access to a powerful streaming protocol! With seamless integration into tools or agents as a tool, 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 agent. This method will return a custom MastraAgentStream. This stream extends a ReadableStream, so all basic stream methods are available.
+
+```typescript
+const stream = await agent.streamVNext({ role: "user", content: "Tell me a story." });
+
+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.finishReason` - The reason the agent stopped streaming.
+- `stream.toolCalls` - The tool calls made by the agent.
+- `stream.toolResults` - The tool results returned by the agent.
+- `stream.usage` - The total token usage of the agent, including agents/workflows as a tool.
+- `stream.text` - The full text of the agent's response.
+- `stream.object` - The object of the agent's response, if you use output or experimental output.
+- `stream.textStream` - A readable stream that will emit the text of the agent's response.
+
+### 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
+  },
+});
+```
+
+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/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 agent's input stream will allow us to automatically sum up the usage of the agent so the total usage count can be calculated.
+

package/.docs/raw/evals/custom-eval.mdx

@@ -3,8 +3,12 @@ title: "Create a custom eval"
 description: "Mastra allows you to create your own evals, here is how."
 ---
 
+import { ScorerCallout } from '@/components/scorer-callout'
+
 # Create a Custom Eval
 
+<ScorerCallout />
+
 Create a custom eval by extending the `Metric` class and implementing the `measure` method. This gives you full control over how scores are calculated and what information is returned. For LLM-based evaluations, extend the `MastraAgentJudge` class to define how the model reasons and scores output.
 
 ## Native JavaScript evaluation

package/.docs/raw/evals/overview.mdx

@@ -3,8 +3,12 @@ title: "Overview"
 description: "Understanding how to evaluate and measure AI agent quality using Mastra evals."
 ---
 
+import { ScorerCallout } from '@/components/scorer-callout'
+
 # Testing your agents with evals
 
+<ScorerCallout />
+
 While traditional software tests have clear pass/fail conditions, AI outputs are non-deterministic — they can vary with the same input. Evals help bridge this gap by providing quantifiable metrics for measuring agent quality.
 
 Evals are automated tests that evaluate Agents outputs using model-graded, rule-based, and statistical methods. Each eval returns a normalized score between 0-1 that can be logged and compared. Evals can be customized with your own prompts and scoring functions.

package/.docs/raw/evals/running-in-ci.mdx

@@ -3,8 +3,12 @@ title: "Running in CI"
 description: "Learn how to run Mastra evals in your CI/CD pipeline to monitor agent quality over time."
 ---
 
+import { ScorerCallout } from '@/components/scorer-callout'
+
 # Running Evals in CI
 
+<ScorerCallout />
+
 Running evals in your CI pipeline helps bridge this gap by providing quantifiable metrics for measuring agent quality over time.
 
 ## Setting Up CI Integration

package/.docs/raw/evals/textual-evals.mdx

@@ -3,8 +3,12 @@ title: "Textual Evals"
 description: "Understand how Mastra uses LLM-as-judge methodology to evaluate text quality."
 ---
 
+import { ScorerCallout } from '@/components/scorer-callout'
+
 # Textual Evals
 
+<ScorerCallout />
+
 Textual evals use an LLM-as-judge methodology to evaluate agent outputs. This approach leverages language models to assess various aspects of text quality, similar to how a teaching assistant might grade assignments using a rubric.
 
 Each eval focuses on specific quality aspects and returns a score between 0 and 1, providing quantifiable metrics for non-deterministic AI outputs.