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

package/.docs/models/providers/friendli.md

@@ -2,7 +2,7 @@
 
 # ![Friendli logo](https://models.dev/logos/friendli.svg)Friendli
 
-Access 7 Friendli models through Mastra's model router. Authentication is handled automatically using the `FRIENDLI_TOKEN` environment variable.
+Access 6 Friendli models through Mastra's model router. Authentication is handled automatically using the `FRIENDLI_TOKEN` environment variable.
 
 Learn more in the [Friendli documentation](https://friendli.ai/docs/guides/serverless_endpoints/introduction).
 
@@ -40,7 +40,6 @@ for await (const chunk of stream) {
 | `friendli/google/gemma-4-31B-it`              | 262K    |       |           |       |       |       | $0.14      | $0.40       |
 | `friendli/MiniMaxAI/MiniMax-M2.5`             | 197K    |       |           |       |       |       | $0.30      | $1          |
 | `friendli/Qwen/Qwen3-235B-A22B-Instruct-2507` | 262K    |       |           |       |       |       | $0.20      | $0.80       |
-| `friendli/zai-org/GLM-5`                      | 203K    |       |           |       |       |       | $1         | $3          |
 | `friendli/zai-org/GLM-5.1`                    | 203K    |       |           |       |       |       | $1         | $4          |
 | `friendli/zai-org/GLM-5.2`                    | 1.0M    |       |           |       |       |       | $1         | $4          |
 

package/.docs/models/providers/nvidia.md

@@ -2,7 +2,7 @@
 
 # ![Nvidia logo](https://models.dev/logos/nvidia.svg)Nvidia
 
-Access 83 Nvidia models through Mastra's model router. Authentication is handled automatically using the `NVIDIA_API_KEY` environment variable.
+Access 84 Nvidia models through Mastra's model router. Authentication is handled automatically using the `NVIDIA_API_KEY` environment variable.
 
 Learn more in the [Nvidia documentation](https://docs.api.nvidia.com/nim/).
 
@@ -119,6 +119,7 @@ for await (const chunk of stream) {
 | `nvidia/stepfun-ai/step-3.5-flash`                     | 256K    |       |           |       |       |       | —          | —           |
 | `nvidia/stepfun-ai/step-3.7-flash`                     | 256K    |       |           |       |       |       | —          | —           |
 | `nvidia/upstage/solar-10_7b-instruct`                  | 128K    |       |           |       |       |       | —          | —           |
+| `nvidia/z-ai/glm-5.2`                                  | 1.0M    |       |           |       |       |       | —          | —           |
 
 ## Advanced configuration
 
@@ -148,7 +149,7 @@ const agent = new Agent({
   model: ({ requestContext }) => {
     const useAdvanced = requestContext.task === "complex";
     return useAdvanced
-      ? "nvidia/upstage/solar-10_7b-instruct"
+      ? "nvidia/z-ai/glm-5.2"
       : "nvidia/abacusai/dracarys-llama-3_1-70b-instruct";
   }
 });

package/.docs/models/providers/tencent-token-plan.md

@@ -17,7 +17,7 @@ const agent = new Agent({
   id: "my-agent",
   name: "My Agent",
   instructions: "You are a helpful assistant",
-  model: "tencent-token-plan/hy3-preview"
+  model: "tencent-token-plan/hy3"
 });
 
 // Generate a response
@@ -34,9 +34,9 @@ for await (const chunk of stream) {
 
 ## Models
 
-| Model                            | Context | Tools | Reasoning | Image | Audio | Video | Input $/1M | Output $/1M |
-| -------------------------------- | ------- | ----- | --------- | ----- | ----- | ----- | ---------- | ----------- |
-| `tencent-token-plan/hy3-preview` | 256K    |       |           |       |       |       | —          | —           |
+| Model                    | Context | Tools | Reasoning | Image | Audio | Video | Input $/1M | Output $/1M |
+| ------------------------ | ------- | ----- | --------- | ----- | ----- | ----- | ---------- | ----------- |
+| `tencent-token-plan/hy3` | 256K    |       |           |       |       |       | —          | —           |
 
 ## Advanced configuration
 
@@ -48,7 +48,7 @@ const agent = new Agent({
   name: "custom-agent",
   model: {
     url: "https://api.lkeap.cloud.tencent.com/plan/v3",
-    id: "tencent-token-plan/hy3-preview",
+    id: "tencent-token-plan/hy3",
     apiKey: process.env.TENCENT_TOKEN_PLAN_API_KEY,
     headers: {
       "X-Custom-Header": "value"
@@ -66,8 +66,8 @@ const agent = new Agent({
   model: ({ requestContext }) => {
     const useAdvanced = requestContext.task === "complex";
     return useAdvanced
-      ? "tencent-token-plan/hy3-preview"
-      : "tencent-token-plan/hy3-preview";
+      ? "tencent-token-plan/hy3"
+      : "tencent-token-plan/hy3";
   }
 });
 ```

package/.docs/models/providers/tencent-tokenhub.md

@@ -2,7 +2,7 @@
 
 # ![Tencent TokenHub logo](https://models.dev/logos/tencent-tokenhub.svg)Tencent TokenHub
 
-Access 1 Tencent TokenHub model through Mastra's model router. Authentication is handled automatically using the `TENCENT_TOKENHUB_API_KEY` environment variable.
+Access 2 Tencent TokenHub models through Mastra's model router. Authentication is handled automatically using the `TENCENT_TOKENHUB_API_KEY` environment variable.
 
 Learn more in the [Tencent TokenHub documentation](https://cloud.tencent.com/document/product/1823/130050).
 
@@ -17,7 +17,7 @@ const agent = new Agent({
   id: "my-agent",
   name: "My Agent",
   instructions: "You are a helpful assistant",
-  model: "tencent-tokenhub/hy3-preview"
+  model: "tencent-tokenhub/hy3"
 });
 
 // Generate a response
@@ -36,6 +36,7 @@ for await (const chunk of stream) {
 
 | Model                          | Context | Tools | Reasoning | Image | Audio | Video | Input $/1M | Output $/1M |
 | ------------------------------ | ------- | ----- | --------- | ----- | ----- | ----- | ---------- | ----------- |
+| `tencent-tokenhub/hy3`         | 256K    |       |           |       |       |       | —          | —           |
 | `tencent-tokenhub/hy3-preview` | 256K    |       |           |       |       |       | —          | —           |
 
 ## Advanced configuration
@@ -48,7 +49,7 @@ const agent = new Agent({
   name: "custom-agent",
   model: {
     url: "https://tokenhub.tencentmaas.com/v1",
-    id: "tencent-tokenhub/hy3-preview",
+    id: "tencent-tokenhub/hy3",
     apiKey: process.env.TENCENT_TOKENHUB_API_KEY,
     headers: {
       "X-Custom-Header": "value"
@@ -67,7 +68,7 @@ const agent = new Agent({
     const useAdvanced = requestContext.task === "complex";
     return useAdvanced
       ? "tencent-tokenhub/hy3-preview"
-      : "tencent-tokenhub/hy3-preview";
+      : "tencent-tokenhub/hy3";
   }
 });
 ```

package/.docs/models/providers.md

@@ -114,6 +114,7 @@ Direct access to individual AI model providers. Each provider offers unique mode
 - [submodel](https://mastra.ai/models/providers/submodel)
 - [Synthetic](https://mastra.ai/models/providers/synthetic)
 - [Tencent Coding Plan (China)](https://mastra.ai/models/providers/tencent-coding-plan)
+- [Tencent Token Plan](https://mastra.ai/models/providers/tencent-token-plan)
 - [Tencent TokenHub](https://mastra.ai/models/providers/tencent-tokenhub)
 - [The Grid AI](https://mastra.ai/models/providers/the-grid-ai)
 - [Tinfoil](https://mastra.ai/models/providers/tinfoil)

package/.docs/reference/acp/acp-agent.md

@@ -54,7 +54,7 @@ export const claudeCodeAgent = new AcpAgent({
 
 **id** (`string`): Unique identifier for the subagent.
 
-**name** (`string`): Display name used during agent delegation. Defaults to \`id\`.
+**name** (`string`): Display name used during agent delegation. Defaults to id.
 
 **description** (`string`): Description shown to the model when it can delegate to this subagent.
 
@@ -66,19 +66,19 @@ export const claudeCodeAgent = new AcpAgent({
 
 **cwd** (`string`): Working directory for the ACP process and ACP session. Also used as the default local filesystem base path. (Default: `process.cwd()`)
 
-**session** (`Partial<NewSessionRequest>`): ACP session creation options. Defaults to \`cwd\` or \`process.cwd()\` and an empty MCP server list.
+**session** (`Partial<NewSessionRequest>`): ACP session creation options. Defaults to cwd or process.cwd() and an empty MCP server list.
 
 **initialize** (`Partial<InitializeRequest>`): ACP initialization options. Defaults to Mastra client information, the current ACP protocol version, and read/write filesystem capabilities.
 
 **authMethodId** (`string`): ACP authentication method ID to invoke after initialization and before session creation.
 
-**persistSession** (`boolean`): Whether to keep the ACP process and session alive after each prompt. Set to \`false\` to stop the process after each prompt completes. (Default: `true`)
+**persistSession** (`boolean`): Whether to keep the ACP process and session alive after each prompt. Set to false to stop the process after each prompt completes. (Default: `true`)
 
 **onPermissionRequest** (`(request: RequestPermissionRequest) => Promise<RequestPermissionResponse>`): Callback invoked when the ACP agent requests permission. Defaults to selecting the first permission option, or cancelling when no option is available.
 
-**workspace** (`Workspace`): Workspace used for ACP file read and write requests. Defaults to a \`Workspace\` backed by \`LocalFilesystem\` at \`cwd\` or \`process.cwd()\`.
+**workspace** (`Workspace`): Workspace used for ACP file read and write requests. Defaults to a Workspace backed by LocalFilesystem at cwd or process.cwd().
 
-**model** (`ModelId`): Model ID to select after ACP session creation using the ACP \`session/set\_model\` method.
+**model** (`ModelId`): Model ID to select after ACP session creation using the ACP session/set\_model method.
 
 ## Properties
 

package/.docs/reference/acp/create-acp-tool.md

@@ -47,19 +47,19 @@ export const codeSupervisor = new Agent({
 
 **cwd** (`string`): Working directory for the ACP process and ACP session. Also used as the default local filesystem base path. (Default: `process.cwd()`)
 
-**session** (`Partial<NewSessionRequest>`): ACP session creation options. Defaults to \`cwd\` or \`process.cwd()\` and an empty MCP server list.
+**session** (`Partial<NewSessionRequest>`): ACP session creation options. Defaults to cwd or process.cwd() and an empty MCP server list.
 
 **initialize** (`Partial<InitializeRequest>`): ACP initialization options. Defaults to Mastra client information, the current ACP protocol version, and read/write filesystem capabilities.
 
 **authMethodId** (`string`): ACP authentication method ID to invoke after initialization and before session creation.
 
-**persistSession** (`boolean`): Whether the ACP connection created for a tool execution disconnects after the prompt. Set to \`false\` to stop the process after each prompt completes. (Default: `true`)
+**persistSession** (`boolean`): Whether the ACP connection created for a tool execution disconnects after the prompt. Set to false to stop the process after each prompt completes. (Default: `true`)
 
 **onPermissionRequest** (`(request: RequestPermissionRequest) => Promise<RequestPermissionResponse>`): Callback invoked when the ACP agent requests permission. Defaults to selecting the first permission option, or cancelling when no option is available.
 
-**workspace** (`Workspace`): Workspace option from the shared ACP connection options. During tool execution, \`createACPTool()\` passes the current Mastra workspace from the execution context when one is available; otherwise the ACP connection falls back to a local filesystem workspace. Use \`AcpAgent\` when you need to provide an explicit workspace instance.
+**workspace** (`Workspace`): Workspace option from the shared ACP connection options. During tool execution, createACPTool() passes the current Mastra workspace from the execution context when one is available; otherwise the ACP connection falls back to a local filesystem workspace. Use AcpAgent when you need to provide an explicit workspace instance.
 
-**model** (`ModelId`): Model ID to select after ACP session creation using the ACP \`session/set\_model\` method.
+**model** (`ModelId`): Model ID to select after ACP session creation using the ACP session/set\_model method.
 
 ## Input schema
 
@@ -79,7 +79,7 @@ export const codeSupervisor = new Agent({
 
 ### Resume payload
 
-**optionId** (`string`): Permission option ID to select when resuming with \`outcome: "selected"\`.
+**optionId** (`string`): Permission option ID to select when resuming with outcome: "selected".
 
 **outcome** (`"selected" | "cancelled"`): Permission decision used to continue or cancel the ACP request.
 

package/.docs/reference/agent-controller/agent-controller-class.md

@@ -52,7 +52,7 @@ await agentController.sendMessage({ content: 'Hello!' })
 
 **id** (`string`): Unique identifier for this agentController instance.
 
-**resourceId** (`string`): Resource ID for grouping threads (e.g., project identifier). Threads are scoped to this resource ID. Defaults to \`id\`.
+**resourceId** (`string`): Resource ID for grouping threads (e.g., project identifier). Threads are scoped to this resource ID. Defaults to id.
 
 **storage** (`MastraCompositeStore`): Storage backend for persistence (threads, messages, state).
 
@@ -62,35 +62,35 @@ await agentController.sendMessage({ content: 'Hello!' })
 
 **memory** (`MastraMemory`): Memory configuration shared across all modes. Propagated to mode agents that don't have their own memory.
 
-**modes** (`AgentControllerMode[]`): Available agent modes. At least one mode is required. When a top-level \`agent\` is provided, each mode layers its own instructions and tool overrides on top of the shared agent.
+**modes** (`AgentControllerMode[]`): Available agent modes. At least one mode is required. When a top-level agent is provided, each mode layers its own instructions and tool overrides on top of the shared agent.
 
-**modes.id** (`string`): Unique identifier for this mode (e.g., \`"plan"\`, \`"build"\`).
+**modes.id** (`string`): Unique identifier for this mode (e.g., "plan", "build").
 
 **modes.name** (`string`): Human-readable name for display.
 
-**modes.default** (`boolean`): Whether this is the default mode when the agentController starts. Deprecated in favor of \`metadata.default\` or the top-level \`defaultModeId\`.
+**modes.default** (`boolean`): Whether this is the default mode when the agentController starts. Deprecated in favor of metadata.default or the top-level defaultModeId.
 
-**modes.defaultModelId** (`string`): Default model ID for this mode (e.g., \`"anthropic/claude-sonnet-4-20250514"\`). Used when no per-mode model has been explicitly selected.
+**modes.defaultModelId** (`string`): Default model ID for this mode (e.g., "anthropic/claude-sonnet-4-20250514"). Used when no per-mode model has been explicitly selected.
 
 **modes.description** (`string`): Description surfaced in mode pickers and Studio UI.
 
 **modes.instructions** (`string`): Additional instructions layered above the backing agent's own instructions for this mode.
 
-**modes.transitionsTo** (`string`): Target mode ID to switch to on \`submit\_plan\` approval. Must reference another mode's \`id\`.
+**modes.transitionsTo** (`string`): Target mode ID to switch to on submit\_plan approval. Must reference another mode's id.
 
-**modes.metadata** (`Record<string, unknown>`): Arbitrary metadata. \`metadata.default === true\` marks the default mode when \`defaultModeId\` is unset.
+**modes.metadata** (`Record<string, unknown>`): Arbitrary metadata. metadata.default === true marks the default mode when defaultModeId is unset.
 
-**modes.tools** (`ToolsInput`): Replaces the backing agent's tools for this mode. Mutually exclusive with \`additionalTools\`.
+**modes.tools** (`ToolsInput`): Replaces the backing agent's tools for this mode. Mutually exclusive with additionalTools.
 
-**modes.additionalTools** (`ToolsInput`): Tools layered on top of the backing agent's tools. Mutually exclusive with \`tools\`.
+**modes.additionalTools** (`ToolsInput`): Tools layered on top of the backing agent's tools. Mutually exclusive with tools.
 
-**modes.availableTools** (`string[]`): Per-mode tool visibility allowlist. When set, only tools whose final exposed names appear in this list are visible to the model and executable during this mode's runs. \`undefined\` = all tools visible; \`\[]\` = no tools. Per-tool and per-category \`deny\` rules take precedence over this list. Workspace tools use the same list — reference them by exposed names (\`view\`, \`write\_file\`, etc.).
+**modes.availableTools** (`string[]`): Per-mode tool visibility allowlist. When set, only tools whose final exposed names appear in this list are visible to the model and executable during this mode's runs. undefined = all tools visible; \[] = no tools. Per-tool and per-category deny rules take precedence over this list. Workspace tools use the same list — reference them by exposed names (view, write\_file, etc.).
 
-**modes.agent** (`Agent`): The agent for this mode. Deprecated in favor of the top-level \`agent\` config with mode-level overrides.
+**modes.agent** (`Agent`): The agent for this mode. Deprecated in favor of the top-level agent config with mode-level overrides.
 
 **agent** (`Agent`): Shared backing agent that each mode forks and decorates. When provided, modes layer instructions and tool overrides on top of this agent instead of providing their own.
 
-**defaultModeId** (`string`): Default mode to enter when a thread has no persisted mode. Takes precedence over \`metadata.default\` on individual modes.
+**defaultModeId** (`string`): Default mode to enter when a thread has no persisted mode. Takes precedence over metadata.default on individual modes.
 
 **instructions** (`string`): Base instructions shared across all modes. Appended to the backing agent's instructions.
 
@@ -100,9 +100,9 @@ await agentController.sendMessage({ content: 'Hello!' })
 
 **browser** (`MastraBrowser | ((ctx) => MastraBrowser)`): Browser automation instance or a dynamic factory function. When omitted, each session created via createSession can provide its own browser.
 
-**subagents** (`AgentControllerSubagent[]`): Subagent definitions. When provided, the agentController creates a built-in \`subagent\` tool that parent agents can call to spawn focused subagents.
+**subagents** (`AgentControllerSubagent[]`): Subagent definitions. When provided, the agentController creates a built-in subagent tool that parent agents can call to spawn focused subagents.
 
-**subagents.id** (`string`): Unique identifier for this subagent type (e.g., \`"explore"\`, \`"execute"\`).
+**subagents.id** (`string`): Unique identifier for this subagent type (e.g., "explore", "execute").
 
 **subagents.name** (`string`): Human-readable name shown in tool output.
 
@@ -112,43 +112,43 @@ await agentController.sendMessage({ content: 'Hello!' })
 
 **subagents.tools** (`ToolsInput`): Tools this subagent has direct access to.
 
-**subagents.allowedAgentControllerTools** (`string[]`): Tool IDs from the agentController's shared \`tools\` config. Merged with \`tools\` above to let subagents use a subset of agentController tools.
+**subagents.allowedAgentControllerTools** (`string[]`): Tool IDs from the agentController's shared tools config. Merged with tools above to let subagents use a subset of agentController tools.
 
 **subagents.allowedWorkspaceTools** (`string[]`): Workspace tool names the subagent is allowed to use. Uses the exposed names (after any renames via workspace tool config). When set, workspace tools not in this list are hidden from the model. Non-workspace tools are never affected. When omitted, all workspace tools are visible.
 
 **subagents.defaultModelId** (`string`): Default model ID for this subagent type.
 
-**subagents.maxSteps** (`number`): Optional maximum number of steps for the spawned subagent. Defaults to \`50\` when omitted.
+**subagents.maxSteps** (`number`): Optional maximum number of steps for the spawned subagent. Defaults to 50 when omitted.
 
 **subagents.stopWhen** (`LoopOptions['stopWhen']`): Optional stop condition for the spawned subagent.
 
-**subagents.forked** (`boolean`): When \`true\`, calls to this subagent default to forked mode: the subagent runs on a clone of the parent thread, reusing the parent agent’s instructions, tools, and model so the prompt-cache prefix stays intact. Requires \`memory\` to be configured. The subagent definition’s own \`instructions\`, \`tools\`, \`allowedAgentControllerTools\`, \`allowedWorkspaceTools\`, \`defaultModelId\`, \`maxSteps\`, and \`stopWhen\` are ignored in forked mode. Callers can still override per-invocation via \`forked: false\` in the \`subagent\` tool input. See the \[Forked subagents]\(#forked-subagents) section below for full semantics.
+**subagents.forked** (`boolean`): When true, calls to this subagent default to forked mode: the subagent runs on a clone of the parent thread, reusing the parent agent’s instructions, tools, and model so the prompt-cache prefix stays intact. Requires memory to be configured. The subagent definition’s own instructions, tools, allowedAgentControllerTools, allowedWorkspaceTools, defaultModelId, maxSteps, and stopWhen are ignored in forked mode. Callers can still override per-invocation via forked: false in the subagent tool input. See the Forked subagents section below for full semantics.
 
-**resolveModel** (`(modelId: string) => MastraLanguageModel`): Converts a model ID string (e.g., \`"anthropic/claude-sonnet-4"\`) to a language model instance. Used by subagents and observational memory model resolution.
+**resolveModel** (`(modelId: string) => MastraLanguageModel`): Converts a model ID string (e.g., "anthropic/claude-sonnet-4") to a language model instance. Used by subagents and observational memory model resolution.
 
 **omConfig** (`AgentControllerOMConfig`): Default configuration for observational memory (observer/reflector model IDs and thresholds).
 
-**disableBuiltinTools** (`BuiltinToolId[]`): Built-in tool IDs to remove from the \`controllerBuiltIn\` toolset. Valid values are \`ask\_user\`, \`submit\_plan\`, \`task\_write\`, \`task\_update\`, \`task\_complete\`, \`task\_check\`, and \`subagent\`.
+**disableBuiltinTools** (`BuiltinToolId[]`): Built-in tool IDs to remove from the controllerBuiltIn toolset. Valid values are ask\_user, submit\_plan, task\_write, task\_update, task\_complete, task\_check, and subagent.
 
-**intervalHandlers** (`IntervalHandler[]`): Periodic background tasks started during \`init()\`. Use for gateway sync, cache refresh, and similar tasks.
+**intervalHandlers** (`IntervalHandler[]`): Periodic background tasks started during init(). Use for gateway sync, cache refresh, and similar tasks.
 
 **idGenerator** (`() => string`): Custom ID generator for AgentController-managed IDs such as threads and mode-run identifiers. (Default: `timestamp + random string`)
 
-**modelAuthChecker** (`ModelAuthChecker`): Custom auth checker for model providers. Return \`true\`/\`false\` to override the default environment variable check, or \`undefined\` to fall back to defaults.
+**modelAuthChecker** (`ModelAuthChecker`): Custom auth checker for model providers. Return true/false to override the default environment variable check, or undefined to fall back to defaults.
 
-**modelUseCountProvider** (`ModelUseCountProvider`): Provides per-model use counts for sorting and display in \`listAvailableModels()\`.
+**modelUseCountProvider** (`ModelUseCountProvider`): Provides per-model use counts for sorting and display in listAvailableModels().
 
-**modelUseCountTracker** (`ModelUseCountTracker`): Callback invoked when a model is selected via \`session.model.switch()\`. Use to track and persist model usage for ranking.
+**modelUseCountTracker** (`ModelUseCountTracker`): Callback invoked when a model is selected via session.model.switch(). Use to track and persist model usage for ranking.
 
-**customModelCatalogProvider** (`CustomModelCatalogProvider`): Catalog hook for additional models (e.g., user-defined custom providers). Returned entries are merged into \`listAvailableModels()\`.
+**customModelCatalogProvider** (`CustomModelCatalogProvider`): Catalog hook for additional models (e.g., user-defined custom providers). Returned entries are merged into listAvailableModels().
 
-**gateways** (`MastraModelGatewayInterface[]`): Model gateways registered on the internal Mastra instance. Apps that need gateway-backed model resolution should also provide \`resolveModel\`.
+**gateways** (`MastraModelGatewayInterface[]`): Model gateways registered on the internal Mastra instance. Apps that need gateway-backed model resolution should also provide resolveModel.
 
-**toolCategoryResolver** (`(toolName: string) => ToolCategory | null`): Maps tool names to permission categories (\`'read'\`, \`'edit'\`, \`'execute'\`, \`'mcp'\`, \`'other'\`). Used by the permission system to resolve category-level policies.
+**toolCategoryResolver** (`(toolName: string) => ToolCategory | null`): Maps tool names to permission categories ('read', 'edit', 'execute', 'mcp', 'other'). Used by the permission system to resolve category-level policies.
 
 **pubsub** (`PubSub`): PubSub instance used by the internal Mastra instance and mode agents for event coordination.
 
-**threadLock** (`{ acquire, release }`): Thread locking callbacks to prevent concurrent access from multiple processes. \`acquire\` should throw if the lock is held.
+**threadLock** (`{ acquire, release }`): Thread locking callbacks to prevent concurrent access from multiple processes. acquire should throw if the lock is held.
 
 **observability** (`ObservabilityEntrypoint`): Observability entrypoint for tracing, scoring, and feedback. When provided, the internal Mastra instance produces trace spans for agent runs.
 

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

@@ -178,27 +178,27 @@ The UI sees the message contents and can also read `attributes` and `metadata` o
 
 Sends a user message to an active run or memory thread. Use this when the active agent should receive the message immediately.
 
-**message** (`string | Array<TextPart | FilePart> | { contents: string | Array<TextPart | FilePart>; attributes?: Record<string, JSONValue>; metadata?: Record<string, unknown>; providerOptions?: ProviderMetadata }`): User-authored input. Bare strings and parts without attributes are sent to the model as normal user input. When \`attributes\` are present, Mastra renders the message as a \`\<user>\` XML element with the attributes included.
+**message** (`string | Array<TextPart | FilePart> | { contents: string | Array<TextPart | FilePart>; attributes?: Record<string, JSONValue>; metadata?: Record<string, unknown>; providerOptions?: ProviderMetadata }`): User-authored input. Bare strings and parts without attributes are sent to the model as normal user input. When attributes are present, Mastra renders the message as a \<user> XML element with the attributes included.
 
 **options** (`object`): Targeting and delivery behavior for the message.
 
 **options.runId** (`string`): Run ID to target directly. Use this when you already know the active run ID.
 
-**options.resourceId** (`string`): Resource ID for the memory thread. Required with \`threadId\` for thread-targeted messages.
+**options.resourceId** (`string`): Resource ID for the memory thread. Required with threadId for thread-targeted messages.
 
-**options.threadId** (`string`): Thread ID to target. Required with \`resourceId\` for thread-targeted messages.
+**options.threadId** (`string`): Thread ID to target. Required with resourceId for thread-targeted messages.
 
 **options.ifActive** (`object`): Controls what happens when the target thread is active.
 
-**options.ifActive.behavior** (`'deliver' | 'persist' | 'discard'`): Controls what happens when the target thread is active. Defaults to \`deliver\`.
+**options.ifActive.behavior** (`'deliver' | 'persist' | 'discard'`): Controls what happens when the target thread is active. Defaults to deliver.
 
 **options.ifActive.attributes** (`Record<string, string | number | boolean>`): Attributes merged into the message when Mastra accepts it while the target thread is active.
 
 **options.ifIdle** (`object`): Controls what happens when the target thread is idle.
 
-**options.ifIdle.behavior** (`'wake' | 'persist' | 'discard'`): Controls what happens when the target thread is idle. Defaults to \`wake\`.
+**options.ifIdle.behavior** (`'wake' | 'persist' | 'discard'`): Controls what happens when the target thread is idle. Defaults to wake.
 
-**options.ifIdle.streamOptions** (`AgentExecutionOptions`): Options for the stream that starts when \`ifIdle.behavior\` is \`wake\`. Mastra uses the top-level \`resourceId\` and \`threadId\` for memory context.
+**options.ifIdle.streamOptions** (`AgentExecutionOptions`): Options for the stream that starts when ifIdle.behavior is wake. Mastra uses the top-level resourceId and threadId for memory context.
 
 **options.ifIdle.attributes** (`Record<string, string | number | boolean>`): Attributes merged into the message when Mastra accepts it while the target thread is idle.
 
@@ -236,27 +236,27 @@ agent.queueMessage('Also check whether the tests need updates.', {
 
 Sends a signal to an active run or memory thread.
 
-**signal** (`{ type: 'user' | 'state' | 'reactive' | 'notification' | 'user-message' | 'system-reminder'; tagName?: string; contents: string | Array<TextPart | FilePart>; attributes?: Record<string, JSONValue>; metadata?: Record<string, unknown>; providerOptions?: ProviderMetadata }`): Signal context to send to the thread. \`type\` is the semantic signal category. \`tagName\` controls the XML tag the model sees. For example, \`{ type: 'notification', tagName: 'github-review' }\` renders as \`\<github-review>...\</github-review>\`. Legacy \`user-message\` and \`system-reminder\` payloads are still accepted and normalized. Unknown \`type\` values are rejected; use \`tagName\` for custom XML tags.
+**signal** (`{ type: 'user' | 'state' | 'reactive' | 'notification' | 'user-message' | 'system-reminder'; tagName?: string; contents: string | Array<TextPart | FilePart>; attributes?: Record<string, JSONValue>; metadata?: Record<string, unknown>; providerOptions?: ProviderMetadata }`): Signal context to send to the thread. type is the semantic signal category. tagName controls the XML tag the model sees. For example, { type: 'notification', tagName: 'github-review' } renders as \<github-review>...\</github-review>. Legacy user-message and system-reminder payloads are still accepted and normalized. Unknown type values are rejected; use tagName for custom XML tags.
 
 **options** (`object`): Targeting and delivery behavior for the signal.
 
 **options.runId** (`string`): Run ID to target directly. Use this when you already know the active run ID.
 
-**options.resourceId** (`string`): Resource ID for the memory thread. Required with \`threadId\` for thread-targeted signals.
+**options.resourceId** (`string`): Resource ID for the memory thread. Required with threadId for thread-targeted signals.
 
-**options.threadId** (`string`): Thread ID to target. Required with \`resourceId\` for thread-targeted signals.
+**options.threadId** (`string`): Thread ID to target. Required with resourceId for thread-targeted signals.
 
 **options.ifActive** (`object`): Controls what happens when the target thread is active.
 
-**options.ifActive.behavior** (`'deliver' | 'persist' | 'discard'`): Controls what happens when the target thread is active. Defaults to \`deliver\`.
+**options.ifActive.behavior** (`'deliver' | 'persist' | 'discard'`): Controls what happens when the target thread is active. Defaults to deliver.
 
 **options.ifActive.attributes** (`Record<string, string | number | boolean>`): Attributes merged into the signal when Mastra accepts it while the target thread is active.
 
 **options.ifIdle** (`object`): Controls what happens when the target thread is idle.
 
-**options.ifIdle.behavior** (`'wake' | 'persist' | 'discard'`): Controls what happens when the target thread is idle. Defaults to \`wake\`.
+**options.ifIdle.behavior** (`'wake' | 'persist' | 'discard'`): Controls what happens when the target thread is idle. Defaults to wake.
 
-**options.ifIdle.streamOptions** (`AgentExecutionOptions`): Options for the stream that starts when \`ifIdle.behavior\` is \`wake\`. Mastra uses the top-level \`resourceId\` and \`threadId\` for memory context.
+**options.ifIdle.streamOptions** (`AgentExecutionOptions`): Options for the stream that starts when ifIdle.behavior is wake. Mastra uses the top-level resourceId and threadId for memory context.
 
 **options.ifIdle.attributes** (`Record<string, string | number | boolean>`): Attributes merged into the signal when Mastra accepts it while the target thread is idle.
 
@@ -301,25 +301,25 @@ const result = await agent.sendStateSignal(
 
 **state** (`object`): State signal to send to the thread.
 
-**state.id** (`string`): State lane name, such as \`browser\` or \`editor\`.
+**state.id** (`string`): State lane name, such as browser or editor.
 
 **state.cacheKey** (`string`): Producer-owned key Mastra uses to skip duplicate state for the same lane and mode.
 
 **state.contents** (`string | Array<TextPart | FilePart>`): LLM-facing representation of the state.
 
-**state.mode** (`'snapshot' | 'delta'`): Whether the state is an authoritative snapshot or a change event. Defaults to \`snapshot\`.
+**state.mode** (`'snapshot' | 'delta'`): Whether the state is an authoritative snapshot or a change event. Defaults to snapshot.
 
-**state.value** (`unknown`): Structured snapshot value for \`mode: 'snapshot'\`.
+**state.value** (`unknown`): Structured snapshot value for mode: 'snapshot'.
 
-**state.delta** (`unknown`): Structured change value for \`mode: 'delta'\`.
+**state.delta** (`unknown`): Structured change value for mode: 'delta'.
 
 **state.attributes** (`Record<string, string | number | boolean>`): Attributes rendered on the state signal tag.
 
 **state.metadata** (`Record<string, unknown>`): Application metadata stored with the state signal.
 
-**state.tagName** (`string`): XML tag name shown to the model. Defaults to \`state\`.
+**state.tagName** (`string`): XML tag name shown to the model. Defaults to state.
 
-**options** (`object`): Targeting and delivery behavior for the state signal. Accepts the same options as \`sendSignal()\`.
+**options** (`object`): Targeting and delivery behavior for the state signal. Accepts the same options as sendSignal().
 
 Returns `{ accepted: Promise<SendAgentSignalAccepted>, signal: CreatedAgentSignal, persisted?: Promise<void>, skipped?: false }` when Mastra accepts new state. Returns `{ skipped: true, reason: 'unchanged' }` when the same `cacheKey` and mode are already current for the state lane. `accepted` resolves at decision-time, once Mastra decides what to do with the signal: `{ action: 'wake', runId, output }` when this process runs the agent (it started or won the lease to start the run), `{ action: 'deliver', runId }` when the signal is forwarded onto an existing run (including when this process loses a cross-process wake race), or `{ action: 'persist' }` / `{ action: 'discard' }` when nothing ran. `runId` is the authoritative id of the run that handled the signal and is present only on `wake` and `deliver`; for `persist`/`discard` use `result.signal.id` to correlate the stored signal. On the `wake` action, `output` is the agent stream for in-process consumption.
 
@@ -345,13 +345,13 @@ const result = await agent.sendNotificationSignal(
 
 **notification** (`object`): Notification inbox record to create or coalesce.
 
-**notification.source** (`string`): External system that produced the notification, such as \`github\`, \`slack\`, or \`email\`.
+**notification.source** (`string`): External system that produced the notification, such as github, slack, or email.
 
-**notification.kind** (`string`): Notification kind within the source, such as \`ci-status\`, \`mention\`, or \`direct-message\`.
+**notification.kind** (`string`): Notification kind within the source, such as ci-status, mention, or direct-message.
 
 **notification.summary** (`string`): LLM-facing summary used as the notification signal contents.
 
-**notification.priority** (`'low' | 'medium' | 'high' | 'urgent'`): Priority used by the notification delivery policy. Defaults to \`medium\`.
+**notification.priority** (`'low' | 'medium' | 'high' | 'urgent'`): Priority used by the notification delivery policy. Defaults to medium.
 
 **notification.payload** (`unknown`): Structured payload stored on the inbox record for tools or application code.
 
@@ -375,7 +375,7 @@ const result = await agent.sendNotificationSignal(
 
 Returns `{ record: NotificationRecord, decision: NotificationDeliveryDecision, runId?: string, signal?: CreatedAgentSignal, persisted?: Promise<void>, accepted?: Promise<SendAgentSignalAccepted> }`. `record` is the stored inbox record. `decision` is the delivery-policy result. `signal` and `runId` are present when ingress emits a signal immediately, including the immediate summary emitted for active high-priority notifications. `persisted` is present when the emitted signal is persisted without waking an idle thread. `accepted` is present when a signal is emitted and resolves at decision-time, once Mastra decides what to do with it: `{ action: 'wake', runId, output }` when this process runs the agent (it started or won the lease to start the run), `{ action: 'deliver', runId }` when the signal is forwarded onto an existing run, or `{ action: 'persist' }` / `{ action: 'discard' }` when nothing ran. `runId` on the accepted result is present only on `wake` and `deliver`. On the `wake` action, `output` is the agent stream for in-process consumption.
 
-Default delivery is priority-aware. `urgent` notifications deliver immediately. `high` notifications deliver immediately when the thread is idle; when the thread is active, Mastra emits a summary immediately and keeps `deliverAt` for later full delivery when the thread is idle. `medium` notifications deliver immediately when idle and batch into summaries when active. `low` notifications batch into summaries in both active and idle threads; idle low-priority summaries reach subscribers without waking the model loop. For the full flow, visit [Signals](https://mastra.ai/docs/agents/signals).
+Default delivery is priority-aware. `urgent` notifications deliver immediately. `high` notifications deliver immediately when the thread is idle; when the thread is active, Mastra emits a summary immediately and keeps `deliverAt` for later full delivery when the thread is idle. `medium` notifications deliver immediately when idle and batch into summaries when active. `low` notifications batch into summaries in both active and idle threads; idle low-priority summaries reach subscribers without waking the model loop. For the full flow, visit [Signals](https://mastra.ai/docs/long-running-agents/signals).
 
 Configure `notifications.deliveryPolicy` on the agent when some notifications should wait for a different dispatch window or summary rollup:
 
@@ -417,9 +417,9 @@ Returns an `AgentThreadSubscription` object with these members:
 
 **stream** (`AsyncIterable<AgentChunkType>`): Raw agent stream chunks for the subscribed thread.
 
-**activeRunId** (`() => string | null`): Returns the active run ID for the thread, or \`null\` when no run is active.
+**activeRunId** (`() => string | null`): Returns the active run ID for the thread, or null when no run is active.
 
-**abort** (`() => boolean`): Aborts the active run for the thread. Returns \`true\` when a run was aborted.
+**abort** (`() => boolean`): Aborts the active run for the thread. Returns true when a run was aborted.
 
 **unsubscribe** (`() => void`): Stops the subscription without aborting the active run.
 
@@ -441,21 +441,21 @@ Returns an `AgentThreadSubscription` object with these members:
 
 **tools** (`ToolsInput | ({ requestContext: RequestContext }) => ToolsInput | Promise<ToolsInput>`): Tools that the agent can access. Can be provided statically or resolved dynamically.
 
-**hooks** (`ToolHooks`): Hooks that run before and after every tool call made by this agent. Per-execution hooks passed to \`generate()\` or \`stream()\` override matching hooks set here. See Tool hooks below.
+**hooks** (`ToolHooks`): Hooks that run before and after every tool call made by this agent. Per-execution hooks passed to generate() or stream() override matching hooks set here. See Tool hooks below.
 
-**hooks.beforeToolCall** (`(context: ToolHookContext) => void | ToolBeforeHookResult | Promise<void | ToolBeforeHookResult>`): Runs before a tool executes. Receives \`{ toolName, input, context, metadata }\`. Return \`{ proceed: false, output }\` to skip the tool call and use \`output\` as its result.
+**hooks.beforeToolCall** (`(context: ToolHookContext) => void | ToolBeforeHookResult | Promise<void | ToolBeforeHookResult>`): Runs before a tool executes. Receives { toolName, input, context, metadata }. Return { proceed: false, output } to skip the tool call and use output as its result.
 
-**hooks.afterToolCall** (`(context: ToolAfterHookContext) => void | Promise<void>`): Runs after a tool executes. Receives \`{ toolName, input, context, metadata, output, error }\`. \`output\` is undefined when the tool throws, and \`error\` is set instead.
+**hooks.afterToolCall** (`(context: ToolAfterHookContext) => void | Promise<void>`): Runs after a tool executes. Receives { toolName, input, context, metadata, output, error }. output is undefined when the tool throws, and error is set instead.
 
-**transform** (`ToolPayloadTransformPolicy`): Shared policy for transforming tool payloads before display streams or user-visible transcript messages receive them. Use per-tool \`transform\` on \`createTool()\` for tool-local rules.
+**transform** (`ToolPayloadTransformPolicy`): Shared policy for transforming tool payloads before display streams or user-visible transcript messages receive them. Use per-tool transform on createTool() for tool-local rules.
 
 **workflows** (`Record<string, Workflow> | ({ requestContext: RequestContext }) => Record<string, Workflow> | Promise<Record<string, Workflow>>`): Workflows that the agent can execute. Can be static or dynamically resolved.
 
-**defaultOptions** (`AgentExecutionOptions | ({ requestContext: RequestContext }) => AgentExecutionOptions | Promise<AgentExecutionOptions>`): Default options used when calling \`stream()\` and \`generate()\`.
+**defaultOptions** (`AgentExecutionOptions | ({ requestContext: RequestContext }) => AgentExecutionOptions | Promise<AgentExecutionOptions>`): Default options used when calling stream() and generate().
 
-**defaultGenerateOptionsLegacy** (`AgentGenerateOptions | ({ requestContext: RequestContext }) => AgentGenerateOptions | Promise<AgentGenerateOptions>`): Default options used when calling \`generateLegacy()\`.
+**defaultGenerateOptionsLegacy** (`AgentGenerateOptions | ({ requestContext: RequestContext }) => AgentGenerateOptions | Promise<AgentGenerateOptions>`): Default options used when calling generateLegacy().
 
-**defaultStreamOptionsLegacy** (`AgentStreamOptions | ({ requestContext: RequestContext }) => AgentStreamOptions | Promise<AgentStreamOptions>`): Default options used when calling \`streamLegacy()\`.
+**defaultStreamOptionsLegacy** (`AgentStreamOptions | ({ requestContext: RequestContext }) => AgentStreamOptions | Promise<AgentStreamOptions>`): Default options used when calling streamLegacy().
 
 **mastra** (`Mastra`): Reference to the Mastra runtime instance (injected automatically).
 
@@ -465,11 +465,11 @@ Returns an `AgentThreadSubscription` object with these members:
 
 **notifications** (`object`): Notification delivery configuration for durable notification signals.
 
-**notifications.deliveryPolicy** (`NotificationDeliveryPolicyConfig`): Controls how notification records are delivered. Configure a default decision, per-priority decisions, per-source decisions, or a custom \`decide()\` function.
+**notifications.deliveryPolicy** (`NotificationDeliveryPolicyConfig`): Controls how notification records are delivered. Configure a default decision, per-priority decisions, per-source decisions, or a custom decide() function.
 
 **voice** (`CompositeVoice`): Voice settings for speech input and output.
 
-**inputProcessors** (`(Processor | ProcessorWorkflow)[] | ({ requestContext: RequestContext }) => (Processor | ProcessorWorkflow)[] | Promise<(Processor | ProcessorWorkflow)[]>`): Input processors that can modify or validate messages before they are processed by the agent. Can be individual Processor objects or workflows created with \`createWorkflow()\` using ProcessorStepSchema.
+**inputProcessors** (`(Processor | ProcessorWorkflow)[] | ({ requestContext: RequestContext }) => (Processor | ProcessorWorkflow)[] | Promise<(Processor | ProcessorWorkflow)[]>`): Input processors that can modify or validate messages before they are processed by the agent. Can be individual Processor objects or workflows created with createWorkflow() using ProcessorStepSchema.
 
 **outputProcessors** (`(Processor | ProcessorWorkflow)[] | ({ requestContext: RequestContext }) => (Processor | ProcessorWorkflow)[] | Promise<(Processor | ProcessorWorkflow)[]>`): Output processors that can modify or validate messages from the agent before they are sent to the client. Can be individual Processor objects or workflows.
 
@@ -550,7 +550,7 @@ The hook context `metadata` includes `agentId` and `agentName`. Per-execution ho
 
 When you register the [`MastraEditor`](https://mastra.ai/reference/editor/mastra-editor), the `editor` field controls which parts of a code-defined agent can be changed through the editor. Fields owned by code are read-only in Studio and are stripped from saved overrides.
 
-**editor** (`false | { instructions?: boolean; tools?: boolean | { description?: boolean } }`): Omit to allow editing instructions and tools. Set to \`false\` to lock the agent. Set \`instructions: true\` to allow instruction edits. Set \`tools: true\` to allow tool membership and description edits, or \`tools: { description: true }\` to allow only description edits.
+**editor** (`false | { instructions?: boolean; tools?: boolean | { description?: boolean } }`): Omit to allow editing instructions and tools. Set to false to lock the agent. Set instructions: true to allow instruction edits. Set tools: true to allow tool membership and description edits, or tools: { description: true } to allow only description edits.
 
 The agent's `id`, `name`, and `model` always come from code and can't be overridden through the editor. See the [Editor overview](https://mastra.ai/docs/editor/overview) for usage.