@mastra/mcp-docs-server 1.2.4 → 1.2.5-alpha.3

package/.docs/reference/agents/generateLegacy.md

@@ -34,11 +34,11 @@ await agent.generateLegacy('message for agent')
 
 **options.structuredOutput.instructions** (`string`): Custom instructions for the structuring agent.
 
-**options.outputProcessors** (`Processor[]`): Overrides the output processors set on the agent. Output processors that can modify or validate messages from the agent before they are returned to the user. Must implement either (or both) of the \`processOutputResult\` and \`processOutputStream\` functions.
+**options.outputProcessors** (`Processor[]`): Overrides the output processors set on the agent. Output processors that can modify or validate messages from the agent before they are returned to the user. Must implement either (or both) of the processOutputResult and processOutputStream functions.
 
-**options.inputProcessors** (`Processor[]`): Overrides the input processors set on the agent. Input processors that can modify or validate messages before they are processed by the agent. Must implement the \`processInput\` function.
+**options.inputProcessors** (`Processor[]`): Overrides the input processors set on the agent. Input processors that can modify or validate messages before they are processed by the agent. Must implement the processInput function.
 
-**options.experimental\_output** (`Zod schema | JsonSchema7`): Note, the preferred route is to use the \`structuredOutput\` property. Enables structured output generation alongside text generation and tool calls. The model will generate responses that conform to the provided schema.
+**options.experimental\_output** (`Zod schema | JsonSchema7`): Note, the preferred route is to use the structuredOutput property. Enables structured output generation alongside text generation and tool calls. The model will generate responses that conform to the provided schema.
 
 **options.instructions** (`string`): Custom instructions that override the agent's default instructions for this specific generation. Useful for dynamically modifying agent behavior without creating a new agent instance.
 
@@ -46,11 +46,11 @@ await agent.generateLegacy('message for agent')
 
 **options.memory** (`object`): Configuration for memory. This is the preferred way to manage memory.
 
-**options.memory.thread** (`string | { id: string; metadata?: Record<string, any>, title?: string }`): The conversation thread, as a string ID or an object with an \`id\` and optional \`metadata\`.
+**options.memory.thread** (`string | { id: string; metadata?: Record<string, any>, title?: string }`): The conversation thread, as a string ID or an object with an id and optional metadata.
 
 **options.memory.resource** (`string`): Identifier for the user or resource associated with the thread.
 
-**options.memory.options** (`MemoryConfig`): Configuration for memory behavior, like message history and semantic recall. See \`MemoryConfig\` below.
+**options.memory.options** (`MemoryConfig`): Configuration for memory behavior, like message history and semantic recall. See MemoryConfig below.
 
 **options.maxSteps** (`number`): Maximum number of execution steps allowed.
 
@@ -86,17 +86,17 @@ await agent.generateLegacy('message for agent')
 
 **options.clientTools** (`ToolsInput`): Tools that are executed on the 'client' side of the request. These tools do not have execute functions in the definition.
 
-**options.hooks** (`ToolHooks`): Per-execution hooks that run before and after tool calls. Overrides matching agent-level hooks for this execution. \`beforeToolCall\` can return \`{ proceed: false, output }\` to skip the tool call.
+**options.hooks** (`ToolHooks`): Per-execution hooks that run before and after tool calls. Overrides matching agent-level hooks for this execution. beforeToolCall can return { proceed: false, output } to skip the tool call.
 
 **options.savePerStep** (`boolean`): Save messages incrementally after each generation step completes (default: false). Disabled internally when observational memory is enabled.
 
-**options.providerOptions** (`Record<string, Record<string, JSONValue>>`): Additional provider-specific options that are passed through to the underlying LLM provider. The structure is \`{ providerName: { optionKey: value } }\`. Since Mastra extends AI SDK, see the \[AI SDK documentation]\(https\://sdk.vercel.ai/docs/providers/ai-sdk-providers) for complete provider options.
+**options.providerOptions** (`Record<string, Record<string, JSONValue>>`): Additional provider-specific options that are passed through to the underlying LLM provider. The structure is { providerName: { optionKey: value } }. Since Mastra extends AI SDK, see the AI SDK documentation for complete provider options.
 
-**options.providerOptions.openai** (`Record<string, JSONValue>`): OpenAI-specific options. Example: \`{ reasoningEffort: 'high' }\`
+**options.providerOptions.openai** (`Record<string, JSONValue>`): OpenAI-specific options. Example: { reasoningEffort: 'high' }
 
-**options.providerOptions.anthropic** (`Record<string, JSONValue>`): Anthropic-specific options. Example: \`{ maxTokens: 1000 }\`
+**options.providerOptions.anthropic** (`Record<string, JSONValue>`): Anthropic-specific options. Example: { maxTokens: 1000 }
 
-**options.providerOptions.google** (`Record<string, JSONValue>`): Google-specific options. Example: \`{ safetySettings: \[...] }\`
+**options.providerOptions.google** (`Record<string, JSONValue>`): Google-specific options. Example: { safetySettings: \[...] }
 
 **options.providerOptions.\[providerName]** (`Record<string, JSONValue>`): Other provider-specific options. The key is the provider name and the value is a record of provider-specific options.
 
@@ -104,7 +104,7 @@ await agent.generateLegacy('message for agent')
 
 **options.maxTokens** (`number`): Maximum number of tokens to generate.
 
-**options.topP** (`number`): Nucleus sampling. This is a number between 0 and 1. It is recommended to set either \`temperature\` or \`topP\`, but not both.
+**options.topP** (`number`): Nucleus sampling. This is a number between 0 and 1. It is recommended to set either temperature or topP, but not both.
 
 **options.topK** (`number`): Only sample from the top K options for each subsequent token. Used to remove 'long tail' low probability responses.
 
@@ -122,7 +122,7 @@ await agent.generateLegacy('message for agent')
 
 **text** (`string`): The generated text response. Present when output is 'text' (no schema provided).
 
-**object** (`object`): The generated structured response. Present when a schema is provided via \`output\`, \`structuredOutput\`, or \`experimental\_output\`.
+**object** (`object`): The generated structured response. Present when a schema is provided via output, structuredOutput, or experimental\_output.
 
 **toolCalls** (`Array<ToolCall>`): The tool calls made during the generation process. Present in both text and object modes.
 

package/.docs/reference/agents/getMetadata.md

@@ -18,7 +18,7 @@ await agent.getMetadata()
 
 ## Returns
 
-**metadata** (`Record<string, unknown> | Promise<Record<string, unknown>>`): The metadata configured for the agent, or \`undefined\` if no metadata was configured. Returns either directly or as a promise that resolves to the metadata when defined as a function.
+**metadata** (`Record<string, unknown> | Promise<Record<string, unknown>>`): The metadata configured for the agent, or undefined if no metadata was configured. Returns either directly or as a promise that resolves to the metadata when defined as a function.
 
 ## Extended usage example
 

package/.docs/reference/agents/getVoice.md

@@ -30,5 +30,5 @@ await agent.getVoice({
 
 ## Related
 
-- [Adding voice to agents](https://mastra.ai/docs/agents/adding-voice)
+- [Voice in Mastra](https://mastra.ai/docs/voice/overview)
 - [Voice providers](https://mastra.ai/reference/voice/mastra-voice)

package/.docs/reference/agents/inngest-agent.md

@@ -65,7 +65,7 @@ Returns: [`InngestAgent`](#inngestagent-interface)
 
 ### Parameters
 
-**agent** (`Agent`): The Agent to wrap with Inngest durable execution. Agent methods (e.g., \`generate()\`, \`listTools()\`, \`getMemory()\`) delegate to this agent via a Proxy.
+**agent** (`Agent`): The Agent to wrap with Inngest durable execution. Agent methods (e.g., generate(), listTools(), getMemory()) delegate to this agent via a Proxy.
 
 **inngest** (`Inngest`): The Inngest client instance. Used to send workflow events and, in SDK v4, publish realtime stream events.
 
@@ -73,9 +73,9 @@ Returns: [`InngestAgent`](#inngestagent-interface)
 
 **name** (`string`): Name override. (Default: `agent.name`)
 
-**pubsub** (`PubSub`): PubSub instance for streaming events. The default \`InngestPubSub\` uses Inngest Realtime, which works across processes. (Default: `InngestPubSub`)
+**pubsub** (`PubSub`): PubSub instance for streaming events. The default InngestPubSub uses Inngest Realtime, which works across processes. (Default: `InngestPubSub`)
 
-**cache** (`MastraServerCache`): Cache for stored stream events, which enables resumable streams. When provided, the PubSub is automatically wrapped with \`CachingPubSub\`. If omitted, the agent inherits the cache from the Mastra instance.
+**cache** (`MastraServerCache`): Cache for stored stream events, which enables resumable streams. When provided, the PubSub is automatically wrapped with CachingPubSub. If omitted, the agent inherits the cache from the Mastra instance.
 
 **mastra** (`Mastra`): Mastra instance for observability. Set automatically when the agent is registered with Mastra.
 
@@ -216,7 +216,7 @@ Returns: `boolean`
 
 `stream()` accepts an `InngestAgentStreamOptions` object. It supports the same agent execution options as [`DurableAgent.stream()`](https://mastra.ai/reference/agents/durable-agent), plus lifecycle callbacks.
 
-**runId** (`string`): Unique identifier for this run. Use it later with \`resume()\` or \`observe()\`.
+**runId** (`string`): Unique identifier for this run. Use it later with resume() or observe().
 
 **instructions** (`AgentExecutionOptions['instructions']`): Overrides the agent's default instructions for this run.
 
@@ -238,7 +238,7 @@ Returns: `boolean`
 
 **requireToolApproval** (`boolean`): Require approval for all tool calls, which suspends the run until resumed.
 
-**autoResumeSuspendedTools** (`boolean`): Automatically resume tools that suspended, instead of waiting for an external \`resume()\` call.
+**autoResumeSuspendedTools** (`boolean`): Automatically resume tools that suspended, instead of waiting for an external resume() call.
 
 **toolCallConcurrency** (`number`): Maximum number of tool calls to execute concurrently.
 
@@ -246,7 +246,7 @@ Returns: `boolean`
 
 **maxProcessorRetries** (`number`): Maximum number of processor retries per generation.
 
-**untilIdle** (`boolean | { maxIdleMs?: number }`): When set, keeps the stream open across background-task continuations until the agent is idle. Pass \`true\` for the default 5-minute idle timeout, or \`{ maxIdleMs }\` to customise.
+**untilIdle** (`boolean | { maxIdleMs?: number }`): When set, keeps the stream open across background-task continuations until the agent is idle. Pass true for the default 5-minute idle timeout, or { maxIdleMs } to customise.
 
 **onChunk** (`(chunk: ChunkType) => void | Promise<void>`): Called for each streamed chunk.
 
@@ -275,11 +275,11 @@ interface InngestAgentStreamResult<OUTPUT = undefined> {
 }
 ```
 
-**output** (`MastraModelOutput`): The streaming output. Await \`output.text\` for the full text, or consume \`output.fullStream\`.
+**output** (`MastraModelOutput`): The streaming output. Await output.text for the full text, or consume output.fullStream.
 
-**fullStream** (`ReadableStream`): The full event stream, delegating to \`output.fullStream\`.
+**fullStream** (`ReadableStream`): The full event stream, delegating to output.fullStream.
 
-**runId** (`string`): The unique run ID. Pass it to \`resume()\` or \`observe()\` to reconnect.
+**runId** (`string`): The unique run ID. Pass it to resume() or observe() to reconnect.
 
 **threadId** (`string`): Thread ID when using memory.
 

package/.docs/reference/agents/network.md

@@ -52,7 +52,7 @@ await agent.network(`
 
 **options.memory** (`object`): Configuration for memory. This is the preferred way to manage memory.
 
-**options.memory.thread** (`string | { id: string; metadata?: Record<string, any>, title?: string }`): The conversation thread, as a string ID or an object with an \`id\` and optional \`metadata\`.
+**options.memory.thread** (`string | { id: string; metadata?: Record<string, any>, title?: string }`): The conversation thread, as a string ID or an object with an id and optional metadata.
 
 **options.memory.resource** (`string`): Identifier for the user or resource associated with the thread.
 

package/.docs/reference/ai-sdk/chat-route.md

@@ -51,13 +51,13 @@ export const mastra = new Mastra({
 
 ## Parameters
 
-**version** (`'v5' | 'v6'`): Selects the AI SDK stream contract to emit. Omit it or pass \`'v5'\` for the existing default behavior. Pass \`'v6'\` when your app is typed against AI SDK v6 response helpers. (Default: `'v5'`)
+**version** (`'v5' | 'v6'`): Selects the AI SDK stream contract to emit. Omit it or pass 'v5' for the existing default behavior. Pass 'v6' when your app is typed against AI SDK v6 response helpers. (Default: `'v5'`)
 
-**path** (`string`): The route path (e.g., \`/chat\` or \`/chat/:agentId\`). Include \`:agentId\` for dynamic agent routing. (Default: `'/chat/:agentId'`)
+**path** (`string`): The route path (e.g., /chat or /chat/:agentId). Include :agentId for dynamic agent routing. (Default: `'/chat/:agentId'`)
 
-**agent** (`string`): The ID of the agent to use for this chat route. Required if the path doesn't include \`:agentId\`.
+**agent** (`string`): The ID of the agent to use for this chat route. Required if the path doesn't include :agentId.
 
-**agentVersion** (`{ versionId: string } | { status?: 'draft' | 'published' }`): Selects a specific agent version. Pass \`{ versionId: '\<id>' }\` to target an exact version, or \`{ status: 'draft' }\` / \`{ status: 'published' }\` to resolve by status. When the route is called, query parameters \`?versionId=\<id>\` or \`?status=draft|published\` take precedence over this static value. Requires the \[Editor]\(/docs/editor/overview) to be configured.
+**agentVersion** (`{ versionId: string } | { status?: 'draft' | 'published' }`): Selects a specific agent version. Pass { versionId: '\<id>' } to target an exact version, or { status: 'draft' } / { status: 'published' } to resolve by status. When the route is called, query parameters ?versionId=\<id> or ?status=draft|published take precedence over this static value. Requires the Editor to be configured.
 
 **defaultOptions** (`AgentExecutionOptions`): Default options passed to agent execution. These can include instructions, memory configuration, maxSteps, and other execution settings.
 

package/.docs/reference/ai-sdk/handle-chat-stream.md

@@ -50,23 +50,23 @@ export async function POST(req: Request) {
 
 ## Parameters
 
-**version** (`'v5' | 'v6'`): Selects the AI SDK stream contract to emit. Omit it or pass \`'v5'\` for the existing default behavior. Pass \`'v6'\` when your app is typed against AI SDK v6 response helpers. (Default: `'v5'`)
+**version** (`'v5' | 'v6'`): Selects the AI SDK stream contract to emit. Omit it or pass 'v5' for the existing default behavior. Pass 'v6' when your app is typed against AI SDK v6 response helpers. (Default: `'v5'`)
 
 **mastra** (`Mastra`): The Mastra instance containing registered agents.
 
 **agentId** (`string`): The ID of the agent to use for chat.
 
-**agentVersion** (`{ versionId: string } | { status?: 'draft' | 'published' }`): Selects a specific agent version. Pass \`{ versionId: '\<id>' }\` to target an exact version, or \`{ status: 'draft' }\` / \`{ status: 'published' }\` to resolve by status. Requires the \[Editor]\(/docs/editor/overview) to be configured.
+**agentVersion** (`{ versionId: string } | { status?: 'draft' | 'published' }`): Selects a specific agent version. Pass { versionId: '\<id>' } to target an exact version, or { status: 'draft' } / { status: 'published' } to resolve by status. Requires the Editor to be configured.
 
 **params** (`ChatStreamHandlerParams`): Parameters for the chat stream, including messages and optional resume data.
 
 **params.messages** (`UIMessage[]`): Array of messages in the conversation.
 
-**params.resumeData** (`Record<string, any>`): Data for resuming a suspended agent execution. Requires \`runId\` to be set.
+**params.resumeData** (`Record<string, any>`): Data for resuming a suspended agent execution. Requires runId to be set.
 
-**params.runId** (`string`): The run ID. Required when \`resumeData\` is provided.
+**params.runId** (`string`): The run ID. Required when resumeData is provided.
 
-**params.providerOptions** (`Record<string, Record<string, unknown>>`): Provider-specific options passed to the language model (e.g. \`{ openai: { reasoningEffort: "high" } }\`). Merged with \`defaultOptions.providerOptions\`, with \`params\` taking precedence.
+**params.providerOptions** (`Record<string, Record<string, unknown>>`): Provider-specific options passed to the language model (e.g. { openai: { reasoningEffort: "high" } }). Merged with defaultOptions.providerOptions, with params taking precedence.
 
 **params.requestContext** (`RequestContext`): Request context to pass to the agent execution.
 
@@ -82,4 +82,4 @@ export async function POST(req: Request) {
 
 **onError** (`(error: unknown) => string`): Called when the stream encounters an error. Return the string that will be sent to the client as the error message. Use this to sanitize errors before they reach the client — for example, to prevent internal infrastructure details from leaking to end users.
 
-**messageMetadata** (`(options: { part: UIMessageStreamPart }) => Record<string, unknown> | undefined`): A function that receives the current stream part and returns metadata to attach to start and finish chunks. See the \[AI SDK message metadata docs]\(https\://ai-sdk.dev/docs/ai-sdk-ui/message-metadata) for details.
+**messageMetadata** (`(options: { part: UIMessageStreamPart }) => Record<string, unknown> | undefined`): A function that receives the current stream part and returns metadata to attach to start and finish chunks. See the AI SDK message metadata docs for details.

package/.docs/reference/ai-sdk/handle-network-stream.md

@@ -34,14 +34,14 @@ export async function POST(req: Request) {
 
 ## Parameters
 
-**version** (`'v5' | 'v6'`): Selects the AI SDK stream contract to emit. Omit it or pass \`'v5'\` for the existing default behavior. Pass \`'v6'\` when your app is typed against AI SDK v6 response helpers. (Default: `'v5'`)
+**version** (`'v5' | 'v6'`): Selects the AI SDK stream contract to emit. Omit it or pass 'v5' for the existing default behavior. Pass 'v6' when your app is typed against AI SDK v6 response helpers. (Default: `'v5'`)
 
 **mastra** (`Mastra`): The Mastra instance to use for agent lookup and execution.
 
 **agentId** (`string`): The ID of the routing agent to execute as a network.
 
-**agentVersion** (`{ versionId: string } | { status?: 'draft' | 'published' }`): Selects a specific agent version. Pass \`{ versionId: '\<id>' }\` to target an exact version, or \`{ status: 'draft' }\` / \`{ status: 'published' }\` to resolve by status. Requires the \[Editor]\(/docs/editor/overview) to be configured.
+**agentVersion** (`{ versionId: string } | { status?: 'draft' | 'published' }`): Selects a specific agent version. Pass { versionId: '\<id>' } to target an exact version, or { status: 'draft' } / { status: 'published' } to resolve by status. Requires the Editor to be configured.
 
-**params** (`NetworkStreamHandlerParams`): The request parameters containing messages and execution options. Includes \`messages\` (required) and any AgentExecutionOptions like \`memory\`, \`maxSteps\`, \`runId\`, etc.
+**params** (`NetworkStreamHandlerParams`): The request parameters containing messages and execution options. Includes messages (required) and any AgentExecutionOptions like memory, maxSteps, runId, etc.
 
 **defaultOptions** (`AgentExecutionOptions`): Default options passed to agent execution. These are merged with params, with params taking precedence.

package/.docs/reference/ai-sdk/handle-workflow-stream.md

@@ -36,7 +36,7 @@ export async function POST(req: Request) {
 
 ## Parameters
 
-**version** (`'v5' | 'v6'`): Selects the AI SDK stream contract to emit. Omit it or pass \`'v5'\` for the existing default behavior. Pass \`'v6'\` when your app is typed against AI SDK v6 response helpers. (Default: `'v5'`)
+**version** (`'v5' | 'v6'`): Selects the AI SDK stream contract to emit. Omit it or pass 'v5' for the existing default behavior. Pass 'v6' when your app is typed against AI SDK v6 response helpers. (Default: `'v5'`)
 
 **mastra** (`Mastra`): The Mastra instance containing registered workflows.
 

package/.docs/reference/ai-sdk/network-route.md

@@ -49,13 +49,13 @@ export const mastra = new Mastra({
 
 ## Parameters
 
-**version** (`'v5' | 'v6'`): Selects the AI SDK stream contract to emit. Omit it or pass \`'v5'\` for the existing default behavior. Pass \`'v6'\` when your app is typed against AI SDK v6 response helpers. (Default: `'v5'`)
+**version** (`'v5' | 'v6'`): Selects the AI SDK stream contract to emit. Omit it or pass 'v5' for the existing default behavior. Pass 'v6' when your app is typed against AI SDK v6 response helpers. (Default: `'v5'`)
 
-**path** (`string`): The route path (e.g., \`/network\` or \`/network/:agentId\`). Include \`:agentId\` for dynamic agent routing. (Default: `'/network/:agentId'`)
+**path** (`string`): The route path (e.g., /network or /network/:agentId). Include :agentId for dynamic agent routing. (Default: `'/network/:agentId'`)
 
-**agent** (`string`): The ID of the routing agent to use for this network route. Required if the path doesn't include \`:agentId\`.
+**agent** (`string`): The ID of the routing agent to use for this network route. Required if the path doesn't include :agentId.
 
-**agentVersion** (`{ versionId: string } | { status?: 'draft' | 'published' }`): Selects a specific agent version. Pass \`{ versionId: '\<id>' }\` to target an exact version, or \`{ status: 'draft' }\` / \`{ status: 'published' }\` to resolve by status. When the route is called, query parameters \`?versionId=\<id>\` or \`?status=draft|published\` take precedence over this static value. Requires the \[Editor]\(/docs/editor/overview) to be configured.
+**agentVersion** (`{ versionId: string } | { status?: 'draft' | 'published' }`): Selects a specific agent version. Pass { versionId: '\<id>' } to target an exact version, or { status: 'draft' } / { status: 'published' } to resolve by status. When the route is called, query parameters ?versionId=\<id> or ?status=draft|published take precedence over this static value. Requires the Editor to be configured.
 
 **defaultOptions** (`AgentExecutionOptions`): Default options passed to agent execution. These can include instructions, memory configuration, maxSteps, and other execution settings.
 

package/.docs/reference/ai-sdk/to-ai-sdk-messages.md

@@ -44,7 +44,7 @@ export default function Chat() {
 
 **messages** (`MessageListInput`): Messages to convert. Can be a string, array of strings, a single message object, or an array of message objects in any supported format.
 
-**options.version** (`'v5' | 'v6'`): Selects the AI SDK message type to return. Omit it or pass \`'v5'\` for the existing default behavior. Pass \`'v6'\` when your app is typed against AI SDK v6 \`useChat()\` message types.
+**options.version** (`'v5' | 'v6'`): Selects the AI SDK message type to return. Omit it or pass 'v5' for the existing default behavior. Pass 'v6' when your app is typed against AI SDK v6 useChat() message types.
 
 ## Returns
 

package/.docs/reference/ai-sdk/to-ai-sdk-stream.md

@@ -64,7 +64,7 @@ The first parameter is the Mastra stream to convert. It can be one of:
 
 The second parameter is an options object:
 
-**version** (`'v5' | 'v6'`): Selects the AI SDK stream contract to emit. Omit it or pass \`'v5'\` for the existing default behavior. Pass \`'v6'\` when your app is typed against AI SDK v6 response helpers. (Default: `'v5'`)
+**version** (`'v5' | 'v6'`): Selects the AI SDK stream contract to emit. Omit it or pass 'v5' for the existing default behavior. Pass 'v6' when your app is typed against AI SDK v6 response helpers. (Default: `'v5'`)
 
 **from** (`'agent' | 'network' | 'workflow'`): The type of Mastra stream being converted. (Default: `'agent'`)
 

package/.docs/reference/ai-sdk/with-mastra.md

@@ -32,7 +32,7 @@ const { text } = await generateText({
 
 ## Parameters
 
-**model** (`LanguageModelV2 | LanguageModelV3`): Any AI SDK v5 or v6 language model (e.g., \`openai('gpt-5.4')\`, \`anthropic('claude-opus-4-6')\`).
+**model** (`LanguageModelV2 | LanguageModelV3`): Any AI SDK v5 or v6 language model (e.g., openai('gpt-5.4'), anthropic('claude-opus-4-6')).
 
 **options** (`WithMastraOptions`): Configuration object for processors and memory.
 
@@ -42,7 +42,7 @@ const { text } = await generateText({
 
 **options.memory** (`WithMastraMemoryOptions`): Memory configuration - enables automatic message history persistence.
 
-**options.memory.storage** (`MemoryStorage`): Memory storage domain for message persistence. Get it from a composite store using \`await storage.getStore('memory')\`.
+**options.memory.storage** (`MemoryStorage`): Memory storage domain for message persistence. Get it from a composite store using await storage.getStore('memory').
 
 **options.memory.threadId** (`string`): Thread ID for conversation persistence.
 

package/.docs/reference/ai-sdk/workflow-route.md

@@ -51,9 +51,9 @@ export const mastra = new Mastra({
 
 ## Parameters
 
-**version** (`'v5' | 'v6'`): Selects the AI SDK stream contract to emit. Omit it or pass \`'v5'\` for the existing default behavior. Pass \`'v6'\` when your app is typed against AI SDK v6 response helpers. (Default: `'v5'`)
+**version** (`'v5' | 'v6'`): Selects the AI SDK stream contract to emit. Omit it or pass 'v5' for the existing default behavior. Pass 'v6' when your app is typed against AI SDK v6 response helpers. (Default: `'v5'`)
 
-**path** (`string`): The route path (e.g., \`/workflow\` or \`/workflow/:workflowId\`). Include \`:workflowId\` for dynamic workflow routing. (Default: `'/api/workflows/:workflowId/stream'`)
+**path** (`string`): The route path (e.g., /workflow or /workflow/:workflowId). Include :workflowId for dynamic workflow routing. (Default: `'/api/workflows/:workflowId/stream'`)
 
 **workflow** (`string`): Fixed workflow ID when not using dynamic routing. (Default: `undefined`)
 

package/.docs/reference/ai-sdk/workflow-snapshot-to-stream.md

@@ -32,7 +32,7 @@ export async function GET(req: Request) {
 
 ## Parameters
 
-**workflowRun** (`WorkflowState`): The workflow run state object, as returned by \`getWorkflowRunById()\` or the workflow runs API. Contains \`runId\`, \`workflowName\`, \`status\`, and \`steps\`.
+**workflowRun** (`WorkflowState`): The workflow run state object, as returned by getWorkflowRunById() or the workflow runs API. Contains runId, workflowName, status, and steps.
 
 ## Returns
 

package/.docs/reference/auth/google.md

@@ -1,6 +1,6 @@
 > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
 
-# MastraAuthGoogle & MastraRBACGoogle class
+# MastraAuthGoogle and MastraRBACGoogle class
 
 ## MastraAuthGoogle class
 
@@ -36,9 +36,9 @@ export const mastra = new Mastra({
 
 **scopes** (`string[]`): OAuth scopes requested during the login flow. (Default: `['openid', 'profile', 'email']`)
 
-**allowedDomains** (`string | string[]`): Allowed Google Workspace hosted domains. Mastra validates these against the verified \`hd\` claim. (Default: `process.env.GOOGLE_ALLOWED_DOMAINS`)
+**allowedDomains** (`string | string[]`): Allowed Google Workspace hosted domains. Mastra validates these against the verified hd claim. (Default: `process.env.GOOGLE_ALLOWED_DOMAINS`)
 
-**hostedDomain** (`string`): Hosted-domain login hint passed to Google as \`hd\`. This is a hint only and is not used for authorization. (Default: `process.env.GOOGLE_HOSTED_DOMAIN or the single allowed domain`)
+**hostedDomain** (`string`): Hosted-domain login hint passed to Google as hd. This is a hint only and is not used for authorization. (Default: `process.env.GOOGLE_HOSTED_DOMAIN or the single allowed domain`)
 
 **session** (`GoogleSessionOptions`): Session cookie configuration.
 
@@ -48,7 +48,7 @@ export const mastra = new Mastra({
 
 **session.cookiePassword** (`string`): Password for encrypting session cookies. Must be at least 32 characters. If not set, an auto-generated value is used in development that does not survive restarts.
 
-**session.secureCookies** (`boolean`): Set the \`Secure\` flag on session cookies.
+**session.secureCookies** (`boolean`): Set the Secure flag on session cookies.
 
 **name** (`string`): Custom name for the auth provider instance. (Default: `'google'`)
 
@@ -123,7 +123,7 @@ Returns: `Promise<GoogleUser | null>`
 
 The `GoogleUser` type extends the base `EEUser` interface with Google-specific fields:
 
-**id** (`string`): Mastra user ID. Uses the Google \`sub\` claim.
+**id** (`string`): Mastra user ID. Uses the Google sub claim.
 
 **googleId** (`string`): Google Account subject identifier.
 
@@ -133,7 +133,7 @@ The `GoogleUser` type extends the base `EEUser` interface with Google-specific f
 
 **avatarUrl** (`string`): URL to the user's Google profile picture.
 
-**hostedDomain** (`string`): Google Workspace hosted domain from the verified \`hd\` claim.
+**hostedDomain** (`string`): Google Workspace hosted domain from the verified hd claim.
 
 **expiresAt** (`Date`): Verified ID token expiration time, when available.
 
@@ -204,7 +204,7 @@ export const mastra = new Mastra({
 
 ### Constructor parameters
 
-**roleMapping** (`RoleMapping`): Maps Google Workspace group role IDs to arrays of Mastra permission strings. Use \`'\_default'\` to assign permissions to users who do not match any group. Supports wildcards like \`'\*'\` (full access) and \`'agents:\*'\` (all agent actions).
+**roleMapping** (`RoleMapping`): Maps Google Workspace group role IDs to arrays of Mastra permission strings. Use '\_default' to assign permissions to users who do not match any group. Supports wildcards like '\*' (full access) and 'agents:\*' (all agent actions).
 
 **accessToken** (`string`): Pre-obtained Workspace Directory API access token.
 
@@ -214,7 +214,7 @@ export const mastra = new Mastra({
 
 **serviceAccount.clientEmail** (`string`): Google service account email.
 
-**serviceAccount.privateKey** (`string`): PEM-encoded private key. Escaped \`\n\` values from .env files are supported.
+**serviceAccount.privateKey** (`string`): PEM-encoded private key. Escaped \n values from .env files are supported.
 
 **serviceAccount.privateKeyId** (`string`): Optional private key ID.
 
@@ -222,9 +222,9 @@ export const mastra = new Mastra({
 
 **serviceAccount.scopes** (`string[]`): OAuth scopes for the service account token.
 
-**getUserKey** (`(user: unknown) => string | undefined`): Extract the Directory API \`userKey\` from an authenticated user. Defaults to \`user.email\`.
+**getUserKey** (`(user: unknown) => string | undefined`): Extract the Directory API userKey from an authenticated user. Defaults to user.email.
 
-**mapGroupToRoles** (`(group: GoogleWorkspaceGroup) => string[]`): Map a Google Workspace group to role IDs. Defaults to \`\[group.email]\`.
+**mapGroupToRoles** (`(group: GoogleWorkspaceGroup) => string[]`): Map a Google Workspace group to role IDs. Defaults to \[group.email].
 
 **cache** (`PermissionCacheOptions`): Configure the LRU cache for group lookups.
 

package/.docs/reference/auth/okta.md

@@ -1,6 +1,6 @@
 > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
 
-# MastraAuthOkta & MastraRBACOkta class
+# MastraAuthOkta and MastraRBACOkta class
 
 ## MastraAuthOkta class
 
@@ -28,7 +28,7 @@ export const mastra = new Mastra({
 
 ### Constructor parameters
 
-**domain** (`string`): Your Okta domain (e.g., \`dev-123456.okta.com\`). Used to construct the issuer URL and API endpoints. (Default: `process.env.OKTA_DOMAIN`)
+**domain** (`string`): Your Okta domain (e.g., dev-123456.okta.com). Used to construct the issuer URL and API endpoints. (Default: `process.env.OKTA_DOMAIN`)
 
 **clientId** (`string`): The OAuth client ID from your Okta application. (Default: `process.env.OKTA_CLIENT_ID`)
 
@@ -40,7 +40,7 @@ export const mastra = new Mastra({
 
 **scopes** (`string[]`): OAuth scopes to request during the login flow. (Default: `['openid', 'profile', 'email', 'groups']`)
 
-**apiToken** (`string`): Okta API token for user lookups via the Users API. Required for \`getUser()\` to return user data by ID. (Default: `process.env.OKTA_API_TOKEN`)
+**apiToken** (`string`): Okta API token for user lookups via the Users API. Required for getUser() to return user data by ID. (Default: `process.env.OKTA_API_TOKEN`)
 
 **session** (`OktaSessionOptions`): Session cookie configuration.
 
@@ -50,7 +50,7 @@ export const mastra = new Mastra({
 
 **session.cookiePassword** (`string`): Password for encrypting session cookies. Must be at least 32 characters. If not set, an auto-generated value is used that does not survive restarts.
 
-**session.secureCookies** (`boolean`): Set the \`Secure\` flag on session cookies.
+**session.secureCookies** (`boolean`): Set the Secure flag on session cookies.
 
 **name** (`string`): Custom name for the auth provider instance. (Default: `'okta'`)
 
@@ -58,13 +58,13 @@ export const mastra = new Mastra({
 
 The following environment variables are automatically used when constructor options aren't provided:
 
-**OKTA\_DOMAIN** (`string`): Your Okta domain (e.g., \`dev-123456.okta.com\`). Found in your Okta admin console.
+**OKTA\_DOMAIN** (`string`): Your Okta domain (e.g., dev-123456.okta.com). Found in your Okta admin console.
 
 **OKTA\_CLIENT\_ID** (`string`): The OAuth client ID from your Okta application.
 
 **OKTA\_CLIENT\_SECRET** (`string`): The OAuth client secret from your Okta application.
 
-**OKTA\_ISSUER** (`string`): Token issuer URL. Defaults to \`https\://{domain}/oauth2/default\` if not set.
+**OKTA\_ISSUER** (`string`): Token issuer URL. Defaults to https\://{domain}/oauth2/default if not set.
 
 **OKTA\_REDIRECT\_URI** (`string`): OAuth redirect URI for the SSO callback.
 
@@ -85,9 +85,9 @@ After authentication, `authorizeUser` checks that the user has a valid `oktaId`.
 
 The `OktaUser` type extends the base `EEUser` interface with Okta-specific fields:
 
-**id** (`string`): User identifier (maps to the \`sub\` claim).
+**id** (`string`): User identifier (maps to the sub claim).
 
-**oktaId** (`string`): Okta user ID (same as \`id\`).
+**oktaId** (`string`): Okta user ID (same as id).
 
 **email** (`string`): User email address.
 
@@ -95,7 +95,7 @@ The `OktaUser` type extends the base `EEUser` interface with Okta-specific field
 
 **avatarUrl** (`string`): URL to the user's profile picture.
 
-**groups** (`string[]`): Okta groups the user belongs to, populated from the \`groups\` claim.
+**groups** (`string[]`): Okta groups the user belongs to, populated from the groups claim.
 
 ## MastraRBACOkta class
 
@@ -149,13 +149,13 @@ export const mastra = new Mastra({
 
 ### Constructor parameters
 
-**roleMapping** (`RoleMapping`): Maps Okta group names to arrays of Mastra permission strings. Use \`'\_default'\` to assign permissions to users who do not match any group. Supports wildcards like \`'\*'\` (full access) and \`'agents:\*'\` (all agent actions).
+**roleMapping** (`RoleMapping`): Maps Okta group names to arrays of Mastra permission strings. Use '\_default' to assign permissions to users who do not match any group. Supports wildcards like '\*' (full access) and 'agents:\*' (all agent actions).
 
 **domain** (`string`): Your Okta domain. Used to initialize the Okta management SDK. (Default: `process.env.OKTA_DOMAIN`)
 
 **apiToken** (`string`): Okta API token for the management SDK. Required to fetch user groups from the Okta API. (Default: `process.env.OKTA_API_TOKEN`)
 
-**getUserId** (`(user: unknown) => string | undefined`): Extract the Okta user ID from a user object. Use this when combining Okta RBAC with a different auth provider. If not provided, falls back to \`oktaId\` or \`id\` on the user object.
+**getUserId** (`(user: unknown) => string | undefined`): Extract the Okta user ID from a user object. Use this when combining Okta RBAC with a different auth provider. If not provided, falls back to oktaId or id on the user object.
 
 **cache** (`PermissionCacheOptions`): Configure the LRU cache for group lookups.
 

package/.docs/reference/auth/workos.md

@@ -32,11 +32,11 @@ export const mastra = new Mastra({
 
 **redirectUri** (`string`): OAuth redirect URI used by WorkOS AuthKit. Set this when you use the built-in WorkOS sign-in flow. (Default: `process.env.WORKOS_REDIRECT_URI`)
 
-**fetchMemberships** (`boolean`): Loads organization memberships during authentication. Set this to \`true\` when you use \`MastraFGAWorkos\` so FGA checks can resolve the correct organization membership ID. (Default: `false`)
+**fetchMemberships** (`boolean`): Loads organization memberships during authentication. Set this to true when you use MastraFGAWorkos so FGA checks can resolve the correct organization membership ID. (Default: `false`)
 
-**trustJwtClaims** (`boolean`): Trusts verified bearer-token claims enough to construct a \`WorkOSUser\` even when \`workos.userManagement.getUser()\` does not apply. Use this for service-account or machine-to-machine tokens backed by a WorkOS custom JWT template. (Default: `false`)
+**trustJwtClaims** (`boolean`): Trusts verified bearer-token claims enough to construct a WorkOSUser even when workos.userManagement.getUser() does not apply. Use this for service-account or machine-to-machine tokens backed by a WorkOS custom JWT template. (Default: `false`)
 
-**jwtClaims** (`{ userId?: string; workosId?: string; email?: string; name?: string; organizationId?: string; organizationMembershipId?: string }`): Maps verified bearer JWT claims into the authenticated \`WorkOSUser\`. Useful for custom JWT templates that include \`organizationMembershipId\` or other FGA-specific claims.
+**jwtClaims** (`{ userId?: string; workosId?: string; email?: string; name?: string; organizationId?: string; organizationMembershipId?: string }`): Maps verified bearer JWT claims into the authenticated WorkOSUser. Useful for custom JWT templates that include organizationMembershipId or other FGA-specific claims.
 
 ## Environment variables
 

package/.docs/reference/channels/slack-provider.md

@@ -37,31 +37,31 @@ await slack.configure({
 
 `SlackProviderConfig` combines Slack-specific fields, Slack-adapter overrides (`toolDisplay`, `streaming`, `typingStatus`), and a curated subset of [`ChannelConfig`](https://mastra.ai/reference/agents/channels) options (such as `handlers`, `inlineMedia`, and `state`) forwarded to every connected agent. All fields are optional.
 
-**refreshToken** (`string`): Slack App Configuration refresh token, used for automatic token rotation. Single-use; each rotation returns a new pair. Can also be provided later via \`configure()\`. If omitted, the provider starts unconfigured and cannot create apps until \`configure()\` is called or tokens are loaded from storage. Generate it under "Your App Configuration Tokens" at api.slack.com/apps.
+**refreshToken** (`string`): Slack App Configuration refresh token, used for automatic token rotation. Single-use; each rotation returns a new pair. Can also be provided later via configure(). If omitted, the provider starts unconfigured and cannot create apps until configure() is called or tokens are loaded from storage. Generate it under "Your App Configuration Tokens" at api.slack.com/apps.
 
-**token** (`string`): Slack App Configuration access token for programmatic app creation. Optional, because the provider rotates to a fresh token on startup using \`refreshToken\`.
+**token** (`string`): Slack App Configuration access token for programmatic app creation. Optional, because the provider rotates to a fresh token on startup using refreshToken.
 
-**baseUrl** (`string`): Public base URL for webhook and OAuth callbacks. Required when calling \`connect()\` to create apps. Can also be set via \`setBaseUrl()\` or auto-detected from the Mastra server config. For local development, use a tunnel such as \`cloudflared\`.
+**baseUrl** (`string`): Public base URL for webhook and OAuth callbacks. Required when calling connect() to create apps. Can also be set via setBaseUrl() or auto-detected from the Mastra server config. For local development, use a tunnel such as cloudflared.
 
-**encryptionKey** (`string`): Encryption key for sensitive stored data (client secret, signing secret, bot token). Use a 32+ character random string. Can be set via the \`MASTRA\_ENCRYPTION\_KEY\` env var. If omitted, secrets are stored in plaintext (not recommended for production).
+**encryptionKey** (`string`): Encryption key for sensitive stored data (client secret, signing secret, bot token). Use a 32+ character random string. Can be set via the MASTRA\_ENCRYPTION\_KEY env var. If omitted, secrets are stored in plaintext (not recommended for production).
 
-**storage** (`ChannelsStorage`): Custom storage for installations. Defaults to Mastra's \`ChannelsStorage\` from the global storage. Throws if no persistent storage is available.
+**storage** (`ChannelsStorage`): Custom storage for installations. Defaults to Mastra's ChannelsStorage from the global storage. Throws if no persistent storage is available.
 
 **redirectPath** (`string`): Path to redirect to after OAuth completion. (Default: `"/"`)
 
 **onInstall** (`(installation: SlackInstallation) => Promise<void>`): Called when a workspace successfully installs the app.
 
-**streaming** (`StreamingConfig | false`): Stream agent text deltas to Slack as they're generated. Pass \`{ updateIntervalMs }\` to customize the post-and-edit interval, or \`false\` to buffer text until step-finish. Disabling streaming restricts \`toolDisplay\` to static modes. (Default: `true`)
+**streaming** (`StreamingConfig | false`): Stream agent text deltas to Slack as they're generated. Pass { updateIntervalMs } to customize the post-and-edit interval, or false to buffer text until step-finish. Disabling streaming restricts toolDisplay to static modes. (Default: `true`)
 
-**toolDisplay** (`ToolDisplay`): How tool calls are rendered in Slack: \`'cards'\`, \`'text'\`, \`'timeline'\`, \`'grouped'\`, \`'hidden'\`, or a function. \`'hidden'\` suppresses tool call/result rendering entirely. \`'timeline'\` and \`'grouped'\` require streaming. With \`streaming: false\`, only static modes are available and the default is \`'cards'\`. (Default: `'grouped'`)
+**toolDisplay** (`ToolDisplay`): How tool calls are rendered in Slack: 'cards', 'text', 'timeline', 'grouped', 'hidden', or a function. 'hidden' suppresses tool call/result rendering entirely. 'timeline' and 'grouped' require streaming. With streaming: false, only static modes are available and the default is 'cards'. (Default: `'grouped'`)
 
-**typingStatus** (`boolean | TypingStatusFn`): Show a typing indicator while the agent works. Set \`false\` to disable, or pass a function to return custom status text per stream chunk (return \`undefined\` to fall back to the default for that chunk). (Default: `true`)
+**typingStatus** (`boolean | TypingStatusFn`): Show a typing indicator while the agent works. Set false to disable, or pass a function to return custom status text per stream chunk (return undefined to fall back to the default for that chunk). (Default: `true`)
 
-**waitUntil** (`WaitUntilFn`): Returns a \`waitUntil\` for the current Slack webhook request. Required on serverless runtimes where Hono can't bridge the platform's \`ExecutionContext\` (Vercel, AWS Lambda). Without it, the invocation freezes after the 200 ack and kills the run mid-flight. Pass the bare \`waitUntil(promise)\` from your platform SDK (for example, \`@vercel/functions\`). Cloudflare Workers and Netlify users typically don't need this.
+**waitUntil** (`WaitUntilFn`): Returns a waitUntil for the current Slack webhook request. Required on serverless runtimes where Hono can't bridge the platform's ExecutionContext (Vercel, AWS Lambda). Without it, the invocation freezes after the 200 ack and kills the run mid-flight. Pass the bare waitUntil(promise) from your platform SDK (for example, @vercel/functions). Cloudflare Workers and Netlify users typically don't need this.
 
-**resolveWaitUntil** (`WaitUntilResolver`): Resolve \`waitUntil\` from the request's Hono \`Context\` when the runtime exposes it through the request and core's default doesn't cover it. Resolution order: \`waitUntil\` → \`resolveWaitUntil\` → core default.
+**resolveWaitUntil** (`WaitUntilResolver`): Resolve waitUntil from the request's Hono Context when the runtime exposes it through the request and core's default doesn't cover it. Resolution order: waitUntil → resolveWaitUntil → core default.
 
-**handlers** (`ChannelHandlers`): Override built-in event handlers (\`onDirectMessage\`, \`onMention\`). Forwarded to \`AgentChannels\` for every agent connected via this provider.
+**handlers** (`ChannelHandlers`): Override built-in event handlers (onDirectMessage, onMention). Forwarded to AgentChannels for every agent connected via this provider.
 
 **inlineMedia** (`ChannelConfig['inlineMedia']`): Which media types to send inline to the model.
 
@@ -69,13 +69,13 @@ await slack.configure({
 
 **threadContext** (`ChannelConfig['threadContext']`): Fetch recent thread messages from Slack when the agent joins mid-conversation.
 
-**tools** (`ChannelConfig['tools']`): Whether to include channel tools (\`add\_reaction\`, \`remove\_reaction\`).
+**tools** (`ChannelConfig['tools']`): Whether to include channel tools (add\_reaction, remove\_reaction).
 
-**state** (`ChannelConfig['state']`): State adapter for message deduplication, locking, and subscriptions. Defaults to the \`MastraStateAdapter\` backed by the Mastra instance's configured storage, so subscriptions persist across restarts.
+**state** (`ChannelConfig['state']`): State adapter for message deduplication, locking, and subscriptions. Defaults to the MastraStateAdapter backed by the Mastra instance's configured storage, so subscriptions persist across restarts.
 
 **chatOptions** (`ChannelConfig['chatOptions']`): Additional options passed directly to the Chat SDK.
 
-**logger** (`SlackAdapterConfig['logger']`): Logger forwarded to the underlying \`SlackAdapter\`. Defaults to the adapter's \`ConsoleLogger\`.
+**logger** (`SlackAdapterConfig['logger']`): Logger forwarded to the underlying SlackAdapter. Defaults to the adapter's ConsoleLogger.
 
 ## Methods
 
@@ -113,7 +113,7 @@ interface ChannelConnectResult {
 
 **manifest** (`(defaults: SlackAppManifest) => SlackAppManifest`): Customize the Slack app manifest before it is sent to the Manifest API. Receives the default manifest and returns the final one. Use it for custom scopes, additional events, or interactivity settings.
 
-**redirectUrl** (`string`): URL to redirect to after successful OAuth completion. Defaults to the provider's \`redirectPath\` or \`/\`.
+**redirectUrl** (`string`): URL to redirect to after successful OAuth completion. Defaults to the provider's redirectPath or /.
 
 #### `disconnect(agentId)`