@mastra/mcp-docs-server 1.2.5-alpha.1 → 1.2.5-alpha.5

package/.docs/reference/server/register-api-route.md

@@ -26,13 +26,13 @@ registerApiRoute("/items/:itemId", { ... })
 
 **method** (`'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'ALL'`): HTTP method for the route
 
-**handler** (`Handler`): Route handler function receiving Hono Context. Use either \`handler\` or \`createHandler\`, not both.
+**handler** (`Handler`): Route handler function receiving Hono Context. Use either handler or createHandler, not both.
 
-**createHandler** (`(c: Context) => Promise<Handler>`): Async factory function to create the handler. Use either \`handler\` or \`createHandler\`, not both.
+**createHandler** (`(c: Context) => Promise<Handler>`): Async factory function to create the handler. Use either handler or createHandler, not both.
 
 **middleware** (`MiddlewareHandler | MiddlewareHandler[]`): Route-specific middleware functions
 
-**cors** (`CorsOptions`): Route-specific CORS configuration. Use this when one custom route needs a different cross-origin policy from \`server.cors\`.
+**cors** (`CorsOptions`): Route-specific CORS configuration. Use this when one custom route needs a different cross-origin policy from server.cors.
 
 **openapi** (`DescribeRouteOptions`): OpenAPI metadata for Swagger UI documentation
 

package/.docs/reference/signals/create-notification-inbox-tool.md

@@ -33,7 +33,7 @@ export const supportAgent = new Agent({
 
 **options** (`object`): Tool configuration.
 
-**options.storage** (`NotificationsStorage`): Notification storage domain returned by \`storage.getStore('notifications')\`.
+**options.storage** (`NotificationsStorage`): Notification storage domain returned by storage.getStore('notifications').
 
 ## Tool input
 
@@ -43,7 +43,7 @@ The generated tool has the id `notification-inbox` and accepts these input field
 
 **threadId** (`string`): Thread ID to inspect. Defaults to the current agent thread when available.
 
-**id** (`string`): Notification ID. Required for \`markSeen\`, \`dismiss\`, and \`archive\`. Optional for \`read\`.
+**id** (`string`): Notification ID. Required for markSeen, dismiss, and archive. Optional for read.
 
 **status** (`'pending' | 'delivered' | 'seen' | 'dismissed' | 'archived' | 'discarded'`): Status filter for list, read, or search actions.
 
@@ -51,7 +51,7 @@ The generated tool has the id `notification-inbox` and accepts these input field
 
 **source** (`string`): Source filter for list, read, or search actions.
 
-**query** (`string`): Search query. Required when \`action\` is \`search\`.
+**query** (`string`): Search query. Required when action is search.
 
 **limit** (`number`): Maximum number of notifications to return. Must be a positive integer.
 

package/.docs/reference/signals/signal-provider.md

@@ -63,9 +63,9 @@ The agent calls `connect(this)`, registers any processors or tools the provider
 
 **name** (`string`): Human-readable display name for the provider.
 
-**pollInterval** (`number`): Poll interval in milliseconds. When set, the framework calls \`poll()\` on this interval. Leave \`undefined\` or \`0\` for webhook-only providers.
+**pollInterval** (`number`): Poll interval in milliseconds. When set, the framework calls poll() on this interval. Leave undefined or 0 for webhook-only providers.
 
-**isConnected** (`boolean`): Whether this provider is connected to an agent. Returns \`true\` after \`connect()\` is called. Used internally to skip re-wiring during \`Agent.\_\_fork()\`.
+**isConnected** (`boolean`): Whether this provider is connected to an agent. Returns true after connect() is called. Used internally to skip re-wiring during Agent.\_\_fork().
 
 ## Methods
 
@@ -154,9 +154,9 @@ const sub = this.subscribe(
 
 Returns: `SignalSubscription` — the created subscription, or the existing one with merged metadata.
 
-**target** (`SignalProviderTarget`): The thread to subscribe. Must include \`threadId\` and \`resourceId\`.
+**target** (`SignalProviderTarget`): The thread to subscribe. Must include threadId and resourceId.
 
-**externalResourceId** (`string`): Provider-specific identifier for the external resource (for example, \`"github:owner/repo#123"\`).
+**externalResourceId** (`string`): Provider-specific identifier for the external resource (for example, "github:owner/repo#123").
 
 **metadata** (`Record<string, unknown>`): Additional data to store with the subscription. Merged into existing metadata on duplicate subscribes.
 
@@ -352,7 +352,7 @@ await this.notify(
 
 **notification.source** (`string`): Identifier for the notification source.
 
-**notification.kind** (`string`): Type of event (for example, \`"pr-updated"\`, \`"new-message"\`).
+**notification.kind** (`string`): Type of event (for example, "pr-updated", "new-message").
 
 **notification.summary** (`string`): Human-readable summary of the event.
 
@@ -360,7 +360,7 @@ await this.notify(
 
 **notification.payload** (`unknown`): Arbitrary data attached to the notification.
 
-**target** (`SignalProviderTarget`): The thread to notify. Must include \`threadId\` and \`resourceId\`.
+**target** (`SignalProviderTarget`): The thread to notify. Must include threadId and resourceId.
 
 ## Types
 
@@ -376,7 +376,7 @@ The subscription object returned by `subscribe()`.
 
 **resourceId** (`string`): The resource owning the thread.
 
-**externalResourceId** (`string`): Provider-specific identifier for the external resource (for example, \`"github:owner/repo#123"\`).
+**externalResourceId** (`string`): Provider-specific identifier for the external resource (for example, "github:owner/repo#123").
 
 **subscribedAt** (`Date`): When the subscription was created.
 

package/.docs/reference/signals/webhook-signal-provider.md

@@ -53,7 +53,7 @@ const result = await webhookProvider.handleWebhook({
 
 **name** (`string`): Human-readable name. (Default: `'Webhook Signals'`)
 
-**extractResourceId** (`(payload: unknown) => string | string[] | undefined`): Extract the external resource ID from a webhook payload. Return \`undefined\` to skip the event. Can return an array to match multiple resources. (Default: ``Returns `payload.resource` or `payload.externalResourceId` if present``)
+**extractResourceId** (`(payload: unknown) => string | string[] | undefined`): Extract the external resource ID from a webhook payload. Return undefined to skip the event. Can return an array to match multiple resources. (Default: ``Returns `payload.resource` or `payload.externalResourceId` if present``)
 
 **buildNotification** (`(payload: unknown, subscription: SignalSubscription) => SendNotificationSignalInput`): Build the notification object from a webhook payload and the matched subscription. (Default: `` Returns `{ source: id, kind: 'webhook-event', summary, payload }` ``)
 
@@ -75,7 +75,7 @@ webhookProvider.subscribeThread(
 
 Returns: `SignalSubscription`
 
-**target** (`SignalProviderTarget`): The thread to subscribe. Must include \`threadId\` and \`resourceId\`.
+**target** (`SignalProviderTarget`): The thread to subscribe. Must include threadId and resourceId.
 
 **externalResourceId** (`string`): The external resource to monitor (for example, a repository full name).
 

package/.docs/reference/storage/clickhouse.md

@@ -174,19 +174,19 @@ The same `client` form is accepted by `ObservabilityStorageClickhouse` and `Obse
 
 **id** (`string`): Unique identifier for this storage instance.
 
-**url** (`string`): ClickHouse server URL (for example, \`https\://your-instance.clickhouse.cloud:8443\` or \`http\://localhost:8123\`). Required when not passing a pre-configured \`client\`.
+**url** (`string`): ClickHouse server URL (for example, https\://your-instance.clickhouse.cloud:8443 or http\://localhost:8123). Required when not passing a pre-configured client.
 
-**username** (`string`): ClickHouse username. Required when not passing a pre-configured \`client\`.
+**username** (`string`): ClickHouse username. Required when not passing a pre-configured client.
 
-**password** (`string`): ClickHouse password. Required when not passing a pre-configured \`client\`. It can be an empty string for the default user on a local instance.
+**password** (`string`): ClickHouse password. Required when not passing a pre-configured client. It can be an empty string for the default user on a local instance.
 
-**client** (`ClickHouseClient`): Pre-configured ClickHouse client from \`@clickhouse/client\`. Use this when you need custom request settings. Mutually exclusive with the credential fields above.
+**client** (`ClickHouseClient`): Pre-configured ClickHouse client from @clickhouse/client. Use this when you need custom request settings. Mutually exclusive with the credential fields above.
 
-**ttl** (`object`): Per-table TTL configuration applied at table creation time. Accepts row-level and column-level TTLs in interval units from \`NANOSECOND\` through \`YEAR\`.
+**ttl** (`object`): Per-table TTL configuration applied at table creation time. Accepts row-level and column-level TTLs in interval units from NANOSECOND through YEAR.
 
-**replication** (`{ cluster?: string; zookeeperPath?: string; replicaName?: string }`): Opt-in replicated table configuration for multi-replica ClickHouse clusters. When set, Mastra creates replicated MergeTree tables. When \`cluster\` is set, Mastra also adds \`ON CLUSTER\` to Mastra-owned data definition language (DDL).
+**replication** (`{ cluster?: string; zookeeperPath?: string; replicaName?: string }`): Opt-in replicated table configuration for multi-replica ClickHouse clusters. When set, Mastra creates replicated MergeTree tables. When cluster is set, Mastra also adds ON CLUSTER to Mastra-owned data definition language (DDL).
 
-**disableInit** (`boolean`): When \`true\`, the store does not run table creation or migrations on first use. Call \`storage.init()\` explicitly from your deployment scripts. (Default: `false`)
+**disableInit** (`boolean`): When true, the store does not run table creation or migrations on first use. Call storage.init() explicitly from your deployment scripts. (Default: `false`)
 
 `ClickhouseStore` also accepts every option from `ClickHouseClientConfigOptions` (such as `database`, `request_timeout`, `compression`, `keep_alive`, and `max_open_connections`).
 

package/.docs/reference/storage/composite.md

@@ -128,11 +128,11 @@ export const mastra = new Mastra({
 
 **id** (`string`): Unique identifier for this storage instance.
 
-**default** (`MastraCompositeStore`): Default storage adapter. Domains not explicitly specified in \`domains\` will use this storage's domains as fallbacks.
+**default** (`MastraCompositeStore`): Default storage adapter. Domains not explicitly specified in domains will use this storage's domains as fallbacks.
 
 **disableInit** (`boolean`): When true, automatic initialization is disabled. You must call init() explicitly.
 
-**domains** (`object`): Individual domain overrides. Each domain can come from a different storage adapter. These take precedence over both \`editor\` and \`default\` storage.
+**domains** (`object`): Individual domain overrides. Each domain can come from a different storage adapter. These take precedence over both editor and default storage.
 
 **domains.memory** (`MemoryStorage`): Storage for threads, messages, and resources.
 

package/.docs/reference/storage/duckdb.md

@@ -108,7 +108,7 @@ const duckdb = new DuckDBStore({ path: ':memory:' })
 
 **id** (`string`): Unique identifier for this storage instance. (Default: `'duckdb'`)
 
-**path** (`string`): Path to the DuckDB database file. Use \`:memory:\` for an ephemeral in-memory database. (Default: `'mastra.duckdb'`)
+**path** (`string`): Path to the DuckDB database file. Use :memory: for an ephemeral in-memory database. (Default: `'mastra.duckdb'`)
 
 ### Lower-level types
 

package/.docs/reference/storage/dynamodb.md

@@ -118,7 +118,7 @@ For local development, you can use [DynamoDB Local](https://docs.aws.amazon.com/
 
 **config.endpoint** (`string`): Custom endpoint for DynamoDB (e.g., 'http\://localhost:8000' for local development).
 
-**config.credentials** (`object`): AWS credentials object with \`accessKeyId\` and \`secretAccessKey\`. If not provided, the AWS SDK will attempt to source credentials from environment variables, IAM roles (e.g., for EC2/Lambda), or the shared AWS credentials file.
+**config.credentials** (`object`): AWS credentials object with accessKeyId and secretAccessKey. If not provided, the AWS SDK will attempt to source credentials from environment variables, IAM roles (e.g., for EC2/Lambda), or the shared AWS credentials file.
 
 **config.ttl** (`object`): TTL (Time To Live) configuration for automatic data expiration. Configure per entity type: thread, message, trace, eval, workflow\_snapshot, resource, score. Each entity config includes: enabled (boolean), attributeName (string, default: 'ttl'), defaultTtlSeconds (number).
 

package/.docs/reference/storage/libsql.md

@@ -91,7 +91,7 @@ storage: new LibSQLStore({
 
 ## Options
 
-**url** (`string`): Database URL. Use \`:memory:\` for in-memory database, \`file:filename.db\` for a file database, or a libSQL connection string (e.g., \`libsql://your-database.turso.io\`) for remote storage.
+**url** (`string`): Database URL. Use :memory: for in-memory database, file:filename.db for a file database, or a libSQL connection string (e.g., libsql://your-database.turso.io) for remote storage.
 
 **authToken** (`string`): Authentication token for remote libSQL databases.
 

package/.docs/reference/storage/postgresql.md

@@ -45,7 +45,7 @@ const storage = new PostgresStore({
 
 **id** (`string`): Unique identifier for this storage instance.
 
-**connectionString** (`string`): PostgreSQL connection string (e.g., postgresql://user:pass\@host:5432/dbname). Required unless using \`pool\` or individual host-based parameters (\`host\`, \`port\`, \`database\`, \`user\`, \`password\`).
+**connectionString** (`string`): PostgreSQL connection string (e.g., postgresql://user:pass\@host:5432/dbname). Required unless using pool or individual host-based parameters (host, port, database, user, password).
 
 **host** (`string`): Database server hostname or IP address. Used with other host-based parameters as an alternative to connectionString.
 
@@ -57,7 +57,7 @@ const storage = new PostgresStore({
 
 **password** (`string`): Password for the database user.
 
-**pool** (`pg.Pool`): Pre-configured pg.Pool instance. Use this to reuse an existing connection pool. When provided, Mastra will not create its own pool and will not close it when \`store.close()\` is called.
+**pool** (`pg.Pool`): Pre-configured pg.Pool instance. Use this to reuse an existing connection pool. When provided, Mastra will not create its own pool and will not close it when store.close() is called.
 
 **schemaName** (`string`): The name of the schema you want the storage to use. Defaults to 'public'.
 

package/.docs/reference/storage/redis.md

@@ -69,7 +69,7 @@ const storage = new RedisStore({
 
 **id** (`string`): Unique identifier for the storage instance
 
-**connectionString** (`string`): Redis connection URL (e.g., \`redis\://localhost:6379\` or \`redis\://:password\@localhost:6379\`)
+**connectionString** (`string`): Redis connection URL (e.g., redis\://localhost:6379 or redis\://:password\@localhost:6379)
 
 **host** (`string`): Redis host address
 
@@ -79,7 +79,7 @@ const storage = new RedisStore({
 
 **db** (`number`): Redis database number (Default: `0`)
 
-**client** (`RedisClient`): Pre-configured redis client (from the \`redis\` package) for advanced setups
+**client** (`RedisClient`): Pre-configured redis client (from the redis package) for advanced setups
 
 > **Note:** You must provide either `connectionString`, `host`, or `client`. These options are mutually exclusive.
 

package/.docs/reference/storage/retention.md

@@ -55,11 +55,11 @@ Set the `retention` field on the store config.
 
 **retention** (`RetentionConfig`): Per-domain, per-table age policies. Unset domains and tables are kept forever.
 
-**retention.\[domain]** (`Record<TableKey, TableRetentionPolicy>`): A real storage domain key (e.g. \`memory\`, \`observability\`). Maps that domain's retention-eligible table keys to their policies.
+**retention.\[domain]** (`Record<TableKey, TableRetentionPolicy>`): A real storage domain key (e.g. memory, observability). Maps that domain's retention-eligible table keys to their policies.
 
 ### TableRetentionPolicy
 
-**maxAge** (`Duration`): Maximum age to keep rows. Rows whose anchor timestamp is strictly older than \`Date.now() - maxAge\` are eligible for deletion. A number is milliseconds, or a string with a unit suffix: \`ms\`, \`s\`, \`m\`, \`h\`, \`d\`, \`w\` (e.g. \`'30d'\`, \`'12h'\`).
+**maxAge** (`Duration`): Maximum age to keep rows. Rows whose anchor timestamp is strictly older than Date.now() - maxAge are eligible for deletion. A number is milliseconds, or a string with a unit suffix: ms, s, m, h, d, w (e.g. '30d', '12h').
 
 **batchSize** (`number`): Rows deleted per batch. Each batch is its own transaction, which bounds lock duration and WAL growth on large tables. (Default: `1000`)
 
@@ -122,13 +122,13 @@ Returns: `Promise<PruneResult[]>`
 
 ##### PruneOptions
 
-**maxBatches** (`number`): Maximum delete batches per table per call. When reached, that table's result is returned with \`done: false\`.
+**maxBatches** (`number`): Maximum delete batches per table per call. When reached, that table's result is returned with done: false.
 
-**maxRows** (`number`): Maximum rows deleted per table per call. When reached, that table's result is returned with \`done: false\`.
+**maxRows** (`number`): Maximum rows deleted per table per call. When reached, that table's result is returned with done: false.
 
 **pauseMs** (`number`): Delay in milliseconds between batches, to avoid starving live traffic.
 
-**signal** (`AbortSignal`): Cooperative cancellation. The batch loop checks it between batches and stops cleanly, returning partial results with \`done: false\`.
+**signal** (`AbortSignal`): Cooperative cancellation. The batch loop checks it between batches and stops cleanly, returning partial results with done: false.
 
 ##### PruneResult
 

package/.docs/reference/storage/spanner.md

@@ -49,23 +49,23 @@ The instance and database must already exist. The adapter creates the required t
 
 **id** (`string`): Unique identifier for this storage instance.
 
-**projectId** (`string`): Google Cloud project ID. Required unless \`database\` is provided.
+**projectId** (`string`): Google Cloud project ID. Required unless database is provided.
 
-**instanceId** (`string`): Cloud Spanner instance ID. Required unless \`database\` is provided.
+**instanceId** (`string`): Cloud Spanner instance ID. Required unless database is provided.
 
-**databaseId** (`string`): Cloud Spanner database ID. Required unless \`database\` is provided.
+**databaseId** (`string`): Cloud Spanner database ID. Required unless database is provided.
 
 **database** (`@google-cloud/spanner Database`): Pre-configured Spanner Database handle. Use this when you manage the Spanner client elsewhere (for example, to share auth or connection options across services).
 
-**spannerOptions** (`object`): Options forwarded to the \`@google-cloud/spanner\` client constructor. Use this to set credentials, custom endpoints, or to point at the local emulator.
+**spannerOptions** (`object`): Options forwarded to the @google-cloud/spanner client constructor. Use this to set credentials, custom endpoints, or to point at the local emulator.
 
-**disableInit** (`boolean`): When true, skip automatic table creation on first use. You must call \`storage.init()\` explicitly during a separate deploy step. (Default: `false`)
+**disableInit** (`boolean`): When true, skip automatic table creation on first use. You must call storage.init() explicitly during a separate deploy step. (Default: `false`)
 
 **skipDefaultIndexes** (`boolean`): When true, skip creation of default indexes during initialization. (Default: `false`)
 
 **indexes** (`CreateIndexOptions[]`): Custom secondary indexes to create. Each index must specify the table it belongs to. Indexes are routed to the appropriate domain based on the table name.
 
-**initMode** (`'sync' | 'validate'`): Controls schema-initialization behavior. \`'sync'\` creates missing tables, columns, and indexes during \`init()\` (the historical behavior). \`'validate'\` issues no DDL and instead verifies that every expected table, column, and default/custom index already exists, throwing a typed user error if anything is missing — useful when an external process (Terraform, Liquibase, a release pipeline, etc.) owns the schema and Mastra should only verify it. (Default: `'sync'`)
+**initMode** (`'sync' | 'validate'`): Controls schema-initialization behavior. 'sync' creates missing tables, columns, and indexes during init() (the historical behavior). 'validate' issues no DDL and instead verifies that every expected table, column, and default/custom index already exists, throwing a typed user error if anything is missing — useful when an external process (Terraform, Liquibase, a release pipeline, etc.) owns the schema and Mastra should only verify it. (Default: `'sync'`)
 
 ## Constructor examples
 

package/.docs/reference/streaming/ChunkType.md

@@ -402,7 +402,7 @@ Contains output from workflow step execution, used primarily for usage tracking
 
 ## Background task chunks
 
-Emitted when a tool call is dispatched as a [background task](https://mastra.ai/docs/agents/background-tasks) and `streamUntilIdle()` is used.
+Emitted when a tool call is dispatched as a [background task](https://mastra.ai/docs/long-running-agents/background-tasks) and `streamUntilIdle()` is used.
 
 ### background-task-started
 
@@ -540,7 +540,7 @@ When consumed by [`Agent.streamUntilIdle()`](https://mastra.ai/reference/streami
 
 **payload.agentId** (`string`): ID of the agent that dispatched the task
 
-**payload.suspendData** (`unknown`): Whatever the tool passed to \`suspend(data)\`
+**payload.suspendData** (`unknown`): Whatever the tool passed to suspend(data)
 
 ### background-task-resumed
 
@@ -614,7 +614,7 @@ Contains monitoring and observability data from agent execution. Can include wor
 
 ### goal
 
-Emitted on every evaluation of an agent [goal](https://mastra.ai/docs/agents/goals). Consumers use this to render judge progress and the result mid-run. A goal that has no judge model configured produces no `goal` chunk.
+Emitted on every evaluation of an agent [goal](https://mastra.ai/docs/long-running-agents/goals). Consumers use this to render judge progress and the result mid-run. A goal that has no judge model configured produces no `goal` chunk.
 
 **type** (`"goal"`): Chunk type identifier
 

package/.docs/reference/streaming/agents/stream.md

@@ -66,7 +66,7 @@ const stream = await agent.stream('message for agent')
 
 **options.delegation.onDelegationStart** (`(context: DelegationStartContext) => DelegationStartResult | void | Promise<DelegationStartResult | void>`): Called before delegating to a subagent. Use this to modify the delegation parameters or reject the delegation entirely.
 
-**options.delegation.onDelegationComplete** (`(context: DelegationCompleteContext) => { feedback?: string } | void | Promise<{ feedback?: string } | void>`): Called after a subagent delegation completes. The context includes a \`bail()\` method to stop further execution, and you can return \`{ feedback }\` to guide the supervisor's next action. Feedback is saved to supervisor memory as an assistant message.
+**options.delegation.onDelegationComplete** (`(context: DelegationCompleteContext) => { feedback?: string } | void | Promise<{ feedback?: string } | void>`): Called after a subagent delegation completes. The context includes a bail() method to stop further execution, and you can return { feedback } to guide the supervisor's next action. Feedback is saved to supervisor memory as an assistant message.
 
 **options.delegation.messageFilter** (`(context: MessageFilterContext) => MastraDBMessage[] | Promise<MastraDBMessage[]>`): Callback function called before delegating to a subagent. Use this to filter the messages that are passed to the subagent.
 
@@ -102,13 +102,13 @@ const stream = await agent.stream('message for agent')
 
 **options.structuredOutput.jsonPromptInjection** (`boolean`): Injects system prompt into the main agent instructing it to return structured output, useful for when a model does not natively support structured outputs.
 
-**options.structuredOutput.providerOptions** (`ProviderOptions`): Provider-specific options passed to the internal structuring agent. Use this to control model behavior like reasoning effort for thinking models (e.g., \`{ openai: { reasoningEffort: 'low' } }\`).
+**options.structuredOutput.providerOptions** (`ProviderOptions`): Provider-specific options passed to the internal structuring agent. Use this to control model behavior like reasoning effort for thinking models (e.g., { openai: { reasoningEffort: 'low' } }).
 
-**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.includeRawChunks** (`boolean`): Whether to include raw chunks in the stream output (not available on all model providers).
 
-**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.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.
 
@@ -118,7 +118,7 @@ const stream = await agent.stream('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.
 
@@ -170,23 +170,23 @@ const stream = await agent.stream('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 stream step completes (default: false).
 
-**options.requireToolApproval** (`boolean`): When true, all tool calls require explicit approval before execution. The stream will emit \`tool-call-approval\` chunks and pause until \`approveToolCall()\` or \`declineToolCall()\` is called.
+**options.requireToolApproval** (`boolean`): When true, all tool calls require explicit approval before execution. The stream will emit tool-call-approval chunks and pause until approveToolCall() or declineToolCall() is called.
 
-**options.autoResumeSuspendedTools** (`boolean`): When true, automatically resumes suspended tools when the user sends a new message on the same thread. The agent extracts \`resumeData\` from the user's message based on the tool's \`resumeSchema\`. Requires memory to be configured.
+**options.autoResumeSuspendedTools** (`boolean`): When true, automatically resumes suspended tools when the user sends a new message on the same thread. The agent extracts resumeData from the user's message based on the tool's resumeSchema. Requires memory to be configured.
 
 **options.toolCallConcurrency** (`number`): Maximum number of tool calls to execute concurrently. Defaults to 1 when approval may be required, otherwise 10.
 
-**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 } }\`. For example: \`{ openai: { reasoningEffort: 'high' }, anthropic: { maxTokens: 1000 } }\`.
+**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 } }. For example: { openai: { reasoningEffort: 'high' }, anthropic: { maxTokens: 1000 } }.
 
-**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.
 
@@ -210,7 +210,7 @@ const stream = await agent.stream('message for agent')
 
 **options.tracingOptions.tags** (`string[]`): Tags to apply to this trace. String labels for categorizing and filtering traces.
 
-**options.versions** (`VersionOverrides`): Per-invocation version overrides for sub-agent delegation. Merged on top of Mastra instance-level versions and propagated automatically through sub-agent calls via requestContext. Requires the editor package. See \[Sub-agent versioning]\(/docs/editor/overview#sub-agent-versioning).
+**options.versions** (`VersionOverrides`): Per-invocation version overrides for sub-agent delegation. Merged on top of Mastra instance-level versions and propagated automatically through sub-agent calls via requestContext. Requires the editor package. See Sub-agent versioning.
 
 **options.versions.agents** (`Record<string, VersionSelector>`): A map of agent IDs to their version selectors.
 
@@ -218,7 +218,7 @@ const stream = await agent.stream('message for agent')
 
 **options.versions.agents.status** (`'draft' | 'published'`): Target the latest version with this publication status.
 
-**options.untilIdle** (`boolean | { maxIdleMs?: number }`): When set, keeps the stream open across background-task continuations. The agent will automatically re-invoke the LLM when background tasks complete, streaming continuation turns through the same \`fullStream\`. Pass \`true\` for default settings (5 min idle timeout), or an object with \`maxIdleMs\` to configure. Requires memory. Replaces the standalone \`streamUntilIdle()\` method.
+**options.untilIdle** (`boolean | { maxIdleMs?: number }`): When set, keeps the stream open across background-task continuations. The agent will automatically re-invoke the LLM when background tasks complete, streaming continuation turns through the same fullStream. Pass true for default settings (5 min idle timeout), or an object with maxIdleMs to configure. Requires memory. Replaces the standalone streamUntilIdle() method.
 
 **options.untilIdle.maxIdleMs** (`number`): Closes the outer stream after this many ms of idleness between turns. The timer only runs while the wrapper is between turns. Default: 5 minutes.
 

package/.docs/reference/streaming/agents/streamLegacy.md

@@ -30,7 +30,7 @@ await agent.streamLegacy('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.
 
@@ -40,7 +40,7 @@ await agent.streamLegacy('message for agent')
 
 **options.maxRetries** (`number`): Maximum number of retries. Set to 0 to disable retries.
 
-**options.memoryOptions** (`MemoryConfig`): \*\*Deprecated.\*\* Use \`memory.options\` instead. Configuration options for memory management.
+**options.memoryOptions** (`MemoryConfig`): \*\*Deprecated.\*\* Use memory.options instead. Configuration options for memory management.
 
 **options.memoryOptions.lastMessages** (`number | false`): Number of recent messages to include in context, or false to disable.
 
@@ -54,7 +54,7 @@ await agent.streamLegacy('message for agent')
 
 **options.onStepFinish** (`StreamTextOnStepFinishCallback<any> | never`): Callback function called after each execution step. Receives step details as a JSON string. Unavailable for structured output
 
-**options.resourceId** (`string`): \*\*Deprecated.\*\* Use \`memory.resource\` instead. Identifier for the user or resource interacting with the agent. Must be provided if threadId is provided.
+**options.resourceId** (`string`): \*\*Deprecated.\*\* Use memory.resource instead. Identifier for the user or resource interacting with the agent. Must be provided if threadId is provided.
 
 **options.telemetry** (`TelemetrySettings`): Settings for telemetry collection during streaming.
 
@@ -68,7 +68,7 @@ await agent.streamLegacy('message for agent')
 
 **options.temperature** (`number`): Controls randomness in the model's output. Higher values (e.g., 0.8) make the output more random, lower values (e.g., 0.2) make it more focused and deterministic.
 
-**options.threadId** (`string`): \*\*Deprecated.\*\* Use \`memory.thread\` instead. Identifier for the conversation thread. Allows for maintaining context across multiple interactions. Must be provided if resourceId is provided.
+**options.threadId** (`string`): \*\*Deprecated.\*\* Use memory.thread instead. Identifier for the conversation thread. Allows for maintaining context across multiple interactions. Must be provided if resourceId is provided.
 
 **options.toolChoice** (`'auto' | 'none' | 'required' | { type: 'tool'; toolName: string }`): Controls how the agent uses tools during streaming.
 
@@ -84,17 +84,17 @@ await agent.streamLegacy('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 stream step completes (default: false).
 
-**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 } }\`. For example: \`{ openai: { reasoningEffort: 'high' }, anthropic: { maxTokens: 1000 } }\`.
+**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 } }. For example: { openai: { reasoningEffort: 'high' }, anthropic: { maxTokens: 1000 } }.
 
-**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.streamLegacy('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.
 

package/.docs/reference/streaming/agents/streamUntilIdle.md

@@ -101,7 +101,7 @@ for await (const chunk of stream.fullStream) {
 
 ## Related
 
-- [Background tasks](https://mastra.ai/docs/agents/background-tasks)
+- [Background tasks](https://mastra.ai/docs/long-running-agents/background-tasks)
 - [`Agent.stream()` reference](https://mastra.ai/reference/streaming/agents/stream)
 - [backgroundTasks configuration reference](https://mastra.ai/reference/configuration)
 - [Stream chunk types](https://mastra.ai/reference/streaming/ChunkType)

package/.docs/reference/streaming/workflows/resumeStream.md

@@ -34,7 +34,7 @@ if (result!.status === 'suspended') {
 
 **step** (`Step<string, any, any, any, any, TEngineType>`): The step to resume execution from
 
-**forEachIndex** (`number`): Target a specific iteration of a suspended \`.foreach()\` step. Pass the zero-based index of the iteration to resume; other iterations remain suspended. Omit 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 to resume; other iterations remain suspended. Omit to resume all suspended iterations of the step with the same resumeData.
 
 **tracingOptions** (`TracingOptions`): Options for Tracing configuration.