@mastra/core 1.9.0 → 1.10.0

package/dist/docs/references/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/dist/docs/references/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/dist/docs/references/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/dist/docs/references/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/dist/docs/references/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/dist/docs/references/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/dist/docs/references/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/dist/docs/references/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/dist/docs/references/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/dist/docs/references/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/dist/docs/references/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/dist/docs/references/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/dist/docs/references/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/dist/docs/references/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/dist/docs/references/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/dist/docs/references/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
 

package/dist/docs/references/reference-core-getScorer.md

@@ -24,11 +24,11 @@ await weatherAgent.generate('What is the weather in Rome', {
 
 ## Parameters
 
-**key:** (`string`): The registration key of the scorer to retrieve. This should match a key used when registering scorers in the Mastra constructor.
+**key** (`string`): The registration key of the scorer to retrieve. This should match a key used when registering scorers in the Mastra constructor.
 
 ## Returns
 
-**scorer:** (`MastraScorer`): The MastraScorer instance associated with the provided key.
+**scorer** (`MastraScorer`): The MastraScorer instance associated with the provided key.
 
 ## Error Handling
 

package/dist/docs/references/reference-core-getScorerById.md

@@ -24,11 +24,11 @@ await weatherAgent.generate('What is the weather in Rome', {
 
 ## Parameters
 
-**id:** (`string`): The id property of the scorer to retrieve. This should match the 'id' field specified when creating the scorer with createScorer(). The method will also search by 'name' property as a fallback.
+**id** (`string`): The id property of the scorer to retrieve. This should match the 'id' field specified when creating the scorer with createScorer(). The method will also search by 'name' property as a fallback.
 
 ## Returns
 
-**scorer:** (`MastraScorer`): The MastraScorer instance that has the matching id (or name) property.
+**scorer** (`MastraScorer`): The MastraScorer instance that has the matching id (or name) property.
 
 ## Error Handling
 

package/dist/docs/references/reference-core-getServer.md

@@ -14,7 +14,7 @@ This method does not accept any parameters.
 
 ## Returns
 
-**server:** (`ServerConfig | undefined`): The configured server configuration including port, host, studioBase, timeout, API routes, middleware, CORS settings, and build options, or undefined if no server has been configured.
+**server** (`ServerConfig | undefined`): The configured server configuration including port, host, studioBase, timeout, API routes, middleware, CORS settings, and build options, or undefined if no server has been configured.
 
 ## Related
 

package/dist/docs/references/reference-core-getStorage.md

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

package/dist/docs/references/reference-core-getStoredAgentById.md

@@ -26,17 +26,15 @@ if (storedConfig) {
 
 ## Parameters
 
-**id:** (`string`): The unique identifier of the stored agent to retrieve.
+**id** (`string`): The unique identifier of the stored agent to retrieve.
 
-**options?:** (`{ raw?: boolean }`): Optional configuration object.
+**options** (`{ raw?: boolean }`): Optional configuration object.
 
-### Options
-
-**raw?:** (`boolean`): When \`true\`, returns the raw \`StorageAgentType\` object from storage instead of creating an \`Agent\` instance. Useful for inspecting stored configuration or metadata. (Default: `false`)
+**options.raw** (`boolean`): When \`true\`, returns the raw \`StorageAgentType\` object from storage instead of creating an \`Agent\` instance. Useful for inspecting stored configuration or metadata.
 
 ## Returns
 
-**result:** (`Agent | StorageAgentType | null`): Returns an \`Agent\` instance by default, or \`StorageAgentType\` when \`raw: true\`. Returns \`null\` if no agent with the given ID exists.
+**result** (`Agent | StorageAgentType | null`): Returns an \`Agent\` instance by default, or \`StorageAgentType\` when \`raw: true\`. Returns \`null\` if no agent with the given ID exists.
 
 ## Primitive Resolution
 
@@ -54,33 +52,33 @@ If a referenced primitive is not found in the registry, a warning is logged but
 
 When using `raw: true`, the returned object has the following structure:
 
-**id:** (`string`): Unique identifier for the agent.
+**id** (`string`): Unique identifier for the agent.
 
-**name:** (`string`): Display name of the agent.
+**name** (`string`): Display name of the agent.
 
-**description?:** (`string`): Optional description of the agent.
+**description** (`string`): Optional description of the agent.
 
-**instructions:** (`string`): System instructions for the agent.
+**instructions** (`string`): System instructions for the agent.
 
-**model:** (`Record<string, unknown>`): Model configuration with provider and name.
+**model** (`Record<string, unknown>`): Model configuration with provider and name.
 
-**tools?:** (`Record<string, unknown>`): Tool references to resolve from registry.
+**tools** (`Record<string, unknown>`): Tool references to resolve from registry.
 
-**workflows?:** (`Record<string, unknown>`): Workflow references to resolve from registry.
+**workflows** (`Record<string, unknown>`): Workflow references to resolve from registry.
 
-**agents?:** (`Record<string, unknown>`): Subagent references to resolve from registry.
+**agents** (`Record<string, unknown>`): Subagent references to resolve from registry.
 
-**memory?:** (`Record<string, unknown>`): Memory reference to resolve from registry.
+**memory** (`Record<string, unknown>`): Memory reference to resolve from registry.
 
-**scorers?:** (`Record<string, unknown>`): Scorer references with optional sampling config.
+**scorers** (`Record<string, unknown>`): Scorer references with optional sampling config.
 
-**defaultOptions?:** (`Record<string, unknown>`): Default options passed to agent execution.
+**defaultOptions** (`Record<string, unknown>`): Default options passed to agent execution.
 
-**metadata?:** (`Record<string, unknown>`): Custom metadata stored with the agent.
+**metadata** (`Record<string, unknown>`): Custom metadata stored with the agent.
 
-**createdAt:** (`Date`): Timestamp when the agent was created.
+**createdAt** (`Date`): Timestamp when the agent was created.
 
-**updatedAt:** (`Date`): Timestamp when the agent was last updated.
+**updatedAt** (`Date`): Timestamp when the agent was last updated.
 
 ## Related
 

package/dist/docs/references/reference-core-getTelemetry.md

@@ -14,7 +14,7 @@ This method does not accept any parameters.
 
 ## Returns
 
-**telemetry:** (`Telemetry | undefined`): The configured telemetry instance used for tracing and observability across all components, or undefined if no telemetry has been configured.
+**telemetry** (`Telemetry | undefined`): The configured telemetry instance used for tracing and observability across all components, or undefined if no telemetry has been configured.
 
 ## Related
 

package/dist/docs/references/reference-core-getVector.md

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

package/dist/docs/references/reference-core-getWorkflow.md

@@ -29,13 +29,13 @@ If you need to retrieve a workflow by its `id` property instead of its registrat
 
 ## Parameters
 
-**id:** (`TWorkflowId extends keyof TWorkflows`): The ID of the workflow to retrieve. Must be a valid workflow ID that exists in the Mastra configuration.
+**id** (`TWorkflowId extends keyof TWorkflows`): The ID of the workflow to retrieve. Must be a valid workflow ID that exists in the Mastra configuration.
 
-**options:** (`{ serialized?: boolean }`): Optional configuration object. When \`serialized\` is true, returns only the workflow name instead of the full workflow instance.
+**options** (`{ serialized?: boolean }`): Optional configuration object. When \`serialized\` is true, returns only the workflow name instead of the full workflow instance.
 
 ## Returns
 
-**workflow:** (`TWorkflows[TWorkflowId]`): The workflow instance with the specified ID. Throws an error if the workflow is not found.
+**workflow** (`TWorkflows[TWorkflowId]`): The workflow instance with the specified ID. Throws an error if the workflow is not found.
 
 ## Related
 

package/dist/docs/references/reference-core-listAgents.md

@@ -14,7 +14,7 @@ This method does not accept any parameters.
 
 ## Returns
 
-**agents:** (`TAgents`): A record of all configured agents, where keys are agent names and values are agent instances.
+**agents** (`TAgents`): A record of all configured agents, where keys are agent names and values are agent instances.
 
 ## Related
 

package/dist/docs/references/reference-core-listGateways.md

@@ -29,7 +29,7 @@ None.
 
 ## Returns
 
-**gateways:** (`Record<string, MastraModelGateway>`): A record of gateway instances indexed by registration key
+**gateways** (`Record<string, MastraModelGateway>`): A record of gateway instances indexed by registration key
 
 ## Related
 

package/dist/docs/references/reference-core-listLogs.md

@@ -10,27 +10,25 @@ mastra.listLogs('456')
 
 ## Parameters
 
-**transportId:** (`string`): The transport ID to retrieve logs from.
+**transportId** (`string`): The transport ID to retrieve logs from.
 
-**options:** (`object`): Optional parameters for filtering and pagination. See Options section below for details.
+**options** (`object`): Optional parameters for filtering and pagination.
 
-### Options
+**options.fromDate** (`Date`): Optional start date for filtering logs. e.g., new Date('2024-01-01').
 
-**fromDate:** (`Date`): Optional start date for filtering logs. e.g., new Date('2024-01-01').
+**options.toDate** (`Date`): Optional end date for filtering logs. e.g., new Date('2024-01-31').
 
-**toDate:** (`Date`): Optional end date for filtering logs. e.g., new Date('2024-01-31').
+**options.logLevel** (`LogLevel`): Optional log level to filter by.
 
-**logLevel:** (`LogLevel`): Optional log level to filter by.
+**options.filters** (`Record<string, any>`): Optional additional filters to apply to the log query.
 
-**filters:** (`Record<string, any>`): Optional additional filters to apply to the log query.
+**options.page** (`number`): Optional page number for pagination.
 
-**page:** (`number`): Optional page number for pagination.
-
-**perPage:** (`number`): Optional number of logs per page for pagination.
+**options.perPage** (`number`): Optional number of logs per page for pagination.
 
 ## Returns
 
-**logs:** (`Promise<any>`): A promise that resolves to the logs for the specified transport ID.
+**logs** (`Promise<any>`): A promise that resolves to the logs for the specified transport ID.
 
 ## Related
 

package/dist/docs/references/reference-core-listLogsByRunId.md

@@ -10,25 +10,25 @@ mastra.listLogsByRunId({ runId: '123', transportId: '456' })
 
 ## Parameters
 
-**runId:** (`string`): The run ID to retrieve logs for.
+**runId** (`string`): The run ID to retrieve logs for.
 
-**transportId:** (`string`): The transport ID to retrieve logs from.
+**transportId** (`string`): The transport ID to retrieve logs from.
 
-**fromDate:** (`Date`): Optional start date for filtering logs. e.g., new Date('2024-01-01').
+**fromDate** (`Date`): Optional start date for filtering logs. e.g., new Date('2024-01-01').
 
-**toDate:** (`Date`): Optional end date for filtering logs. e.g., new Date('2024-01-31').
+**toDate** (`Date`): Optional end date for filtering logs. e.g., new Date('2024-01-31').
 
-**logLevel:** (`LogLevel`): Optional log level to filter by.
+**logLevel** (`LogLevel`): Optional log level to filter by.
 
-**filters:** (`Record<string, any>`): Optional additional filters to apply to the log query.
+**filters** (`Record<string, any>`): Optional additional filters to apply to the log query.
 
-**page:** (`number`): Optional page number for pagination.
+**page** (`number`): Optional page number for pagination.
 
-**perPage:** (`number`): Optional number of logs per page for pagination.
+**perPage** (`number`): Optional number of logs per page for pagination.
 
 ## Returns
 
-**logs:** (`Promise<any>`): A promise that resolves to the logs for the specified run ID and transport ID.
+**logs** (`Promise<any>`): A promise that resolves to the logs for the specified run ID and transport ID.
 
 ## Related
 

package/dist/docs/references/reference-core-listMCPServers.md

@@ -42,7 +42,7 @@ This method does not accept any parameters.
 
 ## Returns
 
-**servers:** (`Record<string, MCPServerBase> | undefined`): A record of all registered MCP server instances, where keys are the registry keys (from mcpServers configuration) and values are MCPServerBase instances, or undefined if no servers are registered.
+**servers** (`Record<string, MCPServerBase> | undefined`): A record of all registered MCP server instances, where keys are the registry keys (from mcpServers configuration) and values are MCPServerBase instances, or undefined if no servers are registered.
 
 ## Related Methods
 

package/dist/docs/references/reference-core-listMemory.md

@@ -18,7 +18,7 @@ This method takes no parameters.
 
 ## Returns
 
-**memory:** (`Record<string, MastraMemory>`): An object containing all registered memory instances, keyed by their registry keys.
+**memory** (`Record<string, MastraMemory>`): An object containing all registered memory instances, keyed by their registry keys.
 
 ## Example: Checking Registered Memory
 

package/dist/docs/references/reference-core-listScorers.md

@@ -20,7 +20,7 @@ This method takes no parameters.
 
 ## Returns
 
-**scorers:** (`Record<string, MastraScorer> | undefined`): An object containing all registered scorers, where keys are scorer names and values are MastraScorer instances. Returns undefined if no scorers are registered.
+**scorers** (`Record<string, MastraScorer> | undefined`): An object containing all registered scorers, where keys are scorer names and values are MastraScorer instances. Returns undefined if no scorers are registered.
 
 ## Related
 

package/dist/docs/references/reference-core-listStoredAgents.md

@@ -33,27 +33,25 @@ for (const config of result.agents) {
 
 ## Parameters
 
-**args?:** (`object`): Optional configuration object for pagination and output format.
+**args** (`object`): Optional configuration object for pagination and output format.
 
-### Args Options
+**args.page** (`number`): Zero-indexed page number for pagination.
 
-**page?:** (`number`): Zero-indexed page number for pagination. (Default: `0`)
+**args.perPage** (`number | false`): Number of items per page. Set to \`false\` to fetch all records without pagination.
 
-**perPage?:** (`number | false`): Number of items per page. Set to \`false\` to fetch all records without pagination. (Default: `100`)
-
-**raw?:** (`boolean`): When \`true\`, returns raw \`StorageAgentType\` objects instead of \`Agent\` instances. (Default: `false`)
+**args.raw** (`boolean`): When \`true\`, returns raw \`StorageAgentType\` objects instead of \`Agent\` instances.
 
 ## Returns
 
-**agents:** (`Agent[] | StorageAgentType[]`): Array of \`Agent\` instances by default, or \`StorageAgentType\` objects when \`raw: true\`.
+**agents** (`Agent[] | StorageAgentType[]`): Array of \`Agent\` instances by default, or \`StorageAgentType\` objects when \`raw: true\`.
 
-**total:** (`number`): Total number of stored agents across all pages.
+**total** (`number`): Total number of stored agents across all pages.
 
-**page:** (`number`): Current page number (zero-indexed).
+**page** (`number`): Current page number (zero-indexed).
 
-**perPage:** (`number | false`): Number of items per page, or \`false\` if fetching all.
+**perPage** (`number | false`): Number of items per page, or \`false\` if fetching all.
 
-**hasMore:** (`boolean`): Whether there are more pages available.
+**hasMore** (`boolean`): Whether there are more pages available.
 
 ## Primitive Resolution
 

package/dist/docs/references/reference-core-listVectors.md

@@ -14,7 +14,7 @@ This method does not accept any parameters.
 
 ## Returns
 
-**vectors:** (`TVectors`): A record of all configured vector stores, where keys are vector store names and values are vector store instances.
+**vectors** (`TVectors`): A record of all configured vector stores, where keys are vector store names and values are vector store instances.
 
 ## Related