@mastra/mcp-docs-server 1.1.7 → 1.1.8

package/.docs/reference/agents/getDefaultOptions.md

@@ -10,11 +10,13 @@ await agent.getDefaultOptions()
 
 ## Parameters
 
-**options?:** (`{ requestContext?: RequestContext }`): Optional configuration object containing request context. (Default: `{}`)
+**options** (`{ requestContext?: RequestContext }`): Optional configuration object containing request context. (Default: `{}`)
+
+**options.requestContext** (`RequestContext`): Request Context for dependency injection and contextual information.
 
 ## 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.
+**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
 
@@ -24,10 +26,6 @@ await agent.getDefaultOptions({
 })
 ```
 
-### 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)

package/.docs/reference/agents/getDefaultStreamOptions.md

@@ -12,11 +12,13 @@ await agent.getDefaultStreamOptionsLegacy()
 
 ## Parameters
 
-**options?:** (`{ requestContext?: RequestContext }`): Optional configuration object containing request context. (Default: `{}`)
+**options** (`{ requestContext?: RequestContext }`): Optional configuration object containing request context. (Default: `{}`)
+
+**options.requestContext** (`RequestContext`): Request Context for dependency injection and contextual information.
 
 ## 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.
+**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
 
@@ -26,10 +28,6 @@ await agent.getDefaultStreamOptionsLegacy({
 })
 ```
 
-### 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)

package/.docs/reference/agents/getDescription.md

@@ -14,7 +14,7 @@ This method takes no parameters.
 
 ## Returns
 
-**description:** (`string`): The description of the agent, or an empty string if no description was configured.
+**description** (`string`): The description of the agent, or an empty string if no description was configured.
 
 ## Related
 

package/.docs/reference/agents/getInstructions.md

@@ -10,11 +10,13 @@ await agent.getInstructions()
 
 ## Parameters
 
-**options?:** (`{ requestContext?: RequestContext }`): Optional configuration object containing request context. (Default: `{}`)
+**options** (`{ requestContext?: RequestContext }`): Optional configuration object containing request context. (Default: `{}`)
+
+**options.requestContext** (`RequestContext`): Request Context for dependency injection and contextual information.
 
 ## 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.
+**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
 
@@ -24,10 +26,6 @@ await agent.getInstructions({
 })
 ```
 
-### Options parameters
-
-**requestContext?:** (`RequestContext`): Request Context for dependency injection and contextual information. (Default: `undefined`)
-
 ## Related
 
 - [Agents overview](https://mastra.ai/docs/agents/overview)

package/.docs/reference/agents/getLLM.md

@@ -10,11 +10,15 @@ await agent.getLLM()
 
 ## Parameters
 
-**options?:** (`{ requestContext?: RequestContext; model?: MastraLanguageModel | DynamicArgument<MastraLanguageModel> }`): Optional configuration object containing request context and optional model override. (Default: `{}`)
+**options** (`{ requestContext?: RequestContext; model?: MastraLanguageModel | DynamicArgument<MastraLanguageModel> }`): Optional configuration object containing request context and optional model override. (Default: `{}`)
+
+**options.requestContext** (`RequestContext`): Request Context for dependency injection and contextual information.
+
+**options.model** (`MastraLanguageModel | DynamicArgument<MastraLanguageModel>`): Optional model override. If provided, this model will be used used instead of the agent's configured model.
 
 ## 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.
+**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
 
@@ -25,12 +29,6 @@ await agent.getLLM({
 })
 ```
 
-### 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)

package/.docs/reference/agents/getMemory.md

@@ -10,11 +10,13 @@ await agent.getMemory()
 
 ## Parameters
 
-**options?:** (`{ requestContext?: RequestContext }`): Optional configuration object containing request context. (Default: `{}`)
+**options** (`{ requestContext?: RequestContext }`): Optional configuration object containing request context. (Default: `{}`)
+
+**options.requestContext** (`RequestContext`): Request Context for dependency injection and contextual information.
 
 ## 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.
+**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
 
@@ -24,10 +26,6 @@ await agent.getMemory({
 })
 ```
 
-### 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)

package/.docs/reference/agents/getModel.md

@@ -10,11 +10,13 @@ await agent.getModel()
 
 ## Parameters
 
-**{ requestContext = new RequestContext() }?:** (`{ requestContext?: RequestContext }`): Optional configuration object containing request context. (Default: `new RequestContext()`)
+**options** (`{ requestContext?: RequestContext }`): Optional configuration object containing request context. (Default: `{}`)
+
+**options.requestContext** (`RequestContext`): Request Context for dependency injection and contextual information.
 
 ## 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.
+**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
 
@@ -24,10 +26,6 @@ await agent.getModel({
 })
 ```
 
-### Options parameters
-
-**requestContext?:** (`RequestContext`): Request Context for dependency injection and contextual information. (Default: `undefined`)
-
 ## Related
 
 - [Agents overview](https://mastra.ai/docs/agents/overview)

package/.docs/reference/agents/getTools.md

@@ -10,11 +10,13 @@ await agent.getTools()
 
 ## Parameters
 
-**options?:** (`{ requestContext?: RequestContext }`): Optional configuration object containing runtime context. (Default: `{}`)
+**options** (`{ requestContext?: RequestContext }`): Optional configuration object containing runtime context. (Default: `{}`)
+
+**options.requestContext** (`RequestContext`): Runtime context for dependency injection and contextual information.
 
 ## Returns
 
-**tools:** (`TTools | Promise<TTools>`): The tools configured for the agent, either as a direct object or a promise that resolves to the tools.
+**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
 
@@ -22,8 +24,4 @@ await agent.getTools()
 await agent.getTools({
   requestContext: new RequestContext(),
 })
-```
-
-### Options parameters
-
-**requestContext?:** (`RequestContext`): Runtime context for dependency injection and contextual information. (Default: `new RequestContext()`)
+```

package/.docs/reference/agents/getVoice.md

@@ -10,11 +10,13 @@ await agent.getVoice()
 
 ## Parameters
 
-**options?:** (`{ requestContext?: RequestContext }`): Optional configuration object containing request context. (Default: `{}`)
+**options** (`{ requestContext?: RequestContext }`): Optional configuration object containing request context. (Default: `{}`)
+
+**options.requestContext** (`RequestContext`): Request Context for dependency injection and contextual information.
 
 ## 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.
+**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
 
@@ -24,10 +26,6 @@ await agent.getVoice({
 })
 ```
 
-### 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)

package/.docs/reference/agents/listAgents.md

@@ -10,11 +10,13 @@ await agent.listAgents()
 
 ## Parameters
 
-**options?:** (`{ requestContext?: RequestContext }`): Optional configuration object containing request context. (Default: `{}`)
+**options** (`{ requestContext?: RequestContext }`): Optional configuration object containing request context. (Default: `{}`)
+
+**options.requestContext** (`RequestContext`): Request Context for dependency injection and contextual information.
 
 ## Returns
 
-**agents:** (`Promise<Record<string, Agent>>`): A promise that resolves to a record of agent names to their corresponding Agent instances.
+**agents** (`Promise<Record<string, Agent>>`): A promise that resolves to a record of agent names to their corresponding Agent instances.
 
 ## Extended usage example
 
@@ -26,10 +28,6 @@ await agent.listAgents({
 })
 ```
 
-### 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/.docs/reference/agents/listScorers.md

@@ -10,11 +10,13 @@ await agent.listScorers()
 
 ## Parameters
 
-**options?:** (`{ requestContext?: RequestContext }`): Optional configuration object containing request context. (Default: `{}`)
+**options** (`{ requestContext?: RequestContext }`): Optional configuration object containing request context. (Default: `{}`)
+
+**options.requestContext** (`RequestContext`): Request Context for dependency injection and contextual information.
 
 ## 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.
+**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
 
@@ -24,10 +26,6 @@ await agent.listScorers({
 })
 ```
 
-### 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/.docs/reference/agents/listTools.md

@@ -10,11 +10,13 @@ await agent.listTools()
 
 ## Parameters
 
-**options?:** (`{ requestContext?: RequestContext }`): Optional configuration object containing request context. (Default: `{}`)
+**options** (`{ requestContext?: RequestContext }`): Optional configuration object containing request context. (Default: `{}`)
+
+**options.requestContext** (`RequestContext`): Request Context for dependency injection and contextual information.
 
 ## Returns
 
-**tools:** (`TTools | Promise<TTools>`): The tools configured for the agent, either as a direct object or a promise that resolves to the tools.
+**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
 
@@ -24,10 +26,6 @@ await agent.listTools({
 })
 ```
 
-### 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)

package/.docs/reference/agents/listWorkflows.md

@@ -10,11 +10,13 @@ await agent.listWorkflows()
 
 ## Parameters
 
-**options?:** (`{ requestContext?: RequestContext }`): Optional configuration object containing request context. (Default: `{}`)
+**options** (`{ requestContext?: RequestContext }`): Optional configuration object containing request context. (Default: `{}`)
+
+**options.requestContext** (`RequestContext`): Request Context for dependency injection and contextual information.
 
 ## Returns
 
-**workflows:** (`Promise<Record<string, Workflow>>`): A promise that resolves to a record of workflow names to their corresponding Workflow instances.
+**workflows** (`Promise<Record<string, Workflow>>`): A promise that resolves to a record of workflow names to their corresponding Workflow instances.
 
 ## Extended usage example
 
@@ -24,10 +26,6 @@ await agent.listWorkflows({
 })
 ```
 
-### 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/.docs/reference/agents/network.md

@@ -36,53 +36,99 @@ await agent.network(`
 
 ## 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.
+**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?:** (`MultiPrimitiveExecutionOptions`): Optional configuration for the network process.
+**options** (`MultiPrimitiveExecutionOptions`): Optional configuration for the network process.
 
-### Options
+**options.maxSteps** (`number`): Maximum number of steps to run during execution.
 
-**maxSteps?:** (`number`): Maximum number of steps to run during execution.
+**options.abortSignal** (`AbortSignal`): Signal to abort the network execution. When aborted, the network stops routing, cancels any in-progress sub-agent, tool, or workflow execution, and skips saving partial results to memory.
 
-**abortSignal?:** (`AbortSignal`): Signal to abort the network execution. When aborted, the network stops routing, cancels any in-progress sub-agent, tool, or workflow execution, and skips saving partial results to memory.
+**options.onAbort** (`(event: { primitiveType: string; primitiveId: string; iteration: number }) => void | Promise<void>`): Callback fired when the network is aborted. Receives an event with the type and ID of the primitive that was executing when the abort occurred.
 
-**onAbort?:** (`(event: { primitiveType: string; primitiveId: string; iteration: number }) => void | Promise<void>`): Callback fired when the network is aborted. Receives an event with the type and ID of the primitive that was executing when the abort occurred.
+**options.memory** (`object`): Configuration for memory. This is the preferred way to manage memory.
 
-**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.
+**options.memory.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\`.
 
-**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.
+**options.memory.resource** (`string`): Identifier for the user or resource associated with the thread.
 
-**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.
+**options.memory.options** (`MemoryConfig`): Configuration for memory behavior, like message history and semantic recall.
 
-**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.
+**options.tracingContext** (`TracingContext`): Tracing context for creating child spans and adding metadata. Automatically injected when using Mastra's tracing system.
 
-**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.
+**options.tracingContext.currentSpan** (`Span`): Current span for creating child spans and adding metadata. Use this to create custom child spans or update span attributes during execution.
 
-**structuredOutput?:** (`StructuredOutputOptions`): schema:ZodSchema | JSONSchema7The schema to validate the output against. Can be a Zod schema or JSON Schema.model?:MastraModelConfigModel to use for generating the structured output. Defaults to the agent's model.instructions?:stringCustom instructions for generating the structured output.
+**options.tracingOptions** (`TracingOptions`): Options for Tracing configuration.
 
-**runId?:** (`string`): Unique ID for this generation run. Useful for tracking and debugging purposes.
+**options.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.
 
-**requestContext?:** (`RequestContext`): Request Context for dependency injection and contextual information.
+**options.tracingOptions.requestContextKeys** (`string[]`): Additional RequestContext keys to extract as metadata for this trace. Supports dot notation for nested values (e.g., 'user.id').
 
-**traceId?:** (`string`): The trace ID associated with this execution when Tracing is enabled. Use this to correlate logs and debug execution flow.
+**options.tracingOptions.traceId** (`string`): Trace ID to use for this execution (1-32 hexadecimal characters). If provided, this trace will be part of the specified trace.
 
-**onStepFinish?:** (`(event: any) => Promise<void> | void`): Callback fired after each LLM step within a sub-agent execution. Receives step details including finish reason and token usage.
+**options.tracingOptions.parentSpanId** (`string`): Parent 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.
 
-**onError?:** (`({ error }: { error: Error | string }) => Promise<void> | void`): Callback fired when an error occurs during sub-agent execution.
+**options.tracingOptions.tags** (`string[]`): Tags to apply to this trace. String labels for categorizing and filtering traces.
+
+**options.telemetry** (`TelemetrySettings`): Settings for OTLP telemetry collection during streaming (not Tracing).
+
+**options.telemetry.isEnabled** (`boolean`): Enable or disable telemetry. Disabled by default while experimental.
+
+**options.telemetry.recordInputs** (`boolean`): Enable or disable input recording. Enabled by default. You might want to disable input recording to avoid recording sensitive information.
+
+**options.telemetry.recordOutputs** (`boolean`): Enable or disable output recording. Enabled by default. You might want to disable output recording to avoid recording sensitive information.
+
+**options.telemetry.functionId** (`string`): Identifier for this function. Used to group telemetry data by function.
+
+**options.modelSettings** (`CallSettings`): Model-specific settings like temperature, maxOutputTokens, topP, etc. These settings control how the language model generates responses.
+
+**options.modelSettings.temperature** (`number`): Controls randomness in generation (0-2). Higher values make output more random.
+
+**options.modelSettings.maxOutputTokens** (`number`): Maximum number of tokens to generate in the response. Note: Use maxOutputTokens (not maxTokens) as per AI SDK v5 convention.
+
+**options.modelSettings.maxRetries** (`number`): Maximum number of retry attempts for failed requests.
+
+**options.modelSettings.topP** (`number`): Nucleus sampling parameter (0-1). Controls diversity of generated text.
+
+**options.modelSettings.topK** (`number`): Top-k sampling parameter. Limits vocabulary to k most likely tokens.
+
+**options.modelSettings.presencePenalty** (`number`): Penalty for token presence (-2 to 2). Reduces repetition.
+
+**options.modelSettings.frequencyPenalty** (`number`): Penalty for token frequency (-2 to 2). Reduces repetition of frequent tokens.
+
+**options.modelSettings.stopSequences** (`string[]`): Stop sequences. If set, the model will stop generating text when one of the stop sequences is generated.
+
+**options.structuredOutput** (`StructuredOutputOptions`): Configuration for generating a typed structured output from the network result.
+
+**options.structuredOutput.schema** (`ZodSchema | JSONSchema7`): The schema to validate the output against. Can be a Zod schema or JSON Schema.
+
+**options.structuredOutput.model** (`MastraModelConfig`): Model to use for generating the structured output. Defaults to the agent's model.
+
+**options.structuredOutput.instructions** (`string`): Custom instructions for generating the structured output.
+
+**options.runId** (`string`): Unique ID for this generation run. Useful for tracking and debugging purposes.
+
+**options.requestContext** (`RequestContext`): Request Context for dependency injection and contextual information.
+
+**options.traceId** (`string`): The trace ID associated with this execution when Tracing is enabled. Use this to correlate logs and debug execution flow.
+
+**options.onStepFinish** (`(event: any) => Promise<void> | void`): Callback fired after each LLM step within a sub-agent execution. Receives step details including finish reason and token usage.
+
+**options.onError** (`({ error }: { error: Error | string }) => Promise<void> | void`): Callback fired when an error occurs during sub-agent execution.
 
 ## Returns
 
-**stream:** (`MastraAgentNetworkStream<NetworkChunkType>`): A custom stream that extends ReadableStream\<NetworkChunkType> with additional network-specific properties
+**stream** (`MastraAgentNetworkStream<NetworkChunkType>`): A custom stream that extends ReadableStream\<NetworkChunkType> with additional network-specific properties
 
-**status:** (`Promise<RunStatus>`): A promise that resolves to the current workflow run status
+**status** (`Promise<RunStatus>`): A promise that resolves to the current workflow run status
 
-**result:** (`Promise<WorkflowResult<TState, TOutput, TSteps>>`): A promise that resolves to the final workflow result
+**result** (`Promise<WorkflowResult<TState, TOutput, TSteps>>`): A promise that resolves to the final workflow result
 
-**usage:** (`Promise<{ promptTokens: number; completionTokens: number; totalTokens: number }>`): A promise that resolves to token usage statistics
+**usage** (`Promise<{ promptTokens: number; completionTokens: number; totalTokens: number }>`): A promise that resolves to token usage statistics
 
-**object:** (`Promise<OUTPUT | undefined>`): A promise that resolves to the structured output object. Only available when structuredOutput option is provided. Resolves to undefined if no schema was specified.
+**object** (`Promise<OUTPUT | undefined>`): A promise that resolves to the structured output object. Only available when structuredOutput option is provided. Resolves to undefined if no schema was specified.
 
-**objectStream:** (`ReadableStream<Partial<OUTPUT>>`): A stream of partial objects during structured output generation. Useful for streaming partial results as they're being generated.
+**objectStream** (`ReadableStream<Partial<OUTPUT>>`): A stream of partial objects during structured output generation. Useful for streaming partial results as they're being generated.
 
 ## Structured Output
 

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

@@ -43,19 +43,19 @@ export const mastra = new Mastra({
 
 ## Parameters
 
-**path:** (`string`): The route path (e.g., \`/chat\` or \`/chat/:agentId\`). Include \`:agentId\` for dynamic agent routing. (Default: `'/chat/:agentId'`)
+**path** (`string`): The route path (e.g., \`/chat\` or \`/chat/:agentId\`). Include \`:agentId\` for dynamic agent routing. (Default: `'/chat/:agentId'`)
 
-**agent?:** (`string`): The ID of the agent to use for this chat route. Required if the path doesn't include \`:agentId\`.
+**agent** (`string`): The ID of the agent to use for this chat route. Required if the path doesn't include \`:agentId\`.
 
-**defaultOptions?:** (`AgentExecutionOptions`): Default options passed to agent execution. These can include instructions, memory configuration, maxSteps, and other execution settings.
+**defaultOptions** (`AgentExecutionOptions`): Default options passed to agent execution. These can include instructions, memory configuration, maxSteps, and other execution settings.
 
-**sendStart?:** (`boolean`): Whether to send start events in the stream. (Default: `true`)
+**sendStart** (`boolean`): Whether to send start events in the stream. (Default: `true`)
 
-**sendFinish?:** (`boolean`): Whether to send finish events in the stream. (Default: `true`)
+**sendFinish** (`boolean`): Whether to send finish events in the stream. (Default: `true`)
 
-**sendReasoning?:** (`boolean`): Whether to include reasoning steps in the stream. (Default: `false`)
+**sendReasoning** (`boolean`): Whether to include reasoning steps in the stream. (Default: `false`)
 
-**sendSources?:** (`boolean`): Whether to include source citations in the stream. (Default: `false`)
+**sendSources** (`boolean`): Whether to include source citations in the stream. (Default: `false`)
 
 ## Additional configuration
 

package/.docs/reference/ai-sdk/handle-chat-stream.md

@@ -28,26 +28,26 @@ export async function POST(req: Request) {
 
 ## Parameters
 
-**mastra:** (`Mastra`): The Mastra instance containing registered agents.
+**mastra** (`Mastra`): The Mastra instance containing registered agents.
 
-**agentId:** (`string`): The ID of the agent to use for chat.
+**agentId** (`string`): The ID of the agent to use for chat.
 
-**params:** (`ChatStreamHandlerParams`): Parameters for the chat stream, including messages and optional resume data.
+**params** (`ChatStreamHandlerParams`): Parameters for the chat stream, including messages and optional resume data.
 
-**params.messages:** (`UIMessage[]`): Array of messages in the conversation.
+**params.messages** (`UIMessage[]`): Array of messages in the conversation.
 
-**params.resumeData?:** (`Record<string, any>`): Data for resuming a suspended agent execution. Requires \`runId\` to be set.
+**params.resumeData** (`Record<string, any>`): Data for resuming a suspended agent execution. Requires \`runId\` to be set.
 
-**params.runId?:** (`string`): The run ID. Required when \`resumeData\` is provided.
+**params.runId** (`string`): The run ID. Required when \`resumeData\` is provided.
 
-**params.requestContext?:** (`RequestContext`): Request context to pass to the agent execution.
+**params.requestContext** (`RequestContext`): Request context to pass to the agent execution.
 
-**defaultOptions?:** (`AgentExecutionOptions`): Default options passed to agent execution. These are merged with params, with params taking precedence.
+**defaultOptions** (`AgentExecutionOptions`): Default options passed to agent execution. These are merged with params, with params taking precedence.
 
-**sendStart?:** (`boolean`): Whether to send start events in the stream. (Default: `true`)
+**sendStart** (`boolean`): Whether to send start events in the stream. (Default: `true`)
 
-**sendFinish?:** (`boolean`): Whether to send finish events in the stream. (Default: `true`)
+**sendFinish** (`boolean`): Whether to send finish events in the stream. (Default: `true`)
 
-**sendReasoning?:** (`boolean`): Whether to include reasoning steps in the stream. (Default: `false`)
+**sendReasoning** (`boolean`): Whether to include reasoning steps in the stream. (Default: `false`)
 
-**sendSources?:** (`boolean`): Whether to include source citations in the stream. (Default: `false`)
+**sendSources** (`boolean`): Whether to include source citations in the stream. (Default: `false`)

package/.docs/reference/ai-sdk/handle-network-stream.md

@@ -28,10 +28,10 @@ export async function POST(req: Request) {
 
 ## Parameters
 
-**mastra:** (`Mastra`): The Mastra instance to use for agent lookup and execution.
+**mastra** (`Mastra`): The Mastra instance to use for agent lookup and execution.
 
-**agentId:** (`string`): The ID of the routing agent to execute as a network.
+**agentId** (`string`): The ID of the routing agent to execute as a network.
 
-**params:** (`NetworkStreamHandlerParams`): The request parameters containing messages and execution options. Includes \`messages\` (required) and any AgentExecutionOptions like \`memory\`, \`maxSteps\`, \`runId\`, etc.
+**params** (`NetworkStreamHandlerParams`): The request parameters containing messages and execution options. Includes \`messages\` (required) and any AgentExecutionOptions like \`memory\`, \`maxSteps\`, \`runId\`, etc.
 
-**defaultOptions?:** (`AgentExecutionOptions`): Default options passed to agent execution. These are merged with params, with params taking precedence.
+**defaultOptions** (`AgentExecutionOptions`): Default options passed to agent execution. These are merged with params, with params taking precedence.

package/.docs/reference/ai-sdk/handle-workflow-stream.md

@@ -32,24 +32,24 @@ export async function POST(req: Request) {
 
 ## Parameters
 
-**mastra:** (`Mastra`): The Mastra instance containing registered workflows.
+**mastra** (`Mastra`): The Mastra instance containing registered workflows.
 
-**workflowId:** (`string`): The ID of the workflow to execute.
+**workflowId** (`string`): The ID of the workflow to execute.
 
-**params:** (`WorkflowStreamHandlerParams`): Parameters for the workflow stream.
+**params** (`WorkflowStreamHandlerParams`): Parameters for the workflow stream.
 
-**params.runId?:** (`string`): Optional run ID for the workflow execution.
+**params.runId** (`string`): Optional run ID for the workflow execution.
 
-**params.resourceId?:** (`string`): Optional resource ID for the workflow run.
+**params.resourceId** (`string`): Optional resource ID for the workflow run.
 
-**params.inputData?:** (`Record<string, any>`): Input data for starting a new workflow execution.
+**params.inputData** (`Record<string, any>`): Input data for starting a new workflow execution.
 
-**params.resumeData?:** (`Record<string, any>`): Data for resuming a suspended workflow execution.
+**params.resumeData** (`Record<string, any>`): Data for resuming a suspended workflow execution.
 
-**params.requestContext?:** (`RequestContext`): Request context to pass to the workflow execution.
+**params.requestContext** (`RequestContext`): Request context to pass to the workflow execution.
 
-**params.tracingOptions?:** (`TracingOptions`): Options for tracing and observability.
+**params.tracingOptions** (`TracingOptions`): Options for tracing and observability.
 
-**params.step?:** (`string`): Specific step to target in the workflow.
+**params.step** (`string`): Specific step to target in the workflow.
 
-**includeTextStreamParts?:** (`boolean`): Whether to include text stream parts in the output. (Default: `true`)
+**includeTextStreamParts** (`boolean`): Whether to include text stream parts in the output. (Default: `true`)

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

@@ -43,11 +43,11 @@ export const mastra = new Mastra({
 
 ## Parameters
 
-**path:** (`string`): The route path (e.g., \`/network\` or \`/network/:agentId\`). Include \`:agentId\` for dynamic agent routing. (Default: `'/network/:agentId'`)
+**path** (`string`): The route path (e.g., \`/network\` or \`/network/:agentId\`). Include \`:agentId\` for dynamic agent routing. (Default: `'/network/:agentId'`)
 
-**agent?:** (`string`): The ID of the routing agent to use for this network route. Required if the path doesn't include \`:agentId\`.
+**agent** (`string`): The ID of the routing agent to use for this network route. Required if the path doesn't include \`:agentId\`.
 
-**defaultOptions?:** (`AgentExecutionOptions`): Default options passed to agent execution. These can include instructions, memory configuration, maxSteps, and other execution settings.
+**defaultOptions** (`AgentExecutionOptions`): Default options passed to agent execution. These can include instructions, memory configuration, maxSteps, and other execution settings.
 
 ## Additional configuration