@mastra/mcp-docs-server 1.1.7 → 1.1.8

package/.docs/reference/evals/run-evals.md

@@ -31,45 +31,45 @@ console.log(`Processed ${result.summary.totalItems} items`)
 
 ## Parameters
 
-**target:** (`Agent | Workflow`): The agent or workflow to evaluate.
+**target** (`Agent | Workflow`): The agent or workflow to evaluate.
 
-**data:** (`RunEvalsDataItem[]`): Array of test cases with input data and optional ground truth.
+**data** (`RunEvalsDataItem[]`): Array of test cases with input data and optional ground truth.
 
-**scorers:** (`MastraScorer[] | WorkflowScorerConfig`): Array of scorers for agents, or configuration object for workflows specifying scorers for the workflow and individual steps.
+**scorers** (`MastraScorer[] | WorkflowScorerConfig`): Array of scorers for agents, or configuration object for workflows specifying scorers for the workflow and individual steps.
 
-**targetOptions?:** (`AgentExecutionOptions | WorkflowRunOptions`): Options forwarded to the target during execution. For agents: options passed to agent.generate() (e.g. maxSteps, modelSettings, instructions). For workflows: options passed to run.start() (e.g. perStep, outputOptions, initialState).
+**targetOptions** (`AgentExecutionOptions | WorkflowRunOptions`): Options forwarded to the target during execution. For agents: options passed to agent.generate() (e.g. maxSteps, modelSettings, instructions). For workflows: options passed to run.start() (e.g. perStep, outputOptions, initialState).
 
-**concurrency?:** (`number`): Number of test cases to run concurrently. (Default: `1`)
+**concurrency** (`number`): Number of test cases to run concurrently. (Default: `1`)
 
-**onItemComplete?:** (`function`): Callback function called after each test case completes. Receives item, target result, and scorer results.
+**onItemComplete** (`function`): Callback function called after each test case completes. Receives item, target result, and scorer results.
 
 ## Data Item Structure
 
-**input:** (`string | string[] | CoreMessage[] | any`): Input data for the target. For agents: messages or strings. For workflows: workflow input data.
+**input** (`string | string[] | CoreMessage[] | any`): Input data for the target. For agents: messages or strings. For workflows: workflow input data.
 
-**groundTruth?:** (`any`): Expected or reference output for comparison during scoring.
+**groundTruth** (`any`): Expected or reference output for comparison during scoring.
 
-**requestContext?:** (`RequestContext`): Request Context to pass to the target during execution.
+**requestContext** (`RequestContext`): Request Context to pass to the target during execution.
 
-**tracingContext?:** (`TracingContext`): Tracing context for observability and debugging.
+**tracingContext** (`TracingContext`): Tracing context for observability and debugging.
 
-**startOptions?:** (`WorkflowRunOptions`): Per-item workflow run options (e.g. initialState, perStep, outputOptions). Merged on top of targetOptions, so per-item values take precedence. Only applicable when the target is a workflow.
+**startOptions** (`WorkflowRunOptions`): Per-item workflow run options (e.g. initialState, perStep, outputOptions). Merged on top of targetOptions, so per-item values take precedence. Only applicable when the target is a workflow.
 
 ## Workflow Scorer Configuration
 
 For workflows, you can specify scorers at different levels using `WorkflowScorerConfig`:
 
-**workflow?:** (`MastraScorer[]`): Array of scorers to evaluate the entire workflow output.
+**workflow** (`MastraScorer[]`): Array of scorers to evaluate the entire workflow output.
 
-**steps?:** (`Record<string, MastraScorer[]>`): Object mapping step IDs to arrays of scorers for evaluating individual step outputs.
+**steps** (`Record<string, MastraScorer[]>`): Object mapping step IDs to arrays of scorers for evaluating individual step outputs.
 
 ## Returns
 
-**scores:** (`Record<string, any>`): Average scores across all test cases, organized by scorer name.
+**scores** (`Record<string, any>`): Average scores across all test cases, organized by scorer name.
 
-**summary:** (`object`): Summary information about the experiment execution.
+**summary** (`object`): Summary information about the experiment execution.
 
-**summary.totalItems:** (`number`): Total number of test cases processed.
+**summary.totalItems** (`number`): Total number of test cases processed.
 
 ## Examples
 

package/.docs/reference/evals/scorer-utils.md

@@ -38,7 +38,7 @@ const scorer = createScorer({
   })
 ```
 
-**output?:** (`ScorerRunOutputForAgent`): The scorer run output (array of MastraDBMessage)
+**output** (`ScorerRunOutputForAgent`): The scorer run output (array of MastraDBMessage)
 
 **Returns:** `string | undefined` - The assistant message text, or undefined if no assistant message is found.
 
@@ -53,7 +53,7 @@ Extracts the text content from the first user message in the run input.
 })
 ```
 
-**input?:** (`ScorerRunInputForAgent`): The scorer run input containing input messages
+**input** (`ScorerRunInputForAgent`): The scorer run input containing input messages
 
 **Returns:** `string | undefined` - The user message text, or undefined if no user message is found.
 
@@ -134,7 +134,7 @@ const reasoningQualityScorer = createScorer({
   })
 ```
 
-**output?:** (`ScorerRunOutputForAgent`): The scorer run output (array of MastraDBMessage)
+**output** (`ScorerRunOutputForAgent`): The scorer run output (array of MastraDBMessage)
 
 **Returns:** `string | undefined` - The reasoning text, or undefined if no reasoning is present.
 

package/.docs/reference/evals/textual-difference.md

@@ -10,11 +10,11 @@ This function returns an instance of the MastraScorer class. See the [MastraScor
 
 ## .run() Returns
 
-**runId:** (`string`): The id of the run (optional).
+**runId** (`string`): The id of the run (optional).
 
-**analyzeStepResult:** (`object`): Object with difference metrics: { confidence: number, changes: number, lengthDiff: number }
+**analyzeStepResult** (`object`): Object with difference metrics: { confidence: number, changes: number, lengthDiff: number }
 
-**score:** (`number`): Similarity ratio (0-1) where 1 indicates identical texts.
+**score** (`number`): Similarity ratio (0-1) where 1 indicates identical texts.
 
 `.run()` returns a result in the following shape:
 

package/.docs/reference/evals/tone-consistency.md

@@ -10,11 +10,11 @@ This function returns an instance of the MastraScorer class. See the [MastraScor
 
 ## .run() Returns
 
-**runId:** (`string`): The id of the run (optional).
+**runId** (`string`): The id of the run (optional).
 
-**analyzeStepResult:** (`object`): Object with tone metrics: { responseSentiment: number, referenceSentiment: number, difference: number } (for comparison mode) OR { avgSentiment: number, sentimentVariance: number } (for stability mode)
+**analyzeStepResult** (`object`): Object with tone metrics: { responseSentiment: number, referenceSentiment: number, difference: number } (for comparison mode) OR { avgSentiment: number, sentimentVariance: number } (for stability mode)
 
-**score:** (`number`): Tone consistency/stability score (0-1).
+**score** (`number`): Tone consistency/stability score (0-1).
 
 `.run()` returns a result in the following shape:
 

package/.docs/reference/evals/tool-call-accuracy.md

@@ -29,11 +29,11 @@ The `createToolCallAccuracyScorerCode()` function from `@mastra/evals/scorers/pr
 
 ### Parameters
 
-**expectedTool:** (`string`): The name of the tool that should be called for the given task. Ignored when expectedToolOrder is provided.
+**expectedTool** (`string`): The name of the tool that should be called for the given task. Ignored when expectedToolOrder is provided.
 
-**strictMode:** (`boolean`): Controls evaluation strictness. For single tool mode: only exact single tool calls accepted. For order checking mode: tools must match exactly with no extra tools allowed.
+**strictMode** (`boolean`): Controls evaluation strictness. For single tool mode: only exact single tool calls accepted. For order checking mode: tools must match exactly with no extra tools allowed.
 
-**expectedToolOrder:** (`string[]`): Array of tool names in the expected calling order. When provided, enables order checking mode and ignores expectedTool parameter.
+**expectedToolOrder** (`string[]`): Array of tool names in the expected calling order. When provided, enables order checking mode and ignores expectedTool parameter.
 
 This function returns an instance of the MastraScorer class. See the [MastraScorer reference](https://mastra.ai/reference/evals/mastra-scorer) for details on the `.run()` method and its input/output.
 
@@ -277,9 +277,9 @@ The `createToolCallAccuracyScorerLLM()` function from `@mastra/evals/scorers/pre
 
 ### Parameters
 
-**model:** (`MastraModelConfig`): The LLM model to use for evaluating tool appropriateness
+**model** (`MastraModelConfig`): The LLM model to use for evaluating tool appropriateness
 
-**availableTools:** (`Array<{name: string, description: string}>`): List of available tools with their descriptions for context
+**availableTools** (`Array<{name: string, description: string}>`): List of available tools with their descriptions for context
 
 ### Features
 

package/.docs/reference/evals/toxicity.md

@@ -6,25 +6,25 @@ The `createToxicityScorer()` function evaluates whether an LLM's output contains
 
 The `createToxicityScorer()` function accepts a single options object with the following properties:
 
-**model:** (`LanguageModel`): Configuration for the model used to evaluate toxicity.
+**model** (`LanguageModel`): Configuration for the model used to evaluate toxicity.
 
-**scale:** (`number`): Maximum score value (default is 1). (Default: `1`)
+**scale** (`number`): Maximum score value (default is 1). (Default: `1`)
 
 This function returns an instance of the MastraScorer class. The `.run()` method accepts the same input as other scorers (see the [MastraScorer reference](https://mastra.ai/reference/evals/mastra-scorer)), but the return value includes LLM-specific fields as documented below.
 
 ## .run() Returns
 
-**runId:** (`string`): The id of the run (optional).
+**runId** (`string`): The id of the run (optional).
 
-**analyzeStepResult:** (`object`): Object with verdicts: { verdicts: Array<{ verdict: 'yes' | 'no', reason: string }> }
+**analyzeStepResult** (`object`): Object with verdicts: { verdicts: Array<{ verdict: 'yes' | 'no', reason: string }> }
 
-**analyzePrompt:** (`string`): The prompt sent to the LLM for the analyze step (optional).
+**analyzePrompt** (`string`): The prompt sent to the LLM for the analyze step (optional).
 
-**score:** (`number`): Toxicity score (0 to scale, default 0-1).
+**score** (`number`): Toxicity score (0 to scale, default 0-1).
 
-**reason:** (`string`): Detailed explanation of the toxicity assessment.
+**reason** (`string`): Detailed explanation of the toxicity assessment.
 
-**generateReasonPrompt:** (`string`): The prompt sent to the LLM for the generateReason step (optional).
+**generateReasonPrompt** (`string`): The prompt sent to the LLM for the generateReason step (optional).
 
 `.run()` returns a result in the following shape:
 

package/.docs/reference/harness/harness-class.md

@@ -38,83 +38,75 @@ await harness.sendMessage({ content: 'Hello!' })
 
 ## Constructor parameters
 
-**id:** (`string`): Unique identifier for this harness instance.
+**id** (`string`): Unique identifier for this harness instance.
 
-**resourceId?:** (`string`): Resource ID for grouping threads (e.g., project identifier). Threads are scoped to this resource ID. Defaults to \`id\`.
+**resourceId** (`string`): Resource ID for grouping threads (e.g., project identifier). Threads are scoped to this resource ID. Defaults to \`id\`.
 
-**storage?:** (`MastraCompositeStore`): Storage backend for persistence (threads, messages, state).
+**storage** (`MastraCompositeStore`): Storage backend for persistence (threads, messages, state).
 
-**stateSchema?:** (`z.ZodObject`): Zod schema defining the shape of harness state. Used for validation and extracting defaults.
+**stateSchema** (`z.ZodObject`): Zod schema defining the shape of harness state. Used for validation and extracting defaults.
 
-**initialState?:** (`Partial<z.infer<TState>>`): Initial state values. Must conform to the schema if provided.
+**initialState** (`Partial<z.infer<TState>>`): Initial state values. Must conform to the schema if provided.
 
-**memory?:** (`MastraMemory`): Memory configuration shared across all modes. Propagated to mode agents that don't have their own memory.
+**memory** (`MastraMemory`): Memory configuration shared across all modes. Propagated to mode agents that don't have their own memory.
 
-**modes:** (`HarnessMode[]`): Available agent modes. At least one mode is required. Each mode defines an agent and optional defaults.
+**modes** (`HarnessMode[]`): Available agent modes. At least one mode is required. Each mode defines an agent and optional defaults.
 
-**tools?:** (`ToolsInput | ((ctx) => ToolsInput)`): Tools available to all agents across all modes. It can be a static tools object or a dynamic function that receives the request context.
+**modes.id** (`string`): Unique identifier for this mode (e.g., \`"plan"\`, \`"build"\`).
 
-**workspace?:** (`Workspace | WorkspaceConfig | ((ctx) => Workspace)`): Workspace configuration. Accepts a pre-constructed Workspace, a WorkspaceConfig for the harness to construct internally, or a dynamic factory function.
+**modes.name** (`string`): Human-readable name for display.
 
-**subagents?:** (`HarnessSubagent[]`): Subagent definitions. When provided, the harness creates a built-in \`subagent\` tool that parent agents can call to spawn focused subagents.
+**modes.default** (`boolean`): Whether this is the default mode when the harness starts.
 
-**resolveModel?:** (`(modelId: string) => MastraLanguageModel`): Converts a model ID string (e.g., \`"anthropic/claude-sonnet-4"\`) to a language model instance. Used by subagents and observational memory model resolution.
+**modes.defaultModelId** (`string`): Default model ID for this mode (e.g., \`"anthropic/claude-sonnet-4-20250514"\`). Used when no per-mode model has been explicitly selected.
 
-**omConfig?:** (`HarnessOMConfig`): Default configuration for observational memory (observer/reflector model IDs and thresholds).
+**modes.color** (`string`): Hex color for the mode indicator (e.g., \`"#7c3aed"\`).
 
-**heartbeatHandlers?:** (`HeartbeatHandler[]`): Periodic background tasks started during \`init()\`. Use for gateway sync, cache refresh, and similar tasks.
+**modes.agent** (`Agent | ((state) => Agent)`): The agent for this mode. It can be a static Agent instance or a function that receives harness state and returns an Agent.
 
-**idGenerator?:** (`() => string`): Custom ID generator for threads, messages, and other entities. (Default: `timestamp + random string`)
+**tools** (`ToolsInput | ((ctx) => ToolsInput)`): Tools available to all agents across all modes. It can be a static tools object or a dynamic function that receives the request context.
 
-**modelAuthChecker?:** (`ModelAuthChecker`): Custom auth checker for model providers. Return \`true\`/\`false\` to override the default environment variable check, or \`undefined\` to fall back to defaults.
+**workspace** (`Workspace | WorkspaceConfig | ((ctx) => Workspace)`): Workspace configuration. Accepts a pre-constructed Workspace, a WorkspaceConfig for the harness to construct internally, or a dynamic factory function.
 
-**modelUseCountProvider?:** (`ModelUseCountProvider`): Provides per-model use counts for sorting and display in \`listAvailableModels()\`.
+**subagents** (`HarnessSubagent[]`): Subagent definitions. When provided, the harness creates a built-in \`subagent\` tool that parent agents can call to spawn focused subagents.
 
-**toolCategoryResolver?:** (`(toolName: string) => ToolCategory | null`): Maps tool names to permission categories (\`'read'\`, \`'edit'\`, \`'execute'\`, \`'mcp'\`, \`'other'\`). Used by the permission system to resolve category-level policies.
+**subagents.id** (`string`): Unique identifier for this subagent type (e.g., \`"explore"\`, \`"execute"\`).
 
-**threadLock?:** (`{ acquire, release }`): Thread locking callbacks to prevent concurrent access from multiple processes. \`acquire\` should throw if the lock is held.
+**subagents.name** (`string`): Human-readable name shown in tool output.
 
-### HarnessMode
+**subagents.description** (`string`): Description of what this subagent does. Used in the auto-generated tool description.
 
-Each entry in the `modes` array configures a single agent mode.
+**subagents.instructions** (`string`): System prompt for this subagent.
 
-**id:** (`string`): Unique identifier for this mode (e.g., \`"plan"\`, \`"build"\`).
+**subagents.tools** (`ToolsInput`): Tools this subagent has direct access to.
 
-**name?:** (`string`): Human-readable name for display.
+**subagents.allowedHarnessTools** (`string[]`): Tool IDs from the harness's shared \`tools\` config. Merged with \`tools\` above to let subagents use a subset of harness tools.
 
-**default?:** (`boolean`): Whether this is the default mode when the harness starts. (Default: `false`)
+**subagents.defaultModelId** (`string`): Default model ID for this subagent type.
 
-**defaultModelId?:** (`string`): Default model ID for this mode (e.g., \`"anthropic/claude-sonnet-4-20250514"\`). Used when no per-mode model has been explicitly selected.
+**subagents.maxSteps** (`number`): Optional maximum number of steps for the spawned subagent. Defaults to \`50\` when omitted.
 
-**color?:** (`string`): Hex color for the mode indicator (e.g., \`"#7c3aed"\`).
+**subagents.stopWhen** (`LoopOptions['stopWhen']`): Optional stop condition for the spawned subagent.
 
-**agent:** (`Agent | ((state) => Agent)`): The agent for this mode. It can be a static Agent instance or a function that receives harness state and returns an Agent.
+**resolveModel** (`(modelId: string) => MastraLanguageModel`): Converts a model ID string (e.g., \`"anthropic/claude-sonnet-4"\`) to a language model instance. Used by subagents and observational memory model resolution.
 
-### HarnessSubagent
+**omConfig** (`HarnessOMConfig`): Default configuration for observational memory (observer/reflector model IDs and thresholds).
 
-Each entry in the `subagents` array defines a subagent the harness can spawn.
+**heartbeatHandlers** (`HeartbeatHandler[]`): Periodic background tasks started during \`init()\`. Use for gateway sync, cache refresh, and similar tasks.
 
-**id:** (`string`): Unique identifier for this subagent type (e.g., \`"explore"\`, \`"execute"\`).
+**idGenerator** (`() => string`): Custom ID generator for threads, messages, and other entities. (Default: `timestamp + random string`)
 
-**name:** (`string`): Human-readable name shown in tool output.
+**modelAuthChecker** (`ModelAuthChecker`): Custom auth checker for model providers. Return \`true\`/\`false\` to override the default environment variable check, or \`undefined\` to fall back to defaults.
 
-**description:** (`string`): Description of what this subagent does. Used in the auto-generated tool description.
+**modelUseCountProvider** (`ModelUseCountProvider`): Provides per-model use counts for sorting and display in \`listAvailableModels()\`.
 
-**instructions:** (`string`): System prompt for this subagent.
+**toolCategoryResolver** (`(toolName: string) => ToolCategory | null`): Maps tool names to permission categories (\`'read'\`, \`'edit'\`, \`'execute'\`, \`'mcp'\`, \`'other'\`). Used by the permission system to resolve category-level policies.
 
-**tools?:** (`ToolsInput`): Tools this subagent has direct access to.
-
-**allowedHarnessTools?:** (`string[]`): Tool IDs from the harness's shared \`tools\` config. Merged with \`tools\` above to let subagents use a subset of harness tools.
-
-**defaultModelId?:** (`string`): Default model ID for this subagent type.
-
-**maxSteps?:** (`number`): Optional maximum number of steps for the spawned subagent. Defaults to \`50\` when omitted.
-
-**stopWhen?:** (`LoopOptions['stopWhen']`): Optional stop condition for the spawned subagent.
+**threadLock** (`{ acquire, release }`): Thread locking callbacks to prevent concurrent access from multiple processes. \`acquire\` should throw if the lock is held.
 
 ## Properties
 
-**id:** (`string`): Harness identifier, set at construction.
+**id** (`string`): Harness identifier, set at construction.
 
 ## Methods
 

package/.docs/reference/logging/pino-logger.md

@@ -20,15 +20,15 @@ export const mastra = new Mastra({
 
 ## Parameters
 
-**name:** (`string`): A label used to group and identify logs from this logger.
+**name** (`string`): A label used to group and identify logs from this logger.
 
-**level:** (`"debug" | "info" | "warn" | "error"`): Sets the minimum log level. Messages below this level are ignored.
+**level** (`"debug" | "info" | "warn" | "error"`): Sets the minimum log level. Messages below this level are ignored.
 
-**transports:** (`Record<string, LoggerTransport>`): A map of transport instances used to persist logs.
+**transports** (`Record<string, LoggerTransport>`): A map of transport instances used to persist logs.
 
-**overrideDefaultTransports?:** (`boolean`): If true, disables the default console transport.
+**overrideDefaultTransports** (`boolean`): If true, disables the default console transport.
 
-**formatters?:** (`pino.LoggerOptions['formatters']`): Custom Pino formatters for log serialization.
+**formatters** (`pino.LoggerOptions['formatters']`): Custom Pino formatters for log serialization.
 
 ## File transport (structured logs)
 

package/.docs/reference/memory/clone-utilities.md

@@ -14,7 +14,7 @@ const isClonedThread = memory.isClone(thread)
 
 ### Parameters
 
-**thread:** (`StorageThreadType`): The thread object to check.
+**thread** (`StorageThreadType`): The thread object to check.
 
 ### Example
 
@@ -40,7 +40,7 @@ const metadata = memory.getCloneMetadata(thread)
 
 ### Parameters
 
-**thread:** (`StorageThreadType`): The thread object to extract clone metadata from.
+**thread** (`StorageThreadType`): The thread object to extract clone metadata from.
 
 ### Example
 
@@ -66,7 +66,7 @@ const sourceThread = await memory.getSourceThread(threadId)
 
 ### Parameters
 
-**threadId:** (`string`): The ID of the cloned thread.
+**threadId** (`string`): The ID of the cloned thread.
 
 ### Example
 
@@ -91,7 +91,7 @@ const clones = await memory.listClones(sourceThreadId)
 
 ### Parameters
 
-**sourceThreadId:** (`string`): The ID of the source thread to find clones for.
+**sourceThreadId** (`string`): The ID of the source thread to find clones for.
 
 ### Example
 
@@ -116,7 +116,7 @@ const history = await memory.getCloneHistory(threadId)
 
 ### Parameters
 
-**threadId:** (`string`): The ID of the thread to get clone history for.
+**threadId** (`string`): The ID of the thread to get clone history for.
 
 ### Example
 

package/.docs/reference/memory/cloneThread.md

@@ -12,49 +12,45 @@ const { thread, clonedMessages } = await memory.cloneThread({
 
 ## Parameters
 
-**sourceThreadId:** (`string`): The ID of the thread to clone
+**sourceThreadId** (`string`): The ID of the thread to clone
 
-**newThreadId?:** (`string`): Optional custom ID for the cloned thread. If not provided, one will be generated.
+**newThreadId** (`string`): Optional custom ID for the cloned thread. If not provided, one will be generated.
 
-**resourceId?:** (`string`): Optional resource ID for the cloned thread. Defaults to the source thread's resourceId.
+**resourceId** (`string`): Optional resource ID for the cloned thread. Defaults to the source thread's resourceId.
 
-**title?:** (`string`): Optional title for the cloned thread. Defaults to '\[source title] (Copy)'.
+**title** (`string`): Optional title for the cloned thread. Defaults to '\[source title] (Copy)'.
 
-**metadata?:** (`Record<string, unknown>`): Optional metadata to merge with the source thread's metadata. Clone metadata is automatically added.
+**metadata** (`Record<string, unknown>`): Optional metadata to merge with the source thread's metadata. Clone metadata is automatically added.
 
-**options?:** (`CloneOptions`): Optional filtering options for the clone operation.
+**options** (`CloneOptions`): Optional filtering options for the clone operation.
 
-### Options Parameters
+**options.messageLimit** (`number`): Maximum number of messages to clone. When set, clones the most recent N messages.
 
-**messageLimit?:** (`number`): Maximum number of messages to clone. When set, clones the most recent N messages.
+**options.messageFilter** (`MessageFilter`): Filter criteria for selecting which messages to clone.
 
-**messageFilter?:** (`MessageFilter`): Filter criteria for selecting which messages to clone.
+**options.messageFilter.startDate** (`Date`): Only clone messages created on or after this date.
 
-### MessageFilter Parameters
+**options.messageFilter.endDate** (`Date`): Only clone messages created on or before this date.
 
-**startDate?:** (`Date`): Only clone messages created on or after this date.
-
-**endDate?:** (`Date`): Only clone messages created on or before this date.
-
-**messageIds?:** (`string[]`): Only clone messages with these specific IDs.
+**options.messageFilter.messageIds** (`string[]`): Only clone messages with these specific IDs.
 
 ## Returns
 
-**thread:** (`StorageThreadType`): The newly created cloned thread with clone metadata.
+**thread** (`StorageThreadType`): The newly created cloned thread with clone metadata.
 
-**clonedMessages:** (`MastraDBMessage[]`): Array of the cloned messages with new IDs assigned to the new thread.
+**clonedMessages** (`MastraDBMessage[]`): Array of the cloned messages with new IDs assigned to the new thread.
 
-**messageIdMap?:** (`Record<string, string>`): A mapping from source message IDs to their corresponding cloned message IDs.
+**messageIdMap** (`Record<string, string>`): A mapping from source message IDs to their corresponding cloned message IDs.
 
 ### Clone Metadata
 
 The cloned thread's metadata includes a `clone` property with:
 
-**sourceThreadId:** (`string`): The ID of the original thread that was cloned.
+**sourceThreadId** (`string`): The ID of the original thread that was cloned.
 
-**clonedAt:** (`Date`): Timestamp when the clone was created.
+**clonedAt** (`Date`): Timestamp when the clone was created.
 
-**lastMessageId?:** (`string`): The ID of the last message in the source thread at the time of cloning.
+**lastMessageId** (`string`): The ID of the last message in the source thread at the time of cloning.
 
 ## Extended Usage Example
 

package/.docs/reference/memory/createThread.md

@@ -10,27 +10,27 @@ await memory?.createThread({ resourceId: 'user-123' })
 
 ## Parameters
 
-**resourceId:** (`string`): Identifier for the resource this thread belongs to (e.g., user ID, project ID)
+**resourceId** (`string`): Identifier for the resource this thread belongs to (e.g., user ID, project ID)
 
-**threadId?:** (`string`): Optional custom ID for the thread. If not provided, one will be generated.
+**threadId** (`string`): Optional custom ID for the thread. If not provided, one will be generated.
 
-**title?:** (`string`): Optional title for the thread
+**title** (`string`): Optional title for the thread
 
-**metadata?:** (`Record<string, unknown>`): Optional metadata to associate with the thread
+**metadata** (`Record<string, unknown>`): Optional metadata to associate with the thread
 
 ## Returns
 
-**id:** (`string`): Unique identifier of the created thread
+**id** (`string`): Unique identifier of the created thread
 
-**resourceId:** (`string`): Resource ID associated with the thread
+**resourceId** (`string`): Resource ID associated with the thread
 
-**title:** (`string`): Title of the thread (if provided)
+**title** (`string`): Title of the thread (if provided)
 
-**createdAt:** (`Date`): Timestamp when the thread was created
+**createdAt** (`Date`): Timestamp when the thread was created
 
-**updatedAt:** (`Date`): Timestamp when the thread was last updated
+**updatedAt** (`Date`): Timestamp when the thread was last updated
 
-**metadata:** (`Record<string, unknown>`): Additional metadata associated with the thread
+**metadata** (`Record<string, unknown>`): Additional metadata associated with the thread
 
 ## Extended usage example
 

package/.docs/reference/memory/deleteMessages.md

@@ -10,11 +10,11 @@ await memory?.deleteMessages(['671ae63f-3a91-4082-a907-fe7de78e10ec'])
 
 ## Parameters
 
-**messageIds:** (`string[]`): Array of message IDs to delete
+**messageIds** (`string[]`): Array of message IDs to delete
 
 ## Returns
 
-**void:** (`Promise<void>`): A promise that resolves when all messages are deleted
+**void** (`Promise<void>`): A promise that resolves when all messages are deleted
 
 ## Extended usage example
 

package/.docs/reference/memory/getThreadById.md

@@ -10,11 +10,11 @@ await memory?.getThreadById({ threadId: 'thread-123' })
 
 ## Parameters
 
-**threadId:** (`string`): The ID of the thread to be retrieved.
+**threadId** (`string`): The ID of the thread to be retrieved.
 
 ## Returns
 
-**thread:** (`Promise<StorageThreadType | null>`): A promise that resolves to the thread associated with the given ID, or null if not found.
+**thread** (`Promise<StorageThreadType | null>`): A promise that resolves to the thread associated with the given ID, or null if not found.
 
 ### Related
 

package/.docs/reference/memory/listThreads.md

@@ -61,17 +61,17 @@ const result = await memory.listThreads({
 
 ## Parameters
 
-**filter?:** (`{ resourceId?: string; metadata?: Record<string, unknown> }`): Optional filter object. resourceId filters threads by resource ID. metadata filters threads by metadata key-value pairs (AND logic - all must match)
+**filter** (`{ resourceId?: string; metadata?: Record<string, unknown> }`): Optional filter object. resourceId filters threads by resource ID. metadata filters threads by metadata key-value pairs (AND logic - all must match)
 
-**page?:** (`number`): Page number (0-indexed) to retrieve
+**page** (`number`): Page number (0-indexed) to retrieve
 
-**perPage?:** (`number | false`): Maximum number of threads to return per page, or false to fetch all
+**perPage** (`number | false`): Maximum number of threads to return per page, or false to fetch all
 
-**orderBy?:** (`{ field: 'createdAt' | 'updatedAt', direction: 'ASC' | 'DESC' }`): Sort configuration with field and direction (defaults to { field: 'createdAt', direction: 'DESC' })
+**orderBy** (`{ field: 'createdAt' | 'updatedAt', direction: 'ASC' | 'DESC' }`): Sort configuration with field and direction (defaults to { field: 'createdAt', direction: 'DESC' })
 
 ## Returns
 
-**result:** (`Promise<StorageListThreadsOutput>`): A promise that resolves to paginated thread results with metadata
+**result** (`Promise<StorageListThreadsOutput>`): A promise that resolves to paginated thread results with metadata
 
 The return object contains:
 

package/.docs/reference/memory/memory-class.md

@@ -22,35 +22,33 @@ export const agent = new Agent({
 })
 ```
 
-> To enable `workingMemory` on an agent, you’ll need a storage provider configured on your main Mastra instance. See [Mastra class](https://mastra.ai/reference/core/mastra-class) for more information.
+> **Note:** To enable `workingMemory` on an agent, you’ll need a storage provider configured on your main Mastra instance. See [Mastra class](https://mastra.ai/reference/core/mastra-class) for more information.
 
 ## Constructor parameters
 
-**storage?:** (`MastraCompositeStore`): Storage implementation for persisting memory data. Defaults to \`new DefaultStorage({ config: { url: "file:memory.db" } })\` if not provided.
+**storage** (`MastraCompositeStore`): Storage implementation for persisting memory data. Defaults to \`new DefaultStorage({ config: { url: "file:memory.db" } })\` if not provided.
 
-**vector?:** (`MastraVector | false`): Vector store for semantic search capabilities. Set to \`false\` to disable vector operations.
+**vector** (`MastraVector | false`): Vector store for semantic search capabilities. Set to \`false\` to disable vector operations.
 
-**embedder?:** (`EmbeddingModel<string> | EmbeddingModelV2<string>`): Embedder instance for vector embeddings. Required when semantic recall is enabled.
+**embedder** (`EmbeddingModel<string> | EmbeddingModelV2<string>`): Embedder instance for vector embeddings. Required when semantic recall is enabled.
 
-**options?:** (`MemoryConfig`): Memory configuration options.
+**options** (`MemoryConfig`): Memory configuration options.
 
-### Options parameters
+**options.lastMessages** (`number | false`): Number of most recent messages to include in context. Set to \`false\` to disable loading conversation history into context. Use \`Number.MAX\_SAFE\_INTEGER\` to retrieve all messages with no limit. To prevent saving new messages, use the \`readOnly\` option instead.
 
-**lastMessages?:** (`number | false`): Number of most recent messages to include in context. Set to \`false\` to disable loading conversation history into context. Use \`Number.MAX\_SAFE\_INTEGER\` to retrieve all messages with no limit. To prevent saving new messages, use the \`readOnly\` option instead. (Default: `10`)
+**options.readOnly** (`boolean`): When true, prevents memory from saving new messages and provides working memory as read-only context (without the updateWorkingMemory tool). Useful for read-only operations like previews, internal routing agents, or sub agents that should reference but not modify memory.
 
-**readOnly?:** (`boolean`): When true, prevents memory from saving new messages and provides working memory as read-only context (without the updateWorkingMemory tool). Useful for read-only operations like previews, internal routing agents, or sub agents that should reference but not modify memory. (Default: `false`)
+**options.semanticRecall** (`boolean | { topK: number; messageRange: number | { before: number; after: number }; scope?: 'thread' | 'resource' }`): Enable semantic search in message history. Can be a boolean or an object with configuration options. When enabled, requires both vector store and embedder to be configured. Default topK is 4, default messageRange is {before: 1, after: 1}.
 
-**semanticRecall?:** (`boolean | { topK: number; messageRange: number | { before: number; after: number }; scope?: 'thread' | 'resource' }`): Enable semantic search in message history. Can be a boolean or an object with configuration options. When enabled, requires both vector store and embedder to be configured. Default topK is 4, default messageRange is {before: 1, after: 1}. (Default: `false`)
+**options.workingMemory** (`WorkingMemory`): Configuration for working memory feature. Can be \`{ enabled: boolean; template?: string; schema?: ZodObject\<any> | JSONSchema7; scope?: 'thread' | 'resource' }\` or \`{ enabled: boolean }\` to disable.
 
-**workingMemory?:** (`WorkingMemory`): Configuration for working memory feature. Can be \`{ enabled: boolean; template?: string; schema?: ZodObject\<any> | JSONSchema7; scope?: 'thread' | 'resource' }\` or \`{ enabled: boolean }\` to disable. (Default: `{ enabled: false, template: '# User Information\n- **First Name**:\n- **Last Name**:\n...' }`)
+**options.observationalMemory** (`boolean | ObservationalMemoryOptions`): Enable Observational Memory for long-context agentic memory. Set to \`true\` for defaults, or pass a config object to customize token budgets, models, and scope. See \[Observational Memory reference]\(/reference/memory/observational-memory) for configuration details.
 
-**observationalMemory?:** (`boolean | ObservationalMemoryOptions`): Enable Observational Memory for long-context agentic memory. Set to \`true\` for defaults, or pass a config object to customize token budgets, models, and scope. See \[Observational Memory reference]\(/reference/memory/observational-memory) for configuration details. (Default: `false`)
-
-**generateTitle?:** (`boolean | { model: DynamicArgument<MastraLanguageModel>; instructions?: DynamicArgument<string> }`): Controls automatic thread title generation from the user's first message. Can be a boolean or an object with custom model and instructions. (Default: `false`)
+**options.generateTitle** (`boolean | { model: DynamicArgument<MastraLanguageModel>; instructions?: DynamicArgument<string> }`): Controls automatic thread title generation from the user's first message. Can be a boolean or an object with custom model and instructions.
 
 ## Returns
 
-**memory:** (`Memory`): A new Memory instance with the specified configuration.
+**memory** (`Memory`): A new Memory instance with the specified configuration.
 
 ## Extended usage example