@mastra/mcp-docs-server 0.13.39 → 1.0.0-beta.0

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

@@ -1,6 +1,6 @@
 ---
 title: "Reference: Interfaces | Observability | Mastra Docs"
-description: AI Tracing type definitions and interfaces
+description: Tracing type definitions and interfaces
 ---
 
 import PropertiesTable from "@site/src/components/PropertiesTable";
@@ -9,40 +9,40 @@ import PropertiesTable from "@site/src/components/PropertiesTable";
 
 ## Core Interfaces
 
-### AITracing
+### ObservabilityInstance
 
-Primary interface for AI Tracing.
+Primary interface for observability.
 
 ```typescript
-interface AITracing {
+interface ObservabilityInstance {
   /** Get current configuration */
-  getConfig(): Readonly<Required<TracingConfig>>;
+  getConfig(): Readonly<Required<ObservabilityInstanceConfig>>;
 
   /** Get all exporters */
-  getExporters(): readonly AITracingExporter[];
+  getExporters(): readonly ObservabilityExporter[];
 
-  /** Get all processors */
-  getProcessors(): readonly AISpanProcessor[];
+  /** Get all span output processors */
+  getSpanOutputProcessors(): readonly SpanOutputProcessor[];
 
   /** Get the logger instance (for exporters and other components) */
   getLogger(): IMastraLogger;
 
-  /** Start a new span of a specific AISpanType */
-  startSpan<TType extends AISpanType>(
+  /** Start a new span of a specific SpanType */
+  startSpan<TType extends SpanType>(
     options: StartSpanOptions<TType>,
-  ): AISpan<TType>;
+  ): Span<TType>;
 
-  /** Shutdown AI tracing and clean up resources */
+  /** Shutdown observability and clean up resources */
   shutdown(): Promise<void>;
 }
 ```
 
-### AISpanTypeMap
+### SpanTypeMap
 
 Mapping of span types to their corresponding attribute interfaces.
 
 ```typescript
-interface AISpanTypeMap {
+interface SpanTypeMap {
   AGENT_RUN: AgentRunAttributes;
   WORKFLOW_RUN: WorkflowRunAttributes;
   MODEL_GENERATION: ModelGenerationAttributes;
@@ -50,6 +50,7 @@ interface AISpanTypeMap {
   MODEL_CHUNK: ModelChunkAttributes;
   TOOL_CALL: ToolCallAttributes;
   MCP_TOOL_CALL: MCPToolCallAttributes;
+  PROCESSOR_RUN: ProcessorRunAttributes;
   WORKFLOW_STEP: WorkflowStepAttributes;
   WORKFLOW_CONDITIONAL: WorkflowConditionalAttributes;
   WORKFLOW_CONDITIONAL_EVAL: WorkflowConditionalEvalAttributes;
@@ -63,12 +64,12 @@ interface AISpanTypeMap {
 
 This mapping defines which attribute interface is used for each span type when creating or processing spans.
 
-### AISpan
+### Span
 
-AI Span interface, used internally for tracing.
+Span interface, used internally for tracing.
 
 ```typescript
-interface AISpan<TType extends AISpanType> {
+interface Span<TType extends SpanType> {
   readonly id: string;
   readonly traceId: string;
   readonly type: TType;
@@ -78,12 +79,12 @@ interface AISpan<TType extends AISpanType> {
   isInternal: boolean;
 
   /** Parent span reference (undefined for root spans) */
-  parent?: AnyAISpan;
+  parent?: AnySpan;
 
-  /** Pointer to the AITracing instance */
-  aiTracing: AITracing;
+  /** Pointer to the ObservabilityInstance instance */
+  observabilityInstance: ObservabilityInstance;
 
-  attributes?: AISpanTypeMap[TType];
+  attributes?: SpanTypeMap[TType];
   metadata?: Record<string, any>;
   input?: any;
   output?: any;
@@ -99,14 +100,14 @@ interface AISpan<TType extends AISpanType> {
   update(options: UpdateSpanOptions<TType>): void;
 
   /** Create child span - can be any span type independent of parent */
-  createChildSpan<TChildType extends AISpanType>(
+  createChildSpan<TChildType extends SpanType>(
     options: ChildSpanOptions<TChildType>,
-  ): AISpan<TChildType>;
+  ): Span<TChildType>;
 
   /** Create event span - can be any span type independent of parent */
-  createEventSpan<TChildType extends AISpanType>(
+  createEventSpan<TChildType extends SpanType>(
     options: ChildEventOptions<TChildType>,
-  ): AISpan<TChildType>;
+  ): Span<TChildType>;
 
   /** Returns TRUE if the span is the root span of a trace */
   get isRootSpan(): boolean;
@@ -116,37 +117,54 @@ interface AISpan<TType extends AISpanType> {
 }
 ```
 
-### AITracingExporter
+### ObservabilityExporter
 
-Interface for tracing exporters.
+Interface for observability exporters.
 
 ```typescript
-interface AITracingExporter {
+interface ObservabilityExporter {
   /** Exporter name */
   name: string;
 
-  /** Initialize exporter (called after all dependencies are ready) */
-  init?(): void;
+  /** Initialize exporter with tracing configuration and/or access to Mastra */
+  init?(options: InitExporterOptions): void;
 
   /** Export tracing events */
-  exportEvent(event: AITracingEvent): Promise<void>;
+  exportTracingEvent(event: TracingEvent): Promise<void>;
+
+  /** Add score to a trace (optional) */
+  addScoreToTrace?({
+    traceId,
+    spanId,
+    score,
+    reason,
+    scorerName,
+    metadata,
+  }: {
+    traceId: string;
+    spanId?: string;
+    score: number;
+    reason?: string;
+    scorerName: string;
+    metadata?: Record<string, any>;
+  }): Promise<void>;
 
   /** Shutdown exporter */
   shutdown(): Promise<void>;
 }
 ```
 
-### AISpanProcessor
+### SpanOutputProcessor
 
-Interface for span processors.
+Interface for span output processors.
 
 ```typescript
-interface AISpanProcessor {
+interface SpanOutputProcessor {
   /** Processor name */
   name: string;
 
   /** Process span before export */
-  process(span?: AnyAISpan): AnyAISpan | undefined;
+  process(span?: AnySpan): AnySpan | undefined;
 
   /** Shutdown processor */
   shutdown(): Promise<void>;
@@ -155,12 +173,12 @@ interface AISpanProcessor {
 
 ## Span Types
 
-### AISpanType
+### SpanType
 
 AI-specific span types with their associated metadata.
 
 ```typescript
-enum AISpanType {
+enum SpanType {
   /** Agent run - root span for agent processes */
   AGENT_RUN = "agent_run",
 
@@ -179,6 +197,9 @@ enum AISpanType {
   /** MCP (Model Context Protocol) tool execution */
   MCP_TOOL_CALL = "mcp_tool_call",
 
+  /** Input or Output Processor execution */
+  PROCESSOR_RUN = "processor_run",
+
   /** Function/tool execution with inputs, outputs, errors */
   TOOL_CALL = "tool_call",
 
@@ -208,12 +229,12 @@ enum AISpanType {
 }
 ```
 
-### AnyAISpan
+### AnySpan
 
 Union type for cases that need to handle any span.
 
 ```typescript
-type AnyAISpan = AISpan<keyof AISpanTypeMap>;
+type AnySpan = Span<keyof SpanTypeMap>;
 ```
 
 ## Span Attributes
@@ -360,6 +381,23 @@ interface MCPToolCallAttributes {
 }
 ```
 
+### ProcessorRunAttributes
+
+Processor attributes.
+
+```typescript
+interface ProcessorRunAttributes {
+  /** Name of the Processor */
+  processorName: string;
+
+  /** Processor type (input or output) */
+  processorType: 'input' | 'output';
+
+  /** Processor index in the agent */
+  processorIndex?: number;
+}
+```
+
 ### WorkflowRunAttributes
 
 Workflow Run attributes.
@@ -369,13 +407,7 @@ interface WorkflowRunAttributes {
   /** Workflow identifier */
   workflowId: string;
 
-  /** Workflow version */
-  workflowVersion?: string;
-
-  /** Workflow run ID */
-  runId?: string;
-
-  /** Final workflow execution status */
+  /** Workflow status */
   status?: WorkflowRunStatus;
 }
 ```
@@ -387,19 +419,10 @@ Workflow Step attributes.
 ```typescript
 interface WorkflowStepAttributes {
   /** Step identifier */
-  stepId?: string;
-
-  /** Step type */
-  stepType?: string;
+  stepId: string;
 
   /** Step status */
   status?: WorkflowStepStatus;
-
-  /** Step execution order */
-  stepNumber?: number;
-
-  /** Result store key */
-  resultKey?: string;
 }
 ```
 
@@ -410,7 +433,7 @@ interface WorkflowStepAttributes {
 Options for starting new spans.
 
 ```typescript
-interface StartSpanOptions<TType extends AISpanType> {
+interface StartSpanOptions<TType extends SpanType> {
   /** Span type */
   type: TType;
 
@@ -418,7 +441,7 @@ interface StartSpanOptions<TType extends AISpanType> {
   name: string;
 
   /** Span attributes */
-  attributes?: AISpanTypeMap[TType];
+  attributes?: SpanTypeMap[TType];
 
   /** Span metadata */
   metadata?: Record<string, any>;
@@ -427,7 +450,7 @@ interface StartSpanOptions<TType extends AISpanType> {
   input?: any;
 
   /** Parent span */
-  parent?: AnyAISpan;
+  parent?: AnySpan;
 
   /** Policy-level tracing configuration */
   tracingPolicy?: TracingPolicy;
@@ -442,9 +465,9 @@ interface StartSpanOptions<TType extends AISpanType> {
 Options for updating spans.
 
 ```typescript
-interface UpdateSpanOptions<TType extends AISpanType> {
+interface UpdateSpanOptions<TType extends SpanType> {
   /** Span attributes */
-  attributes?: Partial<AISpanTypeMap[TType]>;
+  attributes?: Partial<SpanTypeMap[TType]>;
 
   /** Span metadata */
   metadata?: Record<string, any>;
@@ -462,7 +485,7 @@ interface UpdateSpanOptions<TType extends AISpanType> {
 Options for ending spans.
 
 ```typescript
-interface EndSpanOptions<TType extends AISpanType> {
+interface EndSpanOptions<TType extends SpanType> {
   /** Output data */
   output?: any;
 
@@ -470,7 +493,7 @@ interface EndSpanOptions<TType extends AISpanType> {
   metadata?: Record<string, any>;
 
   /** Span attributes */
-  attributes?: Partial<AISpanTypeMap[TType]>;
+  attributes?: Partial<SpanTypeMap[TType]>;
 }
 ```
 
@@ -479,7 +502,7 @@ interface EndSpanOptions<TType extends AISpanType> {
 Options for recording span errors.
 
 ```typescript
-interface ErrorSpanOptions<TType extends AISpanType> {
+interface ErrorSpanOptions<TType extends SpanType> {
   /** The error associated with the issue */
   error: Error;
 
@@ -490,7 +513,7 @@ interface ErrorSpanOptions<TType extends AISpanType> {
   metadata?: Record<string, any>;
 
   /** Span attributes */
-  attributes?: Partial<AISpanTypeMap[TType]>;
+  attributes?: Partial<SpanTypeMap[TType]>;
 }
 ```
 
@@ -498,12 +521,12 @@ interface ErrorSpanOptions<TType extends AISpanType> {
 
 ### TracingContext
 
-Context for AI tracing that flows through workflow and agent execution.
+Context for Tracing that flows through workflow and agent execution.
 
 ```typescript
 interface TracingContext {
-  /** Current AI span for creating child spans and adding metadata */
-  currentSpan?: AnyAISpan;
+  /** Current span for creating child spans and adding metadata */
+  currentSpan?: AnySpan;
 }
 ```
 
@@ -546,35 +569,38 @@ interface TracingPolicy {
 
 ## Configuration Types
 
-### TracingConfig
+### ObservabilityInstanceConfig
 
-Configuration for a single tracing instance.
+Configuration for a single observability instance.
 
 ```typescript
-interface TracingConfig {
-  /** Unique identifier for this config in the ai tracing registry */
+interface ObservabilityInstanceConfig {
+  /** Unique identifier for this config in the observability registry */
   name: string;
 
-  /** Service name for tracing */
+  /** Service name for observability */
   serviceName: string;
 
   /** Sampling strategy - controls whether tracing is collected (defaults to ALWAYS) */
   sampling?: SamplingStrategy;
 
   /** Custom exporters */
-  exporters?: AITracingExporter[];
+  exporters?: ObservabilityExporter[];
 
-  /** Custom processors */
-  processors?: AISpanProcessor[];
+  /** Custom span output processors */
+  spanOutputProcessors?: SpanOutputProcessor[];
 
   /** Set to true if you want to see spans internal to the operation of mastra */
   includeInternalSpans?: boolean;
+
+  /** RequestContext keys to automatically extract as metadata for all spans */
+  requestContextKeys?: string[];
 }
 ```
 
 ### ObservabilityRegistryConfig
 
-Complete AI Tracing registry configuration.
+Complete observability registry configuration.
 
 ```typescript
 interface ObservabilityRegistryConfig {
@@ -584,7 +610,7 @@ interface ObservabilityRegistryConfig {
   };
 
   /** Map of tracing instance names to their configurations or pre-instantiated instances */
-  configs?: Record<string, Omit<TracingConfig, "name"> | AITracing>;
+  configs?: Record<string, Omit<ObservabilityInstanceConfig, "name"> | ObservabilityInstance>;
 
   /** Optional selector function to choose which tracing instance to use */
   configSelector?: ConfigSelector;
@@ -611,7 +637,7 @@ Options passed when using a custom sampler strategy.
 
 ```typescript
 interface CustomSamplerOptions {
-  runtimeContext?: RuntimeContext;
+  requestContext?: RequestContext;
   metadata?: Record<string, any>;
 }
 ```
@@ -620,12 +646,12 @@ interface CustomSamplerOptions {
 
 ### ConfigSelector
 
-Function to select which AI tracing instance to use for a given span.
+Function to select which observability instance to use for a given span.
 
 ```typescript
 type ConfigSelector = (
   options: ConfigSelectorOptions,
-  availableConfigs: ReadonlyMap<string, AITracing>,
+  availableConfigs: ReadonlyMap<string, ObservabilityInstance>,
 ) => string | undefined;
 ```
 
@@ -636,7 +662,7 @@ Options passed when using a custom tracing config selector.
 ```typescript
 interface ConfigSelectorOptions {
   /** Request Context */
-  runtimeContext?: RuntimeContext;
+  requestContext?: RequestContext;
 }
 ```
 
@@ -672,16 +698,16 @@ enum InternalSpans {
 
 ### Documentation
 
-- [AI Tracing Overview](/docs/observability/ai-tracing/overview) - Complete guide to AI tracing
-- [Creating Child Spans](/docs/observability/ai-tracing/overview#creating-child-spans) - Working with span hierarchies
-- [Adding Custom Metadata](/docs/observability/ai-tracing/overview#adding-custom-metadata) - Enriching traces
+- [Tracing Overview]/docs/v1/observability/tracing/overview) - Complete guide to Tracing
+- [Creating Child Spans]/docs/v1/observability/tracing/overview#creating-child-spans) - Working with span hierarchies
+- [Adding Custom Metadata]/docs/v1/observability/tracing/overview#adding-custom-metadata) - Enriching traces
 
 ### Reference
 
-- [Configuration](/reference/observability/ai-tracing/configuration) - Registry and configuration
-- [AITracing Classes](/reference/observability/ai-tracing/) - Core implementations
-- [Span Reference](/reference/observability/ai-tracing/span) - Span lifecycle methods
+- [Configuration]/reference/v1/observability/tracing/configuration) - Registry and configuration
+- [Tracing Classes]/reference/v1/observability/tracing/instances) - Core implementations
+- [Spans Reference]/reference/v1/observability/tracing/spans) - Span lifecycle methods
 
 ### Examples
 
-- [Basic AI Tracing](/examples/observability/basic-ai-tracing) - Implementation example
+- [Basic Tracing]/examples/v1/observability/basic-tracing) - Implementation example

package/.docs/raw/reference/observability/{ai-tracing → tracing}/processors/sensitive-data-filter.mdx

@@ -7,7 +7,7 @@ import PropertiesTable from "@site/src/components/PropertiesTable";
 
 # SensitiveDataFilter
 
-An AISpanProcessor that redacts sensitive information from span fields.
+A SpanOutputProcessor that redacts sensitive information from span fields.
 
 ## Constructor
 
@@ -80,7 +80,7 @@ type RedactionStyle = "full" | "partial";
 ### process
 
 ```typescript
-process(span: AnyAISpan): AnyAISpan
+process(span: AnySpan): AnySpan
 ```
 
 Process a span by filtering sensitive data across its key fields: attributes, metadata, input, output, and errorInfo.
@@ -89,7 +89,7 @@ Process a span by filtering sensitive data across its key fields: attributes, me
   props={[
     {
       name: "span",
-      type: "AnyAISpan",
+      type: "AnySpan",
       description: "The input span to filter",
       required: true,
     },