@mastra/core 1.6.0 → 1.7.0-alpha.0

package/dist/docs/references/reference-agents-generateLegacy.md

@@ -1,176 +0,0 @@
-# Agent.generateLegacy() (Legacy)
-
-> **Warning:** **Deprecated**: This method is deprecated and only works with V1 models. For V2 models, use the new [`.generate()`](https://mastra.ai/reference/agents/generate) method instead.
-
-The `.generateLegacy()` method is the legacy version of the agent generation API, used to interact with V1 model agents to produce text or structured responses. This method accepts messages and optional generation options.
-
-## Usage example
-
-```typescript
-await agent.generateLegacy("message for agent");
-```
-
-## Parameters
-
-**messages:** (`string | string[] | CoreMessage[] | AiMessageType[] | UIMessageWithMetadata[]`): The messages to send to the agent. Can be a single string, array of strings, or structured message objects with multimodal content (text, images, etc.).
-
-**options?:** (`AgentGenerateOptions`): Optional configuration for the generation process.
-
-### Options parameters
-
-**abortSignal?:** (`AbortSignal`): Signal object that allows you to abort the agent's execution. When the signal is aborted, all ongoing operations will be terminated.
-
-**context?:** (`CoreMessage[]`): Additional context messages to provide to the agent.
-
-**structuredOutput?:** (`StructuredOutputOptions<S extends ZodTypeAny = ZodTypeAny>`): schema:z.ZodSchema\<S>Zod schema to validate the output against.model:MastraLanguageModelModel to use for the internal structuring agent.errorStrategy?:'strict' | 'warn' | 'fallback'Strategy when parsing or validation fails. Defaults to 'strict'.fallbackValue?:\<S extends ZodTypeAny>Fallback value when errorStrategy is 'fallback'.instructions?:stringCustom instructions for the structuring agent.
-
-**outputProcessors?:** (`Processor[]`): Overrides the output processors set on the agent. Output processors that can modify or validate messages from the agent before they are returned to the user. Must implement either (or both) of the \`processOutputResult\` and \`processOutputStream\` functions.
-
-**inputProcessors?:** (`Processor[]`): Overrides the input processors set on the agent. Input processors that can modify or validate messages before they are processed by the agent. Must implement the \`processInput\` function.
-
-**experimental\_output?:** (`Zod schema | JsonSchema7`): Note, the preferred route is to use the \`structuredOutput\` property. Enables structured output generation alongside text generation and tool calls. The model will generate responses that conform to the provided schema.
-
-**instructions?:** (`string`): Custom instructions that override the agent's default instructions for this specific generation. Useful for dynamically modifying agent behavior without creating a new agent instance.
-
-**output?:** (`Zod schema | JsonSchema7`): Defines the expected structure of the output. Can be a JSON Schema object or a Zod schema.
-
-**memory?:** (`object`): thread:string | { id: string; metadata?: Record\<string, any>, title?: string }The conversation thread, as a string ID or an object with an \`id\` and optional \`metadata\`.resource:stringIdentifier for the user or resource associated with the thread.options?:MemoryConfigConfiguration for memory behavior, like message history and semantic recall. See \`MemoryConfig\` below.
-
-**maxSteps?:** (`number`): Maximum number of execution steps allowed. (Default: `5`)
-
-**maxRetries?:** (`number`): Maximum number of retries. Set to 0 to disable retries. (Default: `2`)
-
-**onStepFinish?:** (`GenerateTextOnStepFinishCallback<any> | never`): Callback function called after each execution step. Receives step details as a JSON string. Unavailable for structured output
-
-**runId?:** (`string`): Unique ID for this generation run. Useful for tracking and debugging purposes.
-
-**telemetry?:** (`TelemetrySettings`): isEnabled?:booleanEnable or disable telemetry. Disabled by default while experimental.recordInputs?:booleanEnable or disable input recording. Enabled by default. You might want to disable input recording to avoid recording sensitive information.recordOutputs?:booleanEnable or disable output recording. Enabled by default. You might want to disable output recording to avoid recording sensitive information.functionId?:stringIdentifier for this function. Used to group telemetry data by function.
-
-**temperature?:** (`number`): Controls randomness in the model's output. Higher values (e.g., 0.8) make the output more random, lower values (e.g., 0.2) make it more focused and deterministic.
-
-**toolChoice?:** (`'auto' | 'none' | 'required' | { type: 'tool'; toolName: string }`): 'auto':stringLet the model decide whether to use tools (default).'none':stringDo not use any tools.'required':stringRequire the model to use at least one tool.{ type: 'tool'; toolName: string }:objectRequire the model to use a specific tool by name. (Default: `'auto'`)
-
-**toolsets?:** (`ToolsetsInput`): Additional toolsets to make available to the agent during generation.
-
-**clientTools?:** (`ToolsInput`): Tools that are executed on the 'client' side of the request. These tools do not have execute functions in the definition.
-
-**savePerStep?:** (`boolean`): Save messages incrementally after each stream step completes (default: false).
-
-**providerOptions?:** (`Record<string, Record<string, JSONValue>>`): openai?:Record\<string, JSONValue>OpenAI-specific options. Example: \`{ reasoningEffort: 'high' }\`anthropic?:Record\<string, JSONValue>Anthropic-specific options. Example: \`{ maxTokens: 1000 }\`google?:Record\<string, JSONValue>Google-specific options. Example: \`{ safetySettings: \[...] }\`\[providerName]?:Record\<string, JSONValue>Other provider-specific options. The key is the provider name and the value is a record of provider-specific options.
-
-**requestContext?:** (`RequestContext`): Request Context for dependency injection and contextual information.
-
-**maxTokens?:** (`number`): Maximum number of tokens to generate.
-
-**topP?:** (`number`): Nucleus sampling. This is a number between 0 and 1. It is recommended to set either \`temperature\` or \`topP\`, but not both.
-
-**topK?:** (`number`): Only sample from the top K options for each subsequent token. Used to remove 'long tail' low probability responses.
-
-**presencePenalty?:** (`number`): Presence penalty setting. It affects the likelihood of the model to repeat information that is already in the prompt. A number between -1 (increase repetition) and 1 (maximum penalty, decrease repetition).
-
-**frequencyPenalty?:** (`number`): Frequency penalty setting. It affects the likelihood of the model to repeatedly use the same words or phrases. A number between -1 (increase repetition) and 1 (maximum penalty, decrease repetition).
-
-**stopSequences?:** (`string[]`): Stop sequences. If set, the model will stop generating text when one of the stop sequences is generated.
-
-**seed?:** (`number`): The seed (integer) to use for random sampling. If set and supported by the model, calls will generate deterministic results.
-
-**headers?:** (`Record<string, string | undefined>`): Additional HTTP headers to be sent with the request. Only applicable for HTTP-based providers.
-
-## Returns
-
-**text?:** (`string`): The generated text response. Present when output is 'text' (no schema provided).
-
-**object?:** (`object`): The generated structured response. Present when a schema is provided via \`output\`, \`structuredOutput\`, or \`experimental\_output\`.
-
-**toolCalls?:** (`Array<ToolCall>`): toolName:stringThe name of the tool invoked.args:anyThe arguments passed to the tool.
-
-## Migration to New API
-
-> **Info:** The new `.generate()` method offers enhanced capabilities including AI SDK v5+ compatibility, better structured output handling, and improved streaming support. See the [migration guide](https://mastra.ai/guides/migrations/vnext-to-standard-apis) for detailed migration instructions.
-
-### Quick Migration Example
-
-#### Before (Legacy)
-
-```typescript
-const result = await agent.generateLegacy("message", {
-  temperature: 0.7,
-  maxSteps: 3,
-});
-```
-
-#### After (New API)
-
-```typescript
-const result = await agent.generate("message", {
-  modelSettings: {
-    temperature: 0.7,
-  },
-  maxSteps: 3,
-});
-```
-
-## Extended usage example
-
-```typescript
-import { z } from "zod";
-import {
-  ModerationProcessor,
-  TokenLimiterProcessor,
-} from "@mastra/core/processors";
-
-await agent.generateLegacy(
-  [
-    { role: "user", content: "message for agent" },
-    {
-      role: "user",
-      content: [
-        {
-          type: "text",
-          text: "message for agent",
-        },
-        {
-          type: "image",
-          imageUrl: "https://example.com/image.jpg",
-          mimeType: "image/jpeg",
-        },
-      ],
-    },
-  ],
-  {
-    temperature: 0.7,
-    maxSteps: 3,
-    memory: {
-      thread: "user-123",
-      resource: "test-app",
-    },
-    toolChoice: "auto",
-    providerOptions: {
-      openai: {
-        reasoningEffort: "high",
-      },
-    },
-    // Structured output with better DX
-    structuredOutput: {
-      schema: z.object({
-        sentiment: z.enum(["positive", "negative", "neutral"]),
-        confidence: z.number(),
-      }),
-      model: "openai/gpt-5.1",
-      errorStrategy: "warn",
-    },
-    // Output processors for response validation
-    outputProcessors: [
-      new ModerationProcessor({ model: "openai/gpt-4.1-nano" }),
-      new TokenLimiterProcessor({ maxTokens: 1000 }),
-    ],
-  },
-);
-```
-
-## Related
-
-- [Migration Guide](https://mastra.ai/guides/migrations/vnext-to-standard-apis)
-- [New .generate() method](https://mastra.ai/reference/agents/generate)
-- [Generating responses](https://mastra.ai/docs/agents/overview)
-- [Streaming responses](https://mastra.ai/docs/agents/overview)

package/dist/docs/references/reference-agents-getDefaultGenerateOptions.md

@@ -1,36 +0,0 @@
-# Agent.getDefaultGenerateOptionsLegacy()
-
-> **Warning:** **Deprecated**: This method is deprecated and only works with V1 models. For V2 models, use the new [`.getDefaultOptions()`](https://mastra.ai/reference/agents/getDefaultOptions) method instead.
-
-Agents can be configured with default generation options for controlling model behavior, output formatting and tool and workflow calls. The `.getDefaultGenerateOptionsLegacy()` method retrieves these defaults, resolving them if they are functions. These options apply to all `generateLegacy()` calls unless overridden and are useful for inspecting an agent’s unknown defaults.
-
-## Usage example
-
-```typescript
-await agent.getDefaultGenerateOptionsLegacy();
-```
-
-## Parameters
-
-**options?:** (`{ requestContext?: RequestContext }`): Optional configuration object containing request context. (Default: `{}`)
-
-## Returns
-
-**defaultOptions:** (`AgentGenerateOptions | Promise<AgentGenerateOptions>`): The default generation options configured for the agent, either as a direct object or a promise that resolves to the options.
-
-## Extended usage example
-
-```typescript
-await agent.getDefaultGenerateOptionsLegacy({
-  requestContext: new RequestContext(),
-});
-```
-
-### Options parameters
-
-**requestContext?:** (`RequestContext`): Request Context for dependency injection and contextual information. (Default: `new RequestContext()`)
-
-## Related
-
-- [Agent generation](https://mastra.ai/docs/agents/overview)
-- [Request Context](https://mastra.ai/docs/server/request-context)

package/dist/docs/references/reference-agents-getDefaultOptions.md

@@ -1,34 +0,0 @@
-# Agent.getDefaultOptions()
-
-Agents can be configured with default options for memory usage, output format, and iteration steps. The `.getDefaultOptions()` method returns these defaults, resolving them if they are functions. These options apply to all `stream()` and `generate()` calls unless overridden and are useful for inspecting an agent’s unknown defaults.
-
-## Usage example
-
-```typescript
-await agent.getDefaultOptions();
-```
-
-## Parameters
-
-**options?:** (`{ requestContext?: RequestContext }`): Optional configuration object containing request context. (Default: `{}`)
-
-## Returns
-
-**defaultOptions:** (`AgentExecutionOptions<Output> | Promise<AgentExecutionOptions<Output>>`): The default streaming options configured for the agent, either as a direct object or a promise that resolves to the options.
-
-## Extended usage example
-
-```typescript
-await agent.getDefaultOptions({
-  requestContext: new RequestContext(),
-});
-```
-
-### Options parameters
-
-**requestContext?:** (`RequestContext`): Request Context for dependency injection and contextual information. (Default: `new RequestContext()`)
-
-## Related
-
-- [Streaming with agents](https://mastra.ai/docs/streaming/overview)
-- [Request Context](https://mastra.ai/docs/server/request-context)

package/dist/docs/references/reference-agents-getDefaultStreamOptions.md

@@ -1,36 +0,0 @@
-# Agent.getDefaultStreamOptionsLegacy()
-
-> **Warning:** **Deprecated**: This method is deprecated and only works with V1 models. For V2 models, use the new [`.getDefaultOptions()`](https://mastra.ai/reference/agents/getDefaultOptions) method instead.
-
-Agents can be configured with default streaming options for memory usage, output format, and iteration steps. The `.getDefaultStreamOptionsLegacy()` method returns these defaults, resolving them if they are functions. These options apply to all `streamLegacy()` calls unless overridden and are useful for inspecting an agent’s unknown defaults.
-
-## Usage example
-
-```typescript
-await agent.getDefaultStreamOptionsLegacy();
-```
-
-## Parameters
-
-**options?:** (`{ requestContext?: RequestContext }`): Optional configuration object containing request context. (Default: `{}`)
-
-## Returns
-
-**defaultOptions:** (`AgentStreamOptions | Promise<AgentStreamOptions>`): The default vNext streaming options configured for the agent, either as a direct object or a promise that resolves to the options.
-
-## Extended usage example
-
-```typescript
-await agent.getDefaultStreamOptionsLegacy({
-  requestContext: new RequestContext(),
-});
-```
-
-### Options parameters
-
-**requestContext?:** (`RequestContext`): Request Context for dependency injection and contextual information. (Default: `new RequestContext()`)
-
-## Related
-
-- [Streaming with agents](https://mastra.ai/docs/streaming/overview)
-- [Request Context](https://mastra.ai/docs/server/request-context)

package/dist/docs/references/reference-agents-getDescription.md

@@ -1,21 +0,0 @@
-# Agent.getDescription()
-
-The `.getDescription()` method retrieves the description configured for an agent. This method returns a simple string description that describes the agent's purpose and capabilities.
-
-## Usage example
-
-```typescript
-agent.getDescription();
-```
-
-## Parameters
-
-This method takes no parameters.
-
-## Returns
-
-**description:** (`string`): The description of the agent, or an empty string if no description was configured.
-
-## Related
-
-- [Agents overview](https://mastra.ai/docs/agents/overview)

package/dist/docs/references/reference-agents-getInstructions.md

@@ -1,34 +0,0 @@
-# Agent.getInstructions()
-
-The `.getInstructions()` method retrieves the instructions configured for an agent, resolving them if they're a function. These instructions guide the agent's behavior and define its capabilities and constraints.
-
-## Usage example
-
-```typescript
-await agent.getInstructions();
-```
-
-## Parameters
-
-**options?:** (`{ requestContext?: RequestContext }`): Optional configuration object containing request context. (Default: `{}`)
-
-## Returns
-
-**instructions:** (`SystemMessage | Promise<SystemMessage>`): The instructions configured for the agent. SystemMessage can be: string | string\[] | CoreSystemMessage | CoreSystemMessage\[] | SystemModelMessage | SystemModelMessage\[]. Returns either directly or as a promise that resolves to the instructions.
-
-## Extended usage example
-
-```typescript
-await agent.getInstructions({
-  requestContext: new RequestContext(),
-});
-```
-
-### Options parameters
-
-**requestContext?:** (`RequestContext`): Request Context for dependency injection and contextual information. (Default: `undefined`)
-
-## Related
-
-- [Agents overview](https://mastra.ai/docs/agents/overview)
-- [Request Context](https://mastra.ai/docs/server/request-context)

package/dist/docs/references/reference-agents-getLLM.md

@@ -1,37 +0,0 @@
-# Agent.getLLM()
-
-The `.getLLM()` method retrieves the language model instance configured for an agent, resolving it if it's a function. This method provides access to the underlying LLM that powers the agent's capabilities.
-
-## Usage example
-
-```typescript
-await agent.getLLM();
-```
-
-## Parameters
-
-**options?:** (`{ requestContext?: RequestContext; model?: MastraLanguageModel | DynamicArgument<MastraLanguageModel> }`): Optional configuration object containing request context and optional model override. (Default: `{}`)
-
-## Returns
-
-**llm:** (`MastraLLMV1 | Promise<MastraLLMV1>`): The language model instance configured for the agent, either as a direct instance or a promise that resolves to the LLM.
-
-## Extended usage example
-
-```typescript
-await agent.getLLM({
-  requestContext: new RequestContext(),
-  model: "openai/gpt-5.1",
-});
-```
-
-### Options parameters
-
-**requestContext?:** (`RequestContext`): Request Context for dependency injection and contextual information. (Default: `new RequestContext()`)
-
-**model?:** (`MastraLanguageModel | DynamicArgument<MastraLanguageModel>`): Optional model override. If provided, this model will be used used instead of the agent's configured model.
-
-## Related
-
-- [Agents overview](https://mastra.ai/docs/agents/overview)
-- [Request Context](https://mastra.ai/docs/server/request-context)

package/dist/docs/references/reference-agents-getMemory.md

@@ -1,34 +0,0 @@
-# Agent.getMemory()
-
-The `.getMemory()` method retrieves the memory system associated with an agent. This method is used to access the agent's memory capabilities for storing and retrieving information across conversations.
-
-## Usage example
-
-```typescript
-await agent.getMemory();
-```
-
-## Parameters
-
-**options?:** (`{ requestContext?: RequestContext }`): Optional configuration object containing request context. (Default: `{}`)
-
-## Returns
-
-**memory:** (`Promise<MastraMemory | undefined>`): A promise that resolves to the memory system configured for the agent, or undefined if no memory system is configured.
-
-## Extended usage example
-
-```typescript
-await agent.getMemory({
-  requestContext: new RequestContext(),
-});
-```
-
-### Options parameters
-
-**requestContext?:** (`RequestContext`): Request Context for dependency injection and contextual information. (Default: `new RequestContext()`)
-
-## Related
-
-- [Agent memory](https://mastra.ai/docs/agents/agent-memory)
-- [Request Context](https://mastra.ai/docs/server/request-context)

package/dist/docs/references/reference-agents-getModel.md

@@ -1,34 +0,0 @@
-# Agent.getModel()
-
-The `.getModel()` method retrieves the language model configured for an agent, resolving it if it's a function. This method is used to access the underlying model that powers the agent's capabilities.
-
-## Usage example
-
-```typescript
-await agent.getModel();
-```
-
-## Parameters
-
-**{ requestContext = new RequestContext() }?:** (`{ requestContext?: RequestContext }`): Optional configuration object containing request context. (Default: `new RequestContext()`)
-
-## Returns
-
-**model:** (`MastraLanguageModel | Promise<MastraLanguageModel>`): The language model configured for the agent, either as a direct instance or a promise that resolves to the model.
-
-## Extended usage example
-
-```typescript
-await agent.getModel({
-  requestContext: new RequestContext(),
-});
-```
-
-### Options parameters
-
-**requestContext?:** (`RequestContext`): Request Context for dependency injection and contextual information. (Default: `undefined`)
-
-## Related
-
-- [Agents overview](https://mastra.ai/docs/agents/overview)
-- [Request Context](https://mastra.ai/docs/server/request-context)

package/dist/docs/references/reference-agents-getTools.md

@@ -1,29 +0,0 @@
-# Agent.getTools()
-
-The `.getTools()` method retrieves the tools configured for an agent, resolving them if they're a function. These tools extend the agent's capabilities, allowing it to perform specific actions or access external systems.
-
-## Usage example
-
-```typescript
-await agent.getTools();
-```
-
-## Parameters
-
-**options?:** (`{ requestContext?: RequestContext }`): Optional configuration object containing runtime context. (Default: `{}`)
-
-## Returns
-
-**tools:** (`TTools | Promise<TTools>`): The tools configured for the agent, either as a direct object or a promise that resolves to the tools.
-
-## Extended usage example
-
-```typescript
-await agent.getTools({
-  requestContext: new RequestContext(),
-});
-```
-
-### Options parameters
-
-**requestContext?:** (`RequestContext`): Runtime context for dependency injection and contextual information. (Default: `new RequestContext()`)

package/dist/docs/references/reference-agents-getVoice.md

@@ -1,34 +0,0 @@
-# Agent.getVoice()
-
-The `.getVoice()` method retrieves the voice provider configured for an agent, resolving it if it's a function. This method is used to access the agent's speech capabilities for text-to-speech and speech-to-text functionality.
-
-## Usage example
-
-```typescript
-await agent.getVoice();
-```
-
-## Parameters
-
-**options?:** (`{ requestContext?: RequestContext }`): Optional configuration object containing request context. (Default: `{}`)
-
-## Returns
-
-**voice:** (`Promise<MastraVoice>`): A promise that resolves to the voice provider configured for the agent, or a default voice provider if none was configured.
-
-## Extended usage example
-
-```typescript
-await agent.getVoice({
-  requestContext: new RequestContext(),
-});
-```
-
-### Options parameters
-
-**requestContext?:** (`RequestContext`): Request Context for dependency injection and contextual information. (Default: `new RequestContext()`)
-
-## Related
-
-- [Adding voice to agents](https://mastra.ai/docs/agents/adding-voice)
-- [Voice providers](https://mastra.ai/reference/voice/mastra-voice)

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

@@ -1,35 +0,0 @@
-# Agent.listAgents()
-
-The `.listAgents()` method retrieves the subagents configured for an agent, resolving them if they're a function. These subagents enable the agent to access other agents and perform complex actions.
-
-## Usage example
-
-```typescript
-await agent.listAgents();
-```
-
-## Parameters
-
-**options?:** (`{ requestContext?: RequestContext }`): Optional configuration object containing request context. (Default: `{}`)
-
-## Returns
-
-**agents:** (`Promise<Record<string, Agent>>`): A promise that resolves to a record of agent names to their corresponding Agent instances.
-
-## Extended usage example
-
-```typescript
-import { RequestContext } from "@mastra/core/request-context";
-
-await agent.listAgents({
-  requestContext: new RequestContext(),
-});
-```
-
-### Options parameters
-
-**requestContext?:** (`RequestContext`): Request Context for dependency injection and contextual information. (Default: `new RequestContext()`)
-
-## Related
-
-- [Agents overview](https://mastra.ai/docs/agents/overview)

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

@@ -1,34 +0,0 @@
-# Agent.listScorers()
-
-The `.listScorers()` method retrieves the scoring configuration configured for an agent, resolving it if it's a function. This method provides access to the scoring system used for evaluating agent responses and performance.
-
-## Usage example
-
-```typescript
-await agent.listScorers();
-```
-
-## Parameters
-
-**options?:** (`{ requestContext?: RequestContext }`): Optional configuration object containing request context. (Default: `{}`)
-
-## Returns
-
-**scorers:** (`MastraScorers | Promise<MastraScorers>`): The scoring configuration configured for the agent, either as a direct object or a promise that resolves to the scorers.
-
-## Extended usage example
-
-```typescript
-await agent.listScorers({
-  requestContext: new RequestContext(),
-});
-```
-
-### Options parameters
-
-**requestContext?:** (`RequestContext`): Request Context for dependency injection and contextual information. (Default: `new RequestContext()`)
-
-## Related
-
-- [Agents overview](https://mastra.ai/docs/agents/overview)
-- [Request Context](https://mastra.ai/docs/server/request-context)

package/dist/docs/references/reference-agents-listTools.md

@@ -1,34 +0,0 @@
-# Agent.listTools()
-
-The `.listTools()` method retrieves the tools configured for an agent, resolving them if they're a function. These tools extend the agent's capabilities, allowing it to perform specific actions or access external systems.
-
-## Usage example
-
-```typescript
-await agent.listTools();
-```
-
-## Parameters
-
-**options?:** (`{ requestContext?: RequestContext }`): Optional configuration object containing request context. (Default: `{}`)
-
-## Returns
-
-**tools:** (`TTools | Promise<TTools>`): The tools configured for the agent, either as a direct object or a promise that resolves to the tools.
-
-## Extended usage example
-
-```typescript
-await agent.listTools({
-  requestContext: new RequestContext(),
-});
-```
-
-### Options parameters
-
-**requestContext?:** (`RequestContext`): Request Context for dependency injection and contextual information. (Default: `new RequestContext()`)
-
-## Related
-
-- [Using tools with agents](https://mastra.ai/docs/agents/using-tools)
-- [Creating tools](https://mastra.ai/docs/mcp/overview)

package/dist/docs/references/reference-agents-listWorkflows.md

@@ -1,34 +0,0 @@
-# Agent.listWorkflows()
-
-The `.listWorkflows()` method retrieves the workflows configured for an agent, resolving them if they're a function. These workflows enable the agent to execute complex, multi-step processes with defined execution paths.
-
-## Usage example
-
-```typescript
-await agent.listWorkflows();
-```
-
-## Parameters
-
-**options?:** (`{ requestContext?: RequestContext }`): Optional configuration object containing request context. (Default: `{}`)
-
-## Returns
-
-**workflows:** (`Promise<Record<string, Workflow>>`): A promise that resolves to a record of workflow names to their corresponding Workflow instances.
-
-## Extended usage example
-
-```typescript
-await agent.listWorkflows({
-  requestContext: new RequestContext(),
-});
-```
-
-### Options parameters
-
-**requestContext?:** (`RequestContext`): Request Context for dependency injection and contextual information. (Default: `new RequestContext()`)
-
-## Related
-
-- [Agents overview](https://mastra.ai/docs/agents/overview)
-- [Workflows overview](https://mastra.ai/docs/workflows/overview)