@mastra/mcp-docs-server 0.13.11-alpha.1 → 0.13.11-alpha.3

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

@@ -1,16 +1,16 @@
 ---
-title: "Reference: getDefaultGenerateOptions() | Agents | Mastra Docs"
-description: "Documentation for the `.getDefaultGenerateOptions()` method in Mastra agents, which retrieves the default options used for generate calls."
+title: "Reference: Agent.getDefaultGenerateOptions() | Agents | Mastra Docs"
+description: "Documentation for the `Agent.getDefaultGenerateOptions()` method in Mastra agents, which retrieves the default options used for generate calls."
 ---
 
-# getDefaultGenerateOptions()
+# Agent.getDefaultGenerateOptions()
 
 The `.getDefaultGenerateOptions()` method retrieves the default generation options configured for an agent, resolving them if they're a function. These options are used as the base configuration for all `generate()` calls unless overridden.
 
 ## Usage example
 
-```typescript showLineNumbers copy
-const defaultOptions = await agent.getDefaultGenerateOptions();
+```typescript copy
+await agent.getDefaultGenerateOptions();
 ```
 
 ## Parameters
@@ -27,10 +27,22 @@ const defaultOptions = await agent.getDefaultGenerateOptions();
   ]}
 />
 
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: "defaultOptions",
+      type: "AgentGenerateOptions | Promise<AgentGenerateOptions>",
+      description: "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 showLineNumbers copy
-const defaultOptions = await agent.getDefaultGenerateOptions({
+```typescript copy
+await agent.getDefaultGenerateOptions({
   runtimeContext: new RuntimeContext()
 });
 ```
@@ -49,14 +61,7 @@ const defaultOptions = await agent.getDefaultGenerateOptions({
   ]}
 />
 
-## Returns
+## Related
 
-<PropertiesTable
-  content={[
-    {
-      name: "defaultOptions",
-      type: "AgentGenerateOptions | Promise<AgentGenerateOptions>",
-      description: "The default generation options configured for the agent, either as a direct object or a promise that resolves to the options.",
-    },
-  ]}
-/>
+- [Agent generation](../../docs/agents/overview.mdx#generate)
+- [Runtime variables](../../docs/agents/runtime-variables.mdx)

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

@@ -1,16 +1,16 @@
 ---
-title: "Reference: getDefaultStreamOptions() | Agents | Mastra Docs"
-description: "Documentation for the `.getDefaultStreamOptions()` method in Mastra agents, which retrieves the default options used for stream calls."
+title: "Reference: Agent.getDefaultStreamOptions() | Agents | Mastra Docs"
+description: "Documentation for the `Agent.getDefaultStreamOptions()` method in Mastra agents, which retrieves the default options used for stream calls."
 ---
 
-# getDefaultStreamOptions()
+# Agent.getDefaultStreamOptions()
 
 The `.getDefaultStreamOptions()` method retrieves the default streaming options configured for an agent, resolving them if they're a function. These options are used as the base configuration for all `stream()` calls unless overridden.
 
 ## Usage example
 
-```typescript showLineNumbers copy
-const defaultOptions = await agent.getDefaultStreamOptions();
+```typescript copy
+await agent.getDefaultStreamOptions();
 ```
 
 ## Parameters
@@ -27,10 +27,22 @@ const defaultOptions = await agent.getDefaultStreamOptions();
   ]}
 />
 
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: "defaultOptions",
+      type: "AgentStreamOptions | Promise<AgentStreamOptions>",
+      description: "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 showLineNumbers copy
-const defaultOptions = await agent.getDefaultStreamOptions({
+```typescript copy
+await agent.getDefaultStreamOptions({
   runtimeContext: new RuntimeContext()
 });
 ```
@@ -49,14 +61,7 @@ const defaultOptions = await agent.getDefaultStreamOptions({
   ]}
 />
 
-## Returns
+## Related
 
-<PropertiesTable
-  content={[
-    {
-      name: "defaultOptions",
-      type: "AgentStreamOptions | Promise<AgentStreamOptions>",
-      description: "The default streaming options configured for the agent, either as a direct object or a promise that resolves to the options.",
-    },
-  ]}
-/>
+- [Agent streaming](../../docs/agents/streaming.mdx)
+- [Runtime variables](../../docs/agents/runtime-variables.mdx)

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

@@ -1,16 +1,16 @@
 ---
-title: "Reference: getDefaultVNextStreamOptions() | Agents | Mastra Docs"
-description: "Documentation for the `.getDefaultVNextStreamOptions()` method in Mastra agents, which retrieves the default options used for streamVNext calls."
+title: "Reference: Agent.getDefaultVNextStreamOptions() | Agents | Mastra Docs"
+description: "Documentation for the `Agent.getDefaultVNextStreamOptions()` method in Mastra agents, which retrieves the default options used for streamVNext calls."
 ---
 
-# getDefaultVNextStreamOptions()
+# Agent.getDefaultVNextStreamOptions()
 
 The `.getDefaultVNextStreamOptions()` method retrieves the default vNext streaming options configured for an agent, resolving them if they're a function. These options are used as the base configuration for all `streamVNext()` calls unless overridden.
 
 ## Usage example
 
-```typescript showLineNumbers copy
-const defaultOptions = await agent.getDefaultVNextStreamOptions();
+```typescript copy
+await agent.getDefaultVNextStreamOptions();
 ```
 
 ## Parameters
@@ -27,10 +27,22 @@ const defaultOptions = await agent.getDefaultVNextStreamOptions();
   ]}
 />
 
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: "defaultOptions",
+      type: "AgentVNextStreamOptions<Output, StructuredOutput> | Promise<AgentVNextStreamOptions<Output, StructuredOutput>>",
+      description: "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 showLineNumbers copy
-const defaultOptions = await agent.getDefaultVNextStreamOptions({
+```typescript copy
+await agent.getDefaultVNextStreamOptions({
   runtimeContext: new RuntimeContext()
 });
 ```
@@ -49,14 +61,7 @@ const defaultOptions = await agent.getDefaultVNextStreamOptions({
   ]}
 />
 
-## Returns
+## Related
 
-<PropertiesTable
-  content={[
-    {
-      name: "defaultOptions",
-      type: "AgentVNextStreamOptions<Output, StructuredOutput> | Promise<AgentVNextStreamOptions<Output, StructuredOutput>>",
-      description: "The default vNext streaming options configured for the agent, either as a direct object or a promise that resolves to the options.",
-    },
-  ]}
-/>
+- [Agent streaming](../../docs/agents/streaming.mdx)
+- [Runtime variables](../../docs/agents/runtime-variables.mdx)

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

@@ -1,16 +1,16 @@
 ---
-title: "Reference: getDescription() | Agents | Mastra Docs"
-description: "Documentation for the `.getDescription()` method in Mastra agents, which retrieves the agent's description."
+title: "Reference: Agent.getDescription() | Agents | Mastra Docs"
+description: "Documentation for the `Agent.getDescription()` method in Mastra agents, which retrieves the agent's description."
 ---
 
-# getDescription()
+# 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 showLineNumbers copy
-const description = agent.getDescription();
+```typescript copy
+agent.getDescription();
 ```
 
 ## Parameters
@@ -28,3 +28,7 @@ This method takes no parameters.
     },
   ]}
 />
+
+## Related
+
+- [Agents overview](../../docs/agents/overview.mdx)

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

@@ -1,16 +1,16 @@
 ---
-title: "Reference: getInstructions() | Agents | Mastra Docs"
-description: "Documentation for the `.getInstructions()` method in Mastra agents, which retrieves the instructions that guide the agent's behavior."
+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."
 ---
 
-# getInstructions()
+# 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 showLineNumbers copy
-const instructions = await agent.getInstructions();
+```typescript copy
+await agent.getInstructions();
 ```
 
 ## Parameters
@@ -27,10 +27,22 @@ const instructions = await agent.getInstructions();
   ]}
 />
 
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: "instructions",
+      type: "string | Promise<string>",
+      description: "The instructions configured for the agent, either as a direct string or a promise that resolves to the instructions.",
+    },
+  ]}
+/>
+
 ## Extended usage example
 
-```typescript showLineNumbers copy
-const instructions = await agent.getInstructions({
+```typescript copy
+await agent.getInstructions({
   runtimeContext: new RuntimeContext()
 });
 ```
@@ -49,14 +61,7 @@ const instructions = await agent.getInstructions({
   ]}
 />
 
-## Returns
+## Related
 
-<PropertiesTable
-  content={[
-    {
-      name: "instructions",
-      type: "string | Promise<string>",
-      description: "The instructions configured for the agent, either as a direct string or a promise that resolves to the instructions.",
-    },
-  ]}
-/>
+- [Agents overview](../../docs/agents/overview.mdx)
+- [Runtime variables](../../docs/agents/runtime-variables.mdx)

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

@@ -1,16 +1,16 @@
 ---
-title: "Reference: getLLM() | Agents | Mastra Docs"
-description: "Documentation for the `.getLLM()` method in Mastra agents, which retrieves the language model instance."
+title: "Reference: Agent.getLLM() | Agents | Mastra Docs"
+description: "Documentation for the `Agent.getLLM()` method in Mastra agents, which retrieves the language model instance."
 ---
 
-# getLLM()
+# 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 showLineNumbers copy
-const llm = await agent.getLLM();
+```typescript copy
+await agent.getLLM();
 ```
 
 ## Parameters
@@ -27,10 +27,22 @@ const llm = await agent.getLLM();
   ]}
 />
 
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: "llm",
+      type: "MastraLLMBase | Promise<MastraLLMBase>",
+      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 showLineNumbers copy
-const llm = await agent.getLLM({
+```typescript copy
+await agent.getLLM({
   runtimeContext: new RuntimeContext(),
   model: openai('gpt-4')
 });
@@ -51,19 +63,12 @@ const llm = await agent.getLLM({
       name: "model",
       type: "MastraLanguageModel | DynamicArgument<MastraLanguageModel>",
       isOptional: true,
-      description: "Optional model override. If provided, this model will be used instead of the agent's configured model.",
+      description: "Optional model override. If provided, this model will be used used instead of the agent's configured model.",
     },
   ]}
 />
 
-## Returns
+## Related
 
-<PropertiesTable
-  content={[
-    {
-      name: "llm",
-      type: "MastraLLMBase | Promise<MastraLLMBase>",
-      description: "The language model instance configured for the agent, either as a direct instance or a promise that resolves to the LLM.",
-    },
-  ]}
-/>
+- [Agents overview](../../docs/agents/overview.mdx)
+- [Runtime variables](../../docs/agents/runtime-variables.mdx)

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

@@ -1,16 +1,16 @@
 ---
-title: "Reference: getMemory() | Agents | Mastra Docs"
-description: "Documentation for the `.getMemory()` method in Mastra agents, which retrieves the memory system associated with the agent."
+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."
 ---
 
-# getMemory()
+# 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 showLineNumbers copy
-const memory = await agent.getMemory();
+```typescript copy
+await agent.getMemory();
 ```
 
 ## Parameters
@@ -27,10 +27,22 @@ const memory = await agent.getMemory();
   ]}
 />
 
+## 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 showLineNumbers copy
-const memory = await agent.getMemory({
+```typescript copy
+await agent.getMemory({
   runtimeContext: new RuntimeContext()
 });
 ```
@@ -49,14 +61,7 @@ const memory = await agent.getMemory({
   ]}
 />
 
-## Returns
+## Related
 
-<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.",
-    },
-  ]}
-/>
+- [Agent memory](../../docs/agents/agent-memory.mdx)
+- [Runtime variables](../../docs/agents/runtime-variables.mdx)

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

@@ -1,16 +1,16 @@
 ---
-title: "Reference: getModel() | Agents | Mastra Docs"
-description: "Documentation for the `.getModel()` method in Mastra agents, which retrieves the language model that powers the agent."
+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."
 ---
 
-# getModel()
+# 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 showLineNumbers copy
-const model = await agent.getModel();
+```typescript copy
+await agent.getModel();
 ```
 
 ## Parameters
@@ -27,10 +27,22 @@ const model = await agent.getModel();
   ]}
 />
 
+## 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 showLineNumbers copy
-const model = await agent.getModel({
+```typescript copy
+await agent.getModel({
   runtimeContext: new RuntimeContext()
 });
 ```
@@ -49,14 +61,7 @@ const model = await agent.getModel({
   ]}
 />
 
-## Returns
+## Related
 
-<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.",
-    },
-  ]}
-/>
+- [Agents overview](../../docs/agents/overview.mdx)
+- [Runtime variables](../../docs/agents/runtime-variables.mdx)

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

@@ -1,16 +1,16 @@
 ---
-title: "Reference: getScorers() | Agents | Mastra Docs"
-description: "Documentation for the `.getScorers()` method in Mastra agents, which retrieves the scoring configuration."
+title: "Reference: Agent.getScorers() | Agents | Mastra Docs"
+description: "Documentation for the `Agent.getScorers()` method in Mastra agents, which retrieves the scoring configuration."
 ---
 
-# getScorers()
+# 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 showLineNumbers copy
-const scorers = await agent.getScorers();
+```typescript copy
+await agent.getScorers();
 ```
 
 ## Parameters
@@ -27,10 +27,22 @@ const scorers = await agent.getScorers();
   ]}
 />
 
+## 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 showLineNumbers copy
-const scorers = await agent.getScorers({
+```typescript copy
+await agent.getScorers({
   runtimeContext: new RuntimeContext()
 });
 ```
@@ -49,14 +61,7 @@ const scorers = await agent.getScorers({
   ]}
 />
 
-## Returns
+## Related
 
-<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.",
-    },
-  ]}
-/>
+- [Agents overview](../../docs/agents/overview.mdx)
+- [Runtime variables](../../docs/agents/runtime-variables.mdx)

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

@@ -1,16 +1,16 @@
 ---
-title: "Reference: getTools() | Agents | Mastra Docs"
-description: "Documentation for the `.getTools()` method in Mastra agents, which retrieves the tools that the agent can use."
+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."
 ---
 
-# getTools()
+# 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 showLineNumbers copy
-const tools = await agent.getTools();
+```typescript copy
+await agent.getTools();
 ```
 
 ## Parameters
@@ -27,10 +27,22 @@ const tools = await agent.getTools();
   ]}
 />
 
+## 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 showLineNumbers copy
-const tools = await agent.getTools({
+```typescript copy
+await agent.getTools({
   runtimeContext: new RuntimeContext()
 });
 ```
@@ -49,14 +61,7 @@ const tools = await agent.getTools({
   ]}
 />
 
-## Returns
+## Related
 
-<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.",
-    },
-  ]}
-/>
+- [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,16 +1,16 @@
 ---
-title: "Reference: getVoice() | Agents | Mastra Docs"
-description: "Documentation for the `.getVoice()` method in Mastra agents, which retrieves the voice provider for speech capabilities."
+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."
 ---
 
-# getVoice()
+# 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 showLineNumbers copy
-const voice = await agent.getVoice();
+```typescript copy
+await agent.getVoice();
 ```
 
 ## Parameters
@@ -27,10 +27,22 @@ const voice = await agent.getVoice();
   ]}
 />
 
+## 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 showLineNumbers copy
-const voice = await agent.getVoice({
+```typescript copy
+await agent.getVoice({
   runtimeContext: new RuntimeContext()
 });
 ```
@@ -49,14 +61,7 @@ const voice = await agent.getVoice({
   ]}
 />
 
-## Returns
+## Related
 
-<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.",
-    },
-  ]}
-/>
+- [Adding voice to agents](../../docs/agents/adding-voice.mdx)
+- [Voice providers](../voice/mastra-voice.mdx)