@mastra/mcp-docs-server 1.1.7 → 1.1.8

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

@@ -45,23 +45,23 @@ The first parameter is the Mastra stream to convert. It can be one of:
 
 The second parameter is an options object:
 
-**from:** (`'agent' | 'network' | 'workflow'`): The type of Mastra stream being converted. (Default: `'agent'`)
+**from** (`'agent' | 'network' | 'workflow'`): The type of Mastra stream being converted. (Default: `'agent'`)
 
-**lastMessageId?:** (`string`): (Agent only) The ID of the last message in the conversation.
+**lastMessageId** (`string`): (Agent only) The ID of the last message in the conversation.
 
-**sendStart?:** (`boolean`): (Agent only) Whether to send start events in the stream. (Default: `true`)
+**sendStart** (`boolean`): (Agent only) Whether to send start events in the stream. (Default: `true`)
 
-**sendFinish?:** (`boolean`): (Agent only) Whether to send finish events in the stream. (Default: `true`)
+**sendFinish** (`boolean`): (Agent only) Whether to send finish events in the stream. (Default: `true`)
 
-**sendReasoning?:** (`boolean`): (Agent only) Whether to include reasoning-delta chunks in the stream. Set to true to stream reasoning content from models that support extended thinking. (Default: `false`)
+**sendReasoning** (`boolean`): (Agent only) Whether to include reasoning-delta chunks in the stream. Set to true to stream reasoning content from models that support extended thinking. (Default: `false`)
 
-**sendSources?:** (`boolean`): (Agent only) Whether to include source citations in the output. (Default: `false`)
+**sendSources** (`boolean`): (Agent only) Whether to include source citations in the output. (Default: `false`)
 
-**includeTextStreamParts?:** (`boolean`): (Workflow only) Whether to include text stream parts in the output. (Default: `true`)
+**includeTextStreamParts** (`boolean`): (Workflow only) Whether to include text stream parts in the output. (Default: `true`)
 
-**messageMetadata?:** (`(options: { part: UIMessageStreamPart }) => Record<string, unknown> | undefined`): (Agent only) A function that receives the current stream part and returns metadata to attach to start and finish chunks.
+**messageMetadata** (`(options: { part: UIMessageStreamPart }) => Record<string, unknown> | undefined`): (Agent only) A function that receives the current stream part and returns metadata to attach to start and finish chunks.
 
-**onError?:** (`(error: unknown) => string`): (Agent only) A function to handle errors during stream conversion. Receives the error and should return a string representation.
+**onError** (`(error: unknown) => string`): (Agent only) A function to handle errors during stream conversion. Receives the error and should return a string representation.
 
 ## Examples
 

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

@@ -33,27 +33,27 @@ export default function Chat() {
 
 ## Parameters
 
-**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.
+**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.
 
 ## Returns
 
 Returns an array of AI SDK V4 `UIMessage` objects with the following structure:
 
-**id:** (`string`): Unique message identifier.
+**id** (`string`): Unique message identifier.
 
-**role:** (`'user' | 'assistant' | 'system'`): The role of the message sender.
+**role** (`'user' | 'assistant' | 'system'`): The role of the message sender.
 
-**content:** (`string`): Text content of the message.
+**content** (`string`): Text content of the message.
 
-**parts:** (`UIMessagePart[]`): Array of UI parts including text, tool-invocation, file, reasoning, source, and step markers.
+**parts** (`UIMessagePart[]`): Array of UI parts including text, tool-invocation, file, reasoning, source, and step markers.
 
-**createdAt:** (`Date`): Message creation timestamp.
+**createdAt** (`Date`): Message creation timestamp.
 
-**toolInvocations?:** (`ToolInvocation[]`): Array of tool invocations for assistant messages.
+**toolInvocations** (`ToolInvocation[]`): Array of tool invocations for assistant messages.
 
-**experimental\_attachments?:** (`Attachment[]`): File attachments on the message.
+**experimental\_attachments** (`Attachment[]`): File attachments on the message.
 
-**metadata?:** (`Record<string, unknown>`): Custom metadata attached to the message.
+**metadata** (`Record<string, unknown>`): Custom metadata attached to the message.
 
 ## Examples
 

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

@@ -38,19 +38,19 @@ export default function Chat() {
 
 ## Parameters
 
-**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.
+**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.
 
 ## Returns
 
 Returns an array of AI SDK V5+ `UIMessage` objects with the following structure:
 
-**id:** (`string`): Unique message identifier.
+**id** (`string`): Unique message identifier.
 
-**role:** (`'user' | 'assistant' | 'system'`): The role of the message sender.
+**role** (`'user' | 'assistant' | 'system'`): The role of the message sender.
 
-**parts:** (`UIMessagePart[]`): Array of UI parts including text, tool results, files, reasoning, sources, and step markers.
+**parts** (`UIMessagePart[]`): Array of UI parts including text, tool results, files, reasoning, sources, and step markers.
 
-**metadata?:** (`Record<string, unknown>`): Optional metadata including createdAt, threadId, resourceId, and custom fields.
+**metadata** (`Record<string, unknown>`): Optional metadata including createdAt, threadId, resourceId, and custom fields.
 
 ## Examples
 

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

@@ -30,29 +30,29 @@ const { text } = await generateText({
 
 ## Parameters
 
-**model:** (`LanguageModelV2`): Any AI SDK language model (e.g., \`openai('gpt-4o')\`, \`anthropic('claude-3-opus')\`).
+**model** (`LanguageModelV2`): Any AI SDK language model (e.g., \`openai('gpt-4o')\`, \`anthropic('claude-3-opus')\`).
 
-**options?:** (`WithMastraOptions`): Configuration object for processors and memory.
+**options** (`WithMastraOptions`): Configuration object for processors and memory.
 
-**options.inputProcessors?:** (`InputProcessor[]`): Input processors to run before the LLM call.
+**options.inputProcessors** (`InputProcessor[]`): Input processors to run before the LLM call.
 
-**options.outputProcessors?:** (`OutputProcessor[]`): Output processors to run on the LLM response.
+**options.outputProcessors** (`OutputProcessor[]`): Output processors to run on the LLM response.
 
-**options.memory?:** (`WithMastraMemoryOptions`): Memory configuration - enables automatic message history persistence.
+**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.
+**options.memory.threadId** (`string`): Thread ID for conversation persistence.
 
-**options.memory.resourceId?:** (`string`): Resource ID (user/session identifier).
+**options.memory.resourceId** (`string`): Resource ID (user/session identifier).
 
-**options.memory.lastMessages?:** (`number | false`): Number of recent messages to retrieve, or false to disable.
+**options.memory.lastMessages** (`number | false`): Number of recent messages to retrieve, or false to disable.
 
-**options.memory.semanticRecall?:** (`WithMastraSemanticRecallOptions`): Semantic recall configuration (RAG-based memory retrieval).
+**options.memory.semanticRecall** (`WithMastraSemanticRecallOptions`): Semantic recall configuration (RAG-based memory retrieval).
 
-**options.memory.workingMemory?:** (`MemoryConfig['workingMemory']`): Working memory configuration (persistent user data).
+**options.memory.workingMemory** (`MemoryConfig['workingMemory']`): Working memory configuration (persistent user data).
 
-**options.memory.readOnly?:** (`boolean`): Read-only mode - prevents saving new messages.
+**options.memory.readOnly** (`boolean`): Read-only mode - prevents saving new messages.
 
 ## Returns
 

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

@@ -47,11 +47,11 @@ export const mastra = new Mastra({
 
 ## Parameters
 
-**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`)
+**workflow** (`string`): Fixed workflow ID when not using dynamic routing. (Default: `undefined`)
 
-**includeTextStreamParts?:** (`boolean`): Whether to include text stream parts in the output. (Default: `true`)
+**includeTextStreamParts** (`boolean`): Whether to include text stream parts in the output. (Default: `true`)
 
 ## Additional configuration
 

package/.docs/reference/auth/auth0.md

@@ -22,21 +22,21 @@ export const mastra = new Mastra({
 
 ## Constructor parameters
 
-**domain?:** (`string`): Your Auth0 domain (e.g., your-tenant.auth0.com). This is used to verify JWT tokens issued by your Auth0 tenant. (Default: `process.env.AUTH0_DOMAIN`)
+**domain** (`string`): Your Auth0 domain (e.g., your-tenant.auth0.com). This is used to verify JWT tokens issued by your Auth0 tenant. (Default: `process.env.AUTH0_DOMAIN`)
 
-**audience?:** (`string`): Your Auth0 API identifier/audience. This ensures tokens are intended for your specific API. (Default: `process.env.AUTH0_AUDIENCE`)
+**audience** (`string`): Your Auth0 API identifier/audience. This ensures tokens are intended for your specific API. (Default: `process.env.AUTH0_AUDIENCE`)
 
-**name?:** (`string`): Custom name for the auth provider instance. (Default: `"auth0"`)
+**name** (`string`): Custom name for the auth provider instance. (Default: `"auth0"`)
 
-**authorizeUser?:** (`(user: Auth0User) => Promise<boolean> | boolean`): Custom authorization function to determine if a user should be granted access. Called after token verification. By default, allows all authenticated users with valid tokens.
+**authorizeUser** (`(user: Auth0User) => Promise<boolean> | boolean`): Custom authorization function to determine if a user should be granted access. Called after token verification. By default, allows all authenticated users with valid tokens.
 
 ## Environment Variables
 
 The following environment variables are automatically used when constructor options are not provided:
 
-**AUTH0\_DOMAIN?:** (`string`): Your Auth0 domain. Can be found in your Auth0 Dashboard under Applications > Settings.
+**AUTH0\_DOMAIN** (`string`): Your Auth0 domain. Can be found in your Auth0 Dashboard under Applications > Settings.
 
-**AUTH0\_AUDIENCE?:** (`string`): Your Auth0 API identifier. This is the identifier you set when creating an API in your Auth0 Dashboard.
+**AUTH0\_AUDIENCE** (`string`): Your Auth0 API identifier. This is the identifier you set when creating an API in your Auth0 Dashboard.
 
 ## Default Authorization Behavior
 

package/.docs/reference/auth/better-auth.md

@@ -33,15 +33,15 @@ export const mastra = new Mastra({
 
 ## Constructor parameters
 
-**auth:** (`Auth`): Your Better Auth instance created via betterAuth({ ... }). This is required and must be properly configured with a supported database provider.
+**auth** (`Auth`): Your Better Auth instance created via betterAuth({ ... }). This is required and must be properly configured with a supported database provider.
 
-**name?:** (`string`): Custom name for the auth provider instance. (Default: `'better-auth'`)
+**name** (`string`): Custom name for the auth provider instance. (Default: `'better-auth'`)
 
-**authorizeUser?:** (`(user: BetterAuthUser, request: HonoRequest) => Promise<boolean> | boolean`): Custom authorization function to determine if a user should be granted access. Called after session verification. By default, allows all authenticated users with valid sessions.
+**authorizeUser** (`(user: BetterAuthUser, request: HonoRequest) => Promise<boolean> | boolean`): Custom authorization function to determine if a user should be granted access. Called after session verification. By default, allows all authenticated users with valid sessions.
 
-**public?:** (`Array<string | RegExp | [string, Methods | Methods[]]>`): Public routes that do not require authentication. Supports exact paths, wildcards, and path params.
+**public** (`Array<string | RegExp | [string, Methods | Methods[]]>`): Public routes that do not require authentication. Supports exact paths, wildcards, and path params.
 
-**protected?:** (`Array<string | RegExp | [string, Methods | Methods[]]>`): Protected routes that require authentication. Supports exact paths, wildcards, and path params.
+**protected** (`Array<string | RegExp | [string, Methods | Methods[]]>`): Protected routes that require authentication. Supports exact paths, wildcards, and path params.
 
 ## BetterAuthUser Type
 

package/.docs/reference/auth/clerk.md

@@ -21,15 +21,15 @@ export const mastra = new Mastra({
 
 ## Constructor parameters
 
-**publishableKey?:** (`string`): Your Clerk publishable key. Can be found in your Clerk Dashboard under API Keys. (Default: `process.env.CLERK_PUBLISHABLE_KEY`)
+**publishableKey** (`string`): Your Clerk publishable key. Can be found in your Clerk Dashboard under API Keys. (Default: `process.env.CLERK_PUBLISHABLE_KEY`)
 
-**secretKey?:** (`string`): Your Clerk secret key. Used for server-side authentication and token verification. (Default: `process.env.CLERK_SECRET_KEY`)
+**secretKey** (`string`): Your Clerk secret key. Used for server-side authentication and token verification. (Default: `process.env.CLERK_SECRET_KEY`)
 
-**jwksUri?:** (`string`): The JWKS URI from your Clerk application. Used to verify JWT signatures. (Default: `process.env.CLERK_JWKS_URI`)
+**jwksUri** (`string`): The JWKS URI from your Clerk application. Used to verify JWT signatures. (Default: `process.env.CLERK_JWKS_URI`)
 
-**name?:** (`string`): Custom name for the auth provider instance.
+**name** (`string`): Custom name for the auth provider instance.
 
-**authorizeUser?:** (`(user: User, request: HonoRequest) => Promise<boolean> | boolean`): Custom authorization function to determine if a user should be granted access. Called after token verification. By default, allows all authenticated users.
+**authorizeUser** (`(user: User, request: HonoRequest) => Promise<boolean> | boolean`): Custom authorization function to determine if a user should be granted access. Called after token verification. By default, allows all authenticated users.
 
 ## Related
 

package/.docs/reference/auth/firebase.md

@@ -36,23 +36,23 @@ export const mastra = new Mastra({
 
 ## Constructor parameters
 
-**serviceAccount?:** (`string`): Path to the Firebase service account JSON file. This file contains the credentials needed to verify Firebase ID tokens on the server side. (Default: `process.env.FIREBASE_SERVICE_ACCOUNT`)
+**serviceAccount** (`string`): Path to the Firebase service account JSON file. This file contains the credentials needed to verify Firebase ID tokens on the server side. (Default: `process.env.FIREBASE_SERVICE_ACCOUNT`)
 
-**databaseId?:** (`string`): The Firestore database ID to use. Typically '(default)' for the default database. (Default: `process.env.FIRESTORE_DATABASE_ID || process.env.FIREBASE_DATABASE_ID`)
+**databaseId** (`string`): The Firestore database ID to use. Typically '(default)' for the default database. (Default: `process.env.FIRESTORE_DATABASE_ID || process.env.FIREBASE_DATABASE_ID`)
 
-**name?:** (`string`): Custom name for the auth provider instance. (Default: `"firebase"`)
+**name** (`string`): Custom name for the auth provider instance. (Default: `"firebase"`)
 
-**authorizeUser?:** (`(user: FirebaseUser) => Promise<boolean> | boolean`): Custom authorization function to determine if a user should be granted access. Called after token verification. By default, checks for the presence of a document in the 'user\_access' collection keyed by the user's UID.
+**authorizeUser** (`(user: FirebaseUser) => Promise<boolean> | boolean`): Custom authorization function to determine if a user should be granted access. Called after token verification. By default, checks for the presence of a document in the 'user\_access' collection keyed by the user's UID.
 
 ## Environment Variables
 
 The following environment variables are automatically used when constructor options are not provided:
 
-**FIREBASE\_SERVICE\_ACCOUNT?:** (`string`): Path to Firebase service account JSON file. Used if serviceAccount option is not provided.
+**FIREBASE\_SERVICE\_ACCOUNT** (`string`): Path to Firebase service account JSON file. Used if serviceAccount option is not provided.
 
-**FIRESTORE\_DATABASE\_ID?:** (`string`): Firestore database ID. Primary environment variable for database configuration.
+**FIRESTORE\_DATABASE\_ID** (`string`): Firestore database ID. Primary environment variable for database configuration.
 
-**FIREBASE\_DATABASE\_ID?:** (`string`): Alternative environment variable for Firestore database ID. Used if FIRESTORE\_DATABASE\_ID is not set.
+**FIREBASE\_DATABASE\_ID** (`string`): Alternative environment variable for Firestore database ID. Used if FIRESTORE\_DATABASE\_ID is not set.
 
 ## Default Authorization Behavior
 

package/.docs/reference/auth/jwt.md

@@ -19,7 +19,7 @@ export const mastra = new Mastra({
 
 ## Constructor parameters
 
-**secret:** (`string`): A unique string used to sign and verify JSON Web Tokens (JWTs) for authenticating incoming requests.
+**secret** (`string`): A unique string used to sign and verify JSON Web Tokens (JWTs) for authenticating incoming requests.
 
 ## Related
 

package/.docs/reference/auth/supabase.md

@@ -20,13 +20,13 @@ export const mastra = new Mastra({
 
 ## Constructor parameters
 
-**url?:** (`string`): The URL of your Supabase project. Can be found in your Supabase project settings. (Default: `process.env.SUPABASE_URL`)
+**url** (`string`): The URL of your Supabase project. Can be found in your Supabase project settings. (Default: `process.env.SUPABASE_URL`)
 
-**anonKey?:** (`string`): The anonymous/public key for your Supabase project. Used for client-side authentication. (Default: `process.env.SUPABASE_ANON_KEY`)
+**anonKey** (`string`): The anonymous/public key for your Supabase project. Used for client-side authentication. (Default: `process.env.SUPABASE_ANON_KEY`)
 
-**name?:** (`string`): Custom name for the auth provider instance.
+**name** (`string`): Custom name for the auth provider instance.
 
-**authorizeUser?:** (`(user: User, request: HoneRequest) => Promise<boolean> | boolean`): Custom authorization function to determine if a user should be granted access. Called after token verification. By default, checks the 'isAdmin' column in the 'users' table.
+**authorizeUser** (`(user: User, request: HoneRequest) => Promise<boolean> | boolean`): Custom authorization function to determine if a user should be granted access. Called after token verification. By default, checks the 'isAdmin' column in the 'users' table.
 
 ## Related
 

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

@@ -22,21 +22,21 @@ export const mastra = new Mastra({
 
 ## Constructor parameters
 
-**apiKey?:** (`string`): Your WorkOS API key. This is used to authenticate with the WorkOS API for user verification and organization management. (Default: `process.env.WORKOS_API_KEY`)
+**apiKey** (`string`): Your WorkOS API key. This is used to authenticate with the WorkOS API for user verification and organization management. (Default: `process.env.WORKOS_API_KEY`)
 
-**clientId?:** (`string`): Your WorkOS Client ID. This identifies your application when exchanging authorization codes for access tokens. (Default: `process.env.WORKOS_CLIENT_ID`)
+**clientId** (`string`): Your WorkOS Client ID. This identifies your application when exchanging authorization codes for access tokens. (Default: `process.env.WORKOS_CLIENT_ID`)
 
-**name?:** (`string`): Custom name for the auth provider instance. (Default: `"workos"`)
+**name** (`string`): Custom name for the auth provider instance. (Default: `"workos"`)
 
-**authorizeUser?:** (`(user: WorkosUser) => Promise<boolean> | boolean`): Custom authorization function to determine if a user should be granted access. Called after token verification. By default, checks if the user has an 'admin' role in any organization membership.
+**authorizeUser** (`(user: WorkosUser) => Promise<boolean> | boolean`): Custom authorization function to determine if a user should be granted access. Called after token verification. By default, checks if the user has an 'admin' role in any organization membership.
 
 ## Environment Variables
 
 The following environment variables are automatically used when constructor options are not provided:
 
-**WORKOS\_API\_KEY?:** (`string`): Your WorkOS API key. Can be found in your WorkOS Dashboard under API Keys.
+**WORKOS\_API\_KEY** (`string`): Your WorkOS API key. Can be found in your WorkOS Dashboard under API Keys.
 
-**WORKOS\_CLIENT\_ID?:** (`string`): Your WorkOS Client ID. Can be found in your WorkOS Dashboard under Applications.
+**WORKOS\_CLIENT\_ID** (`string`): Your WorkOS Client ID. Can be found in your WorkOS Dashboard under Applications.
 
 ## Default Authorization Behavior
 

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

@@ -92,33 +92,33 @@ bun x create-mastra@latest my-project -- --default --skills claude-code,cursor
 
 Instead of an interactive prompt you can also define these CLI flags.
 
-**--version?:** (`boolean`): Output the version number
+**--version** (`boolean`): Output the version number
 
-**--project-name?:** (`string`): Project name that will be used in package.json and as the project directory name
+**--project-name** (`string`): Project name that will be used in package.json and as the project directory name
 
-**--default?:** (`boolean`): Quick start with defaults (src, OpenAI, no examples)
+**--default** (`boolean`): Quick start with defaults (src, OpenAI, no examples)
 
-**--components?:** (`string`): Comma-separated list of components (agents, tools, workflows, scorers)
+**--components** (`string`): Comma-separated list of components (agents, tools, workflows, scorers)
 
-**--llm?:** (`string`): Default model provider (openai, anthropic, groq, google, or cerebras)
+**--llm** (`string`): Default model provider (openai, anthropic, groq, google, or cerebras)
 
-**--llm-api-key?:** (`string`): API key for the model provider
+**--llm-api-key** (`string`): API key for the model provider
 
-**--example?:** (`boolean`): Include example code
+**--example** (`boolean`): Include example code
 
-**--no-example?:** (`boolean`): Do not include example code
+**--no-example** (`boolean`): Do not include example code
 
-**--template?:** (`string`): Create project from a template (use template name, public GitHub URL, or leave blank to select from list)
+**--template** (`string`): Create project from a template (use template name, public GitHub URL, or leave blank to select from list)
 
-**--timeout?:** (`number`): Configurable timeout for package installation, defaults to 60000 ms
+**--timeout** (`number`): Configurable timeout for package installation, defaults to 60000 ms
 
-**--dir?:** (`string`): Target directory for Mastra source code (default: src/)
+**--dir** (`string`): Target directory for Mastra source code (default: src/)
 
-**--mcp?:** (`string`): MCP Server for code editor (cursor, cursor-global, windsurf, vscode)
+**--mcp** (`string`): MCP Server for code editor (cursor, cursor-global, windsurf, vscode)
 
-**--skills?:** (`string`): Comma-separated list of agents to install Mastra skills for (e.g., claude-code,cursor,windsurf)
+**--skills** (`string`): Comma-separated list of agents to install Mastra skills for (e.g., claude-code,cursor,windsurf)
 
-**--help?:** (`boolean`): Display help for command
+**--help** (`boolean`): Display help for command
 
 ## Telemetry
 

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

@@ -14,50 +14,50 @@ export const mastraClient = new MastraClient({
 
 ## Parameters
 
-**baseUrl:** (`string`): The base URL for the Mastra API. All requests will be sent relative to this URL.
+**baseUrl** (`string`): The base URL for the Mastra API. All requests will be sent relative to this URL.
 
-**retries?:** (`number`): The number of times a request will be retried on failure before throwing an error. (Default: `3`)
+**retries** (`number`): The number of times a request will be retried on failure before throwing an error. (Default: `3`)
 
-**backoffMs?:** (`number`): The initial delay in milliseconds before retrying a failed request. This value is doubled with each retry (exponential backoff). (Default: `300`)
+**backoffMs** (`number`): The initial delay in milliseconds before retrying a failed request. This value is doubled with each retry (exponential backoff). (Default: `300`)
 
-**maxBackoffMs?:** (`number`): The maximum backoff time in milliseconds. Prevents retries from waiting too long between attempts. (Default: `5000`)
+**maxBackoffMs** (`number`): The maximum backoff time in milliseconds. Prevents retries from waiting too long between attempts. (Default: `5000`)
 
-**headers?:** (`Record<string, string>`): An object containing custom HTTP headers to include with every request.
+**headers** (`Record<string, string>`): An object containing custom HTTP headers to include with every request.
 
-**credentials?:** (`"omit" | "same-origin" | "include"`): Credentials mode for requests. See https\://developer.mozilla.org/en-US/docs/Web/API/Request/credentials for more info.
+**credentials** (`"omit" | "same-origin" | "include"`): Credentials mode for requests. See https\://developer.mozilla.org/en-US/docs/Web/API/Request/credentials for more info.
 
 ## Methods
 
-**listAgents():** (`Promise<Record<string, GetAgentResponse>>`): Returns all available agent instances.
+**listAgents()** (`Promise<Record<string, GetAgentResponse>>`): Returns all available agent instances.
 
-**getAgent(agentId):** (`Agent`): Retrieves a specific agent instance by ID.
+**getAgent(agentId)** (`Agent`): Retrieves a specific agent instance by ID.
 
-**getMemoryThreads(params):** (`Promise<StorageThreadType[]>`): Retrieves memory threads for the specified resource and agent. Requires a \`resourceId\` and an \`agentId\`.
+**getMemoryThreads(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.
+**createMemoryThread(params)** (`Promise<MemoryThread>`): Creates a new memory thread with the given parameters.
 
-**getMemoryThread({ threadId, agentId }):** (`MemoryThread`): Fetches a specific memory thread by ID.
+**getMemoryThread({ threadId, agentId })** (`MemoryThread`): Fetches a specific memory thread by ID.
 
-**saveMessageToMemory(params):** (`Promise<{ messages: (MastraMessageV1 | MastraDBMessage)[] }>`): Saves one or more messages to the memory system. Returns the saved messages.
+**saveMessageToMemory(params)** (`Promise<{ messages: (MastraMessageV1 | MastraDBMessage)[] }>`): Saves one or more messages to the memory system. Returns the saved messages.
 
-**getMemoryStatus():** (`Promise<MemoryStatus>`): Returns the current status of the memory system.
+**getMemoryStatus()** (`Promise<MemoryStatus>`): Returns the current status of the memory system.
 
-**listTools():** (`Record<string, Tool>`): Returns all available tools.
+**listTools()** (`Record<string, Tool>`): Returns all available tools.
 
-**getTool(toolId):** (`Tool`): Retrieves a specific tool instance by ID.
+**getTool(toolId)** (`Tool`): Retrieves a specific tool instance by ID.
 
-**listWorkflows():** (`Record<string, Workflow>`): Returns all available workflow instances.
+**listWorkflows()** (`Record<string, Workflow>`): Returns all available workflow instances.
 
-**getWorkflow(workflowId):** (`Workflow`): Retrieves a specific workflow instance by ID.
+**getWorkflow(workflowId)** (`Workflow`): Retrieves a specific workflow instance by ID.
 
-**getVector(vectorName):** (`MastraVector`): Returns a vector store instance by name.
+**getVector(vectorName)** (`MastraVector`): Returns a vector store instance by name.
 
-**listLogs(params):** (`Promise<LogEntry[]>`): Fetches system logs matching the provided filters.
+**listLogs(params)** (`Promise<LogEntry[]>`): Fetches system logs matching the provided filters.
 
-**getLog(params):** (`Promise<LogEntry>`): Retrieves a specific log entry by ID or filter.
+**getLog(params)** (`Promise<LogEntry>`): Retrieves a specific log entry by ID or filter.
 
-**listLogTransports():** (`string[]`): Returns the list of configured log transport types.
+**listLogTransports()** (`string[]`): Returns the list of configured log transport types.
 
-**getTrace(traceId):** (`Promise<TraceRecord>`): Retrieves a specific trace by ID, including all its spans and details.
+**getTrace(traceId)** (`Promise<TraceRecord>`): Retrieves a specific trace by ID, including all its spans and details.
 
-**getTraces(params):** (`Promise<GetTracesResponse>`): Retrieves paginated list of trace root spans with optional filtering. Use getTrace() to get complete traces with all spans.
+**getTraces(params)** (`Promise<GetTracesResponse>`): Retrieves paginated list of trace root spans with optional filtering. Use getTrace() to get complete traces with all spans.

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

@@ -192,8 +192,8 @@ const result = await workflow.runById(runId, {
 
 A workflow run result yields the following:
 
-**runId:** (`string`): Unique identifier for this workflow run instance
+**runId** (`string`): Unique identifier for this workflow run instance
 
-**eventTimestamp:** (`Date`): The timestamp of the event
+**eventTimestamp** (`Date`): The timestamp of the event
 
-**payload:** (`object`): Contains currentStep (id, status, output, payload) and workflowState (status, steps record)
+**payload** (`object`): Contains currentStep (id, status, output, payload) and workflowState (status, steps record)

package/.docs/reference/core/addGateway.md

@@ -19,9 +19,9 @@ mastra.addGateway(new MyCustomGateway())
 
 ## Parameters
 
-**gateway:** (`MastraModelGateway`): The gateway instance to add
+**gateway** (`MastraModelGateway`): The gateway instance to add
 
-**key?:** (`string`): Optional registration key. If not provided, uses gateway.getId()
+**key** (`string`): Optional registration key. If not provided, uses gateway.getId()
 
 ## Returns
 

package/.docs/reference/core/getAgent.md

@@ -10,11 +10,11 @@ mastra.getAgent('testAgent')
 
 ## Parameters
 
-**name:** (`TAgentName extends keyof TAgents`): The name of the agent to retrieve. Must be a valid agent name that exists in the Mastra configuration.
+**name** (`TAgentName extends keyof TAgents`): The name of the agent to retrieve. Must be a valid agent name that exists in the Mastra configuration.
 
 ## Returns
 
-**agent:** (`TAgents[TAgentName]`): The agent instance with the specified name. Throws an error if the agent is not found.
+**agent** (`TAgents[TAgentName]`): The agent instance with the specified name. Throws an error if the agent is not found.
 
 ## Related
 

package/.docs/reference/core/getAgentById.md

@@ -10,11 +10,11 @@ mastra.getAgentById('test-agent-123')
 
 ## Parameters
 
-**id:** (`string`): The ID of the agent to retrieve. The method will first search for an agent with this ID, and if not found, will attempt to use it as a name to call getAgent().
+**id** (`string`): The ID of the agent to retrieve. The method will first search for an agent with this ID, and if not found, will attempt to use it as a name to call getAgent().
 
 ## Returns
 
-**agent:** (`Agent`): The agent instance with the specified ID. Throws an error if the agent is not found.
+**agent** (`Agent`): The agent instance with the specified ID. Throws an error if the agent is not found.
 
 ## Related
 

package/.docs/reference/core/getDeployer.md

@@ -14,7 +14,7 @@ This method does not accept any parameters.
 
 ## Returns
 
-**deployer:** (`MastraDeployer | undefined`): The configured deployer instance, or undefined if no deployer has been configured.
+**deployer** (`MastraDeployer | undefined`): The configured deployer instance, or undefined if no deployer has been configured.
 
 ## Related
 

package/.docs/reference/core/getGateway.md

@@ -19,11 +19,11 @@ console.log(gateway.name) // 'My Custom Gateway'
 
 ## Parameters
 
-**key:** (`string`): The registration key of the gateway
+**key** (`string`): The registration key of the gateway
 
 ## Returns
 
-**gateway:** (`MastraModelGateway`): The gateway instance
+**gateway** (`MastraModelGateway`): The gateway instance
 
 ## Throws
 

package/.docs/reference/core/getGatewayById.md

@@ -26,11 +26,11 @@ console.log(gateway.name) // 'My Custom Gateway'
 
 ## Parameters
 
-**id:** (`string`): The unique ID of the gateway (gateway.id property)
+**id** (`string`): The unique ID of the gateway (gateway.id property)
 
 ## Returns
 
-**gateway:** (`MastraModelGateway | undefined`): The gateway instance, or undefined if not found
+**gateway** (`MastraModelGateway | undefined`): The gateway instance, or undefined if not found
 
 ## Related
 

package/.docs/reference/core/getLogger.md

@@ -14,7 +14,7 @@ This method does not accept any parameters.
 
 ## Returns
 
-**logger:** (`TLogger`): The configured logger instance used for logging across all components (agents, workflows, etc.).
+**logger** (`TLogger`): The configured logger instance used for logging across all components (agents, workflows, etc.).
 
 ## Related
 

package/.docs/reference/core/getMCPServer.md

@@ -30,11 +30,11 @@ const serverById = mastra.getMCPServerById('my-mcp-server')
 
 ## Parameters
 
-**registryKey:** (`string`): The registry key used when registering the MCP server in the mcpServers configuration object. This is the key in the key-value pair, not the server's intrinsic id property.
+**registryKey** (`string`): The registry key used when registering the MCP server in the mcpServers configuration object. This is the key in the key-value pair, not the server's intrinsic id property.
 
 ## Returns
 
-**server:** (`MCPServerBase | undefined`): The MCP server instance with the specified registry key, or undefined if not found.
+**server** (`MCPServerBase | undefined`): The MCP server instance with the specified registry key, or undefined if not found.
 
 ## Related Methods
 

package/.docs/reference/core/getMCPServerById.md

@@ -30,13 +30,13 @@ const serverByKey = mastra.getMCPServer('customKey')
 
 ## Parameters
 
-**serverId:** (`string`): The intrinsic id property of the MCP server (set when the server was instantiated).
+**serverId** (`string`): The intrinsic id property of the MCP server (set when the server was instantiated).
 
-**version?:** (`string`): Optional. If provided, returns the server only if its version matches.
+**version** (`string`): Optional. If provided, returns the server only if its version matches.
 
 ## Returns
 
-**server:** (`MCPServerBase | undefined`): The MCP server instance with the specified id (and version, if provided), or undefined if not found.
+**server** (`MCPServerBase | undefined`): The MCP server instance with the specified id (and version, if provided), or undefined if not found.
 
 ## Notes
 

package/.docs/reference/core/getMemory.md

@@ -16,11 +16,11 @@ const thread = await memory.createThread({
 
 ## Parameters
 
-**key:** (`TMemoryKey extends keyof TMemory`): The registry key of the memory instance to retrieve. Must match a key used when registering memory in the Mastra constructor.
+**key** (`TMemoryKey extends keyof TMemory`): The registry key of the memory instance to retrieve. Must match a key used when registering memory in the Mastra constructor.
 
 ## Returns
 
-**memory:** (`TMemory[TMemoryKey]`): The memory instance with the specified key. Throws an error if the memory is not found.
+**memory** (`TMemory[TMemoryKey]`): The memory instance with the specified key. Throws an error if the memory is not found.
 
 ## Example: Registering and Retrieving Memory