@mastra/mcp-docs-server 0.13.38 → 0.13.39

package/.docs/raw/reference/core/listLogsByRunId.mdx

@@ -0,0 +1,87 @@
+---
+title: "Reference: Mastra.listLogsByRunId() | Core | Mastra Docs"
+description: "Documentation for the `Mastra.listLogsByRunId()` method in Mastra, which retrieves logs for a specific run ID and transport ID."
+---
+
+# Mastra.listLogsByRunId()
+
+The `.listLogsByRunId()` method is used to retrieve logs for a specific run ID and transport ID. This method requires a configured logger that supports the `listLogsByRunId` operation.
+
+## Usage example
+
+```typescript copy
+mastra.listLogsByRunId({ runId: "123", transportId: "456" });
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "runId",
+      type: "string",
+      description: "The run ID to retrieve logs for.",
+    },
+    {
+      name: "transportId",
+      type: "string",
+      description: "The transport ID to retrieve logs from.",
+    },
+    {
+      name: "fromDate",
+      type: "Date",
+      description:
+        "Optional start date for filtering logs. e.g., new Date('2024-01-01').",
+      optional: true,
+    },
+    {
+      name: "toDate",
+      type: "Date",
+      description:
+        "Optional end date for filtering logs. e.g., new Date('2024-01-31').",
+      optional: true,
+    },
+    {
+      name: "logLevel",
+      type: "LogLevel",
+      description: "Optional log level to filter by.",
+      optional: true,
+    },
+    {
+      name: "filters",
+      type: "Record<string, any>",
+      description: "Optional additional filters to apply to the log query.",
+      optional: true,
+    },
+    {
+      name: "page",
+      type: "number",
+      description: "Optional page number for pagination.",
+      optional: true,
+    },
+    {
+      name: "perPage",
+      type: "number",
+      description: "Optional number of logs per page for pagination.",
+      optional: true,
+    },
+  ]}
+/>
+
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: "logs",
+      type: "Promise<any>",
+      description:
+        "A promise that resolves to the logs for the specified run ID and transport ID.",
+    },
+  ]}
+/>
+
+## Related
+
+- [Logging overview](/docs/observability/logging)
+- [Logger reference](/reference/observability/logging/pino-logger)

package/.docs/raw/reference/core/listScorers.mdx

@@ -0,0 +1,43 @@
+---
+title: "Reference: listScorers() | Core | Mastra Docs"
+description: "Documentation for the `listScorers()` method in Mastra, which returns all registered scorers for evaluating AI outputs."
+---
+
+# listScorers()
+
+The `listScorers()` method returns all scorers that have been registered with the Mastra instance. Scorers are used for evaluating AI outputs and can override default scorers during agent generation or workflow execution.
+
+## Usage Example
+
+```typescript
+import { mastra } from "./mastra";
+
+// Get all registered scorers
+const allScorers = mastra.listScorers();
+
+// Access a specific scorer
+const myScorer = allScorers.relevancyScorer;
+```
+
+## Parameters
+
+This method takes no parameters.
+
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: "scorers",
+      type: "Record<string, MastraScorer> | undefined",
+      description:
+        "An object containing all registered scorers, where keys are scorer names and values are MastraScorer instances. Returns undefined if no scorers are registered.",
+    },
+  ]}
+/>
+
+## Related
+
+- [getScorer()](../../reference/core/getScorer) - Get a specific scorer by key
+- [getScorerByName()](../../reference/core/getScorerByName) - Get a scorer by its name property
+- [Scorers Overview](../../docs/scorers/overview) - Learn about creating and using scorers

package/.docs/raw/reference/core/listWorkflows.mdx

@@ -0,0 +1,45 @@
+---
+title: "Reference: Mastra.getWorkflows() | Core | Mastra Docs"
+description: "Documentation for the `Mastra.getWorkflows()` method in Mastra, which retrieves all configured workflows."
+---
+
+# Mastra.getWorkflows()
+
+The `.getWorkflows()` method is used to retrieve all workflows that have been configured in the Mastra instance. The method accepts an optional options object.
+
+## Usage example
+
+```typescript copy
+mastra.getWorkflows();
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "options",
+      type: "{ serialized?: boolean }",
+      description:
+        "Optional configuration object. When `serialized` is true, returns simplified workflow objects with only the name property instead of full workflow instances.",
+      optional: true,
+    },
+  ]}
+/>
+
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: "workflows",
+      type: "Record<string, Workflow>",
+      description:
+        "A record of all configured workflows, where keys are workflow IDs and values are workflow instances (or simplified objects if serialized is true).",
+    },
+  ]}
+/>
+
+## Related
+
+- [Workflows overview](/docs/workflows/overview)

package/.docs/raw/reference/memory/memory-class.mdx

@@ -86,7 +86,8 @@ export const agent = new Agent({
     {
       name: "semanticRecall",
       type: "boolean | { topK: number; messageRange: number | { before: number; after: number }; scope?: 'thread' | 'resource' }",
-      description: "Enable semantic search in message history. Can be a boolean or an object with configuration options. When enabled, requires both vector store and embedder to be configured.",
+      description:
+        "Enable semantic search in message history. Can be a boolean or an object with configuration options. When enabled, requires both vector store and embedder to be configured. Default topK is 4, default messageRange is {before: 1, after: 1}.",
       isOptional: true,
       defaultValue: "false",
     },

package/.docs/raw/reference/observability/ai-tracing/ai-tracing.mdx

@@ -1,7 +1,6 @@
 ---
 title: "Reference: AITracing | Observability | Mastra Docs"
 description: Core AI Tracing classes and methods
-asIndexPage: true
 ---
 
 import PropertiesTable from "@site/src/components/PropertiesTable";

package/.docs/raw/reference/observability/ai-tracing/interfaces.mdx

@@ -635,7 +635,7 @@ Options passed when using a custom tracing config selector.
 
 ```typescript
 interface ConfigSelectorOptions {
-  /** Runtime context */
+  /** Request Context */
   runtimeContext?: RuntimeContext;
 }
 ```

package/.docs/raw/reference/observability/otel-tracing/providers/keywordsai.mdx

@@ -66,7 +66,7 @@ telemetry: {
 mastra dev
 ```
 
-This opens the Mastra playground where you can interact with the weather agent.
+This opens Studio where you can interact with the weather agent.
 
 ## Observability
 

package/.docs/raw/reference/processors/batch-parts-processor.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: BatchPartsProcessor | Processors | Mastra Docs"
+title: "Reference: Batch Parts Processor | Processors | Mastra Docs"
 description: "Documentation for the BatchPartsProcessor in Mastra, which batches multiple stream parts together to reduce frequency of emissions."
 ---
 
@@ -15,7 +15,7 @@ import { BatchPartsProcessor } from "@mastra/core/processors";
 const processor = new BatchPartsProcessor({
   batchSize: 5,
   maxWaitTime: 100,
-  emitOnNonText: true,
+  emitOnNonText: true
 });
 ```
 
@@ -46,16 +46,14 @@ const processor = new BatchPartsProcessor({
     {
       name: "maxWaitTime",
       type: "number",
-      description:
-        "Maximum time to wait before emitting a batch (in milliseconds). If set, will emit the current batch even if it hasn't reached batchSize",
+      description: "Maximum time to wait before emitting a batch (in milliseconds). If set, will emit the current batch even if it hasn't reached batchSize",
       isOptional: true,
       default: "undefined (no timeout)",
     },
     {
       name: "emitOnNonText",
       type: "boolean",
-      description:
-        "Whether to emit immediately when a non-text part is encountered",
+      description: "Whether to emit immediately when a non-text part is encountered",
       isOptional: true,
       default: "true",
     },
@@ -81,8 +79,7 @@ const processor = new BatchPartsProcessor({
     {
       name: "flush",
       type: "(state?: BatchPartsState) => ChunkType | null",
-      description:
-        "Force flush any remaining batched parts when the stream ends",
+      description: "Force flush any remaining batched parts when the stream ends",
       isOptional: false,
     },
   ]}
@@ -91,24 +88,23 @@ const processor = new BatchPartsProcessor({
 ## Extended usage example
 
 ```typescript title="src/mastra/agents/batched-agent.ts" showLineNumbers copy
-import { openai } from "@ai-sdk/openai";
 import { Agent } from "@mastra/core/agent";
 import { BatchPartsProcessor } from "@mastra/core/processors";
 
 export const agent = new Agent({
   name: "batched-agent",
   instructions: "You are a helpful assistant",
-  model: openai("gpt-4o-mini"),
+  model: "openai/gpt-4o-mini",
   outputProcessors: [
     new BatchPartsProcessor({
       batchSize: 5,
       maxWaitTime: 100,
-      emitOnNonText: true,
-    }),
-  ],
+      emitOnNonText: true
+    })
+  ]
 });
 ```
 
 ## Related
 
-- [Output Processors documentation](/docs/agents/guardrails)
+- [Guardrails](/docs/agents/guardrails)

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: LanguageDetector | Processors | Mastra Docs"
+title: "Reference: Language Detector | Processors | Mastra Docs"
 description: "Documentation for the LanguageDetector in Mastra, which detects language and can translate content in AI responses."
 ---
 
@@ -10,14 +10,13 @@ The `LanguageDetector` is an **input processor** that identifies the language of
 ## Usage example
 
 ```typescript copy
-import { openai } from "@ai-sdk/openai";
 import { LanguageDetector } from "@mastra/core/processors";
 
 const processor = new LanguageDetector({
-  model: openai("gpt-4.1-nano"),
+  model: "openai/gpt-4.1-nano",
   targetLanguages: ["English", "en"],
   threshold: 0.8,
-  strategy: "translate",
+  strategy: "translate"
 });
 ```
 
@@ -28,8 +27,7 @@ const processor = new LanguageDetector({
     {
       name: "options",
       type: "Options",
-      description:
-        "Configuration options for language detection and translation",
+      description: "Configuration options for language detection and translation",
       isOptional: false,
     },
   ]}
@@ -41,55 +39,49 @@ const processor = new LanguageDetector({
   content={[
     {
       name: "model",
-      type: "MastraLanguageModel",
+      type: "MastraModelConfig",
       description: "Model configuration for the detection/translation agent",
       isOptional: false,
     },
     {
       name: "targetLanguages",
       type: "string[]",
-      description:
-        "Target language(s) for the project. If content is detected in a different language, it may be translated. Can be language name ('English') or ISO code ('en')",
+      description: "Target language(s) for the project. If content is detected in a different language, it may be translated. Can be language name ('English') or ISO code ('en')",
       isOptional: true,
       default: "['English', 'en']",
     },
     {
       name: "threshold",
       type: "number",
-      description:
-        "Confidence threshold for language detection (0-1). Only process when detection confidence exceeds this threshold",
+      description: "Confidence threshold for language detection (0-1). Only process when detection confidence exceeds this threshold",
       isOptional: true,
       default: "0.7",
     },
     {
       name: "strategy",
       type: "'detect' | 'translate' | 'block' | 'warn'",
-      description:
-        "Strategy when non-target language is detected: 'detect' only detects language, 'translate' automatically translates to target language, 'block' rejects content not in target language, 'warn' logs warning but allows through",
+      description: "Strategy when non-target language is detected: 'detect' only detects language, 'translate' automatically translates to target language, 'block' rejects content not in target language, 'warn' logs warning but allows through",
       isOptional: true,
       default: "'detect'",
     },
     {
       name: "preserveOriginal",
       type: "boolean",
-      description:
-        "Whether to preserve original content in message metadata. Useful for audit trails and debugging",
+      description: "Whether to preserve original content in message metadata. Useful for audit trails and debugging",
       isOptional: true,
       default: "true",
     },
     {
       name: "instructions",
       type: "string",
-      description:
-        "Custom detection instructions for the agent. If not provided, uses default instructions",
+      description: "Custom detection instructions for the agent. If not provided, uses default instructions",
       isOptional: true,
       default: "undefined",
     },
     {
       name: "minTextLength",
       type: "number",
-      description:
-        "Minimum text length to perform detection. Short text is often unreliable for language detection",
+      description: "Minimum text length to perform detection. Short text is often unreliable for language detection",
       isOptional: true,
       default: "10",
     },
@@ -103,8 +95,7 @@ const processor = new LanguageDetector({
     {
       name: "translationQuality",
       type: "'speed' | 'quality' | 'balanced'",
-      description:
-        "Translation quality preference: 'speed' prioritizes fast translation, 'quality' prioritizes accuracy, 'balanced' balances between speed and quality",
+      description: "Translation quality preference: 'speed' prioritizes fast translation, 'quality' prioritizes accuracy, 'balanced' balances between speed and quality",
       isOptional: true,
       default: "'quality'",
     },
@@ -124,8 +115,7 @@ const processor = new LanguageDetector({
     {
       name: "processInput",
       type: "(args: { messages: MastraMessageV2[]; abort: (reason?: string) => never; tracingContext?: TracingContext }) => Promise<MastraMessageV2[]>",
-      description:
-        "Processes input messages to detect language and optionally translate content before sending to LLM",
+      description: "Processes input messages to detect language and optionally translate content before sending to LLM",
       isOptional: false,
     },
   ]}
@@ -134,31 +124,29 @@ const processor = new LanguageDetector({
 ## Extended usage example
 
 ```typescript title="src/mastra/agents/multilingual-agent.ts" showLineNumbers copy
-import { openai } from "@ai-sdk/openai";
 import { Agent } from "@mastra/core/agent";
 import { LanguageDetector } from "@mastra/core/processors";
 
 export const agent = new Agent({
   name: "multilingual-agent",
   instructions: "You are a helpful assistant",
-  model: openai("gpt-4o-mini"),
+  model: "openai/gpt-4o-mini",
   inputProcessors: [
     new LanguageDetector({
-      model: openai("gpt-4.1-nano"),
+      model: "openai/gpt-4.1-nano",
       targetLanguages: ["English", "en"],
       threshold: 0.8,
       strategy: "translate",
       preserveOriginal: true,
-      instructions:
-        "Detect language and translate non-English content to English while preserving original intent",
+      instructions: "Detect language and translate non-English content to English while preserving original intent",
       minTextLength: 10,
       includeDetectionDetails: true,
-      translationQuality: "quality",
-    }),
-  ],
+      translationQuality: "quality"
+    })
+  ]
 });
 ```
 
 ## Related
 
-- [Input Processors](/docs/agents/guardrails)
+- [Guardrails](/docs/agents/guardrails)

package/.docs/raw/reference/processors/moderation-processor.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: ModerationProcessor | Processors | Mastra Docs"
+title: "Reference: Moderation Processor | Processors | Mastra Docs"
 description: "Documentation for the ModerationProcessor in Mastra, which provides content moderation using LLM to detect inappropriate content across multiple categories."
 ---
 
@@ -10,14 +10,13 @@ The `ModerationProcessor` is a **hybrid processor** that can be used for both in
 ## Usage example
 
 ```typescript copy
-import { openai } from "@ai-sdk/openai";
 import { ModerationProcessor } from "@mastra/core/processors";
 
 const processor = new ModerationProcessor({
-  model: openai("gpt-4.1-nano"),
+  model: "openai/gpt-4.1-nano",
   threshold: 0.7,
   strategy: "block",
-  categories: ["hate", "harassment", "violence"],
+  categories: ["hate", "harassment", "violence"]
 });
 ```
 
@@ -40,56 +39,49 @@ const processor = new ModerationProcessor({
   content={[
     {
       name: "model",
-      type: "MastraLanguageModel",
+      type: "MastraModelConfig",
       description: "Model configuration for the moderation agent",
       isOptional: false,
     },
     {
       name: "categories",
       type: "string[]",
-      description:
-        "Categories to check for moderation. If not specified, uses default OpenAI categories",
+      description: "Categories to check for moderation. If not specified, uses default OpenAI categories",
       isOptional: true,
-      default:
-        "['hate', 'hate/threatening', 'harassment', 'harassment/threatening', 'self-harm', 'self-harm/intent', 'self-harm/instructions', 'sexual', 'sexual/minors', 'violence', 'violence/graphic']",
+      default: "['hate', 'hate/threatening', 'harassment', 'harassment/threatening', 'self-harm', 'self-harm/intent', 'self-harm/instructions', 'sexual', 'sexual/minors', 'violence', 'violence/graphic']",
     },
     {
       name: "threshold",
       type: "number",
-      description:
-        "Confidence threshold for flagging (0-1). Content is flagged if any category score exceeds this threshold",
+      description: "Confidence threshold for flagging (0-1). Content is flagged if any category score exceeds this threshold",
       isOptional: true,
       default: "0.5",
     },
     {
       name: "strategy",
       type: "'block' | 'warn' | 'filter'",
-      description:
-        "Strategy when content is flagged: 'block' rejects with error, 'warn' logs warning but allows through, 'filter' removes flagged messages",
+      description: "Strategy when content is flagged: 'block' rejects with error, 'warn' logs warning but allows through, 'filter' removes flagged messages",
       isOptional: true,
       default: "'block'",
     },
     {
       name: "instructions",
       type: "string",
-      description:
-        "Custom moderation instructions for the agent. If not provided, uses default instructions based on categories",
+      description: "Custom moderation instructions for the agent. If not provided, uses default instructions based on categories",
       isOptional: true,
       default: "undefined",
     },
     {
       name: "includeScores",
       type: "boolean",
-      description:
-        "Whether to include confidence scores in logs. Useful for tuning thresholds and debugging",
+      description: "Whether to include confidence scores in logs. Useful for tuning thresholds and debugging",
       isOptional: true,
       default: "false",
     },
     {
       name: "chunkWindow",
       type: "number",
-      description:
-        "Number of previous chunks to include for context when moderating stream chunks. If set to 1, includes the previous part, etc.",
+      description: "Number of previous chunks to include for context when moderating stream chunks. If set to 1, includes the previous part, etc.",
       isOptional: true,
       default: "0 (no context window)",
     },
@@ -109,15 +101,13 @@ const processor = new ModerationProcessor({
     {
       name: "processInput",
       type: "(args: { messages: MastraMessageV2[]; abort: (reason?: string) => never; tracingContext?: TracingContext }) => Promise<MastraMessageV2[]>",
-      description:
-        "Processes input messages to moderate content before sending to LLM",
+      description: "Processes input messages to moderate content before sending to LLM",
       isOptional: false,
     },
     {
       name: "processOutputStream",
       type: "(args: { part: ChunkType; streamParts: ChunkType[]; state: Record<string, any>; abort: (reason?: string) => never; tracingContext?: TracingContext }) => Promise<ChunkType | null | undefined>",
-      description:
-        "Processes streaming output parts to moderate content during streaming",
+      description: "Processes streaming output parts to moderate content during streaming",
       isOptional: false,
     },
   ]}
@@ -125,30 +115,56 @@ const processor = new ModerationProcessor({
 
 ## Extended usage example
 
+### Input processing
+
 ```typescript title="src/mastra/agents/moderated-agent.ts" showLineNumbers copy
-import { openai } from "@ai-sdk/openai";
 import { Agent } from "@mastra/core/agent";
 import { ModerationProcessor } from "@mastra/core/processors";
 
 export const agent = new Agent({
   name: "moderated-agent",
   instructions: "You are a helpful assistant",
-  model: openai("gpt-4o-mini"),
+  model: "openai/gpt-4o-mini",
   inputProcessors: [
     new ModerationProcessor({
-      model: openai("gpt-4.1-nano"),
+      model: "openai/gpt-4.1-nano",
       categories: ["hate", "harassment", "violence"],
       threshold: 0.7,
       strategy: "block",
       instructions: "Detect and flag inappropriate content in user messages",
-      includeScores: true,
+      includeScores: true
+    })
+  ]
+});
+```
+
+### Output processing with batching
+
+When using `ModerationProcessor` 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 moderator, reducing the number of LLM calls required for moderation.
+
+```typescript title="src/mastra/agents/output-moderated-agent.ts" showLineNumbers copy
+import { Agent } from "@mastra/core/agent";
+import { BatchPartsProcessor, ModerationProcessor } from "@mastra/core/processors";
+
+export const agent = new Agent({
+  name: "output-moderated-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 moderation on batched content
+    new ModerationProcessor({
+      model: "openai/gpt-4.1-nano",
+      strategy: "filter",
       chunkWindow: 1,
     }),
-  ],
+  ]
 });
 ```
 
 ## Related
 
-- [Input Processors](/docs/agents/guardrails)
-- [Output Processors](/docs/agents/guardrails)
+- [Guardrails](/docs/agents/guardrails)