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

package/.docs/reference/tools/mcp-server.md

@@ -59,19 +59,19 @@ The constructor accepts an `MCPServerConfig` object with the following propertie
 
 **version** (`string`): The semantic version of your server (e.g., '1.0.0').
 
-**tools** (`ToolsInput`): An object where keys are tool names and values are Mastra tool definitions (created with \`createTool\` or Vercel AI SDK). These tools will be directly exposed.
+**tools** (`ToolsInput`): An object where keys are tool names and values are Mastra tool definitions (created with createTool or Vercel AI SDK). These tools will be directly exposed.
 
-**agents** (`Record<string, Agent>`): An object where keys are agent identifiers and values are Mastra Agent instances. Each agent will be automatically converted into a tool named \`ask\_\<agentIdentifier>\`. The agent \*\*must\*\* have a non-empty \`description\` string property defined in its constructor configuration. This description will be used in the tool's description. If an agent's description is missing or empty, an error will be thrown during MCPServer initialization.
+**agents** (`Record<string, Agent>`): An object where keys are agent identifiers and values are Mastra Agent instances. Each agent will be automatically converted into a tool named ask\_\<agentIdentifier>. The agent \*\*must\*\* have a non-empty description string property defined in its constructor configuration. This description will be used in the tool's description. If an agent's description is missing or empty, an error will be thrown during MCPServer initialization.
 
-**workflows** (`Record<string, Workflow>`): An object where keys are workflow identifiers and values are Mastra Workflow instances. Each workflow is converted into a tool named \`run\_\<workflowKey>\`. The workflow's \`inputSchema\` becomes the tool's input schema. The workflow \*\*must\*\* have a non-empty \`description\` string property, which is used for the tool's description. If a workflow's description is missing or empty, an error will be thrown. The tool executes the workflow by calling \`workflow\.createRun()\` followed by \`run.start({ inputData: \<tool\_input> })\`. If a tool name derived from an agent or workflow (e.g., \`ask\_myAgent\` or \`run\_myWorkflow\`) collides with an explicitly defined tool name or another derived name, the explicitly defined tool takes precedence, and a warning is logged. Agents/workflows leading to subsequent collisions are skipped.
+**workflows** (`Record<string, Workflow>`): An object where keys are workflow identifiers and values are Mastra Workflow instances. Each workflow is converted into a tool named run\_\<workflowKey>. The workflow's inputSchema becomes the tool's input schema. The workflow \*\*must\*\* have a non-empty description string property, which is used for the tool's description. If a workflow's description is missing or empty, an error will be thrown. The tool executes the workflow by calling workflow\.createRun() followed by run.start({ inputData: \<tool\_input> }). If a tool name derived from an agent or workflow (e.g., ask\_myAgent or run\_myWorkflow) collides with an explicitly defined tool name or another derived name, the explicitly defined tool takes precedence, and a warning is logged. Agents/workflows leading to subsequent collisions are skipped.
 
 **description** (`string`): Optional description of what the MCP server does.
 
 **instructions** (`string`): Optional instructions describing how to use the server and its features.
 
-**mapAuthInfoToUser** (`({ authInfo, extra, requestContext }) => unknown | null | undefined | Promise<unknown | null | undefined>`): Maps MCP transport auth data from \`extra.authInfo\` into the \`user\` value used by Mastra FGA checks. Use this when an OAuth-protected MCP server is registered on a Mastra instance with an FGA provider.
+**mapAuthInfoToUser** (`({ authInfo, extra, requestContext }) => unknown | null | undefined | Promise<unknown | null | undefined>`): Maps MCP transport auth data from extra.authInfo into the user value used by Mastra FGA checks. Use this when an OAuth-protected MCP server is registered on a Mastra instance with an FGA provider.
 
-**fga** (`{ resourceMapping?: Partial<Record<'tool' | 'tools', { fgaResourceType: string; deriveId?: ({ user, resourceId, requestContext }) => string | undefined }>>; permissionMapping?: Record<string, string> }`): Overrides resource and permission mappings for this MCP server's \`tools/list\` and \`tools/call\` FGA checks. Use this when MCP authorization should be scoped differently from internal agent or workflow tool execution.
+**fga** (`{ resourceMapping?: Partial<Record<'tool' | 'tools', { fgaResourceType: string; deriveId?: ({ user, resourceId, requestContext }) => string | undefined }>>; permissionMapping?: Record<string, string> }`): Overrides resource and permission mappings for this MCP server's tools/list and tools/call FGA checks. Use this when MCP authorization should be scoped differently from internal agent or workflow tool execution.
 
 **repository** (`Repository`): Optional repository information for the server's source code.
 
@@ -89,7 +89,7 @@ The constructor accepts an `MCPServerConfig` object with the following propertie
 
 **prompts** (`MCPServerPrompts`): An object defining how the server should handle MCP prompts. See Prompt Handling section for details.
 
-**appResources** (`AppResources`): A map of \`ui://\` URIs to app resource configurations. Each entry defines an interactive HTML UI served via the MCP Apps extension (SEP-1865). See the MCP Apps section for details.
+**appResources** (`AppResources`): A map of ui:// URIs to app resource configurations. Each entry defines an interactive HTML UI served via the MCP Apps extension (SEP-1865). See the MCP Apps section for details.
 
 ## Exposing agents as tools
 
@@ -422,13 +422,13 @@ Here are the details for the values needed by the `startHTTP` method:
 
 The `StreamableHTTPServerTransportOptions` object allows you to customize the behavior of the HTTP transport. Here are the available options:
 
-**serverless** (`boolean`): If \`true\`, runs in stateless mode without session management. Each request is handled independently with a fresh server instance. Essential for serverless environments (Cloudflare Workers, Supabase Edge Functions, Vercel Edge, etc.) where sessions cannot persist between invocations. Defaults to \`false\`.
+**serverless** (`boolean`): If true, runs in stateless mode without session management. Each request is handled independently with a fresh server instance. Essential for serverless environments (Cloudflare Workers, Supabase Edge Functions, Vercel Edge, etc.) where sessions cannot persist between invocations. Defaults to false.
 
-**sessionIdGenerator** (`(() => string) | undefined`): A function that generates a unique session ID. This should be a cryptographically secure, globally unique string. Return \`undefined\` to disable session management.
+**sessionIdGenerator** (`(() => string) | undefined`): A function that generates a unique session ID. This should be a cryptographically secure, globally unique string. Return undefined to disable session management.
 
 **onsessioninitialized** (`(sessionId: string) => void`): A callback that is invoked when a new session is initialized. This is useful for tracking active MCP sessions.
 
-**enableJsonResponse** (`boolean`): If \`true\`, the server will return plain JSON responses instead of using Server-Sent Events (SSE) for streaming. Defaults to \`false\`.
+**enableJsonResponse** (`boolean`): If true, the server will return plain JSON responses instead of using Server-Sent Events (SSE) for streaming. Defaults to false.
 
 **eventStore** (`EventStore`): An event store for message resumability. Providing this enables clients to reconnect and resume message streams.
 
@@ -1350,7 +1350,7 @@ The `appResources` option lets you serve interactive HTML UIs from your MCP serv
 
 ### `AppResources` type
 
-**Key (URI)** (`string`): A \`ui://\` URI that identifies the app resource (e.g., \`ui://calculator/main\`).
+**Key (URI)** (`string`): A ui:// URI that identifies the app resource (e.g., ui://calculator/main).
 
 Each value is an `AppResource` object:
 
@@ -1358,9 +1358,9 @@ Each value is an `AppResource` object:
 
 **description** (`string`): Optional description of the UI resource.
 
-**html** (`string`): Inline HTML content for the UI. Provide either \`html\` or \`htmlPath\`.
+**html** (`string`): Inline HTML content for the UI. Provide either html or htmlPath.
 
-**htmlPath** (`string`): Path to an HTML file. Resolved at server startup. Provide either \`html\` or \`htmlPath\`.
+**htmlPath** (`string`): Path to an HTML file. Resolved at server startup. Provide either html or htmlPath.
 
 **meta** (`McpUiResourceMeta`): UI resource metadata (CSP, permissions, rendering preferences) from the official ext-apps SDK.
 

package/.docs/reference/tools/perplexity.md

@@ -56,11 +56,11 @@ const searchTool = createPerplexitySearchTool({ apiKey: 'pplx-...' })
 
 All factory functions accept a `PerplexityClientOptions` object:
 
-**apiKey** (`string`): Perplexity API key. Falls back to the \`PERPLEXITY\_API\_KEY\` then \`PPLX\_API\_KEY\` environment variables.
+**apiKey** (`string`): Perplexity API key. Falls back to the PERPLEXITY\_API\_KEY then PPLX\_API\_KEY environment variables.
 
 **baseUrl** (`string`): Override the API base URL. (Default: `'https://api.perplexity.ai'`)
 
-**fetch** (`typeof fetch`): Custom \`fetch\` implementation. Useful for tests, retries, or instrumentation.
+**fetch** (`typeof fetch`): Custom fetch implementation. Useful for tests, retries, or instrumentation.
 
 ## Methods
 
@@ -97,7 +97,7 @@ const searchTool = createPerplexitySearchTool()
 
 **maxResults** (`number`): Maximum number of results to return (1-20).
 
-**searchDomainFilter** (`string[]`): Restrict (or exclude) results by domain. Prefix a domain with \`-\` to exclude it (for example, \`-pinterest.com\`). Do not mix allow- and deny-list entries in the same call.
+**searchDomainFilter** (`string[]`): Restrict (or exclude) results by domain. Prefix a domain with - to exclude it (for example, -pinterest.com). Do not mix allow- and deny-list entries in the same call.
 
 **searchRecencyFilter** (`'hour' | 'day' | 'week' | 'month' | 'year'`): Only return results from within the given recency window.
 

package/.docs/reference/tools/tavily.md

@@ -57,7 +57,7 @@ By default, all tools read `TAVILY_API_KEY` from the environment. You can pass `
 
 All factory functions accept `TavilyClientOptions` from `@tavily/core`:
 
-**apiKey** (`string`): Tavily API key. Falls back to the \`TAVILY\_API\_KEY\` environment variable.
+**apiKey** (`string`): Tavily API key. Falls back to the TAVILY\_API\_KEY environment variable.
 
 **clientSource** (`string`): Attribution string sent with each request. (Default: `'mastra'`)
 

package/.docs/reference/tools/vector-query-tool.md

@@ -71,7 +71,7 @@ const queryTool = createVectorQueryTool({
 
 **providerOptions** (`Record<string, Record<string, any>>`): Provider-specific options for the embedding model (e.g., outputDimensionality). \*\*Important\*\*: Only works with AI SDK EmbeddingModelV2 models. For V1 models, configure options when creating the model itself.
 
-**vectorStore** (`MastraVector | VectorStoreResolver`): Direct vector store instance or a resolver function for dynamic selection. Use a function for multi-tenant applications where the vector store is selected based on request context. When provided, \`vectorStoreName\` becomes optional.
+**vectorStore** (`MastraVector | VectorStoreResolver`): Direct vector store instance or a resolver function for dynamic selection. Use a function for multi-tenant applications where the vector store is selected based on request context. When provided, vectorStoreName becomes optional.
 
 ## Returns
 

package/.docs/reference/vectors/chroma.md

@@ -129,7 +129,7 @@ You can also provide the shape of your metadata to a `get` call for type inferen
 
 **limit** (`number`): The maximum number of records to return (Default: `100`)
 
-**offset** (`number`): Offset for returning records. Use with \`limit\` to paginate results.
+**offset** (`number`): Offset for returning records. Use with limit to paginate results.
 
 ### `listIndexes()`
 

package/.docs/reference/vectors/mongodb.md

@@ -103,7 +103,7 @@ Searches for similar vectors with optional metadata filtering.
 
 **topK** (`number`): Number of results to return (Default: `10`)
 
-**filter** (`Record<string, any>`): Metadata filters (applies to the \`metadata\` field)
+**filter** (`Record<string, any>`): Metadata filters (applies to the metadata field)
 
 **documentFilter** (`Record<string, any>`): Filters on original document fields (not just metadata)
 

package/.docs/reference/vectors/pg.md

@@ -28,7 +28,7 @@ The PgVector class provides vector search using [PostgreSQL](https://www.postgre
 
 **pgPoolOptions** (`PoolConfig`): Additional pg pool configuration options
 
-**disableInit** (`boolean`): When true, automatic DDL (schema, extension, table, and index creation) inside \`createIndex\` is skipped. Useful for CI/CD pipelines where schema and indexes are managed separately and the runtime database role lacks DDL privileges. Can also be enabled with the \`MASTRA\_DISABLE\_STORAGE\_INIT\` environment variable. (Default: `false`)
+**disableInit** (`boolean`): When true, automatic DDL (schema, extension, table, and index creation) inside createIndex is skipped. Useful for CI/CD pipelines where schema and indexes are managed separately and the runtime database role lacks DDL privileges. Can also be enabled with the MASTRA\_DISABLE\_STORAGE\_INIT environment variable. (Default: `false`)
 
 ## Constructor examples
 

package/.docs/reference/vectors/s3vectors.md

@@ -88,9 +88,9 @@ await store.disconnect()
 
 **vectorBucketName** (`string`): Target S3 Vectors vector bucket name.
 
-**clientConfig** (`S3VectorsClientConfig`): AWS SDK v3 client options (e.g., \`region\`, \`credentials\`).
+**clientConfig** (`S3VectorsClientConfig`): AWS SDK v3 client options (e.g., region, credentials).
 
-**nonFilterableMetadataKeys** (`string[]`): Metadata keys that should NOT be filterable (applied to the index at creation time). Use this for large text fields like \`content\`.
+**nonFilterableMetadataKeys** (`string[]`): Metadata keys that should NOT be filterable (applied to the index at creation time). Use this for large text fields like content.
 
 ## Methods
 
@@ -102,7 +102,7 @@ Creates a new vector index in the configured vector bucket. If the index already
 
 **dimension** (`number`): Vector dimension (must match your embedding model)
 
-**metric** (`'cosine' | 'euclidean'`): Distance metric for similarity search. \`dotproduct\` is not supported by S3 Vectors. (Default: `cosine`)
+**metric** (`'cosine' | 'euclidean'`): Distance metric for similarity search. dotproduct is not supported by S3 Vectors. (Default: `cosine`)
 
 ### `upsert()`
 
@@ -126,7 +126,7 @@ Searches for nearest neighbors with optional metadata filtering.
 
 **topK** (`number`): Number of results to return (Default: `10`)
 
-**filter** (`S3VectorsFilter`): JSON-based metadata filter supporting \`$and\`, \`$or\`, \`$eq\`, \`$ne\`, \`$gt\`, \`$gte\`, \`$lt\`, \`$lte\`, \`$in\`, \`$nin\`, \`$exists\`.
+**filter** (`S3VectorsFilter`): JSON-based metadata filter supporting $and, $or, $eq, $ne, $gt, $gte, $lt, $lte, $in, $nin, $exists.
 
 **includeVector** (`boolean`): Whether to include vectors in the results (Default: `false`)
 

package/.docs/reference/voice/google-gemini-live.md

@@ -162,7 +162,7 @@ await voice.sendContext([
 await voice.send(micStream)
 ```
 
-**turns** (`IncrementalTurn[]`): Prior conversation turns to seed into the session. Each turn has a \`role\` ("user" or "assistant") and \`content\` string. Both roles are supported on newer models (e.g. \`gemini-2.5-flash-native-audio-preview-12-2025\`). Some older models only accept user-role turns.
+**turns** (`IncrementalTurn[]`): Prior conversation turns to seed into the session. Each turn has a role ("user" or "assistant") and content string. Both roles are supported on newer models (e.g. gemini-2.5-flash-native-audio-preview-12-2025). Some older models only accept user-role turns.
 
 **options** (`object`): Optional configuration.
 
@@ -266,9 +266,9 @@ The GeminiLiveVoice class emits the following events:
 
 **speaking** (`event`): Emitted with audio metadata. Callback receives { audioData?: Int16Array, sampleRate?: number }.
 
-**writing** (`event`): Emitted when transcribed text is available. Callback receives { text: string, role: 'assistant' | 'user' }. On native-audio models the assistant transcript is driven by the server's \`output\_audio\_transcription\` channel rather than \`modelTurn.parts.text\`.
+**writing** (`event`): Emitted when transcribed text is available. Callback receives { text: string, role: 'assistant' | 'user' }. On native-audio models the assistant transcript is driven by the server's output\_audio\_transcription channel rather than modelTurn.parts.text.
 
-**thinking** (`event`): Emitted on native-audio models with the model's chain-of-thought / reasoning text from \`modelTurn.parts.text\`. Callback receives { text: string }. Does not fire on non-native-audio models, where \`modelTurn.parts.text\` is the spoken response and is emitted as \`writing\` instead.
+**thinking** (`event`): Emitted on native-audio models with the model's chain-of-thought / reasoning text from modelTurn.parts.text. Callback receives { text: string }. Does not fire on non-native-audio models, where modelTurn.parts.text is the spoken response and is emitted as writing instead.
 
 **session** (`event`): Emitted on session state changes. Callback receives { state: 'connecting' | 'connected' | 'disconnected' | 'disconnecting' | 'updated', config?: object }.
 

package/.docs/reference/voice/inworld-realtime.md

@@ -68,7 +68,7 @@ voice.close()
 
 **speaker** (`string`): Default voice ID for speech synthesis. Any voice from Inworld's catalog is accepted. (Default: `'Sarah'`)
 
-**sessionId** (`string`): Client-generated session key surfaced as the URL \`key\` parameter. A timestamp-based key is generated automatically when omitted. (Default: `'voice-{Date.now()}'`)
+**sessionId** (`string`): Client-generated session key surfaced as the URL key parameter. A timestamp-based key is generated automatically when omitted. (Default: `'voice-{Date.now()}'`)
 
 **instructions** (`string`): System prompt sent with the initial session.update.
 
@@ -76,9 +76,9 @@ voice.close()
 
 **debug** (`boolean`): Log raw server events. (Default: `false`)
 
-**providerData** (`InworldProviderData`): Typed Inworld extension config (stt, tts, memory, backchannel, responsiveness, plus user\_id and metadata). Sent under session.providerData on every session.update. Composes with any session.providerData set via the \`session\` field; the constructor option wins on key collisions.
+**providerData** (`InworldProviderData`): Typed Inworld extension config (stt, tts, memory, backchannel, responsiveness, plus user\_id and metadata). Sent under session.providerData on every session.update. Composes with any session.providerData set via the session field; the constructor option wins on key collisions.
 
-**connectTimeoutMs** (`number`): Max time \`connect()\` will wait for both the WebSocket handshake and the initial \`session.updated\` round-trip. A pre-open error or close on the WebSocket — or this timeout expiring — surfaces as a rejected promise instead of an uncaught socket error. (Default: `15000`)
+**connectTimeoutMs** (`number`): Max time connect() will wait for both the WebSocket handshake and the initial session.updated round-trip. A pre-open error or close on the WebSocket — or this timeout expiring — surfaces as a rejected promise instead of an uncaught socket error. (Default: `15000`)
 
 ### `session` (typed knobs)
 
@@ -86,21 +86,21 @@ Use the typed `session` field for documented Inworld realtime options. Fields co
 
 **output\_modalities** (`Array<"text" | "audio">`): Modalities the model should produce.
 
-**audio.output.voice** (`string`): Voice catalog ID. When omitted, the constructor \`speaker\` is used.
+**audio.output.voice** (`string`): Voice catalog ID. When omitted, the constructor speaker is used.
 
 **audio.output.speed** (`number`): Playback speed multiplier for synthesized audio (0.25 to 1.5).
 
 **audio.output.model** (`string`): Inworld TTS model (e.g. "inworld-tts-2").
 
-**audio.output.format** (`InworldAudioFormat`): Output audio encoding. A codec string (e.g. "audio/pcm", "audio/pcmu", "audio/pcma", "audio/float32") or an object \`{ type, rate? }\`. \`rate\` (Hz) applies to audio/pcm and audio/float32 (default 24000); audio/pcmu and audio/pcma are fixed at 8 kHz.
+**audio.output.format** (`InworldAudioFormat`): Output audio encoding. A codec string (e.g. "audio/pcm", "audio/pcmu", "audio/pcma", "audio/float32") or an object { type, rate? }. rate (Hz) applies to audio/pcm and audio/float32 (default 24000); audio/pcmu and audio/pcma are fixed at 8 kHz.
 
-**audio.input.format** (`InworldAudioFormat`): Input audio encoding sent to the server. Same shape as \`audio.output.format\` — a codec string or \`{ type, rate? }\` object.
+**audio.input.format** (`InworldAudioFormat`): Input audio encoding sent to the server. Same shape as audio.output.format — a codec string or { type, rate? } object.
 
 **audio.input.noise\_reduction** (`{ type: "near_field" | "far_field" }`): Input noise-reduction mode applied before transcription and VAD.
 
-**audio.input.transcription** (`{ model?: string; language?: string; prompt?: string }`): Server-side transcription for incoming user audio. Defaults to \`{ model: "inworld/inworld-stt-1" }\`. \`prompt\` biases transcription with vocabulary, spelling, or style hints. Supply your own object to override; set to \`null\` to disable user-side transcription.
+**audio.input.transcription** (`{ model?: string; language?: string; prompt?: string }`): Server-side transcription for incoming user audio. Defaults to { model: "inworld/inworld-stt-1" }. prompt biases transcription with vocabulary, spelling, or style hints. Supply your own object to override; set to null to disable user-side transcription.
 
-**audio.input.turn\_detection** (`InworldTurnDetection | null`): Voice activity / turn detection. Defaults to \`{ type: "semantic\_vad", eagerness: "medium", create\_response: true, interrupt\_response: true }\`. Supply your own object to override; set to \`null\` to disable turn detection entirely. The \`eagerness\` field controls how quickly semantic VAD ends a user turn — \`low\` waits for clearer pauses (more interruption-resistant), \`high\` ends turns sooner (snappier, more prone to cutting users off). Default \`medium\` balances both. \`idle\_timeout\_ms\` (server\_vad only) sets the idle window before the server commits a turn.
+**audio.input.turn\_detection** (`InworldTurnDetection | null`): Voice activity / turn detection. Defaults to { type: "semantic\_vad", eagerness: "medium", create\_response: true, interrupt\_response: true }. Supply your own object to override; set to null to disable turn detection entirely. The eagerness field controls how quickly semantic VAD ends a user turn — low waits for clearer pauses (more interruption-resistant), high ends turns sooner (snappier, more prone to cutting users off). Default medium balances both. idle\_timeout\_ms (server\_vad only) sets the idle window before the server commits a turn.
 
 **tool\_choice** (`string | { type: "function"; name: string } | { type: "mcp"; server_label: string }`): Tool selection strategy. Use the mcp variant to route tool calls through a configured Inworld MCP server.
 
@@ -279,11 +279,11 @@ The `InworldRealtimeVoice` class emits the following events:
 
 **writing** (`event`): Emitted as transcribed text becomes available. Callback receives { text: string, response\_id: string, role: "assistant" | "user", voiceProfile? }. Deduplicated across audio-transcript and text deltas in the same response so a single response only emits one stream. On user events, voiceProfile is present when providerData.stt.voice\_profile is enabled.
 
-**speech-started** (`event`): Raw \`input\_audio\_buffer.speech\_started\` VAD edge from the server.
+**speech-started** (`event`): Raw input\_audio\_buffer.speech\_started VAD edge from the server.
 
-**speech-stopped** (`event`): Raw \`input\_audio\_buffer.speech\_stopped\` VAD edge from the server.
+**speech-stopped** (`event`): Raw input\_audio\_buffer.speech\_stopped VAD edge from the server.
 
-**interrupted** (`event`): Synthetic client-side signal: emitted once per in-flight \`response\_id\` when the user starts speaking. Use this to stop main response playback on barge-in. Callback receives \`{ response\_id: string }\`. Only carries main-response ids — never back-channel ids — so stopping the matching \`speaker\` stream leaves \`backchannel\` streams playing (back-channels are meant to overlap user speech and are never cancelled by barge-in).
+**interrupted** (`event`): Synthetic client-side signal: emitted once per in-flight response\_id when the user starts speaking. Use this to stop main response playback on barge-in. Callback receives { response\_id: string }. Only carries main-response ids — never back-channel ids — so stopping the matching speaker stream leaves backchannel streams playing (back-channels are meant to overlap user speech and are never cancelled by barge-in).
 
 **turn-suggestion** (`event`): Smart-turn endpointing hint for a buffered user utterance. Callback receives { item\_id, utterance\_index, probability, trailing\_silence\_ms?, audio\_duration\_ms?, inference\_ms? }.
 
@@ -303,7 +303,7 @@ The `InworldRealtimeVoice` class emits the following events:
 
 **memory** (`event`): Emitted with Inworld's rolling summary and facts state, deduplicated by version. Requires providerData.memory.enabled. Callback receives InworldMemoryState.
 
-**backchannel** (`event`): Emitted with a PassThrough stream of back-channel PCM audio (short acknowledgements while the user speaks). Each stream's \`.id\` is a \`backchannel\_id\` that never appears in \`interrupted\`, so play these on a separate track that barge-in does not stop. Requires providerData.backchannel.enabled.
+**backchannel** (`event`): Emitted with a PassThrough stream of back-channel PCM audio (short acknowledgements while the user speaks). Each stream's .id is a backchannel\_id that never appears in interrupted, so play these on a separate track that barge-in does not stop. Requires providerData.backchannel.enabled.
 
 **backchannel.done** (`event`): Emitted when a back-channel finishes. Callback receives { backchannel\_id: string, phrase? }.
 

package/.docs/reference/voice/inworld.md

@@ -84,9 +84,9 @@ const audioStream = await voice.speak('Hello, world!', {
 
 **options.speakingRate** (`number`): Adjust the speaking rate.
 
-**options.temperature** (`number`): Controls voice variability. Honored on \`inworld-tts-1.5-\*\` models; ignored by \`inworld-tts-2\`.
+**options.temperature** (`number`): Controls voice variability. Honored on inworld-tts-1.5-\* models; ignored by inworld-tts-2.
 
-**options.deliveryMode** (`'STABLE' | 'BALANCED' | 'CREATIVE'`): Steering control for delivery style. Only honored by \`inworld-tts-2\`.
+**options.deliveryMode** (`'STABLE' | 'BALANCED' | 'CREATIVE'`): Steering control for delivery style. Only honored by inworld-tts-2.
 
 **options.language** (`string`): BCP-47 language code for this request. Auto-detected when omitted.
 

package/.docs/reference/voice/voice.on.md

@@ -50,7 +50,7 @@ voice.on('error', ({ message, code, details }) => {
 
 ## Parameters
 
-**event** (`string`): Name of the event to listen for. See the \[Voice Events]\(./voice.events) documentation for a list of available events.
+**event** (`string`): Name of the event to listen for. See the Voice Events documentation for a list of available events.
 
 **callback** (`function`): Callback function that will be called when the event occurs. The callback signature depends on the specific event.
 

package/.docs/reference/workflows/run-methods/resume.md

@@ -28,7 +28,7 @@ if (result.status === 'suspended') {
 
 **retryCount** (`number`): Optional retry count for nested workflow execution
 
-**forEachIndex** (`number`): Target a specific iteration of a suspended \`.foreach()\` step. Pass the zero-based index of the iteration you want to resume; other iterations remain suspended. Omit this field to resume all suspended iterations of the step with the same \`resumeData\`.
+**forEachIndex** (`number`): Target a specific iteration of a suspended .foreach() step. Pass the zero-based index of the iteration you want to resume; other iterations remain suspended. Omit this field to resume all suspended iterations of the step with the same resumeData.
 
 **tracingContext** (`TracingContext`): Tracing context for creating child spans and adding metadata. Automatically injected when using Mastra's tracing system.
 

package/.docs/reference/workflows/run-methods/timeTravel.md

@@ -159,4 +159,4 @@ const result = await run.timeTravel({
 - [Workflows overview](https://mastra.ai/docs/workflows/overview)
 - [Workflow.createRun()](https://mastra.ai/reference/workflows/workflow-methods/create-run)
 - [Snapshots](https://mastra.ai/docs/workflows/snapshots)
-- [Suspend & Resume](https://mastra.ai/docs/workflows/suspend-and-resume)
+- [Suspend and Resume](https://mastra.ai/docs/workflows/suspend-and-resume)

package/.docs/reference/workspace/agentcore-runtime-sandbox.md

@@ -94,13 +94,13 @@ if (!result?.success) {
 
 **commandTimeout** (`number`): Default command timeout in milliseconds. (Default: `300000`)
 
-**stopSessionOnLifecycle** (`boolean`): Whether \`stop()\` and \`destroy()\` should call \`StopRuntimeSession\`. Defaults to false because AgentCore Runtime sessions are often shared with agent invocations outside the sandbox instance. (Default: `false`)
+**stopSessionOnLifecycle** (`boolean`): Whether stop() and destroy() should call StopRuntimeSession. Defaults to false because AgentCore Runtime sessions are often shared with agent invocations outside the sandbox instance. (Default: `false`)
 
-**stopClientToken** (`string`): Client token used when \`StopRuntimeSession\` is called. (Default: `Generated UUID`)
+**stopClientToken** (`string`): Client token used when StopRuntimeSession is called. (Default: `Generated UUID`)
 
 **client** (`BedrockAgentCoreClient`): Preconfigured AWS SDK client. Use this for custom credentials, retry behavior, or tests.
 
-**instructions** (`string | ((opts) => string)`): Custom instructions that override the default instructions returned by \`getInstructions()\`. Pass a string to replace the defaults, or a function to extend them.
+**instructions** (`string | ((opts) => string)`): Custom instructions that override the default instructions returned by getInstructions(). Pass a string to replace the defaults, or a function to extend them.
 
 ## Properties
 
@@ -110,7 +110,7 @@ if (!result?.success) {
 
 **provider** (`'agentcore'`): Provider type identifier.
 
-**status** (`ProviderStatus`): Current lifecycle status: \`'pending'\`, \`'starting'\`, \`'running'\`, \`'stopping'\`, \`'stopped'\`, \`'destroying'\`, \`'destroyed'\`, or \`'error'\`.
+**status** (`ProviderStatus`): Current lifecycle status: 'pending', 'starting', 'running', 'stopping', 'stopped', 'destroying', 'destroyed', or 'error'.
 
 **runtimeSessionId** (`string`): AgentCore Runtime session ID used for command execution.
 

package/.docs/reference/workspace/agentfs-filesystem.md

@@ -86,7 +86,7 @@ const filesystem = new AgentFSFilesystem({
 
 You must provide at least one of `agentId`, `path`, or `agent`.
 
-**agentId** (`string`): Agent ID — creates database at \`.agentfs/\<agentId>.db\`
+**agentId** (`string`): Agent ID — creates database at .agentfs/\<agentId>.db
 
 **path** (`string`): Explicit database file path (alternative to agentId)
 

package/.docs/reference/workspace/apple-container-sandbox.md

@@ -73,7 +73,7 @@ console.log(response.text)
 
 **id** (`string`): Unique identifier for this sandbox instance. (Default: `Auto-generated`)
 
-**name** (`string`): Apple container name passed to \`container run --name\`. Characters outside \`\[a-zA-Z0-9\_.-]\` are replaced with \`-\` and the result is prefixed if it would not start with an alphanumeric character. (Default: `` The sandbox `id` ``)
+**name** (`string`): Apple container name passed to container run --name. Characters outside \[a-zA-Z0-9\_.-] are replaced with - and the result is prefixed if it would not start with an alphanumeric character. (Default: `` The sandbox `id` ``)
 
 **image** (`string`): OCI image to use for the container. (Default: `'node:22-slim'`)
 
@@ -83,13 +83,13 @@ console.log(response.text)
 
 **volumes** (`Record<string, string>`): Host-to-container bind mounts. Keys are host paths, values are container paths.
 
-**mounts** (`string[]`): Raw \`container run --mount\` specs.
+**mounts** (`string[]`): Raw container run --mount specs.
 
 **network** (`string`): Apple container network attachment spec.
 
-**publishedPorts** (`string[]`): Port publish specs passed as \`--publish\`.
+**publishedPorts** (`string[]`): Port publish specs passed as --publish.
 
-**publishedSockets** (`string[]`): Socket publish specs passed as \`--publish-socket\`.
+**publishedSockets** (`string[]`): Socket publish specs passed as --publish-socket.
 
 **cpus** (`number | string`): Number of CPUs to allocate.
 
@@ -115,7 +115,7 @@ console.log(response.text)
 
 **capDrop** (`string[]`): Linux capabilities to drop.
 
-**tmpfs** (`string[]`): tmpfs destination paths passed as \`--tmpfs\`, for example \`/tmp\`.
+**tmpfs** (`string[]`): tmpfs destination paths passed as --tmpfs, for example /tmp.
 
 **dns** (`string[]`): DNS nameserver IPs.
 

package/.docs/reference/workspace/archil-filesystem.md

@@ -95,17 +95,17 @@ const filesystem = new ArchilFilesystem({
 
 ## Constructor parameters
 
-**diskId** (`string`): Existing Archil disk ID (e.g. "dsk-0123456789abcdef"). Mutually exclusive with \`createDiskOptions\`.
+**diskId** (`string`): Existing Archil disk ID (e.g. "dsk-0123456789abcdef"). Mutually exclusive with createDiskOptions.
 
-**createDiskOptions** (`CreateDiskRequest`): Options for creating a new disk on init. Mutually exclusive with \`diskId\`.
+**createDiskOptions** (`CreateDiskRequest`): Options for creating a new disk on init. Mutually exclusive with diskId.
 
-**apiKey** (`string`): Archil API key. Falls back to \`ARCHIL\_API\_KEY\` environment variable.
+**apiKey** (`string`): Archil API key. Falls back to ARCHIL\_API\_KEY environment variable.
 
-**region** (`string`): Archil region (e.g. "aws-us-east-1"). Falls back to \`ARCHIL\_REGION\` environment variable.
+**region** (`string`): Archil region (e.g. "aws-us-east-1"). Falls back to ARCHIL\_REGION environment variable.
 
 **baseUrl** (`string`): Custom Archil control-plane URL (for testing or self-hosted deployments).
 
-**s3BaseUrl** (`string`): Custom S3-compatible API URL. Falls back to \`ARCHIL\_S3\_BASE\_URL\` environment variable.
+**s3BaseUrl** (`string`): Custom S3-compatible API URL. Falls back to ARCHIL\_S3\_BASE\_URL environment variable.
 
 **id** (`string`): Unique identifier for this filesystem instance. (Default: `Auto-generated`)
 

package/.docs/reference/workspace/blaxel-sandbox.md

@@ -101,7 +101,7 @@ const workspace = new Workspace({
 
 **instance** (`SandboxInstance`): The underlying Blaxel SandboxInstance for direct access to Blaxel APIs. Throws SandboxNotReadyError if the sandbox has not been started.
 
-**processes** (`BlaxelProcessManager`): Background process manager. See \[SandboxProcessManager reference]\(/reference/workspace/process-manager).
+**processes** (`BlaxelProcessManager`): Background process manager. See SandboxProcessManager reference.
 
 ## Background processes
 

package/.docs/reference/workspace/daytona-sandbox.md

@@ -321,7 +321,7 @@ const workspace = new Workspace({
 
 **instance** (`Sandbox`): The underlying Daytona Sandbox instance. Throws SandboxNotReadyError if the sandbox has not been started.
 
-**processes** (`DaytonaProcessManager`): Background process manager. See \[SandboxProcessManager reference]\(/reference/workspace/process-manager).
+**processes** (`DaytonaProcessManager`): Background process manager. See SandboxProcessManager reference.
 
 ## Background processes
 

package/.docs/reference/workspace/docker-sandbox.md

@@ -61,7 +61,7 @@ const agent = new Agent({
 
 **id** (`string`): Unique identifier for this sandbox instance. Used for label-based reconnection. (Default: `Auto-generated`)
 
-**name** (`string`): Container display name passed to Docker as \`--name\`. Characters outside \`\[a-zA-Z0-9\_.-]\` are replaced with \`-\` and the result is prefixed if it would not start with an alphanumeric character. (Default: `` The sandbox `id` ``)
+**name** (`string`): Container display name passed to Docker as --name. Characters outside \[a-zA-Z0-9\_.-] are replaced with - and the result is prefixed if it would not start with an alphanumeric character. (Default: `` The sandbox `id` ``)
 
 **image** (`string`): Docker image to use for the container. (Default: `'node:22-slim'`)
 
@@ -121,7 +121,7 @@ const agent = new Agent({
 
 **container** (`Container`): The underlying dockerode Container instance. Throws SandboxNotReadyError if the sandbox has not been started.
 
-**processes** (`DockerProcessManager`): Background process manager. See \[SandboxProcessManager reference]\(/reference/workspace/process-manager).
+**processes** (`DockerProcessManager`): Background process manager. See SandboxProcessManager reference.
 
 ## Background processes
 

package/.docs/reference/workspace/e2b-sandbox.md

@@ -76,7 +76,7 @@ const agent = new Agent({
 
 **metadata** (`Record<string, unknown>`): Custom metadata attached to the sandbox instance.
 
-**instructions** (`string | ((opts: { defaultInstructions: string; requestContext?: RequestContext }) => string)`): Custom instructions returned by \`getInstructions()\`. A string fully replaces the defaults; a function receives the defaults and can extend or customize them per-request. Pass an empty string to suppress instructions entirely.
+**instructions** (`string | ((opts: { defaultInstructions: string; requestContext?: RequestContext }) => string)`): Custom instructions returned by getInstructions(). A string fully replaces the defaults; a function receives the defaults and can extend or customize them per-request. Pass an empty string to suppress instructions entirely.
 
 ## Properties
 
@@ -88,7 +88,7 @@ const agent = new Agent({
 
 **status** (`ProviderStatus`): 'pending' | 'initializing' | 'ready' | 'starting' | 'running' | 'stopping' | 'stopped' | 'destroying' | 'destroyed' | 'error'
 
-**processes** (`E2BProcessManager`): Background process manager. See \[SandboxProcessManager reference]\(/reference/workspace/process-manager).
+**processes** (`E2BProcessManager`): Background process manager. See SandboxProcessManager reference.
 
 ## Background processes
 

package/.docs/reference/workspace/files-sdk-filesystem.md

@@ -105,7 +105,7 @@ All write operations (`writeFile`, `appendFile`, `deleteFile`, `copyFile`, `move
 
 ## Constructor parameters
 
-**files** (`Files`): A pre-configured FilesSDK \`Files\` instance bound to the adapter and credentials you want to use.
+**files** (`Files`): A pre-configured FilesSDK Files instance bound to the adapter and credentials you want to use.
 
 **id** (`string`): Unique identifier for this filesystem instance. (Default: `Auto-generated`)
 

package/.docs/reference/workspace/filesystem.md

@@ -263,7 +263,7 @@ const instructions = filesystem.getInstructions?.()
 
 **Parameters:**
 
-**opts.requestContext** (`RequestContext`): Forwarded to the \`instructions\` function if one was provided in the constructor.
+**opts.requestContext** (`RequestContext`): Forwarded to the instructions function if one was provided in the constructor.
 
 **Returns:** `string`
 

package/.docs/reference/workspace/local-filesystem.md

@@ -38,9 +38,9 @@ const response = await agent.generate('List all files in the workspace')
 
 **id** (`string`): Unique identifier for this filesystem instance (Default: `Auto-generated`)
 
-**contained** (`boolean`): When true, all file operations are restricted to stay within basePath. Prevents path traversal attacks and symlink escapes. See \[containment]\(/docs/workspace/filesystem#containment). (Default: `true`)
+**contained** (`boolean`): When true, all file operations are restricted to stay within basePath. Prevents path traversal attacks and symlink escapes. See containment. (Default: `true`)
 
-**allowedPaths** (`string[]`): Additional directories the agent can access outside of \`basePath\`. (Default: `[]`)
+**allowedPaths** (`string[]`): Additional directories the agent can access outside of basePath. (Default: `[]`)
 
 **instructions** (`string | ((opts: { defaultInstructions: string; requestContext?: RequestContext }) => string)`): Custom instructions that override the default instructions returned by getInstructions(). Pass a string to fully replace them, or a function to extend them with access to the current requestContext for per-request customization.
 
@@ -302,7 +302,7 @@ const instructions = filesystem.getInstructions({ requestContext })
 
 **Parameters:**
 
-**opts.requestContext** (`RequestContext`): Forwarded to the \`instructions\` function if one was provided in the constructor.
+**opts.requestContext** (`RequestContext`): Forwarded to the instructions function if one was provided in the constructor.
 
 **Returns:** `string`
 

package/.docs/reference/workspace/local-sandbox.md

@@ -84,7 +84,7 @@ Configuration options for native OS sandboxing (used with `isolation: 'seatbelt'
 
 **workingDirectory** (`string`): The configured working directory
 
-**processes** (`LocalProcessManager`): Background process manager. See \[SandboxProcessManager reference]\(/reference/workspace/process-manager).
+**processes** (`LocalProcessManager`): Background process manager. See SandboxProcessManager reference.
 
 ## Path Resolution
 

package/.docs/reference/workspace/mesa-filesystem.md

@@ -65,7 +65,7 @@ const agent = new Agent({
 
 ## Constructor parameters
 
-**apiKey** (`string`): Mesa API key. Falls back to \`MESA\_API\_KEY\` when omitted.
+**apiKey** (`string`): Mesa API key. Falls back to MESA\_API\_KEY when omitted.
 
 **org** (`string`): Mesa org slug. When omitted, the Mesa SDK resolves the default org.
 
@@ -81,9 +81,9 @@ const agent = new Agent({
 
 **id** (`string`): Filesystem instance identifier.
 
-**name** (`string`): Provider name (\`'MesaFilesystem'\`).
+**name** (`string`): Provider name ('MesaFilesystem').
 
-**provider** (`string`): Provider identifier (\`'mesa'\`).
+**provider** (`string`): Provider identifier ('mesa').
 
 **readOnly** (`boolean | undefined`): Whether write operations are blocked.
 

package/.docs/reference/workspace/modal-sandbox.md

@@ -114,7 +114,7 @@ Get your credentials from the [Modal dashboard](https://modal.com/settings/token
 
 **modal** (`Sandbox`): The underlying Modal Sandbox instance. Throws SandboxNotReadyError if the sandbox has not been started.
 
-**processes** (`ModalProcessManager`): Background process manager. See \[SandboxProcessManager reference]\(/reference/workspace/process-manager).
+**processes** (`ModalProcessManager`): Background process manager. See SandboxProcessManager reference.
 
 ## Sandbox lifecycle
 

package/.docs/reference/workspace/railway-sandbox.md

@@ -188,7 +188,7 @@ const result = await sandbox.executeCommand('cat', ['/tmp/state.txt'])
 
 **railway** (`Sandbox`): The underlying Railway Sandbox instance for direct SDK access. Throws SandboxNotReadyError if the sandbox has not been started.
 
-**processes** (`RailwayProcessManager`): Background process manager. See \[SandboxProcessManager reference]\(/reference/workspace/process-manager).
+**processes** (`RailwayProcessManager`): Background process manager. See SandboxProcessManager reference.
 
 ## Methods
 

package/.docs/reference/workspace/s3-filesystem.md

@@ -164,13 +164,13 @@ Tigris uses virtual-hosted-style addressing, so `forcePathStyle` must be set to
 
 **region** (`string`): AWS region (use 'auto' for R2)
 
-**credentials** (`AwsCredentialIdentity | AwsCredentialIdentityProvider`): AWS credentials or credential provider function. Accepts static credentials or a provider that auto-refreshes (e.g. \`fromNodeProviderChain()\` from \`@aws-sdk/credential-providers\`). Takes precedence over \`accessKeyId\`/\`secretAccessKey\`/\`sessionToken\`. When all credential options are omitted, the SDK default credential provider chain is used.
+**credentials** (`AwsCredentialIdentity | AwsCredentialIdentityProvider`): AWS credentials or credential provider function. Accepts static credentials or a provider that auto-refreshes (e.g. fromNodeProviderChain() from @aws-sdk/credential-providers). Takes precedence over accessKeyId/secretAccessKey/sessionToken. When all credential options are omitted, the SDK default credential provider chain is used.
 
-**accessKeyId** (`string`): AWS access key ID. When omitted along with \`secretAccessKey\` and \`credentials\`, the SDK default credential provider chain is used.
+**accessKeyId** (`string`): AWS access key ID. When omitted along with secretAccessKey and credentials, the SDK default credential provider chain is used.
 
-**secretAccessKey** (`string`): AWS secret access key. When omitted along with \`accessKeyId\` and \`credentials\`, the SDK default credential provider chain is used.
+**secretAccessKey** (`string`): AWS secret access key. When omitted along with accessKeyId and credentials, the SDK default credential provider chain is used.
 
-**sessionToken** (`string`): AWS session token for static temporary credentials. Use with \`accessKeyId\`/\`secretAccessKey\` only when passing a complete temporary credential set manually. For auto-refreshing SSO, AssumeRole, or container credentials, use the \`credentials\` provider parameter or the SDK default credential provider chain.
+**sessionToken** (`string`): AWS session token for static temporary credentials. Use with accessKeyId/secretAccessKey only when passing a complete temporary credential set manually. For auto-refreshing SSO, AssumeRole, or container credentials, use the credentials provider parameter or the SDK default credential provider chain.
 
 **endpoint** (`string`): Custom endpoint URL for S3-compatible storage (R2, MinIO, Tigris, etc.)