@mastra/mcp-docs-server 0.0.0-error-handler-fix-20251020202607 → 0.0.0-execa-dynamic-import-20260304221256

package/.docs/raw/reference/agents/getInstructions.mdx

@@ -1,67 +0,0 @@
----
-title: "Reference: Agent.getInstructions() | Agents | Mastra Docs"
-description: "Documentation for the `Agent.getInstructions()` method in Mastra agents, which retrieves the instructions that guide the agent's behavior."
----
-
-# 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 copy
-await agent.getInstructions();
-```
-
-## Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "options",
-      type: "{ runtimeContext?: RuntimeContext }",
-      isOptional: true,
-      defaultValue: "{}",
-      description: "Optional configuration object containing runtime context.",
-    },
-  ]}
-/>
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "instructions",
-      type: "SystemMessage | Promise<SystemMessage>",
-      description: "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 copy
-await agent.getInstructions({
-  runtimeContext: new RuntimeContext()
-});
-```
-
-### Options parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "runtimeContext",
-      type: "RuntimeContext",
-      isOptional: true,
-      defaultValue: "undefined",
-      description: "Runtime context for dependency injection and contextual information.",
-    },
-  ]}
-/>
-
-## Related
-
-- [Agents overview](../../docs/agents/overview.mdx)
-- [Runtime Context](../../docs/server-db/runtime-context.mdx)

package/.docs/raw/reference/agents/getLLM.mdx

@@ -1,74 +0,0 @@
----
-title: "Reference: Agent.getLLM() | Agents | Mastra Docs"
-description: "Documentation for the `Agent.getLLM()` method in Mastra agents, which retrieves the language model instance."
----
-
-# 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 copy
-await agent.getLLM();
-```
-
-## Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "options",
-      type: "{ runtimeContext?: RuntimeContext; model?: MastraLanguageModel | DynamicArgument<MastraLanguageModel> }",
-      isOptional: true,
-      defaultValue: "{}",
-      description: "Optional configuration object containing runtime context and optional model override.",
-    },
-  ]}
-/>
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "llm",
-      type: "MastraLLMV1 | Promise<MastraLLMV1>",
-      description: "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 copy
-await agent.getLLM({
-  runtimeContext: new RuntimeContext(),
-  model: openai('gpt-4')
-});
-```
-
-### Options parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "runtimeContext",
-      type: "RuntimeContext",
-      isOptional: true,
-      defaultValue: "new RuntimeContext()",
-      description: "Runtime context for dependency injection and contextual information.",
-    },
-    {
-      name: "model",
-      type: "MastraLanguageModel | DynamicArgument<MastraLanguageModel>",
-      isOptional: true,
-      description: "Optional model override. If provided, this model will be used used instead of the agent's configured model.",
-    },
-  ]}
-/>
-
-## Related
-
-- [Agents overview](../../docs/agents/overview.mdx)
-- [Runtime Context](../../docs/server-db/runtime-context.mdx)

package/.docs/raw/reference/agents/getMemory.mdx

@@ -1,67 +0,0 @@
----
-title: "Reference: Agent.getMemory() | Agents | Mastra Docs"
-description: "Documentation for the `Agent.getMemory()` method in Mastra agents, which retrieves the memory system associated with the agent."
----
-
-# 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 copy
-await agent.getMemory();
-```
-
-## Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "options",
-      type: "{ runtimeContext?: RuntimeContext }",
-      isOptional: true,
-      defaultValue: "{}",
-      description: "Optional configuration object containing runtime context.",
-    },
-  ]}
-/>
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "memory",
-      type: "Promise<MastraMemory | undefined>",
-      description: "A promise that resolves to the memory system configured for the agent, or undefined if no memory system is configured.",
-    },
-  ]}
-/>
-
-## Extended usage example
-
-```typescript copy
-await agent.getMemory({
-  runtimeContext: new RuntimeContext()
-});
-```
-
-### Options parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "runtimeContext",
-      type: "RuntimeContext",
-      isOptional: true,
-      defaultValue: "new RuntimeContext()",
-      description: "Runtime context for dependency injection and contextual information.",
-    },
-  ]}
-/>
-
-## Related
-
-- [Agent memory](../../docs/agents/agent-memory.mdx)
-- [Runtime Context](../../docs/server-db/runtime-context.mdx)

package/.docs/raw/reference/agents/getModel.mdx

@@ -1,67 +0,0 @@
----
-title: "Reference: Agent.getModel() | Agents | Mastra Docs"
-description: "Documentation for the `Agent.getModel()` method in Mastra agents, which retrieves the language model that powers the agent."
----
-
-# 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 copy
-await agent.getModel();
-```
-
-## Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "{ runtimeContext = new RuntimeContext() }",
-      type: "{ runtimeContext?: RuntimeContext }",
-      isOptional: true,
-      defaultValue: "new RuntimeContext()",
-      description: "Optional configuration object containing runtime context.",
-    },
-  ]}
-/>
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "model",
-      type: "MastraLanguageModel | Promise<MastraLanguageModel>",
-      description: "The language model configured for the agent, either as a direct instance or a promise that resolves to the model.",
-    },
-  ]}
-/>
-
-## Extended usage example
-
-```typescript copy
-await agent.getModel({
-  runtimeContext: new RuntimeContext()
-});
-```
-
-### Options parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "runtimeContext",
-      type: "RuntimeContext",
-      isOptional: true,
-      defaultValue: "undefined",
-      description: "Runtime context for dependency injection and contextual information.",
-    },
-  ]}
-/>
-
-## Related
-
-- [Agents overview](../../docs/agents/overview.mdx)
-- [Runtime Context](../../docs/server-db/runtime-context.mdx)

package/.docs/raw/reference/agents/getScorers.mdx

@@ -1,67 +0,0 @@
----
-title: "Reference: Agent.getScorers() | Agents | Mastra Docs"
-description: "Documentation for the `Agent.getScorers()` method in Mastra agents, which retrieves the scoring configuration."
----
-
-# Agent.getScorers()
-
-The `.getScorers()` 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 copy
-await agent.getScorers();
-```
-
-## Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "options",
-      type: "{ runtimeContext?: RuntimeContext }",
-      isOptional: true,
-      defaultValue: "{}",
-      description: "Optional configuration object containing runtime context.",
-    },
-  ]}
-/>
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "scorers",
-      type: "MastraScorers | Promise<MastraScorers>",
-      description: "The scoring configuration configured for the agent, either as a direct object or a promise that resolves to the scorers.",
-    },
-  ]}
-/>
-
-## Extended usage example
-
-```typescript copy
-await agent.getScorers({
-  runtimeContext: new RuntimeContext()
-});
-```
-
-### Options parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "runtimeContext",
-      type: "RuntimeContext",
-      isOptional: true,
-      defaultValue: "new RuntimeContext()",
-      description: "Runtime context for dependency injection and contextual information.",
-    },
-  ]}
-/>
-
-## Related
-
-- [Agents overview](../../docs/agents/overview.mdx)
-- [Runtime Context](../../docs/server-db/runtime-context.mdx)

package/.docs/raw/reference/agents/getTools.mdx

@@ -1,67 +0,0 @@
----
-title: "Reference: Agent.getTools() | Agents | Mastra Docs"
-description: "Documentation for the `Agent.getTools()` method in Mastra agents, which retrieves the tools that the agent can use."
----
-
-# 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 copy
-await agent.getTools();
-```
-
-## Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "options",
-      type: "{ runtimeContext?: RuntimeContext }",
-      isOptional: true,
-      defaultValue: "{}",
-      description: "Optional configuration object containing runtime context.",
-    },
-  ]}
-/>
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "tools",
-      type: "TTools | Promise<TTools>",
-      description: "The tools configured for the agent, either as a direct object or a promise that resolves to the tools.",
-    },
-  ]}
-/>
-
-## Extended usage example
-
-```typescript copy
-await agent.getTools({
-  runtimeContext: new RuntimeContext()
-});
-```
-
-### Options parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "runtimeContext",
-      type: "RuntimeContext",
-      isOptional: true,
-      defaultValue: "new RuntimeContext()",
-      description: "Runtime context for dependency injection and contextual information.",
-    },
-  ]}
-/>
-
-## Related
-
-- [Using tools with agents](../../docs/agents/using-tools-and-mcp.mdx)
-- [Creating tools](../../docs/tools-mcp/overview.mdx)

package/.docs/raw/reference/agents/getVoice.mdx

@@ -1,67 +0,0 @@
----
-title: "Reference: Agent.getVoice() | Agents | Mastra Docs"
-description: "Documentation for the `Agent.getVoice()` method in Mastra agents, which retrieves the voice provider for speech capabilities."
----
-
-# 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 copy
-await agent.getVoice();
-```
-
-## Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "options",
-      type: "{ runtimeContext?: RuntimeContext }",
-      isOptional: true,
-      defaultValue: "{}",
-      description: "Optional configuration object containing runtime context.",
-    },
-  ]}
-/>
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "voice",
-      type: "Promise<MastraVoice>",
-      description: "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 copy
-await agent.getVoice({
-  runtimeContext: new RuntimeContext()
-});
-```
-
-### Options parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "runtimeContext",
-      type: "RuntimeContext",
-      isOptional: true,
-      defaultValue: "new RuntimeContext()",
-      description: "Runtime context for dependency injection and contextual information.",
-    },
-  ]}
-/>
-
-## Related
-
-- [Adding voice to agents](../../docs/agents/adding-voice.mdx)
-- [Voice providers](../voice/mastra-voice.mdx)

package/.docs/raw/reference/agents/getWorkflows.mdx

@@ -1,67 +0,0 @@
----
-title: "Reference: Agent.getWorkflows() | Agents | Mastra Docs"
-description: "Documentation for the `Agent.getWorkflows()` method in Mastra agents, which retrieves the workflows that the agent can execute."
----
-
-# Agent.getWorkflows()
-
-The `.getWorkflows()` 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 copy
-await agent.getWorkflows();
-```
-
-## Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "options",
-      type: "{ runtimeContext?: RuntimeContext }",
-      isOptional: true,
-      defaultValue: "{}",
-      description: "Optional configuration object containing runtime context.",
-    },
-  ]}
-/>
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "workflows",
-      type: "Promise<Record<string, Workflow>>",
-      description: "A promise that resolves to a record of workflow names to their corresponding Workflow instances.",
-    },
-  ]}
-/>
-
-## Extended usage example
-
-```typescript copy
-await agent.getWorkflows({
-  runtimeContext: new RuntimeContext()
-});
-```
-
-### Options parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "runtimeContext",
-      type: "RuntimeContext",
-      isOptional: true,
-      defaultValue: "new RuntimeContext()",
-      description: "Runtime context for dependency injection and contextual information.",
-    },
-  ]}
-/>
-
-## Related
-
-- [Agents overview](../../docs/agents/overview.mdx)
-- [Workflows overview](../../docs/workflows/overview.mdx)

package/.docs/raw/reference/agents/listAgents.mdx

@@ -1,68 +0,0 @@
----
-title: "Reference: Agent.listAgents() | Agents | Mastra Docs"
-description: "Documentation for the `Agent.listAgents()` method in Mastra agents, which retrieves the sub-agents that the agent can access."
----
-
-# Agent.listAgents()
-
-The `.listAgents()` method retrieves the sub-agents configured for an agent, resolving them if they're a function. These sub-agents enable the agent to access other agents and perform complex actions.
-
-## Usage example
-
-```typescript copy
-await agent.listAgents();
-```
-
-## Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "options",
-      type: "{ runtimeContext?: RuntimeContext }",
-      isOptional: true,
-      defaultValue: "{}",
-      description: "Optional configuration object containing runtime context.",
-    },
-  ]}
-/>
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "agents",
-      type: "Promise<Record<string, Agent>>",
-      description: "A promise that resolves to a record of agent names to their corresponding Agent instances.",
-    },
-  ]}
-/>
-
-## Extended usage example
-
-```typescript copy
-import { RuntimeContext } from "@mastra/core/runtime-context";
-
-await agent.listAgents({
-  runtimeContext: new RuntimeContext()
-});
-```
-
-### Options parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "runtimeContext",
-      type: "RuntimeContext",
-      isOptional: true,
-      defaultValue: "new RuntimeContext()",
-      description: "Runtime context for dependency injection and contextual information.",
-    },
-  ]}
-/>
-
-## Related
-
-- [Agents overview](../../docs/agents/overview.mdx)