@mastra/mcp-docs-server 1.1.4 → 1.1.5-alpha.0

package/.docs/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/.docs/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/.docs/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/.docs/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/.docs/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/.docs/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/.docs/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/.docs/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/.docs/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/.docs/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/.docs/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/.docs/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/.docs/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/.docs/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)

package/.docs/reference/agents/network.md

@@ -1,134 +0,0 @@
-# Agent.network()
-
-The `.network()` method enables multi-agent collaboration and routing. This method accepts messages and optional execution options.
-
-## Usage example
-
-```typescript
-import { Agent } from "@mastra/core/agent";
-import { agent1, agent2 } from "./agents";
-import { workflow1 } from "./workflows";
-import { tool1, tool2 } from "./tools";
-
-const agent = new Agent({
-  id: "network-agent",
-  name: "Network Agent",
-  instructions:
-    "You are a network agent that can help users with a variety of tasks.",
-  model: "openai/gpt-5.1",
-  agents: {
-    agent1,
-    agent2,
-  },
-  workflows: {
-    workflow1,
-  },
-  tools: {
-    tool1,
-    tool2,
-  },
-});
-
-await agent.network(`
-  Find me the weather in Tokyo.
-  Based on the weather, plan an activity for me.
-`);
-```
-
-## 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?:** (`MultiPrimitiveExecutionOptions`): Optional configuration for the network process.
-
-### Options
-
-**maxSteps?:** (`number`): Maximum number of steps to run during execution.
-
-**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.
-
-**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.
-
-**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.
-
-**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.
-
-**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.
-
-**runId?:** (`string`): Unique ID for this generation run. Useful for tracking and debugging purposes.
-
-**requestContext?:** (`RequestContext`): Request Context for dependency injection and contextual information.
-
-**traceId?:** (`string`): The trace ID associated with this execution when Tracing is enabled. Use this to correlate logs and debug execution flow.
-
-## Returns
-
-**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
-
-**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
-
-**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.
-
-## Structured Output
-
-When you need typed, validated results from your network, use the `structuredOutput` option. The network will generate a response matching your schema after task completion.
-
-```typescript
-import { z } from "zod";
-
-const resultSchema = z.object({
-  summary: z.string().describe("A brief summary of the findings"),
-  recommendations: z.array(z.string()).describe("List of recommendations"),
-  confidence: z.number().min(0).max(1).describe("Confidence score"),
-});
-
-const stream = await agent.network("Research AI trends and summarize", {
-  structuredOutput: {
-    schema: resultSchema,
-  },
-});
-
-// Consume the stream
-for await (const chunk of stream) {
-  // Handle streaming events
-}
-
-// Get the typed result
-const result = await stream.object;
-// result is typed as { summary: string; recommendations: string[]; confidence: number }
-console.log(result?.summary);
-console.log(result?.recommendations);
-```
-
-### Streaming Partial Objects
-
-You can also stream partial objects as they're being generated:
-
-```typescript
-const stream = await agent.network("Analyze data", {
-  structuredOutput: { schema: resultSchema },
-});
-
-// Stream partial objects
-for await (const partial of stream.objectStream) {
-  console.log("Partial result:", partial);
-}
-
-// Get final result
-const final = await stream.object;
-```
-
-### Chunk Types
-
-When using structured output, additional chunk types are emitted:
-
-- `network-object`: Emitted with partial objects during streaming
-- `network-object-result`: Emitted with the final structured object