@mastra/mcp-docs-server 0.13.37 → 0.13.38

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

@@ -1,9 +1,9 @@
 ---
-title: "Interfaces | AI Tracing | Reference"
+title: "Reference: Interfaces | Observability | Mastra Docs"
 description: AI Tracing type definitions and interfaces
 ---
 
-import { PropertiesTable } from "@/components/properties-table";
+import PropertiesTable from "@site/src/components/PropertiesTable";
 
 # Interfaces
 
@@ -17,19 +17,21 @@ Primary interface for AI Tracing.
 interface AITracing {
   /** Get current configuration */
   getConfig(): Readonly<Required<TracingConfig>>;
-  
+
   /** Get all exporters */
   getExporters(): readonly AITracingExporter[];
-  
+
   /** Get all processors */
   getProcessors(): readonly AISpanProcessor[];
-  
+
   /** Get the logger instance (for exporters and other components) */
   getLogger(): IMastraLogger;
-  
+
   /** Start a new span of a specific AISpanType */
-  startSpan<TType extends AISpanType>(options: StartSpanOptions<TType>): AISpan<TType>;
-  
+  startSpan<TType extends AISpanType>(
+    options: StartSpanOptions<TType>,
+  ): AISpan<TType>;
+
   /** Shutdown AI tracing and clean up resources */
   shutdown(): Promise<void>;
 }
@@ -71,44 +73,44 @@ interface AISpan<TType extends AISpanType> {
   readonly traceId: string;
   readonly type: TType;
   readonly name: string;
-  
+
   /** 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;
-  
+
   attributes?: AISpanTypeMap[TType];
   metadata?: Record<string, any>;
   input?: any;
   output?: any;
   errorInfo?: any;
-  
+
   /** End the span */
   end(options?: EndSpanOptions<TType>): void;
-  
+
   /** Record an error for the span, optionally end the span as well */
   error(options: ErrorSpanOptions<TType>): void;
-  
+
   /** Update span attributes */
   update(options: UpdateSpanOptions<TType>): void;
-  
+
   /** Create child span - can be any span type independent of parent */
   createChildSpan<TChildType extends AISpanType>(
-    options: ChildSpanOptions<TChildType>
+    options: ChildSpanOptions<TChildType>,
   ): AISpan<TChildType>;
-  
+
   /** Create event span - can be any span type independent of parent */
   createEventSpan<TChildType extends AISpanType>(
-    options: ChildEventOptions<TChildType>
+    options: ChildEventOptions<TChildType>,
   ): AISpan<TChildType>;
-  
+
   /** Returns TRUE if the span is the root span of a trace */
   get isRootSpan(): boolean;
-  
+
   /** Returns TRUE if the span is a valid span (not a NO-OP Span) */
   get isValid(): boolean;
 }
@@ -122,13 +124,13 @@ Interface for tracing exporters.
 interface AITracingExporter {
   /** Exporter name */
   name: string;
-  
+
   /** Initialize exporter (called after all dependencies are ready) */
   init?(): void;
-  
+
   /** Export tracing events */
   exportEvent(event: AITracingEvent): Promise<void>;
-  
+
   /** Shutdown exporter */
   shutdown(): Promise<void>;
 }
@@ -142,10 +144,10 @@ Interface for span processors.
 interface AISpanProcessor {
   /** Processor name */
   name: string;
-  
+
   /** Process span before export */
   process(span?: AnyAISpan): AnyAISpan | undefined;
-  
+
   /** Shutdown processor */
   shutdown(): Promise<void>;
 }
@@ -160,49 +162,49 @@ AI-specific span types with their associated metadata.
 ```typescript
 enum AISpanType {
   /** Agent run - root span for agent processes */
-  AGENT_RUN = 'agent_run',
+  AGENT_RUN = "agent_run",
 
   /** Generic span for custom operations */
-  GENERIC = 'generic',
+  GENERIC = "generic",
 
   /** Model generation with model calls, token usage, prompts, completions */
-  MODEL_GENERATION = 'model_generation',
+  MODEL_GENERATION = "model_generation",
 
   /** Single model execution step within a generation (one API call) */
-  MODEL_STEP = 'model_step',
+  MODEL_STEP = "model_step",
 
   /** Individual model streaming chunk/event */
-  MODEL_CHUNK = 'model_chunk',
+  MODEL_CHUNK = "model_chunk",
 
   /** MCP (Model Context Protocol) tool execution */
-  MCP_TOOL_CALL = 'mcp_tool_call',
-  
+  MCP_TOOL_CALL = "mcp_tool_call",
+
   /** Function/tool execution with inputs, outputs, errors */
-  TOOL_CALL = 'tool_call',
-  
+  TOOL_CALL = "tool_call",
+
   /** Workflow run - root span for workflow processes */
-  WORKFLOW_RUN = 'workflow_run',
-  
+  WORKFLOW_RUN = "workflow_run",
+
   /** Workflow step execution with step status, data flow */
-  WORKFLOW_STEP = 'workflow_step',
-  
+  WORKFLOW_STEP = "workflow_step",
+
   /** Workflow conditional execution with condition evaluation */
-  WORKFLOW_CONDITIONAL = 'workflow_conditional',
-  
+  WORKFLOW_CONDITIONAL = "workflow_conditional",
+
   /** Individual condition evaluation within conditional */
-  WORKFLOW_CONDITIONAL_EVAL = 'workflow_conditional_eval',
-  
+  WORKFLOW_CONDITIONAL_EVAL = "workflow_conditional_eval",
+
   /** Workflow parallel execution */
-  WORKFLOW_PARALLEL = 'workflow_parallel',
-  
+  WORKFLOW_PARALLEL = "workflow_parallel",
+
   /** Workflow loop execution */
-  WORKFLOW_LOOP = 'workflow_loop',
-  
+  WORKFLOW_LOOP = "workflow_loop",
+
   /** Workflow sleep operation */
-  WORKFLOW_SLEEP = 'workflow_sleep',
-  
+  WORKFLOW_SLEEP = "workflow_sleep",
+
   /** Workflow wait for event operation */
-  WORKFLOW_WAIT_EVENT = 'workflow_wait_event',
+  WORKFLOW_WAIT_EVENT = "workflow_wait_event",
 }
 ```
 
@@ -224,16 +226,16 @@ Agent Run attributes.
 interface AgentRunAttributes {
   /** Agent identifier */
   agentId: string;
-  
+
   /** Agent Instructions */
   instructions?: string;
-  
+
   /** Agent Prompt */
   prompt?: string;
-  
+
   /** Available tools for this execution */
   availableTools?: string[];
-  
+
   /** Maximum steps allowed */
   maxSteps?: number;
 }
@@ -247,13 +249,17 @@ Model Generation attributes.
 interface ModelGenerationAttributes {
   /** Model name (e.g., 'gpt-4', 'claude-3') */
   model?: string;
-  
+
   /** Model provider (e.g., 'openai', 'anthropic') */
   provider?: string;
-  
+
   /** Type of result/output this model call produced */
-  resultType?: 'tool_selection' | 'response_generation' | 'reasoning' | 'planning';
-  
+  resultType?:
+    | "tool_selection"
+    | "response_generation"
+    | "reasoning"
+    | "planning";
+
   /** Token usage statistics */
   usage?: {
     promptTokens?: number;
@@ -262,7 +268,7 @@ interface ModelGenerationAttributes {
     promptCacheHitTokens?: number;
     promptCacheMissTokens?: number;
   };
-  
+
   /** Model parameters */
   parameters?: {
     maxOutputTokens?: number;
@@ -275,10 +281,10 @@ interface ModelGenerationAttributes {
     seed?: number;
     maxRetries?: number;
   };
-  
+
   /** Whether this was a streaming response */
   streaming?: boolean;
-  
+
   /** Reason the generation finished */
   finishReason?: string;
 }
@@ -315,7 +321,7 @@ Model Chunk attributes - for individual streaming chunks/events.
 interface ModelChunkAttributes {
   /** Type of chunk (text-delta, reasoning-delta, tool-call, etc.) */
   chunkType?: string;
-  
+
   /** Sequence number of this chunk in the stream */
   sequenceNumber?: number;
 }
@@ -342,13 +348,13 @@ MCP Tool Call attributes.
 interface MCPToolCallAttributes {
   /** Id of the MCP tool/function */
   toolId: string;
-  
+
   /** MCP server identifier */
   mcpServer: string;
-  
+
   /** MCP server version */
   serverVersion?: string;
-  
+
   /** Whether tool execution was successful */
   success?: boolean;
 }
@@ -362,13 +368,13 @@ Workflow Run attributes.
 interface WorkflowRunAttributes {
   /** Workflow identifier */
   workflowId: string;
-  
+
   /** Workflow version */
   workflowVersion?: string;
-  
+
   /** Workflow run ID */
   runId?: string;
-  
+
   /** Final workflow execution status */
   status?: WorkflowRunStatus;
 }
@@ -382,16 +388,16 @@ Workflow Step attributes.
 interface WorkflowStepAttributes {
   /** Step identifier */
   stepId?: string;
-  
+
   /** Step type */
   stepType?: string;
-  
+
   /** Step status */
   status?: WorkflowStepStatus;
-  
+
   /** Step execution order */
   stepNumber?: number;
-  
+
   /** Result store key */
   resultKey?: string;
 }
@@ -407,25 +413,25 @@ Options for starting new spans.
 interface StartSpanOptions<TType extends AISpanType> {
   /** Span type */
   type: TType;
-  
+
   /** Span name */
   name: string;
-  
+
   /** Span attributes */
   attributes?: AISpanTypeMap[TType];
-  
+
   /** Span metadata */
   metadata?: Record<string, any>;
-  
+
   /** Input data */
   input?: any;
-  
+
   /** Parent span */
   parent?: AnyAISpan;
-  
+
   /** Policy-level tracing configuration */
   tracingPolicy?: TracingPolicy;
-  
+
   /** Options passed when using a custom sampler strategy */
   customSamplerOptions?: CustomSamplerOptions;
 }
@@ -439,13 +445,13 @@ Options for updating spans.
 interface UpdateSpanOptions<TType extends AISpanType> {
   /** Span attributes */
   attributes?: Partial<AISpanTypeMap[TType]>;
-  
+
   /** Span metadata */
   metadata?: Record<string, any>;
-  
+
   /** Input data */
   input?: any;
-  
+
   /** Output data */
   output?: any;
 }
@@ -459,10 +465,10 @@ Options for ending spans.
 interface EndSpanOptions<TType extends AISpanType> {
   /** Output data */
   output?: any;
-  
+
   /** Span metadata */
   metadata?: Record<string, any>;
-  
+
   /** Span attributes */
   attributes?: Partial<AISpanTypeMap[TType]>;
 }
@@ -476,13 +482,13 @@ Options for recording span errors.
 interface ErrorSpanOptions<TType extends AISpanType> {
   /** The error associated with the issue */
   error: Error;
-  
+
   /** End the span when true */
   endSpan?: boolean;
-  
+
   /** Span metadata */
   metadata?: Record<string, any>;
-  
+
   /** Span attributes */
   attributes?: Partial<AISpanTypeMap[TType]>;
 }
@@ -529,7 +535,7 @@ Policy-level tracing configuration applied when creating a workflow or agent.
 
 ```typescript
 interface TracingPolicy {
-  /** 
+  /**
    * Bitwise options to set different types of spans as Internal in
    * a workflow or agent execution. Internal spans are hidden by
    * default in exported traces.
@@ -548,19 +554,19 @@ Configuration for a single tracing instance.
 interface TracingConfig {
   /** Unique identifier for this config in the ai tracing registry */
   name: string;
-  
+
   /** Service name for tracing */
   serviceName: string;
-  
+
   /** Sampling strategy - controls whether tracing is collected (defaults to ALWAYS) */
   sampling?: SamplingStrategy;
-  
+
   /** Custom exporters */
   exporters?: AITracingExporter[];
-  
+
   /** Custom processors */
   processors?: AISpanProcessor[];
-  
+
   /** Set to true if you want to see spans internal to the operation of mastra */
   includeInternalSpans?: boolean;
 }
@@ -576,10 +582,10 @@ interface ObservabilityRegistryConfig {
   default?: {
     enabled?: boolean;
   };
-  
+
   /** Map of tracing instance names to their configurations or pre-instantiated instances */
-  configs?: Record<string, Omit<TracingConfig, 'name'> | AITracing>;
-  
+  configs?: Record<string, Omit<TracingConfig, "name"> | AITracing>;
+
   /** Optional selector function to choose which tracing instance to use */
   configSelector?: ConfigSelector;
 }
@@ -593,10 +599,10 @@ Sampling strategy configuration.
 
 ```typescript
 type SamplingStrategy =
-  | { type: 'always' }
-  | { type: 'never' }
-  | { type: 'ratio'; probability: number }
-  | { type: 'custom'; sampler: (options?: CustomSamplerOptions) => boolean };
+  | { type: "always" }
+  | { type: "never" }
+  | { type: "ratio"; probability: number }
+  | { type: "custom"; sampler: (options?: CustomSamplerOptions) => boolean };
 ```
 
 ### CustomSamplerOptions
@@ -619,7 +625,7 @@ Function to select which AI tracing instance to use for a given span.
 ```typescript
 type ConfigSelector = (
   options: ConfigSelectorOptions,
-  availableConfigs: ReadonlyMap<string, AITracing>
+  availableConfigs: ReadonlyMap<string, AITracing>,
 ) => string | undefined;
 ```
 
@@ -644,13 +650,13 @@ Bitwise options to set different types of spans as internal in a workflow or age
 enum InternalSpans {
   /** No spans are marked internal */
   NONE = 0,
-  
+
   /** Workflow spans are marked internal */
   WORKFLOW = 1 << 0,
-  
+
   /** Agent spans are marked internal */
   AGENT = 1 << 1,
-  
+
   /** Tool spans are marked internal */
   TOOL = 1 << 2,
 
@@ -665,14 +671,17 @@ enum InternalSpans {
 ## See Also
 
 ### 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
 
 ### Reference
+
 - [Configuration](/reference/observability/ai-tracing/configuration) - Registry and configuration
-- [AITracing Classes](/reference/observability/ai-tracing/ai-tracing) - Core implementations
+- [AITracing Classes](/reference/observability/ai-tracing/) - Core implementations
 - [Span Reference](/reference/observability/ai-tracing/span) - Span lifecycle methods
 
 ### Examples
-- [Basic AI Tracing](/examples/observability/basic-ai-tracing) - Implementation example
+
+- [Basic AI Tracing](/examples/observability/basic-ai-tracing) - Implementation example

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

@@ -1,9 +1,9 @@
 ---
-title: "SensitiveDataFilter | Processors | AI Tracing | Reference"
+title: "Reference: SensitiveDataFilter | Observability | Mastra Docs"
 description: API reference for the SensitiveDataFilter processor
 ---
 
-import { PropertiesTable } from "@/components/properties-table";
+import PropertiesTable from "@site/src/components/PropertiesTable";
 
 # SensitiveDataFilter
 
@@ -19,23 +19,23 @@ new SensitiveDataFilter(options?: SensitiveDataFilterOptions)
 
 ```typescript
 interface SensitiveDataFilterOptions {
-  /** 
+  /**
    * List of sensitive field names to redact.
-   * Matching is case-insensitive and normalizes separators 
+   * Matching is case-insensitive and normalizes separators
    * (api-key, api_key, Api Key → apikey).
-   * Defaults include: password, token, secret, key, apikey, auth, 
-   * authorization, bearer, bearertoken, jwt, credential, 
+   * Defaults include: password, token, secret, key, apikey, auth,
+   * authorization, bearer, bearertoken, jwt, credential,
    * clientsecret, privatekey, refresh, ssn.
    */
   sensitiveFields?: string[];
-  
-  /** 
+
+  /**
    * The token used for full redaction.
    * Default: "[REDACTED]"
    */
   redactionToken?: string;
-  
-  /** 
+
+  /**
    * Style of redaction to use:
    * - "full": always replace with redactionToken
    * - "partial": show 3 characters from the start and end, redact the middle
@@ -50,7 +50,8 @@ interface SensitiveDataFilterOptions {
     {
       name: "sensitiveFields",
       type: "string[]",
-      description: "Field names to redact (case-insensitive, separator-agnostic)",
+      description:
+        "Field names to redact (case-insensitive, separator-agnostic)",
       required: false,
     },
     {
@@ -71,7 +72,7 @@ interface SensitiveDataFilterOptions {
 ## RedactionStyle
 
 ```typescript
-type RedactionStyle = 'full' | 'partial';
+type RedactionStyle = "full" | "partial";
 ```
 
 ## Methods
@@ -117,22 +118,22 @@ When no custom fields are provided:
 
 ```typescript
 [
-  'password',
-  'token',
-  'secret',
-  'key',
-  'apikey',
-  'auth',
-  'authorization',
-  'bearer',
-  'bearertoken',
-  'jwt',
-  'credential',
-  'clientsecret',
-  'privatekey',
-  'refresh',
-  'ssn'
-]
+  "password",
+  "token",
+  "secret",
+  "key",
+  "apikey",
+  "auth",
+  "authorization",
+  "bearer",
+  "bearertoken",
+  "jwt",
+  "credential",
+  "clientsecret",
+  "privatekey",
+  "refresh",
+  "ssn",
+];
 ```
 
 ## Processing Behavior
@@ -140,7 +141,7 @@ When no custom fields are provided:
 ### Field Matching
 
 - **Case-insensitive**: `APIKey`, `apikey`, `ApiKey` all match
-- **Separator-agnostic**: `api-key`, `api_key`, `apiKey` are treated identically  
+- **Separator-agnostic**: `api-key`, `api_key`, `apiKey` are treated identically
 - **Exact matching**: After normalization, fields must match exactly
   - `token` matches `token`, `Token`, `TOKEN`
   - `token` does NOT match `promptTokens` or `tokenCount`
@@ -162,7 +163,11 @@ All matched values replaced with redactionToken.
 If filtering a field fails, the field is replaced with:
 
 ```typescript
-{ error: { processor: "sensitive-data-filter" } }
+{
+  error: {
+    processor: "sensitive-data-filter";
+  }
+}
 ```
 
 ### Processed Fields
@@ -172,7 +177,7 @@ The filter recursively processes:
 - `span.attributes` - Span metadata and properties
 - `span.metadata` - Custom metadata
 - `span.input` - Input data
-- `span.output` - Output data  
+- `span.output` - Output data
 - `span.errorInfo` - Error information
 
-Handles nested objects, arrays, and circular references safely.
+Handles nested objects, arrays, and circular references safely.