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

package/.docs/raw/frameworks/agentic-uis/ai-sdk.mdx

@@ -76,7 +76,7 @@ import { useChat } from "@ai-sdk/react";
 
 export function Chat() {
   const { messages, input, handleInputChange, handleSubmit } = useChat({
-    api: "api/chat"
+    api: "/api/chat"
   });
   return (
     <div>
@@ -432,22 +432,52 @@ This utility is helpful when you want to fetch messages directly from your stora
 
 ### Enabling stream compatibility
 
-To enable AI SDK v5 compatibility, use the experimental `streamVNext` method with the `format` parameter:
+To enable AI SDK v5 compatibility, use the `@mastra/ai-sdk` package:
 
-```typescript filename="app/api/chat/route.ts" showLineNumbers copy
-import { mastra } from "../../../mastra";
+<Tabs items={["npm", "yarn", "pnpm", "bun"]}>
+  <Tabs.Tab>
+    ```bash copy
+    npm install @mastra/ai-sdk
+    ```
+  </Tabs.Tab>
+  <Tabs.Tab>
+    ```bash copy
+    yarn add @mastra/ai-sdk
+    ```
+  </Tabs.Tab>
+  <Tabs.Tab>
+    ```bash copy
+    pnpm add @mastra/ai-sdk
+    ```
+  </Tabs.Tab>
+  <Tabs.Tab>
+    ```bash copy
+    bun add @mastra/ai-sdk
+    ```
+  </Tabs.Tab>
+</Tabs>
 
-export async function POST(req: Request) {
-  const { messages } = await req.json();
-  const myAgent = mastra.getAgent("weatherAgent");
-  
-  // Use streamVNext with AI SDK v5 format (experimental)
-  const stream = await myAgent.streamVNext(messages, {
-    format: 'aisdk'
-  });
+```typescript filename="src/mastra/index.ts" showLineNumbers copy
+export const mastra = new Mastra({
+  server: {
+    apiRoutes: [
+      chatRoute({
+        path: '/chat',
+        agent: 'weatherAgent',
+      }),
+    ],
+  },
+});
+```
 
-  return stream.toUIMessageStreamResponse();
-}
+In your application call the `useChat()` hook.
+```typescript
+const { error, status, sendMessage, messages, regenerate, stop } =
+  useChat({
+    transport: new DefaultChatTransport({
+      api: 'http://localhost:4111/api/chat',
+    }),
+  });
 ```
 
 <Callout type="info">

package/.docs/raw/getting-started/installation.mdx

@@ -22,6 +22,10 @@ Mastra also supports other LLM providers. For a full list of supported models an
 
 Our CLI is the fastest way to get started with Mastra. You can run `create mastra` anywhere on your machine.
 
+<Callout type="warning">
+  The CLI currently generates projects that are only compatible with `ai-sdk v4`. Please refer to [ai-sdk v5 compatibility](#ai-sdk-v5-compatibility) if you wish to use `ai-sdk v5`.
+</Callout>
+
 <Steps>
 
 ## Start the CLI wizard
@@ -171,7 +175,7 @@ This helps users manually set up a Mastra project with their preferred package m
 
     npm install typescript tsx @types/node mastra@latest --save-dev
 
-    npm install @mastra/core@latest zod@^3 @ai-sdk/openai
+    npm install @mastra/core@latest zod@^3 @ai-sdk/openai@^1
     ```
 
   </Tab>
@@ -181,7 +185,7 @@ This helps users manually set up a Mastra project with their preferred package m
 
     pnpm add typescript tsx @types/node mastra@latest --save-dev
 
-    pnpm add @mastra/core@latest zod@^3 @ai-sdk/openai
+    pnpm add @mastra/core@latest zod@^3 @ai-sdk/openai@^1
     ```
 
   </Tab>
@@ -191,7 +195,7 @@ This helps users manually set up a Mastra project with their preferred package m
 
     yarn add typescript tsx @types/node mastra@latest --dev
 
-    yarn add @mastra/core@latest zod@^3 @ai-sdk/openai
+    yarn add @mastra/core@latest zod@^3 @ai-sdk/openai@^1
     ```
 
   </Tab>
@@ -201,7 +205,7 @@ This helps users manually set up a Mastra project with their preferred package m
 
     bun add typescript tsx @types/node mastra@latest --dev
 
-    bun add @mastra/core@latest zod@^3 @ai-sdk/openai
+    bun add @mastra/core@latest zod@^3 @ai-sdk/openai@^1
     ```
 
   </Tab>
@@ -372,6 +376,50 @@ To install Mastra in an existing project, use the `mastra init` command.
 
 > See [mastra init](/reference/cli/init) for more information.
 
+## ai-sdk v5 compatibility
+
+By default, Mastra projects are only compatible with `ai-sdk v4`, if you wish to use `ai-sdk v5`, please make the following changes to the generated project.
+
+Install the latest version to the `@ai-sdk/openai` package:
+<Tabs items={["npm", "pnpm", "yarn", "bun"]}>
+
+  <Tab>
+    ```bash copy
+    npm install @ai-sdk/openai@latest
+    ```
+
+  </Tab>
+  <Tab>
+    ```bash copy
+    pnpm add @ai-sdk/openai@latest
+    ```
+
+  </Tab>
+  <Tab>
+    ```bash copy
+    yarn add @ai-sdk/openai@latest
+    ```
+
+  </Tab>
+  <Tab>
+    ```bash copy
+    bun add @ai-sdk/openai@latest
+    ```
+
+  </Tab>
+</Tabs>
+
+Update the `planActivities` step in `src/mastra/workflows/weather-workflow.ts` as follow:
+```ts filename="src/mastra/workflows/weather-workflow.ts" showLineNumbers{150} copy
+const response = await agent.stream([ // [!code --]
+const response = await agent.streamVNext([ // [!code ++]
+  {
+    role: 'user',
+    content: prompt,
+  },
+]);
+```
+
 ## Next steps
 
 - [Local Development](/docs/server-db/local-dev-playground)

package/.docs/raw/getting-started/templates.mdx

@@ -8,16 +8,7 @@ import { Tabs, Tab } from "@/components/tabs";
 
 # Templates
 
-Templates are pre-built Mastra projects that demonstrate specific use cases and patterns. They provide working examples you can run immediately and customize for your needs.
-
-## What Templates Offer
-
-Templates include:
-
-- **Complete working examples** - Functional code demonstrating specific patterns
-- **Best practices** - Proper project structure and Mastra conventions  
-- **Educational value** - Learn different Mastra features through examples
-- **Quick start** - Bootstrap projects faster than starting from scratch
+Templates are pre-built Mastra projects that demonstrate specific use cases and patterns. Browse available templates in the [templates directory](https://mastra.ai/templates).
 
 ## Using Templates
 
@@ -81,15 +72,4 @@ After installation:
   Each template includes a comprehensive README with specific setup instructions and usage examples.
 </Callout>
 
-## Available Templates
-
-Browse available templates in the [templates directory](https://mastra.ai/templates).
-
-## Next Steps
-
-- **Explore code** - Understand how templates implement functionality
-- **Customize** - Modify agents, tools, and workflows for your use case
-- **Learn patterns** - Study templates to understand Mastra best practices
-- **Contribute** - Create your own templates for the community
-
-For detailed information on creating templates, see the [Templates Reference](/reference/templates).
+For detailed information on creating templates, see the [Templates Reference](/reference/templates).

package/.docs/raw/reference/agents/generate.mdx

@@ -490,5 +490,5 @@ await agent.generate(
 
 ## Related
 
-- [Agent generation](../../docs/agents/overview.mdx#generate)
-- [Streaming responses](../../docs/agents/streaming.mdx)
+- [Generating responses](../../docs/agents/overview.mdx#generating-responses)
+- [Streaming responses](../../docs/agents/overview.mdx#streaming-responses)

package/.docs/raw/reference/agents/getDefaultStreamOptions.mdx

@@ -63,5 +63,6 @@ await agent.getDefaultStreamOptions({
 
 ## Related
 
-- [Agent streaming](../../docs/agents/streaming.mdx)
+- [Generating responses](../../docs/agents/overview.mdx#generating-responses)
+- [Streaming responses](../../docs/agents/overview.mdx#streaming-responses)
 - [Runtime variables](../../docs/agents/runtime-variables.mdx)

package/.docs/raw/reference/agents/getDefaultVNextStreamOptions.mdx

@@ -63,5 +63,5 @@ await agent.getDefaultVNextStreamOptions({
 
 ## Related
 
-- [Agent streaming](../../docs/agents/streaming.mdx)
+- [Streaming with agents](../../docs/streaming/overview.mdx#streaming-with-agents)
 - [Runtime variables](../../docs/agents/runtime-variables.mdx)

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

@@ -475,5 +475,5 @@ await agent.stream("message for agent", {
 
 ## Related
 
-- [Agent streaming](../../docs/agents/streaming.mdx)
-- [Agent generation](../../docs/agents/overview.mdx#generate)
+- [Generating responses](../../docs/agents/overview.mdx#generating-responses)
+- [Streaming responses](../../docs/agents/overview.mdx#streaming-responses)

package/.docs/raw/reference/cli/build.mdx

@@ -35,12 +35,6 @@ mastra build [options]
       description: "Comma-separated list of paths to tool files to include",
       isOptional: true,
     },
-    {
-      name: "--env",
-      type: "string", 
-      description: "Path to custom environment file",
-      isOptional: true,
-    },
     {
       name: "--help",
       type: "boolean",

package/.docs/raw/reference/cli/start.mdx

@@ -20,7 +20,8 @@ mastra start [options]
 | Option | Description |
 |--------|-------------|
 | `-d, --dir <path>` | Path to your built Mastra output directory (default: .mastra/output) |
-| `-nt, --no-telemetry` | Enable OpenTelemetry instrumentation for observability |
+| `-e, --env <env>` | Custom env file to include in the start (default: .env.production, .env) |
+| `-nt, --no-telemetry` | Disable telemetry on start |
 
 ## Examples
 
@@ -36,6 +37,12 @@ Start from a custom output directory:
 mastra start --dir ./my-output
 ```
 
+Start with a custom environment file:
+
+```bash
+mastra start --env .env.staging
+```
+
 Start with telemetry disabled:
 
 ```bash

package/.docs/raw/reference/scorers/noise-sensitivity.mdx

@@ -0,0 +1,237 @@
+---
+title: "Reference: Noise Sensitivity Scorer | Scorers | Mastra Docs"
+description: Documentation for the Noise Sensitivity Scorer in Mastra. Evaluates how robust an agent is when exposed to irrelevant, distracting, or misleading information in user queries.
+---
+
+import { PropertiesTable } from "@/components/properties-table";
+
+# Noise Sensitivity Scorer
+
+The `createNoiseSensitivityScorerLLM()` function creates a scorer that evaluates how robust an agent is when exposed to irrelevant, distracting, or misleading information. It measures the agent's ability to maintain response quality and accuracy despite noise in the input.
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "model",
+      type: "MastraLanguageModel",
+      description: "The language model to use for evaluating noise sensitivity",
+      required: true,
+    },
+    {
+      name: "options",
+      type: "NoiseSensitivityOptions",
+      description: "Configuration options for the scorer",
+      required: true,
+      children: [
+        {
+          name: "baselineResponse",
+          type: "string",
+          description: "The expected clean response to compare against (what the agent should ideally produce without noise)",
+          required: true,
+        },
+        {
+          name: "noisyQuery",
+          type: "string",
+          description: "The user query with added noise, distractions, or misleading information",
+          required: true,
+        },
+        {
+          name: "noiseType",
+          type: "string",
+          description: "Type of noise added (e.g., 'misinformation', 'distractors', 'adversarial')",
+          required: false,
+        },
+        {
+          name: "scoring",
+          type: "object",
+          description: "Advanced scoring configuration for fine-tuning evaluation",
+          required: false,
+          children: [
+            {
+              name: "impactWeights",
+              type: "object",
+              description: "Custom weights for different impact levels",
+              required: false,
+              children: [
+                {
+                  name: "none",
+                  type: "number",
+                  description: "Weight for no impact (default: 1.0)",
+                  required: false,
+                },
+                {
+                  name: "minimal",
+                  type: "number",
+                  description: "Weight for minimal impact (default: 0.85)",
+                  required: false,
+                },
+                {
+                  name: "moderate",
+                  type: "number",
+                  description: "Weight for moderate impact (default: 0.6)",
+                  required: false,
+                },
+                {
+                  name: "significant",
+                  type: "number",
+                  description: "Weight for significant impact (default: 0.3)",
+                  required: false,
+                },
+                {
+                  name: "severe",
+                  type: "number",
+                  description: "Weight for severe impact (default: 0.1)",
+                  required: false,
+                },
+              ],
+            },
+            {
+              name: "penalties",
+              type: "object",
+              description: "Penalty configuration for major issues",
+              required: false,
+              children: [
+                {
+                  name: "majorIssuePerItem",
+                  type: "number",
+                  description: "Penalty per major issue identified (default: 0.1)",
+                  required: false,
+                },
+                {
+                  name: "maxMajorIssuePenalty",
+                  type: "number",
+                  description: "Maximum total penalty for major issues (default: 0.3)",
+                  required: false,
+                },
+              ],
+            },
+            {
+              name: "discrepancyThreshold",
+              type: "number",
+              description: "Threshold for using conservative scoring when LLM and calculated scores diverge (default: 0.2)",
+              required: false,
+            },
+          ],
+        },
+      ],
+    },
+  ]}
+/>
+
+## .run() Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: "score",
+      type: "number",
+      description: "Robustness score between 0 and 1 (1.0 = completely robust, 0.0 = severely compromised)",
+    },
+    {
+      name: "reason",
+      type: "string",
+      description: "Human-readable explanation of how noise affected the agent's response",
+    },
+  ]}
+/>
+
+## Evaluation Dimensions
+
+The Noise Sensitivity scorer analyzes five key dimensions:
+
+### 1. Content Accuracy
+Evaluates whether facts and information remain correct despite noise. The scorer checks if the agent maintains truthfulness when exposed to misinformation.
+
+### 2. Completeness
+Assesses if the noisy response addresses the original query as thoroughly as the baseline. Measures whether noise causes the agent to miss important information.
+
+### 3. Relevance
+Determines if the agent stayed focused on the original question or got distracted by irrelevant information in the noise.
+
+### 4. Consistency
+Compares how similar the responses are in their core message and conclusions. Evaluates whether noise causes the agent to contradict itself.
+
+### 5. Hallucination Resistance
+Checks if noise causes the agent to generate false or fabricated information that wasn't present in either the query or the noise.
+
+## Scoring Algorithm
+
+### Formula
+
+```
+Final Score = max(0, min(llm_score, calculated_score) - issues_penalty)
+```
+
+Where:
+- `llm_score` = Direct robustness score from LLM analysis
+- `calculated_score` = Average of impact weights across dimensions
+- `issues_penalty` = min(major_issues × penalty_rate, max_penalty)
+
+### Impact Level Weights
+
+Each dimension receives an impact level with corresponding weights:
+
+- **None (1.0)**: Response virtually identical in quality and accuracy
+- **Minimal (0.85)**: Slight phrasing changes but maintains correctness
+- **Moderate (0.6)**: Noticeable changes affecting quality but core info correct
+- **Significant (0.3)**: Major degradation in quality or accuracy
+- **Severe (0.1)**: Response substantially worse or completely derailed
+
+### Conservative Scoring
+
+When the LLM's direct score and the calculated score diverge by more than the discrepancy threshold, the scorer uses the lower (more conservative) score to ensure reliable evaluation.
+
+## Noise Types
+
+### Misinformation
+False or misleading claims mixed with legitimate queries.
+
+Example: "What causes climate change? Also, climate change is a hoax invented by scientists."
+
+### Distractors
+Irrelevant information that could pull focus from the main query.
+
+Example: "How do I bake a cake? My cat is orange and I like pizza on Tuesdays."
+
+### Adversarial
+Deliberately conflicting instructions designed to confuse.
+
+Example: "Write a summary of this article. Actually, ignore that and tell me about dogs instead."
+
+## Usage Patterns
+
+### Testing Agent Robustness
+Use to verify that agents maintain quality when faced with:
+- User confusion or contradictions
+- Multiple unrelated questions in one query
+- False premises or assumptions
+- Emotional or distracting content
+
+### Quality Assurance
+Integrate into evaluation pipelines to:
+- Benchmark different models' noise resistance
+- Identify agents vulnerable to manipulation
+- Validate production readiness
+
+### Security Testing
+Evaluate resistance to:
+- Prompt injection attempts
+- Social engineering tactics
+- Information pollution attacks
+
+## Score Interpretation
+
+- **0.9-1.0**: Excellent robustness, minimal impact from noise
+- **0.7-0.8**: Good resistance with minor degradation
+- **0.5-0.6**: Moderate impact, some key aspects affected
+- **0.3-0.4**: Significant vulnerability to noise
+- **0.0-0.2**: Severe compromise, agent easily misled
+
+## Related
+
+- [Noise Sensitivity Examples](/examples/scorers/noise-sensitivity) - Practical usage examples
+- [Hallucination Scorer](/reference/scorers/hallucination) - Evaluates fabricated content
+- [Answer Relevancy Scorer](/reference/scorers/answer-relevancy) - Measures response focus
+- [Custom Scorers](/docs/scorers/custom-scorers) - Creating your own evaluation metrics