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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

package/.docs/reference/cli/mastra.md

@@ -193,8 +193,151 @@ Path to a JSON file containing named [request context](https://mastra.ai/docs/se
 mastra studio --request-context-presets ./presets.json
 ```
 
+## `mastra deploy`
+
+Builds and deploys your project to a named environment on Mastra platform. This is the recommended command for all new deploys and replaces both [`mastra studio deploy`](#mastra-studio-deploy) and [`mastra server deploy`](#mastra-server-deploy), which continue to work but should no longer be used for new setups.
+
+Requires authentication via [`mastra auth login`](#mastra-auth-login) or a `MASTRA_API_TOKEN` environment variable.
+
+```bash
+mastra deploy
+mastra deploy --env staging
+mastra deploy --env production --region eu
+```
+
+The command runs `mastra build`, zips the output, uploads it to the selected environment, and then polls the deploy status while streaming build logs until the deploy reaches a terminal state.
+
+Organization, project, and environment are resolved in order from: environment variable (`MASTRA_ORG_ID`, `MASTRA_PROJECT_ID`), CLI flag (`--org`, `--project`, `--env`), `.mastra-project.json` config file, current org from credentials, and lastly interactive prompt. On first deploy, the CLI saves the resolved org and project IDs to `.mastra-project.json` so subsequent deploys skip the prompts.
+
+If the project doesn't exist yet, the CLI creates it from the `package.json` `name` field after confirmation. If the target environment doesn't exist, the CLI creates it (defaulting to `type: staging` for anything other than `production`) after confirmation. Combined with `--yes`, this creates and deploys everything in one non-interactive command:
+
+```bash
+mastra deploy --env staging --yes
+```
+
+When `--env <name>` is set and `--env-file` is not, the CLI auto-selects `.env.<name>` from the project directory if present (for example `.env.staging`). The `<name>` value is validated against a strict allowlist before being interpolated into a file path.
+
+### Arguments
+
+#### `[dir]`
+
+Project directory. Defaults to the current directory.
+
+### Flags
+
+#### `--env`
+
+Target environment name. Defaults to `production`. Auto-selects `.env.<name>` from the project directory when `--env-file` is not set. If the environment doesn't exist, the CLI creates it after confirmation.
+
+#### `--org`
+
+Organization ID. Can also be set via the `MASTRA_ORG_ID` environment variable.
+
+#### `--project`
+
+Project ID, slug, or name. Can also be set via the `MASTRA_PROJECT_ID` environment variable. If no project matches, the value is used as the name of a new project to create on deploy.
+
+#### `-y, --yes`
+
+Auto-accept defaults without confirmation prompts, including creating projects and environments.
+
+#### `-c, --config`
+
+Path to the project config file. Defaults to `.mastra-project.json`.
+
+#### `--env-file`
+
+Path to the env file to bundle with the deploy (relative to the project directory). When set, disables the `.env.<name>` auto-selection based on `--env`.
+
+```bash
+mastra deploy --env staging --env-file .env.staging.local
+```
+
+#### `--region`
+
+Region for a newly created environment (for example `eu`). Applied only when the CLI creates the environment.
+
+#### `--skip-build`
+
+Skip the build step and deploy the existing `.mastra/output` directory. The CLI warns if the existing build is stale relative to the current source.
+
+#### `--skip-preflight`
+
+Skip the pre-upload validation of the built output.
+
+#### `--debug`
+
+Enable debug logs during the build step.
+
+### CI/CD usage
+
+Set `MASTRA_API_TOKEN`, `MASTRA_ORG_ID`, and `MASTRA_PROJECT_ID` as environment variables for headless deploys. Interactive prompts are skipped automatically when `MASTRA_API_TOKEN` is set. Combine with `--yes` to auto-accept environment creation.
+
+```bash
+export MASTRA_API_TOKEN="..."
+export MASTRA_ORG_ID="..."
+export MASTRA_PROJECT_ID="..."
+mastra deploy --env staging --yes
+```
+
+## `mastra env`
+
+Manages environments on Mastra platform. Environments are named deploy targets (for example `production`, `staging`, `preview-42`) that belong to a project. Every subcommand takes a `<project>` argument (name, slug, or ID) and resolves the current organization from stored credentials.
+
+### `mastra env list`
+
+Lists environments for a project.
+
+```bash
+mastra env list <project>
+```
+
+#### `--json`
+
+Emit machine-readable JSON. Only non-sensitive metadata (id, name, slug, type, region, branch, and URLs) is included so the output is safe to log in CI.
+
+### `mastra env create`
+
+Creates a new environment for a project.
+
+```bash
+mastra env create <project> --name staging --type staging --region eu
+```
+
+#### `-n, --name`
+
+Environment name (required).
+
+#### `-t, --type`
+
+Environment type. One of `production`, `staging`, or `preview`. Defaults to `staging`.
+
+#### `-r, --region`
+
+Region for the environment (for example `eu`).
+
+#### `--json`
+
+Emit machine-readable JSON. Sensitive fields are omitted, as with [`mastra env list`](#mastra-env-list).
+
+### `mastra env delete`
+
+Deletes an environment.
+
+```bash
+mastra env delete <project> <env>
+```
+
+`<env>` can be an environment name, slug, or ID. The CLI prompts for confirmation unless `--yes` is passed.
+
+#### `-y, --yes`
+
+Skip the confirmation prompt.
+
 ## `mastra studio deploy`
 
+> **Info:** `mastra studio deploy` continues to work but is superseded by [`mastra deploy`](#mastra-deploy), which supports named environments (`--env staging`, `--env production`) on a single project. New setups should use `mastra deploy`.
+
 Builds and deploys your project to Mastra platform. Requires authentication via [`mastra auth login`](#mastra-auth-login) or a `MASTRA_API_TOKEN` environment variable.
 
 ```bash
@@ -311,6 +454,8 @@ Creates a new project through an interactive prompt. This command doesn't accept
 
 ## `mastra server deploy`
 
+> **Info:** `mastra server deploy` continues to work but is superseded by [`mastra deploy`](#mastra-deploy), which deploys a single project to multiple named environments instead of separate Studio and Server commands. New setups should use `mastra deploy`.
+
 Builds and deploys your project to Server on Mastra platform. Works the same as [`mastra studio deploy`](#mastra-studio-deploy) with the same flags, arguments, and resolution logic.
 
 The deploy command auto-loads the project's `.env` file. If `MASTRA_PROJECT_ID` points to a project that was provisioned for Observability, the deploy links to that project instead of creating a new one. Deploying Server to an observability-only project converts it into a Server project on the platform side.

package/.docs/reference/client-js/agents.md

@@ -237,21 +237,21 @@ await agent.sendSignal({
 
 Returns `{ accepted: true, runId: string }`.
 
-**signal** (`{ type: 'user' | 'reactive' | 'notification' | string; tagName?: string; contents: string | Array<TextPart | FilePart>; attributes?: Record<string, JSONValue>; metadata?: Record<string, unknown>; providerOptions?: ProviderMetadata }`): Lower-level signal payload. Use \`type\` for the semantic signal category and \`tagName\` for the XML tag shown to the model. \`providerOptions\` is attached to the resulting prompt turn and persisted on the stored signal message.
+**signal** (`{ type: 'user' | 'reactive' | 'notification' | string; tagName?: string; contents: string | Array<TextPart | FilePart>; attributes?: Record<string, JSONValue>; metadata?: Record<string, unknown>; providerOptions?: ProviderMetadata }`): Lower-level signal payload. Use type for the semantic signal category and tagName for the XML tag shown to the model. providerOptions is attached to the resulting prompt turn and persisted on the stored signal message.
 
 **runId** (`string`): Run ID to target directly.
 
-**resourceId** (`string`): Resource ID for the memory thread. Use with \`threadId\` for thread-targeted signals.
+**resourceId** (`string`): Resource ID for the memory thread. Use with threadId for thread-targeted signals.
 
-**threadId** (`string`): Thread ID to target. Use with \`resourceId\` for thread-targeted signals.
+**threadId** (`string`): Thread ID to target. Use with resourceId for thread-targeted signals.
 
-**ifActive.behavior** (`'deliver' | 'persist' | 'discard'`): Controls what happens when the target thread is active. Defaults to \`deliver\`.
+**ifActive.behavior** (`'deliver' | 'persist' | 'discard'`): Controls what happens when the target thread is active. Defaults to deliver.
 
 **ifActive.attributes** (`Record<string, string | number | boolean>`): Attributes merged into the signal when Mastra accepts it while the target thread is active.
 
-**ifIdle.behavior** (`'wake' | 'persist' | 'discard'`): Controls what happens when the target thread is idle. Defaults to \`wake\`.
+**ifIdle.behavior** (`'wake' | 'persist' | 'discard'`): Controls what happens when the target thread is idle. Defaults to wake.
 
-**ifIdle.streamOptions** (`Omit<AgentExecutionOptions, 'messages'>`): Options for the stream that starts when \`ifIdle.behavior\` is \`wake\`.
+**ifIdle.streamOptions** (`Omit<AgentExecutionOptions, 'messages'>`): Options for the stream that starts when ifIdle.behavior is wake.
 
 **ifIdle.attributes** (`Record<string, string | number | boolean>`): Attributes merged into the signal when Mastra accepts it while the target thread is idle.
 
@@ -281,11 +281,11 @@ await subscription.processDataStream({
 
 **threadId** (`string`): Thread ID to subscribe to.
 
-**processDataStream().reconnect** (`boolean | { maxRetries?: number; delayMs?: number }`): Reconnects the subscription stream after it closes or a reconnect request fails. \`true\` retries indefinitely with a one-second delay.
+**processDataStream().reconnect** (`boolean | { maxRetries?: number; delayMs?: number }`): Reconnects the subscription stream after it closes or a reconnect request fails. true retries indefinitely with a one-second delay.
 
 ### `streamUntilIdle()`
 
-Stream a response and keep the stream open until every [background task](https://mastra.ai/docs/agents/background-tasks) dispatched during the run completes. The server re-enters the agentic loop on each task completion so the LLM can react to results in the same call. Requires background tasks to be [enabled on the Mastra instance](https://mastra.ai/reference/configuration) and a memory thread; otherwise the call falls through to a plain `stream()`.
+Stream a response and keep the stream open until every [background task](https://mastra.ai/docs/long-running-agents/background-tasks) dispatched during the run completes. The server re-enters the agentic loop on each task completion so the LLM can react to results in the same call. Requires background tasks to be [enabled on the Mastra instance](https://mastra.ai/reference/configuration) and a memory thread; otherwise the call falls through to a plain `stream()`.
 
 ```typescript
 const response = await agent.streamUntilIdle('Research solana for me', {
@@ -307,7 +307,7 @@ response.processDataStream({
 
 ### `resumeStreamUntilIdle()`
 
-Resume a suspended agent stream with custom data and keep the stream open until every [background task](https://mastra.ai/docs/agents/background-tasks) dispatched during the run completes. Use this to continue execution after a suspension point, such as a workflow suspend within an agent. Requires background tasks to be [enabled on the Mastra instance](https://mastra.ai/reference/configuration) and a memory thread; otherwise the call falls through to a plain `resumeStream()`:
+Resume a suspended agent stream with custom data and keep the stream open until every [background task](https://mastra.ai/docs/long-running-agents/background-tasks) dispatched during the run completes. Use this to continue execution after a suspension point, such as a workflow suspend within an agent. Requires background tasks to be [enabled on the Mastra instance](https://mastra.ai/reference/configuration) and a memory thread; otherwise the call falls through to a plain `resumeStream()`:
 
 ```typescript
 const response = await agent.resumeStreamUntilIdle(

package/.docs/reference/client-js/mastra-client.md

@@ -57,7 +57,7 @@ You can also pass `requestContext` as a `Record<string, any>`.
 
 **getAgent(agentId)** (`Agent`): Retrieves a specific agent instance by ID.
 
-**listMemoryThreads(params)** (`Promise<StorageThreadType[]>`): Retrieves memory threads for the specified resource and agent. Requires a \`resourceId\` and an \`agentId\`.
+**listMemoryThreads(params)** (`Promise<StorageThreadType[]>`): Retrieves memory threads for the specified resource and agent. Requires a resourceId and an agentId.
 
 **createMemoryThread(params)** (`Promise<MemoryThread>`): Creates a new memory thread with the given parameters.
 
@@ -75,13 +75,13 @@ You can also pass `requestContext` as a `Record<string, any>`.
 
 **getWorkflow(workflowId)** (`Workflow`): Retrieves a specific workflow instance by ID.
 
-**getAgentBuilderActions()** (`Promise<Record<string, WorkflowInfo>>`): Returns all available Agent Builder actions. See \[Agent Builder API]\(/reference/client-js/agent-builder).
+**getAgentBuilderActions()** (`Promise<Record<string, WorkflowInfo>>`): Returns all available Agent Builder actions. See Agent Builder API.
 
-**getAgentBuilderAction(actionId)** (`AgentBuilder`): Retrieves an Agent Builder action by ID. See \[Agent Builder API]\(/reference/client-js/agent-builder).
+**getAgentBuilderAction(actionId)** (`AgentBuilder`): Retrieves an Agent Builder action by ID. See Agent Builder API.
 
-**responses** (`Responses`): Provides OpenAI-style Responses API helpers with \`create()\`, \`retrieve()\`, \`stream()\`, and \`delete()\`.
+**responses** (`Responses`): Provides OpenAI-style Responses API helpers with create(), retrieve(), stream(), and delete().
 
-**conversations** (`Conversations`): Provides conversation helpers with \`create()\`, \`retrieve()\`, \`delete()\`, and \`items.list()\`.
+**conversations** (`Conversations`): Provides conversation helpers with create(), retrieve(), delete(), and items.list().
 
 **getVector(vectorName)** (`MastraVector`): Returns a vector store instance by name.
 

package/.docs/reference/client-js/responses.md

@@ -196,15 +196,15 @@ The returned response object includes:
 
 ## Parameters
 
-**agent\_id** (`string`): Required on initial requests. Selects the Mastra agent that executes the request. Stored follow-up turns can omit it when continuing with \`previous\_response\_id\`.
+**agent\_id** (`string`): Required on initial requests. Selects the Mastra agent that executes the request. Stored follow-up turns can omit it when continuing with previous\_response\_id.
 
-**model** (`string`): Optional model override for this request, such as \`openai/gpt-5\`. If omitted, Mastra uses the model configured on the selected agent.
+**model** (`string`): Optional model override for this request, such as openai/gpt-5. If omitted, Mastra uses the model configured on the selected agent.
 
 **input** (`string | Array<{ role: 'system' | 'developer' | 'user' | 'assistant'; content: string | Array<{ type: 'input_text' | 'text' | 'output_text'; text: string }> }>`): Required. Input text or message array for the response.
 
 **instructions** (`string`): Optional instruction override for this request.
 
-**text** (`{ format: { type: 'json_object' } | { type: 'json_schema'; name: string; schema: Record<string, unknown>; description?: string; strict?: boolean } }`): Optional text output format. Use \`json\_object\` for JSON mode or \`json\_schema\` for schema-constrained structured output.
+**text** (`{ format: { type: 'json_object' } | { type: 'json_schema'; name: string; schema: Record<string, unknown>; description?: string; strict?: boolean } }`): Optional text output format. Use json\_object for JSON mode or json\_schema for schema-constrained structured output.
 
 **providerOptions** (`Record<string, Record<string, unknown> | undefined>`): Optional provider-specific options passed through to the underlying model call.
 

package/.docs/reference/configuration.md

@@ -44,7 +44,7 @@ export const mastra = new Mastra({
 
 Enables and configures the background task manager. When enabled, agents can dispatch long-running tool calls (including subagent invocations) to run asynchronously while the agentic loop continues. Tasks are persisted, so a configured `storage` backend is required.
 
-Visit the [Background tasks documentation](https://mastra.ai/docs/agents/background-tasks) to learn more.
+Visit the [Background tasks documentation](https://mastra.ai/docs/long-running-agents/background-tasks) to learn more.
 
 ```typescript
 import { Mastra } from '@mastra/core'