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

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

@@ -1,9 +1,9 @@
 ---
-title: "Span | AI Tracing | Reference"
+title: "Reference: Span | Observability | Mastra Docs"
 description: Span interfaces, methods, and lifecycle events
 ---
 
-import { PropertiesTable } from "@/components/properties-table";
+import PropertiesTable from "@site/src/components/PropertiesTable";
 
 # Span
 
@@ -15,34 +15,34 @@ Base interface for all span types.
 interface BaseSpan<TType extends AISpanType> {
   /** Unique span identifier */
   id: string;
-  
+
   /** OpenTelemetry-compatible trace ID (32 hex chars) */
   traceId: string;
-  
+
   /** Name of the span */
   name: string;
-  
+
   /** Type of the span */
   type: TType;
-  
+
   /** When span started */
   startTime: Date;
-  
+
   /** When span ended */
   endTime?: Date;
-  
+
   /** Type-specific attributes */
   attributes?: AISpanTypeMap[TType];
-  
+
   /** User-defined metadata */
   metadata?: Record<string, any>;
-  
+
   /** Input passed at the start of the span */
   input?: any;
-  
+
   /** Output generated at the end of the span */
   output?: any;
-  
+
   /** Error information if span failed */
   errorInfo?: {
     message: string;
@@ -51,7 +51,7 @@ interface BaseSpan<TType extends AISpanType> {
     category?: string;
     details?: Record<string, any>;
   };
-  
+
   /** Is an event span? (occurs at startTime, has no endTime) */
   isEvent: boolean;
 }
@@ -65,10 +65,10 @@ AI Span interface, used internally for tracing. Extends BaseSpan with lifecycle
 interface AISpan<TType extends AISpanType> extends BaseSpan<TType> {
   /** Is an internal span? (spans internal to the operation of mastra) */
   isInternal: boolean;
-  
+
   /** Parent span reference (undefined for root spans) */
   parent?: AnyAISpan;
-  
+
   /** Pointer to the AITracing instance */
   aiTracing: AITracing;
 }
@@ -301,7 +301,7 @@ Exported AI Span interface, used for tracing exporters. A lightweight version of
 interface ExportedAISpan<TType extends AISpanType> extends BaseSpan<TType> {
   /** Parent span id reference (undefined for root spans) */
   parentSpanId?: string;
-  
+
   /** TRUE if the span is the root span of a trace */
   isRootSpan: boolean;
 }
@@ -316,13 +316,13 @@ Events emitted during the span lifecycle.
 ```typescript
 enum AITracingEventType {
   /** Emitted when a span is created and started */
-  SPAN_STARTED = 'span_started',
-  
+  SPAN_STARTED = "span_started",
+
   /** Emitted when a span is updated via update() */
-  SPAN_UPDATED = 'span_updated',
-  
+  SPAN_UPDATED = "span_updated",
+
   /** Emitted when a span is ended via end() or error() */
-  SPAN_ENDED = 'span_ended',
+  SPAN_ENDED = "span_ended",
 }
 ```
 
@@ -330,9 +330,9 @@ enum AITracingEventType {
 
 ```typescript
 type AITracingEvent =
-  | { type: 'span_started'; exportedSpan: AnyExportedAISpan }
-  | { type: 'span_updated'; exportedSpan: AnyExportedAISpan }
-  | { type: 'span_ended'; exportedSpan: AnyExportedAISpan };
+  | { type: "span_started"; exportedSpan: AnyExportedAISpan }
+  | { type: "span_updated"; exportedSpan: AnyExportedAISpan }
+  | { type: "span_ended"; exportedSpan: AnyExportedAISpan };
 ```
 
 Exporters receive these events to process and send trace data to observability platforms.
@@ -358,14 +358,17 @@ Union type for cases that need to handle any exported span type.
 ## See Also
 
 ### Documentation
+
 - [AI Tracing Overview](/docs/observability/ai-tracing/overview) - Concepts and usage
 - [Creating Child Spans](/docs/observability/ai-tracing/overview#creating-child-spans) - Practical examples
 - [Retrieving Trace IDs](/docs/observability/ai-tracing/overview#retrieving-trace-ids) - Using trace IDs
 
 ### Reference
-- [AITracing Classes](/reference/observability/ai-tracing/ai-tracing) - Core tracing classes
+
+- [AITracing Classes](/reference/observability/ai-tracing/) - Core tracing classes
 - [Interfaces](/reference/observability/ai-tracing/interfaces) - Complete type reference
 - [Configuration](/reference/observability/ai-tracing/configuration) - Configuration options
 
 ### Examples
-- [Basic AI Tracing](/examples/observability/basic-ai-tracing) - Working with spans
+
+- [Basic AI Tracing](/examples/observability/basic-ai-tracing) - Working with spans

package/.docs/raw/reference/observability/logging/pino-logger.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: PinoLogger | Mastra Observability Docs"
+title: "Reference: PinoLogger | Observability | Mastra Docs"
 description: Documentation for PinoLogger, which provides methods to record events at various severity levels.
 ---
 
@@ -7,19 +7,19 @@ description: Documentation for PinoLogger, which provides methods to record even
 
 A Logger instance is created using `new PinoLogger()` and provides methods to record events at various severity levels.
 
-When deploying to Mastra Cloud, logs are displayed on the [Logs](../../../docs/mastra-cloud/dashboard.mdx#logs) page. In self-hosted or custom environments, logs can be directed to files or external services depending on the configured transports.
+When deploying to Mastra Cloud, logs are displayed on the [Logs](/docs/mastra-cloud/dashboard#logs) page. In self-hosted or custom environments, logs can be directed to files or external services depending on the configured transports.
 
 ## Usage example
 
-```typescript filename="src/mastra/index.ts" showLineNumbers copy
-import { Mastra } from '@mastra/core/mastra';
-import { PinoLogger } from '@mastra/loggers';
+```typescript title="src/mastra/index.ts" showLineNumbers copy
+import { Mastra } from "@mastra/core/mastra";
+import { PinoLogger } from "@mastra/loggers";
 
 export const mastra = new Mastra({
   // ...
   logger: new PinoLogger({
-    name: 'Mastra',
-    level: 'info',
+    name: "Mastra",
+    level: "info",
   }),
 });
 ```
@@ -33,10 +33,11 @@ export const mastra = new Mastra({
       type: "string",
       description: "A label used to group and identify logs from this logger.",
     },
-     {
+    {
       name: "level",
       type: `"debug" | "info" | "warn" | "error"`,
-      description: "Sets the minimum log level. Messages below this level are ignored.",
+      description:
+        "Sets the minimum log level. Messages below this level are ignored.",
     },
     {
       name: "transports",
@@ -58,13 +59,11 @@ export const mastra = new Mastra({
   ]}
 />
 
-
 ## File transport (structured logs)
 
 Writes structured logs to a file using the `FileTransport`. The logger accepts a plain message as the first argument and structured metadata as the second argument. These are internally converted to a `BaseLogMessage` and persisted to the configured file path.
 
-
-```typescript filename="src/mastra/loggers/file-transport.ts" showLineNumbers copy
+```typescript title="src/mastra/loggers/file-transport.ts" showLineNumbers copy
 import { FileTransport } from "@mastra/loggers/file";
 import { PinoLogger } from "@mastra/loggers/pino";
 
@@ -88,7 +87,7 @@ fileLogger.warn("Low disk space", {
 
 Streams structured logs to a remote Redis list using the `UpstashTransport`. The logger accepts a string message and a structured metadata object. This enables centralized logging for distributed environments, supporting filtering by `destinationPath`, `type`, and `runId`.
 
-```typescript filename="src/mastra/loggers/upstash-transport.ts" showLineNumbers copy
+```typescript title="src/mastra/loggers/upstash-transport.ts" showLineNumbers copy
 import { UpstashTransport } from "@mastra/loggers/upstash";
 import { PinoLogger } from "@mastra/loggers/pino";
 
@@ -105,7 +104,6 @@ export const upstashLogger = new PinoLogger({
 });
 ```
 
-
 ### Upstash transport usage
 
 ```typescript showLineNumbers copy
@@ -124,7 +122,7 @@ You can create custom transports using the `createCustomTransport` utility to in
 
 Creates a custom transport using `createCustomTransport` and integrates it with a third-party logging stream such as `pino-sentry-transport`. This allows forwarding logs to an external system like Sentry for advanced monitoring and observability.
 
-```typescript filename="src/mastra/loggers/sentry-transport.ts" showLineNumbers copy
+```typescript title="src/mastra/loggers/sentry-transport.ts" showLineNumbers copy
 import { createCustomTransport } from "@mastra/core/loggers";
 import { PinoLogger } from "@mastra/loggers/pino";
 import pinoSentry from "pino-sentry-transport";

package/.docs/raw/reference/observability/otel-tracing/otel-config.mdx

@@ -1,9 +1,9 @@
 ---
-title: "Reference: OtelConfig | Mastra Observability Docs"
+title: "Reference: `OtelConfig` | Observability | Mastra Docs"
 description: Documentation for the OtelConfig object, which configures OpenTelemetry instrumentation, tracing, and exporting behavior.
 ---
 
-# `OtelConfig`
+# OtelConfig
 
 The `OtelConfig` object is used to configure OpenTelemetry instrumentation, tracing, and exporting behavior within your application. By adjusting its properties, you can control how telemetry data (such as traces) is collected, sampled, and exported.
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Arize AX Integration | Mastra Observability Docs"
+title: "Reference: Arize AX | Observability | Mastra Docs"
 description: Documentation for integrating Arize AX with Mastra, a comprehensive AI observability platform for monitoring and evaluating LLM applications.
 ---
 
@@ -54,8 +54,8 @@ export const mastra = new Mastra({
       exporter: new OpenInferenceOTLPTraceExporter({
         url: "https://otlp.arize.com/v1/traces",
         headers: {
-          "space_id": process.env.ARIZE_SPACE_ID!,
-          "api_key": process.env.ARIZE_API_KEY!,
+          space_id: process.env.ARIZE_SPACE_ID!,
+          api_key: process.env.ARIZE_API_KEY!,
         },
         spanFilter: isOpenInferenceSpan,
       }),

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Arize Phoenix Integration | Mastra Observability Docs"
+title: "Reference: Arize Phoenix | Observability | Mastra Docs"
 description: Documentation for integrating Arize Phoenix with Mastra, an open-source AI observability platform for monitoring and evaluating LLM applications.
 ---
 
@@ -114,6 +114,7 @@ All traces follow OpenTelemetry standards and include relevant metadata such as
 ## Dashboard
 
 Once configured, you can view your traces and analytics in Phoenix:
+
 - **Phoenix Cloud**: [app.phoenix.arize.com](https://app.phoenix.arize.com)
 - **Self-hosted**: Your Phoenix instance URL (e.g., `http://localhost:6006`)
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Dash0 Integration | Mastra Observability Docs"
+title: "Reference: Dash0 | Observability | Mastra Docs"
 description: Documentation for integrating Mastra with Dash0, an Open Telemetry native observability solution.
 ---
 

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

@@ -1,22 +1,20 @@
 ---
-title: "OTLP Providers | Observability | Mastra Docs"
+title: "Reference: OTLP Providers | Observability | Mastra Docs"
 description: Overview of OTLP observability providers.
 ---
 
-import { Callout } from "nextra/components";
-
 # OTLP Providers
 
 These providers are supported with OTLP-based tracing:
 
-- [Arize AX](./providers/arize-ax.mdx)
-- [Arize Phoenix](./providers/arize-phoenix.mdx)
-- [Braintrust](./providers/braintrust.mdx)
-- [Dash0](./providers/dash0.mdx)
-- [Laminar](./providers/laminar.mdx)
-- [Langfuse](./providers/langfuse.mdx)
-- [Langsmith](./providers/langsmith.mdx)
-- [LangWatch](./providers/langwatch.mdx)
-- [New Relic](./providers/new-relic.mdx)
-- [SigNoz](./providers/signoz.mdx)
-- [Traceloop](./providers/traceloop.mdx)
+- [Arize AX](./arize-ax)
+- [Arize Phoenix](./arize-phoenix)
+- [Braintrust](./braintrust)
+- [Dash0](./dash0)
+- [Laminar](./laminar)
+- [Langfuse](./langfuse)
+- [Langsmith](./langsmith)
+- [LangWatch](./langwatch)
+- [New Relic](./new-relic)
+- [SigNoz](./signoz)
+- [Traceloop](./traceloop)

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

@@ -11,7 +11,6 @@ This tutorial shows how to set up Keywords AI tracing with [Mastra](https://mast
 
 To help you get started quickly, we’ve provided a pre-built example. You can find the code [on GitHub](https://github.com/Keywords-AI/keywordsai-example-projects/tree/main/mastra-ai-weather-agent).
 
-
 ## Setup
 
 Here's the tutorial about the Mastra Weather Agent example.
@@ -30,7 +29,7 @@ Copy the example environment file and add your API keys:
 cp .env.local.example .env.local
 ```
 
-Update .env.local with your credentials: 
+Update .env.local with your credentials:
 
 ```bash .env.local copy
 OPENAI_API_KEY=your-openai-api-key
@@ -42,7 +41,7 @@ KEYWORDSAI_BASE_URL=https://api.keywordsai.co
 
 Configure with KeywordsAI telemetry in `src/mastra/index.ts`:
 
-```typescript filename="src/mastra/index.ts" showLineNumbers copy
+```typescript title="src/mastra/index.ts" showLineNumbers copy
 
 import { Mastra } from "@mastra/core/mastra";
 import { KeywordsAIExporter } from "@keywordsai/exporter-vercel";
@@ -66,7 +65,8 @@ telemetry: {
 ```bash copy
 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/observability/otel-tracing/providers/laminar.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Laminar Integration | Mastra Observability Docs"
+title: "Reference: Laminar | Observability | Mastra Docs"
 description: Documentation for integrating Laminar with Mastra, a specialized observability platform for LLM applications.
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Langfuse Integration | Mastra Observability Docs"
+title: "Reference: Langfuse | Observability | Mastra Docs"
 description: Documentation for integrating Langfuse with Mastra, an open-source observability platform for LLM applications.
 ---
 
@@ -52,8 +52,8 @@ export const mastra = new Mastra({
   telemetry: {
     enabled: true,
     export: {
-      type: 'otlp',
-      endpoint: 'https://cloud.langfuse.com/api/public/otel/v1/traces', // or your preferred endpoint
+      type: "otlp",
+      endpoint: "https://cloud.langfuse.com/api/public/otel/v1/traces", // or your preferred endpoint
       headers: {
         Authorization: `Basic ${AUTH_STRING}`, // Your base64-encoded auth string
       },
@@ -72,7 +72,7 @@ export const mastra = new Mastra({
   telemetry: {
     enabled: true,
     export: {
-      type: 'otlp',
+      type: "otlp",
       // endpoint and headers will be read from OTEL_EXPORTER_OTLP_* env vars
     },
   },

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: LangSmith Integration | Mastra Observability Docs"
+title: "Reference: LangSmith | Observability | Mastra Docs"
 description: Documentation for integrating LangSmith with Mastra, a platform for debugging, testing, evaluating, and monitoring LLM applications.
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: LangWatch Integration | Mastra Observability Docs"
+title: "Reference: LangWatch | Observability | Mastra Docs"
 description: Documentation for integrating LangWatch with Mastra, a specialized observability platform for LLM applications.
 ---
 
@@ -31,7 +31,7 @@ export const mastra = new Mastra({
     export: {
       type: "custom",
       exporter: new LangWatchExporter({
-        apiKey: process.env.LANGWATCH_API_KEY
+        apiKey: process.env.LANGWATCH_API_KEY,
       }),
     },
   },

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: New Relic Integration | Mastra Observability Docs"
+title: "Reference: New Relic | Observability | Mastra Docs"
 description: Documentation for integrating New Relic with Mastra, a comprehensive observability platform supporting OpenTelemetry for full-stack monitoring.
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: SigNoz Integration | Mastra Observability Docs"
+title: "Reference: SigNoz | Observability | Mastra Docs"
 description: Documentation for integrating SigNoz with Mastra, an open-source APM and observability platform providing full-stack monitoring through OpenTelemetry.
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Traceloop Integration | Mastra Observability Docs"
+title: "Reference: Traceloop | Observability | Mastra Docs"
 description: Documentation for integrating Traceloop with Mastra, an OpenTelemetry-native observability platform for LLM applications.
 ---
 

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

@@ -87,15 +87,14 @@ const processor = new BatchPartsProcessor({
 
 ## Extended usage example
 
-```typescript filename="src/mastra/agents/batched-agent.ts" showLineNumbers copy
-import { openai } from "@ai-sdk/openai";
+```typescript title="src/mastra/agents/batched-agent.ts" showLineNumbers copy
 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,
@@ -108,4 +107,4 @@ export const agent = new Agent({
 
 ## Related
 
-- [Output Processors documentation](/docs/agents/output-processors)
+- [Guardrails](/docs/agents/guardrails)

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

@@ -10,11 +10,10 @@ 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"
@@ -40,7 +39,7 @@ const processor = new LanguageDetector({
   content={[
     {
       name: "model",
-      type: "MastraLanguageModel",
+      type: "MastraModelConfig",
       description: "Model configuration for the detection/translation agent",
       isOptional: false,
     },
@@ -124,18 +123,17 @@ const processor = new LanguageDetector({
 
 ## Extended usage example
 
-```typescript filename="src/mastra/agents/multilingual-agent.ts" showLineNumbers copy
-import { openai } from "@ai-sdk/openai";
+```typescript title="src/mastra/agents/multilingual-agent.ts" showLineNumbers copy
 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",
@@ -151,4 +149,4 @@ export const agent = new Agent({
 
 ## Related
 
-- [Input Processors](/docs/agents/input-processors)
+- [Guardrails](/docs/agents/guardrails)

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

@@ -10,11 +10,10 @@ 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"]
@@ -40,7 +39,7 @@ const processor = new ModerationProcessor({
   content={[
     {
       name: "model",
-      type: "MastraLanguageModel",
+      type: "MastraModelConfig",
       description: "Model configuration for the moderation agent",
       isOptional: false,
     },
@@ -116,30 +115,56 @@ const processor = new ModerationProcessor({
 
 ## Extended usage example
 
-```typescript filename="src/mastra/agents/moderated-agent.ts" showLineNumbers copy
-import { openai } from "@ai-sdk/openai";
+### Input processing
+
+```typescript title="src/mastra/agents/moderated-agent.ts" showLineNumbers copy
 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,
-      chunkWindow: 1
+      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/input-processors)
-- [Output Processors](/docs/agents/output-processors)
+- [Guardrails](/docs/agents/guardrails)