@mastra/core 1.9.0 → 1.10.0

package/dist/docs/references/reference-processors-pii-detector.md

@@ -17,37 +17,35 @@ const processor = new PIIDetector({
 
 ## Constructor parameters
 
-**options:** (`Options`): Configuration options for PII detection and redaction
+**options** (`Options`): Configuration options for PII detection and redaction
 
-### Options
+**options.model** (`MastraModelConfig`): Model configuration for the detection agent
 
-**model:** (`MastraModelConfig`): Model configuration for the detection agent
+**options.detectionTypes** (`string[]`): PII types to detect. If not specified, uses default types
 
-**detectionTypes?:** (`string[]`): PII types to detect. If not specified, uses default types
+**options.threshold** (`number`): Confidence threshold for flagging (0-1). PII is flagged if any category score exceeds this threshold
 
-**threshold?:** (`number`): Confidence threshold for flagging (0-1). PII is flagged if any category score exceeds this threshold
+**options.strategy** (`'block' | 'warn' | 'filter' | 'redact'`): Strategy when PII is detected: 'block' rejects with error, 'warn' logs warning but allows through, 'filter' removes flagged messages, 'redact' replaces PII with redacted versions
 
-**strategy?:** (`'block' | 'warn' | 'filter' | 'redact'`): Strategy when PII is detected: 'block' rejects with error, 'warn' logs warning but allows through, 'filter' removes flagged messages, 'redact' replaces PII with redacted versions
+**options.redactionMethod** (`'mask' | 'hash' | 'remove' | 'placeholder'`): Redaction method for PII: 'mask' replaces with asterisks, 'hash' replaces with SHA256 hash, 'remove' removes entirely, 'placeholder' replaces with type placeholder
 
-**redactionMethod?:** (`'mask' | 'hash' | 'remove' | 'placeholder'`): Redaction method for PII: 'mask' replaces with asterisks, 'hash' replaces with SHA256 hash, 'remove' removes entirely, 'placeholder' replaces with type placeholder
+**options.instructions** (`string`): Custom detection instructions for the agent. If not provided, uses default instructions based on detection types
 
-**instructions?:** (`string`): Custom detection instructions for the agent. If not provided, uses default instructions based on detection types
+**options.includeDetections** (`boolean`): Whether to include detection details in logs. Useful for compliance auditing and debugging
 
-**includeDetections?:** (`boolean`): Whether to include detection details in logs. Useful for compliance auditing and debugging
+**options.preserveFormat** (`boolean`): Whether to preserve PII format during redaction. When true, maintains structure like \*\*\*-\*\*-1234 for phone numbers
 
-**preserveFormat?:** (`boolean`): Whether to preserve PII format during redaction. When true, maintains structure like \*\*\*-\*\*-1234 for phone numbers
-
-**providerOptions?:** (`ProviderOptions`): Provider-specific options passed to the internal detection agent. Use this to control model behavior like reasoning effort for thinking models (e.g., \`{ openai: { reasoningEffort: 'low' } }\`)
+**options.providerOptions** (`ProviderOptions`): Provider-specific options passed to the internal detection agent. Use this to control model behavior like reasoning effort for thinking models (e.g., \`{ openai: { reasoningEffort: 'low' } }\`)
 
 ## Returns
 
-**id:** (`string`): Processor identifier set to 'pii-detector'
+**id** (`string`): Processor identifier set to 'pii-detector'
 
-**name?:** (`string`): Optional processor display name
+**name** (`string`): Optional processor display name
 
-**processInput:** (`(args: { messages: MastraDBMessage[]; abort: (reason?: string) => never; tracingContext?: TracingContext }) => Promise<MastraDBMessage[]>`): Processes input messages to detect and redact PII before sending to LLM
+**processInput** (`(args: { messages: MastraDBMessage[]; abort: (reason?: string) => never; tracingContext?: TracingContext }) => Promise<MastraDBMessage[]>`): Processes input messages to detect and redact PII before sending to LLM
 
-**processOutputStream:** (`(args: { part: ChunkType; streamParts: ChunkType[]; state: Record<string, any>; abort: (reason?: string) => never; tracingContext?: TracingContext }) => Promise<ChunkType | null | undefined>`): Processes streaming output parts to detect and redact PII during streaming
+**processOutputStream** (`(args: { part: ChunkType; streamParts: ChunkType[]; state: Record<string, any>; abort: (reason?: string) => never; tracingContext?: TracingContext }) => Promise<ChunkType | null | undefined>`): Processes streaming output parts to detect and redact PII during streaming
 
 ## Extended usage example
 

package/dist/docs/references/reference-processors-processor-interface.md

@@ -80,9 +80,9 @@ interface Processor<TId extends string = string> {
 
 ## Properties
 
-**id:** (`string`): Unique identifier for the processor. Used for tracing and debugging.
+**id** (`string`): Unique identifier for the processor. Used for tracing and debugging.
 
-**name?:** (`string`): Optional display name for the processor. Falls back to id if not provided.
+**name** (`string`): Optional display name for the processor. Falls back to id if not provided.
 
 ## Methods
 
@@ -96,29 +96,29 @@ processInput?(args: ProcessInputArgs): Promise<ProcessInputResult> | ProcessInpu
 
 #### ProcessInputArgs
 
-**messages:** (`MastraDBMessage[]`): User and assistant messages to process (excludes system messages).
+**messages** (`MastraDBMessage[]`): User and assistant messages to process (excludes system messages).
 
-**systemMessages:** (`CoreMessage[]`): All system messages (agent instructions, memory context, user-provided). Can be modified and returned.
+**systemMessages** (`CoreMessage[]`): All system messages (agent instructions, memory context, user-provided). Can be modified and returned.
 
-**messageList:** (`MessageList`): Full MessageList instance for advanced message management.
+**messageList** (`MessageList`): Full MessageList instance for advanced message management.
 
-**abort:** (`(reason?: string, options?: { retry?: boolean; metadata?: unknown }) => never`): Function to abort processing. Throws a TripWire error that stops execution. Pass \`retry: true\` to request the LLM retry the step with feedback.
+**abort** (`(reason?: string, options?: { retry?: boolean; metadata?: unknown }) => never`): Function to abort processing. Throws a TripWire error that stops execution. Pass \`retry: true\` to request the LLM retry the step with feedback.
 
-**retryCount?:** (`number`): Number of times processors have triggered retry for this generation. Use this to limit retry attempts.
+**retryCount** (`number`): Number of times processors have triggered retry for this generation. Use this to limit retry attempts.
 
-**tracingContext?:** (`TracingContext`): Tracing context for observability.
+**tracingContext** (`TracingContext`): Tracing context for observability.
 
-**requestContext?:** (`RequestContext`): Request-scoped context with execution metadata like threadId and resourceId.
+**requestContext** (`RequestContext`): Request-scoped context with execution metadata like threadId and resourceId.
 
 #### ProcessInputResult
 
 The method can return one of three types:
 
-**MastraDBMessage\[]:** (`array`): Transformed messages array. System messages remain unchanged.
+**MastraDBMessage\[]** (`array`): Transformed messages array. System messages remain unchanged.
 
-**MessageList:** (`MessageList`): The same messageList instance passed in. Indicates you've mutated it directly.
+**MessageList** (`MessageList`): The same messageList instance passed in. Indicates you've mutated it directly.
 
-**{ messages, systemMessages }:** (`object`): Object with both transformed messages and modified system messages.
+**{ messages, systemMessages }** (`object`): Object with both transformed messages and modified system messages.
 
 ***
 
@@ -141,59 +141,59 @@ processInputStep?(args: ProcessInputStepArgs): ProcessorMessageResult;
 
 #### ProcessInputStepArgs
 
-**messages:** (`MastraDBMessage[]`): All messages including tool calls and results from previous steps (read-only snapshot).
+**messages** (`MastraDBMessage[]`): All messages including tool calls and results from previous steps (read-only snapshot).
 
-**messageList:** (`MessageList`): MessageList instance for managing messages. Can mutate directly or return in result.
+**messageList** (`MessageList`): MessageList instance for managing messages. Can mutate directly or return in result.
 
-**stepNumber:** (`number`): Current step number (0-indexed). Step 0 is the initial LLM call.
+**stepNumber** (`number`): Current step number (0-indexed). Step 0 is the initial LLM call.
 
-**steps:** (`StepResult[]`): Results from previous steps, including text, toolCalls, and toolResults.
+**steps** (`StepResult[]`): Results from previous steps, including text, toolCalls, and toolResults.
 
-**systemMessages:** (`CoreMessage[]`): All system messages (read-only snapshot). Return in result to replace.
+**systemMessages** (`CoreMessage[]`): All system messages (read-only snapshot). Return in result to replace.
 
-**model:** (`MastraLanguageModelV2`): Current model being used. Return a different model in result to switch.
+**model** (`MastraLanguageModelV2`): Current model being used. Return a different model in result to switch.
 
-**toolChoice?:** (`ToolChoice`): Current tool choice setting ('auto', 'none', 'required', or specific tool).
+**toolChoice** (`ToolChoice`): Current tool choice setting ('auto', 'none', 'required', or specific tool).
 
-**activeTools?:** (`string[]`): Currently active tool names. Return filtered array to limit tools.
+**activeTools** (`string[]`): Currently active tool names. Return filtered array to limit tools.
 
-**tools?:** (`ToolSet`): Current tools available for this step. Return in result to add/replace tools.
+**tools** (`ToolSet`): Current tools available for this step. Return in result to add/replace tools.
 
-**providerOptions?:** (`SharedV2ProviderOptions`): Provider-specific options (e.g., Anthropic cacheControl, OpenAI reasoningEffort).
+**providerOptions** (`SharedV2ProviderOptions`): Provider-specific options (e.g., Anthropic cacheControl, OpenAI reasoningEffort).
 
-**modelSettings?:** (`CallSettings`): Model settings like temperature, maxTokens, topP.
+**modelSettings** (`CallSettings`): Model settings like temperature, maxTokens, topP.
 
-**structuredOutput?:** (`StructuredOutputOptions`): Structured output configuration (schema, output mode). Return in result to modify.
+**structuredOutput** (`StructuredOutputOptions`): Structured output configuration (schema, output mode). Return in result to modify.
 
-**abort:** (`(reason?: string) => never`): Function to abort processing.
+**abort** (`(reason?: string) => never`): Function to abort processing.
 
-**tracingContext?:** (`TracingContext`): Tracing context for observability.
+**tracingContext** (`TracingContext`): Tracing context for observability.
 
-**requestContext?:** (`RequestContext`): Request-scoped context with execution metadata.
+**requestContext** (`RequestContext`): Request-scoped context with execution metadata.
 
 #### ProcessInputStepResult
 
 The method can return any combination of these properties:
 
-**model?:** (`LanguageModelV2 | string`): Change the model for this step. Can be a model instance or router ID like 'openai/gpt-4o'.
+**model** (`LanguageModelV2 | string`): Change the model for this step. Can be a model instance or router ID like 'openai/gpt-4o'.
 
-**toolChoice?:** (`ToolChoice`): Change tool selection behavior for this step.
+**toolChoice** (`ToolChoice`): Change tool selection behavior for this step.
 
-**activeTools?:** (`string[]`): Filter which tools are available for this step.
+**activeTools** (`string[]`): Filter which tools are available for this step.
 
-**tools?:** (`ToolSet`): Replace or modify tools for this step. Use spread to merge: { tools: { ...tools, newTool } }.
+**tools** (`ToolSet`): Replace or modify tools for this step. Use spread to merge: { tools: { ...tools, newTool } }.
 
-**messages?:** (`MastraDBMessage[]`): Replace all messages. Cannot be used with messageList.
+**messages** (`MastraDBMessage[]`): Replace all messages. Cannot be used with messageList.
 
-**messageList?:** (`MessageList`): Return the same messageList instance (indicates you mutated it). Cannot be used with messages.
+**messageList** (`MessageList`): Return the same messageList instance (indicates you mutated it). Cannot be used with messages.
 
-**systemMessages?:** (`CoreMessage[]`): Replace all system messages for this step only.
+**systemMessages** (`CoreMessage[]`): Replace all system messages for this step only.
 
-**providerOptions?:** (`SharedV2ProviderOptions`): Change provider-specific options for this step.
+**providerOptions** (`SharedV2ProviderOptions`): Change provider-specific options for this step.
 
-**modelSettings?:** (`CallSettings`): Change model settings for this step.
+**modelSettings** (`CallSettings`): Change model settings for this step.
 
-**structuredOutput?:** (`StructuredOutputOptions`): Change structured output configuration for this step.
+**structuredOutput** (`StructuredOutputOptions`): Change structured output configuration for this step.
 
 #### Processor chaining
 
@@ -232,21 +232,21 @@ processOutputStream?(args: ProcessOutputStreamArgs): Promise<ChunkType | null |
 
 #### ProcessOutputStreamArgs
 
-**part:** (`ChunkType`): The current stream chunk being processed.
+**part** (`ChunkType`): The current stream chunk being processed.
 
-**streamParts:** (`ChunkType[]`): All chunks seen so far in the stream.
+**streamParts** (`ChunkType[]`): All chunks seen so far in the stream.
 
-**state:** (`Record<string, unknown>`): Mutable state object that persists across chunks within a single stream.
+**state** (`Record<string, unknown>`): Mutable state object that persists across chunks within a single stream.
 
-**abort:** (`(reason?: string) => never`): Function to abort the stream.
+**abort** (`(reason?: string) => never`): Function to abort the stream.
 
-**messageList?:** (`MessageList`): MessageList instance for accessing conversation history.
+**messageList** (`MessageList`): MessageList instance for accessing conversation history.
 
-**tracingContext?:** (`TracingContext`): Tracing context for observability.
+**tracingContext** (`TracingContext`): Tracing context for observability.
 
-**requestContext?:** (`RequestContext`): Request-scoped context with execution metadata.
+**requestContext** (`RequestContext`): Request-scoped context with execution metadata.
 
-**writer?:** (`ProcessorStreamWriter`): Stream writer for emitting custom data chunks back to the client. Call writer.custom() to emit data-\* typed chunks. Available during streaming.
+**writer** (`ProcessorStreamWriter`): Stream writer for emitting custom data chunks back to the client. Call writer.custom() to emit data-\* typed chunks. Available during streaming.
 
 #### Return value
 
@@ -265,17 +265,17 @@ processOutputResult?(args: ProcessOutputResultArgs): ProcessorMessageResult;
 
 #### ProcessOutputResultArgs
 
-**messages:** (`MastraDBMessage[]`): The generated response messages.
+**messages** (`MastraDBMessage[]`): The generated response messages.
 
-**messageList:** (`MessageList`): MessageList instance for managing messages.
+**messageList** (`MessageList`): MessageList instance for managing messages.
 
-**abort:** (`(reason?: string) => never`): Function to abort processing.
+**abort** (`(reason?: string) => never`): Function to abort processing.
 
-**tracingContext?:** (`TracingContext`): Tracing context for observability.
+**tracingContext** (`TracingContext`): Tracing context for observability.
 
-**requestContext?:** (`RequestContext`): Request-scoped context with execution metadata.
+**requestContext** (`RequestContext`): Request-scoped context with execution metadata.
 
-**writer?:** (`ProcessorStreamWriter`): Stream writer for emitting custom data chunks back to the client. Call writer.custom() to emit data-\* typed chunks. Available during streaming.
+**writer** (`ProcessorStreamWriter`): Stream writer for emitting custom data chunks back to the client. Call writer.custom() to emit data-\* typed chunks. Available during streaming.
 
 ***
 
@@ -289,27 +289,27 @@ processOutputStep?(args: ProcessOutputStepArgs): ProcessorMessageResult;
 
 #### ProcessOutputStepArgs
 
-**messages:** (`MastraDBMessage[]`): All messages including the latest LLM response.
+**messages** (`MastraDBMessage[]`): All messages including the latest LLM response.
 
-**messageList:** (`MessageList`): MessageList instance for managing messages.
+**messageList** (`MessageList`): MessageList instance for managing messages.
 
-**stepNumber:** (`number`): Current step number (0-indexed).
+**stepNumber** (`number`): Current step number (0-indexed).
 
-**finishReason?:** (`string`): The finish reason from the LLM (stop, tool-use, length, etc.).
+**finishReason** (`string`): The finish reason from the LLM (stop, tool-use, length, etc.).
 
-**toolCalls?:** (`ToolCallInfo[]`): Tool calls made in this step (if any).
+**toolCalls** (`ToolCallInfo[]`): Tool calls made in this step (if any).
 
-**text?:** (`string`): Generated text from this step.
+**text** (`string`): Generated text from this step.
 
-**systemMessages?:** (`CoreMessage[]`): All system messages for read/modify access.
+**systemMessages** (`CoreMessage[]`): All system messages for read/modify access.
 
-**abort:** (`(reason?: string, options?: { retry?: boolean; metadata?: unknown }) => never`): Function to abort processing. Pass \`retry: true\` to request the LLM retry the step.
+**abort** (`(reason?: string, options?: { retry?: boolean; metadata?: unknown }) => never`): Function to abort processing. Pass \`retry: true\` to request the LLM retry the step.
 
-**retryCount?:** (`number`): Number of times processors have triggered retry. Use this to limit retry attempts.
+**retryCount** (`number`): Number of times processors have triggered retry. Use this to limit retry attempts.
 
-**tracingContext?:** (`TracingContext`): Tracing context for observability.
+**tracingContext** (`TracingContext`): Tracing context for observability.
 
-**requestContext?:** (`RequestContext`): Request-scoped context with execution metadata.
+**requestContext** (`RequestContext`): Request-scoped context with execution metadata.
 
 #### Use cases
 

package/dist/docs/references/reference-processors-prompt-injection-detector.md

@@ -17,31 +17,29 @@ const processor = new PromptInjectionDetector({
 
 ## Constructor parameters
 
-**options:** (`Options`): Configuration options for prompt injection detection
+**options** (`Options`): Configuration options for prompt injection detection
 
-### Options
+**options.model** (`MastraModelConfig`): Model configuration for the detection agent
 
-**model:** (`MastraModelConfig`): Model configuration for the detection agent
+**options.detectionTypes** (`string[]`): Detection types to check for. If not specified, uses default categories
 
-**detectionTypes?:** (`string[]`): Detection types to check for. If not specified, uses default categories
+**options.threshold** (`number`): Confidence threshold for flagging (0-1). Higher threshold = less sensitive to avoid false positives
 
-**threshold?:** (`number`): Confidence threshold for flagging (0-1). Higher threshold = less sensitive to avoid false positives
+**options.strategy** (`'block' | 'warn' | 'filter' | 'rewrite'`): Strategy when injection is detected: 'block' rejects with error, 'warn' logs warning but allows through, 'filter' removes flagged messages, 'rewrite' attempts to neutralize the injection
 
-**strategy?:** (`'block' | 'warn' | 'filter' | 'rewrite'`): Strategy when injection is detected: 'block' rejects with error, 'warn' logs warning but allows through, 'filter' removes flagged messages, 'rewrite' attempts to neutralize the injection
+**options.instructions** (`string`): Custom detection instructions for the agent. If not provided, uses default instructions based on detection types
 
-**instructions?:** (`string`): Custom detection instructions for the agent. If not provided, uses default instructions based on detection types
+**options.includeScores** (`boolean`): Whether to include confidence scores in logs. Useful for tuning thresholds and debugging
 
-**includeScores?:** (`boolean`): Whether to include confidence scores in logs. Useful for tuning thresholds and debugging
-
-**providerOptions?:** (`ProviderOptions`): Provider-specific options passed to the internal detection agent. Use this to control model behavior like reasoning effort for thinking models (e.g., \`{ openai: { reasoningEffort: 'low' } }\`)
+**options.providerOptions** (`ProviderOptions`): Provider-specific options passed to the internal detection agent. Use this to control model behavior like reasoning effort for thinking models (e.g., \`{ openai: { reasoningEffort: 'low' } }\`)
 
 ## Returns
 
-**id:** (`string`): Processor identifier set to 'prompt-injection-detector'
+**id** (`string`): Processor identifier set to 'prompt-injection-detector'
 
-**name?:** (`string`): Optional processor display name
+**name** (`string`): Optional processor display name
 
-**processInput:** (`(args: { messages: MastraDBMessage[]; abort: (reason?: string) => never; tracingContext?: TracingContext }) => Promise<MastraDBMessage[]>`): Processes input messages to detect prompt injection attempts before sending to LLM
+**processInput** (`(args: { messages: MastraDBMessage[]; abort: (reason?: string) => never; tracingContext?: TracingContext }) => Promise<MastraDBMessage[]>`): Processes input messages to detect prompt injection attempts before sending to LLM
 
 ## Extended usage example
 

package/dist/docs/references/reference-processors-semantic-recall-processor.md

@@ -20,37 +20,35 @@ const processor = new SemanticRecall({
 
 ## Constructor parameters
 
-**options:** (`SemanticRecallOptions`): Configuration options for the semantic recall processor
+**options** (`SemanticRecallOptions`): Configuration options for the semantic recall processor
 
-### Options
+**options.storage** (`MemoryStorage`): Storage instance for retrieving messages
 
-**storage:** (`MemoryStorage`): Storage instance for retrieving messages
+**options.vector** (`MastraVector`): Vector store for semantic search
 
-**vector:** (`MastraVector`): Vector store for semantic search
+**options.embedder** (`MastraEmbeddingModel<string>`): Embedder for generating query embeddings
 
-**embedder:** (`MastraEmbeddingModel<string>`): Embedder for generating query embeddings
+**options.topK** (`number`): Number of most similar messages to retrieve
 
-**topK?:** (`number`): Number of most similar messages to retrieve
+**options.messageRange** (`number | { before: number; after: number }`): Number of context messages to include before/after each match. Can be a single number (same for both) or an object with separate values
 
-**messageRange?:** (`number | { before: number; after: number }`): Number of context messages to include before/after each match. Can be a single number (same for both) or an object with separate values
+**options.scope** (`'thread' | 'resource'`): Scope of semantic search. 'thread' searches within the current thread only. 'resource' searches across all threads for the resource
 
-**scope?:** (`'thread' | 'resource'`): Scope of semantic search. 'thread' searches within the current thread only. 'resource' searches across all threads for the resource
+**options.threshold** (`number`): Minimum similarity score threshold (0-1). Messages below this threshold are filtered out
 
-**threshold?:** (`number`): Minimum similarity score threshold (0-1). Messages below this threshold are filtered out
+**options.indexName** (`string`): Index name for the vector store. If not provided, auto-generated based on embedder model
 
-**indexName?:** (`string`): Index name for the vector store. If not provided, auto-generated based on embedder model
-
-**logger?:** (`IMastraLogger`): Optional logger instance for structured logging
+**options.logger** (`IMastraLogger`): Optional logger instance for structured logging
 
 ## Returns
 
-**id:** (`string`): Processor identifier set to 'semantic-recall'
+**id** (`string`): Processor identifier set to 'semantic-recall'
 
-**name:** (`string`): Processor display name set to 'SemanticRecall'
+**name** (`string`): Processor display name set to 'SemanticRecall'
 
-**processInput:** (`(args: { messages: MastraDBMessage[]; messageList: MessageList; abort: (reason?: string) => never; tracingContext?: TracingContext; requestContext?: RequestContext }) => Promise<MessageList | MastraDBMessage[]>`): Performs semantic search on historical messages and adds relevant context to the message list
+**processInput** (`(args: { messages: MastraDBMessage[]; messageList: MessageList; abort: (reason?: string) => never; tracingContext?: TracingContext; requestContext?: RequestContext }) => Promise<MessageList | MastraDBMessage[]>`): Performs semantic search on historical messages and adds relevant context to the message list
 
-**processOutputResult:** (`(args: { messages: MastraDBMessage[]; messageList?: MessageList; abort: (reason?: string) => never; tracingContext?: TracingContext; requestContext?: RequestContext }) => Promise<MessageList | MastraDBMessage[]>`): Creates embeddings for new messages to enable future semantic search
+**processOutputResult** (`(args: { messages: MastraDBMessage[]; messageList?: MessageList; abort: (reason?: string) => never; tracingContext?: TracingContext; requestContext?: RequestContext }) => Promise<MessageList | MastraDBMessage[]>`): Creates embeddings for new messages to enable future semantic search
 
 ## Extended usage example
 

package/dist/docs/references/reference-processors-system-prompt-scrubber.md

@@ -17,33 +17,31 @@ const processor = new SystemPromptScrubber({
 
 ## Constructor parameters
 
-**options:** (`Options`): Configuration options for system prompt detection and handling
+**options** (`Options`): Configuration options for system prompt detection and handling
 
-### Options
+**options.model** (`MastraModelConfig`): Model configuration for the detection agent
 
-**model:** (`MastraModelConfig`): Model configuration for the detection agent
+**options.strategy** (`'block' | 'warn' | 'filter' | 'redact'`): Strategy when system prompts are detected: 'block' rejects with error, 'warn' logs warning but allows through, 'filter' removes flagged messages, 'redact' replaces with redacted versions
 
-**strategy?:** (`'block' | 'warn' | 'filter' | 'redact'`): Strategy when system prompts are detected: 'block' rejects with error, 'warn' logs warning but allows through, 'filter' removes flagged messages, 'redact' replaces with redacted versions
+**options.customPatterns** (`string[]`): Custom patterns to detect system prompts (regex strings)
 
-**customPatterns?:** (`string[]`): Custom patterns to detect system prompts (regex strings)
+**options.includeDetections** (`boolean`): Whether to include detection details in warnings. Useful for debugging and monitoring
 
-**includeDetections?:** (`boolean`): Whether to include detection details in warnings. Useful for debugging and monitoring
+**options.instructions** (`string`): Custom instructions for the detection agent. If not provided, uses default instructions
 
-**instructions?:** (`string`): Custom instructions for the detection agent. If not provided, uses default instructions
+**options.redactionMethod** (`'mask' | 'placeholder' | 'remove'`): Redaction method for system prompts: 'mask' replaces with asterisks, 'placeholder' replaces with placeholder text, 'remove' removes entirely
 
-**redactionMethod?:** (`'mask' | 'placeholder' | 'remove'`): Redaction method for system prompts: 'mask' replaces with asterisks, 'placeholder' replaces with placeholder text, 'remove' removes entirely
-
-**placeholderText?:** (`string`): Custom placeholder text for redaction when redactionMethod is 'placeholder'
+**options.placeholderText** (`string`): Custom placeholder text for redaction when redactionMethod is 'placeholder'
 
 ## Returns
 
-**id:** (`string`): Processor identifier set to 'system-prompt-scrubber'
+**id** (`string`): Processor identifier set to 'system-prompt-scrubber'
 
-**name?:** (`string`): Optional processor display name
+**name** (`string`): Optional processor display name
 
-**processOutputStream:** (`(args: { part: ChunkType; streamParts: ChunkType[]; state: Record<string, any>; abort: (reason?: string) => never; tracingContext?: TracingContext }) => Promise<ChunkType | null>`): Processes streaming output parts to detect and handle system prompts during streaming
+**processOutputStream** (`(args: { part: ChunkType; streamParts: ChunkType[]; state: Record<string, any>; abort: (reason?: string) => never; tracingContext?: TracingContext }) => Promise<ChunkType | null>`): Processes streaming output parts to detect and handle system prompts during streaming
 
-**processOutputResult:** (`(args: { messages: MastraDBMessage[]; abort: (reason?: string) => never }) => Promise<MastraDBMessage[]>`): Processes final output results to detect and handle system prompts in non-streaming scenarios
+**processOutputResult** (`(args: { messages: MastraDBMessage[]; abort: (reason?: string) => never }) => Promise<MastraDBMessage[]>`): Processes final output results to detect and handle system prompts in non-streaming scenarios
 
 ## Extended usage example
 

package/dist/docs/references/reference-processors-token-limiter-processor.md

@@ -19,31 +19,29 @@ const processor = new TokenLimiterProcessor({
 
 ## Constructor parameters
 
-**options:** (`number | Options`): Either a simple number for token limit, or configuration options object
+**options** (`number | Options`): Either a simple number for token limit, or configuration options object
 
-### Options
+**options.limit** (`number`): Maximum number of tokens to allow in the response
 
-**limit:** (`number`): Maximum number of tokens to allow in the response
+**options.encoding** (`TiktokenBPE`): Optional encoding to use. Defaults to o200k\_base which is used by gpt-5.1
 
-**encoding?:** (`TiktokenBPE`): Optional encoding to use. Defaults to o200k\_base which is used by gpt-5.1
+**options.strategy** (`'truncate' | 'abort'`): Strategy when token limit is reached: 'truncate' stops emitting chunks, 'abort' calls abort() to stop the stream
 
-**strategy?:** (`'truncate' | 'abort'`): Strategy when token limit is reached: 'truncate' stops emitting chunks, 'abort' calls abort() to stop the stream
-
-**countMode?:** (`'cumulative' | 'part'`): Whether to count tokens from the beginning of the stream or just the current part: 'cumulative' counts all tokens from start, 'part' only counts tokens in current part
+**options.countMode** (`'cumulative' | 'part'`): Whether to count tokens from the beginning of the stream or just the current part: 'cumulative' counts all tokens from start, 'part' only counts tokens in current part
 
 ## Returns
 
-**id:** (`string`): Processor identifier set to 'token-limiter'
+**id** (`string`): Processor identifier set to 'token-limiter'
 
-**name?:** (`string`): Optional processor display name
+**name** (`string`): Optional processor display name
 
-**processInput:** (`(args: { messages: MastraDBMessage[]; abort: (reason?: string) => never }) => Promise<MastraDBMessage[]>`): Filters input messages to fit within token limit, prioritizing recent messages while preserving system messages
+**processInput** (`(args: { messages: MastraDBMessage[]; abort: (reason?: string) => never }) => Promise<MastraDBMessage[]>`): Filters input messages to fit within token limit, prioritizing recent messages while preserving system messages
 
-**processOutputStream:** (`(args: { part: ChunkType; streamParts: ChunkType[]; state: Record<string, any>; abort: (reason?: string) => never }) => Promise<ChunkType | null>`): Processes streaming output parts to limit token count during streaming
+**processOutputStream** (`(args: { part: ChunkType; streamParts: ChunkType[]; state: Record<string, any>; abort: (reason?: string) => never }) => Promise<ChunkType | null>`): Processes streaming output parts to limit token count during streaming
 
-**processOutputResult:** (`(args: { messages: MastraDBMessage[]; abort: (reason?: string) => never }) => Promise<MastraDBMessage[]>`): Processes final output results to limit token count in non-streaming scenarios
+**processOutputResult** (`(args: { messages: MastraDBMessage[]; abort: (reason?: string) => never }) => Promise<MastraDBMessage[]>`): Processes final output results to limit token count in non-streaming scenarios
 
-**getMaxTokens:** (`() => number`): Get the maximum token limit
+**getMaxTokens** (`() => number`): Get the maximum token limit
 
 ## Error behavior
 

package/dist/docs/references/reference-processors-tool-call-filter.md

@@ -18,19 +18,17 @@ const filterSpecific = new ToolCallFilter({
 
 ## Constructor parameters
 
-**options?:** (`Options`): Configuration options for the tool call filter
+**options** (`Options`): Configuration options for the tool call filter
 
-### Options
-
-**exclude?:** (`string[]`): List of specific tool names to exclude. If not provided or undefined, all tool calls are excluded
+**options.exclude** (`string[]`): List of specific tool names to exclude. If not provided or undefined, all tool calls are excluded
 
 ## Returns
 
-**id:** (`string`): Processor identifier set to 'tool-call-filter'
+**id** (`string`): Processor identifier set to 'tool-call-filter'
 
-**name:** (`string`): Processor display name set to 'ToolCallFilter'
+**name** (`string`): Processor display name set to 'ToolCallFilter'
 
-**processInput:** (`(args: { messages: MastraDBMessage[]; messageList: MessageList; abort: (reason?: string) => never; requestContext?: RequestContext }) => Promise<MessageList | MastraDBMessage[]>`): Processes input messages to filter out tool calls and their results based on configuration
+**processInput** (`(args: { messages: MastraDBMessage[]; messageList: MessageList; abort: (reason?: string) => never; requestContext?: RequestContext }) => Promise<MessageList | MastraDBMessage[]>`): Processes input messages to filter out tool calls and their results based on configuration
 
 ## Extended usage example
 

package/dist/docs/references/reference-processors-tool-search-processor.md

@@ -23,27 +23,25 @@ const toolSearch = new ToolSearchProcessor({
 
 ## Constructor parameters
 
-**options:** (`ToolSearchProcessorOptions`): Configuration options for the tool search processor
+**options** (`ToolSearchProcessorOptions`): Configuration options for the tool search processor
 
-### Options
+**options.tools** (`Record<string, Tool>`): All tools that can be searched and loaded dynamically. These tools are not immediately available to the agent — they must be discovered via search and loaded on demand.
 
-**tools:** (`Record<string, Tool>`): All tools that can be searched and loaded dynamically. These tools are not immediately available to the agent — they must be discovered via search and loaded on demand.
+**options.search** (`{ topK?: number; minScore?: number }`): Configuration for the search behavior.
 
-**search?:** (`{ topK?: number; minScore?: number }`): Configuration for the search behavior.
+**options.search.topK** (`number`): Maximum number of tools to return in search results.
 
-**search.topK?:** (`number`): Maximum number of tools to return in search results.
+**options.search.minScore** (`number`): Minimum relevance score (0-1) for including a tool in search results.
 
-**search.minScore?:** (`number`): Minimum relevance score (0-1) for including a tool in search results.
-
-**ttl?:** (`number`): Time-to-live for thread state in milliseconds. After this duration of inactivity, thread state will be cleaned up. Set to 0 to disable cleanup.
+**options.ttl** (`number`): Time-to-live for thread state in milliseconds. After this duration of inactivity, thread state will be cleaned up. Set to 0 to disable cleanup.
 
 ## Returns
 
-**id:** (`string`): Processor identifier set to 'tool-search'
+**id** (`string`): Processor identifier set to 'tool-search'
 
-**name:** (`string`): Processor display name set to 'Tool Search Processor'
+**name** (`string`): Processor display name set to 'Tool Search Processor'
 
-**processInputStep:** (`(args: ProcessInputStepArgs) => Promise<ProcessInputStepResult>`): Processes each step to inject search/load meta-tools and any previously loaded tools into the agent's tool set.
+**processInputStep** (`(args: ProcessInputStepArgs) => Promise<ProcessInputStepResult>`): Processes each step to inject search/load meta-tools and any previously loaded tools into the agent's tool set.
 
 ## Extended usage example
 

package/dist/docs/references/reference-processors-unicode-normalizer.md

@@ -15,25 +15,23 @@ const processor = new UnicodeNormalizer({
 
 ## Constructor parameters
 
-**options?:** (`Options`): Configuration options for Unicode text normalization
+**options** (`Options`): Configuration options for Unicode text normalization
 
-### Options
+**options.stripControlChars** (`boolean`): Whether to strip control characters. When enabled, removes control characters except , ,
 
-**stripControlChars?:** (`boolean`): Whether to strip control characters. When enabled, removes control characters except , ,
+**options.preserveEmojis** (`boolean`): Whether to preserve emojis. When disabled, emojis may be removed if they contain control characters
 
-**preserveEmojis?:** (`boolean`): Whether to preserve emojis. When disabled, emojis may be removed if they contain control characters
+**options.collapseWhitespace** (`boolean`): Whether to collapse consecutive whitespace. When enabled, multiple spaces/tabs/newlines are collapsed to single instances
 
-**collapseWhitespace?:** (`boolean`): Whether to collapse consecutive whitespace. When enabled, multiple spaces/tabs/newlines are collapsed to single instances
-
-**trim?:** (`boolean`): Whether to trim leading and trailing whitespace
+**options.trim** (`boolean`): Whether to trim leading and trailing whitespace
 
 ## Returns
 
-**id:** (`string`): Processor identifier set to 'unicode-normalizer'
+**id** (`string`): Processor identifier set to 'unicode-normalizer'
 
-**name?:** (`string`): Optional processor display name
+**name** (`string`): Optional processor display name
 
-**processInput:** (`(args: { messages: MastraDBMessage[]; abort: (reason?: string) => never }) => MastraDBMessage[]`): Processes input messages to normalize Unicode text
+**processInput** (`(args: { messages: MastraDBMessage[]; abort: (reason?: string) => never }) => MastraDBMessage[]`): Processes input messages to normalize Unicode text
 
 ## Extended usage example