@mastra/core 1.7.0 → 1.8.0

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

@@ -0,0 +1,186 @@
+# Agent.generate()
+
+The `.generate()` method enables non-streaming response generation from an agent with enhanced capabilities. It accepts messages and optional generation options.
+
+## Usage example
+
+```typescript
+// Basic usage
+const result = await agent.generate('message for agent')
+
+// With model settings (e.g., limiting output tokens)
+const limitedResult = await agent.generate('Write a short poem about coding', {
+  modelSettings: {
+    maxOutputTokens: 50,
+    temperature: 0.7,
+  },
+})
+
+// With structured output
+const structuredResult = await agent.generate("Extract the user's name and age", {
+  structuredOutput: {
+    schema: z.object({
+      name: z.string(),
+      age: z.number(),
+    }),
+  },
+})
+
+// With memory for conversation persistence
+const memoryResult = await agent.generate('Remember my favorite color is blue', {
+  memory: {
+    thread: 'user-123-thread',
+    resource: 'user-123',
+  },
+})
+
+// Accessing response headers
+const result = await agent.generate('Hello!')
+const remainingRequests = result.response?.headers?.['anthropic-ratelimit-requests-remaining']
+const remainingTokens = result.response?.headers?.['x-ratelimit-remaining-tokens']
+console.log(`Remaining requests: ${remainingRequests}, Remaining tokens: ${remainingTokens}`)
+```
+
+> **Info:** **Model Compatibility**: This method requires AI SDK v5+ models. If you're using AI SDK v4 models, use the [`.generateLegacy()`](https://mastra.ai/reference/agents/generateLegacy) method instead. The framework automatically detects your model version and will throw an error if there's a mismatch.
+
+## 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.
+
+**options?:** (`AgentExecutionOptions<Output, Format>`): Optional configuration for the generation process.
+
+### Options
+
+**maxSteps?:** (`number`): Maximum number of steps to run during execution.
+
+**stopWhen?:** (`LoopOptions['stopWhen']`): Conditions for stopping execution (e.g., step count, token limit).
+
+**onIterationComplete?:** (`(context: IterationCompleteContext) => { continue?: boolean; feedback?: string } | void | Promise<{ continue?: boolean; feedback?: string } | void>`): context.iteration:numberCurrent iteration number (1-based).context.maxIterations:number | undefinedMaximum iterations allowed (if set).context.text:stringThe text response from this iteration.context.isFinal:booleanWhether this is the final iteration.context.finishReason:stringReason why this iteration finished (e.g., 'stop', 'length', 'tool-calls').context.toolCalls:ToolCall\[]Tool calls made in this iteration.context.messages:MastraDBMessage\[]All messages accumulated so far.return.continue?:booleanSet to false to stop execution early.return.feedback?:stringFeedback message to guide the agent's next iteration.
+
+**isTaskComplete?:** (`IsTaskCompleteConfig`): scorers:MastraScorer\[]Array of scorers that evaluate task completion. Each scorer returns 0 (failed) or 1 (passed).strategy?:'all' | 'any'Strategy for combining scorer results. 'all' requires all scorers to pass, 'any' requires at least one.onComplete?:(result: IsTaskCompleteRunResult) => void | Promise\<void>Callback called when the task completion check finishes. Receives the result with individual scorer scores.parallel?:booleanWhether to run scorers in parallel.timeout?:numberMaximum time in milliseconds to wait for all scorers to complete.
+
+**delegation?:** (`DelegationConfig`): onDelegationStart?:(context: DelegationStartContext) => DelegationStartResult | void | Promise\<DelegationStartResult | void>Called before delegating to a subagent. Use this to modify the delegation parameters or reject the delegation entirely.onDelegationComplete?:(context: DelegationCompleteContext) => { feedback?: string } | void | Promise<{ feedback?: string } | void>Called after a subagent delegation completes. The context includes a \`bail()\` method to stop further execution, and you can return \`{ feedback }\` to guide the supervisor's next action. Feedback is saved to supervisor memory as an assistant message.messageFilter?:(context: MessageFilterContext) => MastraDBMessage\[] | Promise\<MastraDBMessage\[]>Callback function called before delegating to a subagent. Use this to filter the messages that are passed to the subagent.
+
+**scorers?:** (`MastraScorers | Record<string, { scorer: MastraScorer['name']; sampling?: ScoringSamplingConfig }>`): scorer:stringName of the scorer to use.sampling?:ScoringSamplingConfigSampling configuration for the scorer.type:'none' | 'ratio'Type of sampling strategy. Use 'none' to disable sampling or 'ratio' for percentage-based sampling.rate?:numberSampling rate (0-1). Required when type is 'ratio'.
+
+**returnScorerData?:** (`boolean`): Whether to return detailed scoring data in the response.
+
+**onChunk?:** (`(chunk: ChunkType) => Promise<void> | void`): Callback function called for each chunk during generation.
+
+**onError?:** (`({ error }: { error: Error | string }) => Promise<void> | void`): Callback function called when an error occurs during generation.
+
+**onAbort?:** (`(event: any) => Promise<void> | void`): Callback function called when the generation is aborted.
+
+**activeTools?:** (`Array<keyof ToolSet> | undefined`): Array of tool names that should be active during execution. If undefined, all available tools are active.
+
+**abortSignal?:** (`AbortSignal`): Signal object that allows you to abort the agent's execution. When the signal is aborted, all ongoing operations will be terminated.
+
+**prepareStep?:** (`PrepareStepFunction`): Callback function called before each step of multi-step execution.
+
+**requireToolApproval?:** (`boolean`): When true, all tool calls require explicit approval before execution. The generate() method will return with \`finishReason: 'suspended'\` and include a \`suspendPayload\` with tool call details (\`toolCallId\`, \`toolName\`, \`args\`). Use \`approveToolCallGenerate()\` or \`declineToolCallGenerate()\` to proceed. See \[Agent Approval]\(/docs/agents/agent-approval#tool-approval-with-generate) for details.
+
+**autoResumeSuspendedTools?:** (`boolean`): When true, automatically resumes suspended tools when the user sends a new message on the same thread. The agent extracts \`resumeData\` from the user's message based on the tool's \`resumeSchema\`. Requires memory to be configured.
+
+**toolCallConcurrency?:** (`number`): Maximum number of tool calls to execute concurrently. Defaults to 1 when approval may be required, otherwise 10.
+
+**context?:** (`ModelMessage[]`): Additional context messages to provide to the agent.
+
+**structuredOutput?:** (`StructuredOutputOptions<S extends ZodTypeAny = ZodTypeAny>`): schema:z.ZodSchema\<S>Zod schema defining the expected output structure.model?:MastraLanguageModelLanguage model to use for structured output generation. If provided, enables the agent to respond in multi step with tool calls, text, and structured outputerrorStrategy?:'strict' | 'warn' | 'fallback'Strategy for handling schema validation errors. 'strict' throws errors, 'warn' logs warnings, 'fallback' uses fallback values.fallbackValue?:\<S extends ZodTypeAny>Fallback value to use when schema validation fails and errorStrategy is 'fallback'.instructions?:stringAdditional instructions for the structured output model.jsonPromptInjection?:booleanInjects system prompt into the main agent instructing it to return structured output, useful for when a model does not natively support structured outputs.logger?:IMastraLoggerOptional logger instance for structured logging during output generation.providerOptions?:ProviderOptionsProvider-specific options passed to the internal structuring agent. Use this to control model behavior like reasoning effort for thinking models (e.g., \`{ openai: { reasoningEffort: 'low' } }\`).
+
+**outputProcessors?:** (`OutputProcessorOrWorkflow[]`): Output processors to use for this execution (overrides agent's default).
+
+**maxProcessorRetries?:** (`number`): Maximum number of times processors can trigger a retry for this generation. Overrides agent's default maxProcessorRetries.
+
+**inputProcessors?:** (`InputProcessorOrWorkflow[]`): Input processors to use for this execution (overrides agent's default).
+
+**instructions?:** (`string | string[] | CoreSystemMessage | SystemModelMessage | CoreSystemMessage[] | SystemModelMessage[]`): Custom instructions that override the agent's default instructions for this execution. Can be a single string, message object, or array of either.
+
+**system?:** (`string | string[] | CoreSystemMessage | SystemModelMessage | CoreSystemMessage[] | SystemModelMessage[]`): Custom system message(s) to include in the prompt. Can be a single string, message object, or array of either. System messages provide additional context or behavior instructions that supplement the agent's main instructions.
+
+**output?:** (`Zod schema | JsonSchema7`): \*\*Deprecated.\*\* Use structuredOutput without a model to achieve the same thing. 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 }Thread identifier for conversation continuity. Can be a string ID or an object with ID and optional metadata/title.resource:stringResource identifier for organizing conversations by user, session, or context.options?:MemoryConfigAdditional memory configuration options including lastMessages, readOnly, semanticRecall, and workingMemory.
+
+**onFinish?:** (`LoopConfig['onFinish']`): Callback fired when generation completes.
+
+**onStepFinish?:** (`LoopConfig['onStepFinish']`): Callback fired after each generation step.
+
+**telemetry?:** (`TelemetrySettings`): isEnabled?:booleanWhether telemetry collection is enabled.recordInputs?:booleanWhether to record input data in telemetry.recordOutputs?:booleanWhether to record output data in telemetry.functionId?:stringIdentifier for the function being executed.
+
+**modelSettings?:** (`CallSettings`): temperature?:numberControls randomness in generation (0-2). Higher values make output more random.maxOutputTokens?:numberMaximum number of tokens to generate in the response. Note: Use maxOutputTokens (not maxTokens) as per AI SDK v5 convention.maxRetries?:numberMaximum number of retry attempts for failed requests.topP?:numberNucleus sampling parameter (0-1). Controls diversity of generated text.topK?:numberTop-k sampling parameter. Limits vocabulary to k most likely tokens.presencePenalty?:numberPenalty for token presence (-2 to 2). Reduces repetition.frequencyPenalty?:numberPenalty for token frequency (-2 to 2). Reduces repetition of frequent tokens.stopSequences?:string\[]Stop sequences. If set, the model will stop generating text when one of the stop sequences is generated.
+
+**toolChoice?:** (`'auto' | 'none' | 'required' | { type: 'tool'; toolName: string }`): 'auto':stringLet the model decide when to use tools (default).'none':stringDisable tool usage entirely.'required':stringForce the model to use at least one tool.{ type: 'tool'; toolName: string }:objectForce the model to use a specific tool.
+
+**toolsets?:** (`ToolsetsInput`): Additional tool sets that can be used for this execution.
+
+**clientTools?:** (`ToolsInput`): Client-side tools available during execution.
+
+**savePerStep?:** (`boolean`): Save messages incrementally after each generation step completes (default: false).
+
+**providerOptions?:** (`Record<string, Record<string, JSONValue>>`): openai?:Record\<string, JSONValue>OpenAI-specific options like reasoningEffort, responseFormat, etc.anthropic?:Record\<string, JSONValue>Anthropic-specific options like maxTokens, etc.google?:Record\<string, JSONValue>Google-specific options.\[providerName]?:Record\<string, JSONValue>Any provider-specific options.
+
+**runId?:** (`string`): Unique identifier for this execution run.
+
+**requestContext?:** (`RequestContext`): Request Context containing dynamic configuration and state.
+
+**tracingContext?:** (`TracingContext`): currentSpan?:SpanCurrent span for creating child spans and adding metadata. Use this to create custom child spans or update span attributes during execution.
+
+**tracingOptions?:** (`TracingOptions`): metadata?:Record\<string, any>Metadata to add to the root trace span. Useful for adding custom attributes like user IDs, session IDs, or feature flags.requestContextKeys?:string\[]Additional RequestContext keys to extract as metadata for this trace. Supports dot notation for nested values (e.g., 'user.id').traceId?:stringTrace ID to use for this execution (1-32 hexadecimal characters). If provided, this trace will be part of the specified trace.parentSpanId?:stringParent span ID to use for this execution (1-16 hexadecimal characters). If provided, the root span will be created as a child of this span.tags?:string\[]Tags to apply to this trace. String labels for categorizing and filtering traces.
+
+**includeRawChunks?:** (`boolean`): Whether to include raw chunks in the stream output. Not available on all model providers.
+
+## Returns
+
+**result:** (`Awaited<ReturnType<MastraModelOutput<Output>['getFullOutput']>>`): Returns the full output of the generation process including text, object (if structured output), tool calls, tool results, usage statistics, and step information.
+
+**text:** (`string`): The generated text response from the agent.
+
+**object?:** (`Output | undefined`): The structured output object if structuredOutput was provided, validated against the schema.
+
+**toolCalls:** (`ToolCall[]`): Array of tool calls made during generation.
+
+**toolResults:** (`ToolResult[]`): Array of results from tool executions.
+
+**usage:** (`TokenUsage`): Token usage statistics for the generation.
+
+**steps:** (`Step[]`): Array of execution steps, useful for debugging multi-step generations.
+
+**finishReason:** (`string`): The reason generation finished. Values include 'stop' (normal completion), 'tool-calls' (ended with tool calls), 'suspended' (waiting for tool approval), or 'error' (error occurred).
+
+**response:** (`object`): id?:stringResponse ID from the model provider.timestamp?:DateTimestamp when the response was generated.modelId?:stringModel identifier used for this response.headers?:Record\<string, string>HTTP response headers from the model provider. Contains rate limit information (e.g., \`anthropic-ratelimit-requests-remaining\`, \`x-ratelimit-remaining-tokens\`) and other provider-specific metadata.messages?:ResponseMessage\[]Response messages in model format.uiMessages?:UIMessage\[]Response messages in UI format, includes any metadata added by output processors.
+
+**request?:** (`object`): body?:unknownThe request body sent to the model provider.
+
+**warnings?:** (`LanguageModelWarning[]`): Any warnings from the model provider during generation.
+
+**providerMetadata?:** (`Record<string, unknown>`): Provider-specific metadata returned with the response.
+
+**reasoning?:** (`ReasoningChunk[]`): Reasoning details from models that support reasoning (e.g., OpenAI o1 series).
+
+**reasoningText?:** (`string`): Combined reasoning text from reasoning models.
+
+**sources?:** (`SourceChunk[]`): Sources referenced by the model during generation.
+
+**files?:** (`FileChunk[]`): Files generated by the model.
+
+**suspendPayload?:** (`object`): toolCallId:stringUnique identifier for the pending tool call.toolName:stringName of the tool that requires approval.args:Record\<string, any>Arguments that will be passed to the tool.
+
+**runId?:** (`string`): Unique identifier for this execution run. Required when calling \`approveToolCallGenerate()\` or \`declineToolCallGenerate()\` to resume a suspended execution.
+
+**traceId?:** (`string`): The trace ID associated with this execution when Tracing is enabled. Use this to correlate logs and debug execution flow.
+
+**messages:** (`MastraDBMessage[]`): All messages from this execution including input, memory history, and response.
+
+**rememberedMessages:** (`MastraDBMessage[]`): Only messages loaded from memory (conversation history).
+
+**error?:** (`Error`): Error object if the generation failed.
+
+**tripwire?:** (`StepTripwireData`): Tripwire data if content was blocked by a processor.
+
+**scoringData?:** (`object`): Scoring data for evals when \`returnScorerData\` is enabled.
+
+## Related
+
+- [Agent Networks](https://mastra.ai/docs/agents/networks) - Using the supervisor pattern for multi-agent coordination
+- [Migration: .network() to Supervisor Pattern](https://mastra.ai/guides/migrations/network-to-supervisor)
+- [Guide: Research Coordinator](https://mastra.ai/guides/guide/research-coordinator)

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

@@ -0,0 +1,173 @@
+# 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

@@ -0,0 +1,36 @@
+# 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

@@ -0,0 +1,34 @@
+# 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

@@ -0,0 +1,36 @@
+# 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

@@ -0,0 +1,21 @@
+# 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

@@ -0,0 +1,34 @@
+# 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

@@ -0,0 +1,37 @@
+# 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

@@ -0,0 +1,34 @@
+# 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

@@ -0,0 +1,34 @@
+# 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)