@mastra/mcp-docs-server 0.13.37 → 0.13.39-alpha.0

package/.docs/raw/reference/processors/pii-detector.mdx

@@ -10,11 +10,10 @@ The `PIIDetector` is a **hybrid processor** that can be used for both input and
 ## Usage example
 
 ```typescript copy
-import { openai } from "@ai-sdk/openai";
 import { PIIDetector } from "@mastra/core/processors";
 
 const processor = new PIIDetector({
-  model: openai("gpt-4.1-nano"),
+  model: "openai/gpt-4.1-nano",
   threshold: 0.6,
   strategy: "redact",
   detectionTypes: ["email", "phone", "credit-card", "ssn"]
@@ -40,7 +39,7 @@ const processor = new PIIDetector({
   content={[
     {
       name: "model",
-      type: "MastraLanguageModel",
+      type: "MastraModelConfig",
       description: "Model configuration for the detection agent",
       isOptional: false,
     },
@@ -123,18 +122,19 @@ const processor = new PIIDetector({
 
 ## Extended usage example
 
-```typescript filename="src/mastra/agents/private-agent.ts" showLineNumbers copy
-import { openai } from "@ai-sdk/openai";
+### Input processing
+
+```typescript title="src/mastra/agents/private-agent.ts" showLineNumbers copy
 import { Agent } from "@mastra/core/agent";
 import { PIIDetector } from "@mastra/core/processors";
 
 export const agent = new Agent({
   name: "private-agent",
   instructions: "You are a helpful assistant",
-  model: openai("gpt-4o-mini"),
+  model: "openai/gpt-4o-mini",
   inputProcessors: [
     new PIIDetector({
-      model: openai("gpt-4.1-nano"),
+      model: "openai/gpt-4.1-nano",
       detectionTypes: ["email", "phone", "credit-card", "ssn"],
       threshold: 0.6,
       strategy: "redact",
@@ -147,7 +147,32 @@ export const agent = new Agent({
 });
 ```
 
+### Output processing with batching
+
+When using `PIIDetector` as an output processor, it's recommended to combine it with `BatchPartsProcessor` to optimize performance. The `BatchPartsProcessor` batches stream chunks together before passing them to the PII detector, reducing the number of LLM calls required for detection.
+
+```typescript title="src/mastra/agents/output-pii-agent.ts" showLineNumbers copy
+import { Agent } from "@mastra/core/agent";
+import { BatchPartsProcessor, PIIDetector } from "@mastra/core/processors";
+
+export const agent = new Agent({
+  name: "output-pii-agent",
+  instructions: "You are a helpful assistant",
+  model: "openai/gpt-4o-mini",
+  outputProcessors: [
+    // Batch stream parts first to reduce LLM calls
+    new BatchPartsProcessor({
+      batchSize: 10,
+    }),
+    // Then apply PII detection on batched content
+    new PIIDetector({
+      model: "openai/gpt-4.1-nano",
+      strategy: "redact",
+    })
+  ]
+});
+```
+
 ## Related
 
-- [Input Processors](/docs/agents/input-processors)
-- [Output Processors](/docs/agents/output-processors)
+- [Guardrails](/docs/agents/guardrails)

package/.docs/raw/reference/processors/prompt-injection-detector.mdx

@@ -10,11 +10,10 @@ The `PromptInjectionDetector` is an **input processor** that detects and prevent
 ## Usage example
 
 ```typescript copy
-import { openai } from "@ai-sdk/openai";
 import { PromptInjectionDetector } from "@mastra/core/processors";
 
 const processor = new PromptInjectionDetector({
-  model: openai("gpt-4.1-nano"),
+  model: "openai/gpt-4.1-nano",
   threshold: 0.8,
   strategy: "rewrite",
   detectionTypes: ["injection", "jailbreak", "system-override"]
@@ -40,7 +39,7 @@ const processor = new PromptInjectionDetector({
   content={[
     {
       name: "model",
-      type: "MastraLanguageModel",
+      type: "MastraModelConfig",
       description: "Model configuration for the detection agent",
       isOptional: false,
     },
@@ -103,18 +102,17 @@ const processor = new PromptInjectionDetector({
 
 ## Extended usage example
 
-```typescript filename="src/mastra/agents/secure-agent.ts" showLineNumbers copy
-import { openai } from "@ai-sdk/openai";
+```typescript title="src/mastra/agents/secure-agent.ts" showLineNumbers copy
 import { Agent } from "@mastra/core/agent";
 import { PromptInjectionDetector } from "@mastra/core/processors";
 
 export const agent = new Agent({
   name: "secure-agent",
   instructions: "You are a helpful assistant",
-  model: openai("gpt-4o-mini"),
+  model: "openai/gpt-4o-mini",
   inputProcessors: [
     new PromptInjectionDetector({
-      model: openai("gpt-4.1-nano"),
+      model: "openai/gpt-4.1-nano",
       detectionTypes: ['injection', 'jailbreak', 'system-override'],
       threshold: 0.8,
       strategy: 'rewrite',
@@ -127,4 +125,4 @@ export const agent = new Agent({
 
 ## Related
 
-- [Input Processors](/docs/agents/input-processors)
+- [Guardrails](/docs/agents/guardrails)

package/.docs/raw/reference/processors/system-prompt-scrubber.mdx

@@ -40,7 +40,7 @@ const processor = new SystemPromptScrubber({
   content={[
     {
       name: "model",
-      type: "MastraLanguageModel",
+      type: "MastraModelConfig",
       description: "Model configuration for the detection agent",
       isOptional: false,
     },
@@ -116,30 +116,34 @@ const processor = new SystemPromptScrubber({
 
 ## Extended usage example
 
-```typescript filename="src/mastra/agents/scrubbed-agent.ts" showLineNumbers copy
-import { openai } from "@ai-sdk/openai";
+When using `SystemPromptScrubber` as an output processor, it's recommended to combine it with `BatchPartsProcessor` to optimize performance. The `BatchPartsProcessor` batches stream chunks together before passing them to the scrubber, reducing the number of LLM calls required for detection.
+
+```typescript title="src/mastra/agents/scrubbed-agent.ts" showLineNumbers copy
 import { Agent } from "@mastra/core/agent";
-import { SystemPromptScrubber } from "@mastra/core/processors";
+import { BatchPartsProcessor, SystemPromptScrubber } from "@mastra/core/processors";
 
 export const agent = new Agent({
   name: "scrubbed-agent",
   instructions: "You are a helpful assistant",
-  model: openai("gpt-4o-mini"),
+  model: "openai/gpt-4o-mini",
   outputProcessors: [
+    // Batch stream parts first to reduce LLM calls
+    new BatchPartsProcessor({
+      batchSize: 10,
+    }),
+    // Then apply system prompt detection on batched content
     new SystemPromptScrubber({
-      model: openai("gpt-4.1-nano"),
+      model: "openai/gpt-4.1-nano",
       strategy: "redact",
       customPatterns: ["system prompt", "internal instructions"],
       includeDetections: true,
-      instructions: "Detect and redact system prompts, internal instructions, and security-sensitive content",
       redactionMethod: "placeholder",
       placeholderText: "[REDACTED]"
-    })
+    }),
   ]
 });
 ```
 
 ## Related
 
-- [Input Processors](/docs/agents/input-processors)
-- [Output Processors](/docs/agents/output-processors)
+- [Guardrails](/docs/agents/guardrails)

package/.docs/raw/reference/processors/token-limiter-processor.mdx

@@ -111,15 +111,14 @@ const processor = new TokenLimiterProcessor({
 
 ## Extended usage example
 
-```typescript filename="src/mastra/agents/limited-agent.ts" showLineNumbers copy
-import { openai } from "@ai-sdk/openai";
+```typescript title="src/mastra/agents/limited-agent.ts" showLineNumbers copy
 import { Agent } from "@mastra/core/agent";
 import { TokenLimiterProcessor } from "@mastra/core/processors";
 
 export const agent = new Agent({
   name: "limited-agent",
   instructions: "You are a helpful assistant",
-  model: openai("gpt-4o-mini"),
+  model: "openai/gpt-4o-mini",
   outputProcessors: [
     new TokenLimiterProcessor({
       limit: 1000,
@@ -132,5 +131,4 @@ export const agent = new Agent({
 
 ## Related
 
-- [Input Processors](/docs/agents/input-processors)
-- [Output Processors](/docs/agents/output-processors)
+- [Guardrails](/docs/agents/guardrails)

package/.docs/raw/reference/processors/unicode-normalizer.mdx

@@ -88,15 +88,14 @@ const processor = new UnicodeNormalizer({
 
 ## Extended usage example
 
-```typescript filename="src/mastra/agents/normalized-agent.ts" showLineNumbers copy
-import { openai } from "@ai-sdk/openai";
+```typescript title="src/mastra/agents/normalized-agent.ts" showLineNumbers copy
 import { Agent } from "@mastra/core/agent";
 import { UnicodeNormalizer } from "@mastra/core/processors";
 
 export const agent = new Agent({
   name: "normalized-agent",
   instructions: "You are a helpful assistant",
-  model: openai("gpt-4o-mini"),
+  model: "openai/gpt-4o-mini",
   inputProcessors: [
     new UnicodeNormalizer({
       stripControlChars: true,
@@ -111,4 +110,4 @@ export const agent = new Agent({
 
 ## Related
 
-- [Input Processors](../../docs/agents/input-processors.mdx)
+- [Guardrails](/docs/agents/guardrails)

package/.docs/raw/reference/rag/chunk.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: .chunk() | Document Processing | RAG | Mastra Docs"
+title: "Reference: Reference: .chunk() | RAG | Mastra Docs"
 description: Documentation for the chunk function in Mastra, which splits documents into smaller segments using various strategies.
 ---
 
@@ -59,13 +59,15 @@ The following parameters are available for all chunking strategies.
       type: "number",
       isOptional: true,
       defaultValue: "4000",
-      description: "Maximum size of each chunk. **Note:** Some strategy configurations (markdown with headers, HTML with headers) ignore this parameter.",
+      description:
+        "Maximum size of each chunk. **Note:** Some strategy configurations (markdown with headers, HTML with headers) ignore this parameter.",
     },
     {
       name: "size",
       type: "number",
       isOptional: true,
-      description: "**Deprecated:** Use `maxSize` instead. This parameter will be removed in the next major version.",
+      description:
+        "**Deprecated:** Use `maxSize` instead. This parameter will be removed in the next major version.",
     },
     {
       name: "overlap",
@@ -78,7 +80,8 @@ The following parameters are available for all chunking strategies.
       name: "lengthFunction",
       type: "(text: string) => number",
       isOptional: true,
-      description: "Function to calculate text length. Defaults to character count.",
+      description:
+        "Function to calculate text length. Defaults to character count.",
     },
     {
       name: "keepSeparator",
@@ -105,13 +108,12 @@ The following parameters are available for all chunking strategies.
       name: "extract",
       type: "ExtractParams",
       isOptional: true,
-      description:
-        "Metadata extraction configuration.",
+      description: "Metadata extraction configuration.",
     },
   ]}
 />
 
-See [ExtractParams reference](/reference/rag/extract-params.mdx) for details on the `extract` parameter.
+See [ExtractParams reference](/reference/rag/extract-params) for details on the `extract` parameter.
 
 ## Strategy-Specific Options
 
@@ -189,7 +191,8 @@ The options documented below are passed directly at the top level of the configu
       name: "separators",
       type: "string[]",
       isOptional: true,
-      description: "Array of separators to try in order of preference. The strategy will attempt to split on the first separator, then fall back to subsequent ones.",
+      description:
+        "Array of separators to try in order of preference. The strategy will attempt to split on the first separator, then fall back to subsequent ones.",
     },
     {
       name: "isSeparatorRegex",
@@ -209,7 +212,8 @@ The options documented below are passed directly at the top level of the configu
       name: "separators",
       type: "string[]",
       isOptional: true,
-      description: "Array of separators to try in order of preference. The strategy will attempt to split on the first separator, then fall back to subsequent ones.",
+      description:
+        "Array of separators to try in order of preference. The strategy will attempt to split on the first separator, then fall back to subsequent ones.",
     },
     {
       name: "isSeparatorRegex",
@@ -222,7 +226,8 @@ The options documented below are passed directly at the top level of the configu
       name: "language",
       type: "Language",
       isOptional: true,
-      description: "Programming or markup language for language-specific splitting behavior. See Language enum for supported values.",
+      description:
+        "Programming or markup language for language-specific splitting behavior. See Language enum for supported values.",
     },
   ]}
 />
@@ -234,41 +239,47 @@ The options documented below are passed directly at the top level of the configu
     {
       name: "maxSize",
       type: "number",
-      description: "Maximum size of each chunk (required for sentence strategy)",
+      description:
+        "Maximum size of each chunk (required for sentence strategy)",
     },
     {
       name: "minSize",
       type: "number",
       isOptional: true,
       defaultValue: "50",
-      description: "Minimum size of each chunk. Chunks smaller than this will be merged with adjacent chunks when possible.",
+      description:
+        "Minimum size of each chunk. Chunks smaller than this will be merged with adjacent chunks when possible.",
     },
     {
       name: "targetSize",
       type: "number",
       isOptional: true,
-      description: "Preferred target size for chunks. Defaults to 80% of maxSize. The strategy will try to create chunks close to this size.",
+      description:
+        "Preferred target size for chunks. Defaults to 80% of maxSize. The strategy will try to create chunks close to this size.",
     },
     {
       name: "sentenceEnders",
       type: "string[]",
       isOptional: true,
       defaultValue: "['.', '!', '?']",
-      description: "Array of characters that mark sentence endings for splitting boundaries.",
+      description:
+        "Array of characters that mark sentence endings for splitting boundaries.",
     },
     {
       name: "fallbackToWords",
       type: "boolean",
       isOptional: true,
       defaultValue: "true",
-      description: "Whether to fall back to word-level splitting for sentences that exceed maxSize.",
+      description:
+        "Whether to fall back to word-level splitting for sentences that exceed maxSize.",
     },
     {
       name: "fallbackToCharacters",
       type: "boolean",
       isOptional: true,
       defaultValue: "true",
-      description: "Whether to fall back to character-level splitting for words that exceed maxSize. Only applies if fallbackToWords is enabled.",
+      description:
+        "Whether to fall back to character-level splitting for words that exceed maxSize. Only applies if fallbackToWords is enabled.",
     },
   ]}
 />
@@ -336,33 +347,38 @@ The options documented below are passed directly at the top level of the configu
       type: "number",
       isOptional: true,
       defaultValue: "500",
-      description: "Maximum token count for merging related sections. Sections exceeding this limit individually are left intact, but smaller sections are merged with siblings or parents if the combined size stays under this threshold.",
+      description:
+        "Maximum token count for merging related sections. Sections exceeding this limit individually are left intact, but smaller sections are merged with siblings or parents if the combined size stays under this threshold.",
     },
     {
       name: "modelName",
       type: "string",
       isOptional: true,
-      description: "Name of the model for tokenization. If provided, the model's underlying tokenization `encodingName` will be used.",
+      description:
+        "Name of the model for tokenization. If provided, the model's underlying tokenization `encodingName` will be used.",
     },
     {
       name: "encodingName",
       type: "string",
       isOptional: true,
       defaultValue: "cl100k_base",
-      description: "Name of the token encoding to use. Derived from `modelName` if available.",
+      description:
+        "Name of the token encoding to use. Derived from `modelName` if available.",
     },
     {
       name: "allowedSpecial",
       type: "Set<string> | 'all'",
       isOptional: true,
-      description: "Set of special tokens allowed during tokenization, or 'all' to allow all special tokens",
+      description:
+        "Set of special tokens allowed during tokenization, or 'all' to allow all special tokens",
     },
     {
       name: "disallowedSpecial",
       type: "Set<string> | 'all'",
       isOptional: true,
       defaultValue: "all",
-      description: "Set of special tokens to disallow during tokenization, or 'all' to disallow all special tokens",
+      description:
+        "Set of special tokens to disallow during tokenization, or 'all' to disallow all special tokens",
     },
   ]}
 />
@@ -387,13 +403,15 @@ The options documented below are passed directly at the top level of the configu
       name: "allowedSpecial",
       type: "Set<string> | 'all'",
       isOptional: true,
-      description: "Set of special tokens allowed during tokenization, or 'all' to allow all special tokens",
+      description:
+        "Set of special tokens allowed during tokenization, or 'all' to allow all special tokens",
     },
     {
       name: "disallowedSpecial",
       type: "Set<string> | 'all'",
       isOptional: true,
-      description: "Set of special tokens to disallow during tokenization, or 'all' to disallow all special tokens",
+      description:
+        "Set of special tokens to disallow during tokenization, or 'all' to disallow all special tokens",
     },
   ]}
 />