@mastra/mcp-docs-server 0.13.37 → 0.13.39-alpha.0

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

@@ -34,7 +34,8 @@ await agent.getDefaultGenerateOptions();
     {
       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.",
+      description:
+        "The default generation options configured for the agent, either as a direct object or a promise that resolves to the options.",
     },
   ]}
 />
@@ -43,7 +44,7 @@ await agent.getDefaultGenerateOptions();
 
 ```typescript copy
 await agent.getDefaultGenerateOptions({
-  runtimeContext: new RuntimeContext()
+  runtimeContext: new RuntimeContext(),
 });
 ```
 
@@ -56,12 +57,13 @@ await agent.getDefaultGenerateOptions({
       type: "RuntimeContext",
       isOptional: true,
       defaultValue: "new RuntimeContext()",
-      description: "Runtime context for dependency injection and contextual information.",
+      description:
+        "Runtime context for dependency injection and contextual information.",
     },
   ]}
 />
 
 ## Related
 
-- [Agent generation](../../docs/agents/overview.mdx#generate)
-- [Runtime Context](../../docs/server-db/runtime-context.mdx)
+- [Agent generation](/docs/agents/overview#generating-responses)
+- [Runtime Context](/docs/server-db/runtime-context)

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

@@ -34,7 +34,8 @@ await agent.getDefaultStreamOptions();
     {
       name: "defaultOptions",
       type: "AgentExecutionOptions<Output> | Promise<AgentExecutionOptions<Output>>",
-      description: "The default vNext streaming options configured for the agent, either as a direct object or a promise that resolves to the options.",
+      description:
+        "The default vNext streaming options configured for the agent, either as a direct object or a promise that resolves to the options.",
     },
   ]}
 />
@@ -43,7 +44,7 @@ await agent.getDefaultStreamOptions();
 
 ```typescript copy
 await agent.getDefaultStreamOptions({
-  runtimeContext: new RuntimeContext()
+  runtimeContext: new RuntimeContext(),
 });
 ```
 
@@ -56,12 +57,13 @@ await agent.getDefaultStreamOptions({
       type: "RuntimeContext",
       isOptional: true,
       defaultValue: "new RuntimeContext()",
-      description: "Runtime context for dependency injection and contextual information.",
+      description:
+        "Runtime context for dependency injection and contextual information.",
     },
   ]}
 />
 
 ## Related
 
-- [Streaming with agents](../../docs/streaming/overview.mdx#streaming-with-agents)
-- [Runtime Context](../../docs/server-db/runtime-context.mdx)
+- [Streaming with agents](/docs/streaming/overview#streaming-with-agents)
+- [Runtime Context](/docs/server-db/runtime-context)

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

@@ -24,11 +24,12 @@ This method takes no parameters.
     {
       name: "description",
       type: "string",
-      description: "The description of the agent, or an empty string if no description was configured.",
+      description:
+        "The description of the agent, or an empty string if no description was configured.",
     },
   ]}
 />
 
 ## Related
 
-- [Agents overview](../../docs/agents/overview.mdx)
+- [Agents overview](/docs/agents/overview)

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

@@ -34,7 +34,8 @@ await agent.getInstructions();
     {
       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.",
+      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.",
     },
   ]}
 />
@@ -43,7 +44,7 @@ await agent.getInstructions();
 
 ```typescript copy
 await agent.getInstructions({
-  runtimeContext: new RuntimeContext()
+  runtimeContext: new RuntimeContext(),
 });
 ```
 
@@ -56,12 +57,13 @@ await agent.getInstructions({
       type: "RuntimeContext",
       isOptional: true,
       defaultValue: "undefined",
-      description: "Runtime context for dependency injection and contextual information.",
+      description:
+        "Runtime context for dependency injection and contextual information.",
     },
   ]}
 />
 
 ## Related
 
-- [Agents overview](../../docs/agents/overview.mdx)
-- [Runtime Context](../../docs/server-db/runtime-context.mdx)
+- [Agents overview](/docs/agents/overview)
+- [Runtime Context](/docs/server-db/runtime-context)

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

@@ -22,7 +22,8 @@ await agent.getLLM();
       type: "{ runtimeContext?: RuntimeContext; model?: MastraLanguageModel | DynamicArgument<MastraLanguageModel> }",
       isOptional: true,
       defaultValue: "{}",
-      description: "Optional configuration object containing runtime context and optional model override.",
+      description:
+        "Optional configuration object containing runtime context and optional model override.",
     },
   ]}
 />
@@ -34,7 +35,8 @@ await agent.getLLM();
     {
       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.",
+      description:
+        "The language model instance configured for the agent, either as a direct instance or a promise that resolves to the LLM.",
     },
   ]}
 />
@@ -44,7 +46,7 @@ await agent.getLLM();
 ```typescript copy
 await agent.getLLM({
   runtimeContext: new RuntimeContext(),
-  model: openai('gpt-4')
+  model: openai("gpt-4"),
 });
 ```
 
@@ -57,18 +59,20 @@ await agent.getLLM({
       type: "RuntimeContext",
       isOptional: true,
       defaultValue: "new RuntimeContext()",
-      description: "Runtime context for dependency injection and contextual information.",
+      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.",
+      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)
+- [Agents overview](/docs/agents/overview)
+- [Runtime Context](/docs/server-db/runtime-context)

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

@@ -34,7 +34,8 @@ await agent.getMemory();
     {
       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.",
+      description:
+        "A promise that resolves to the memory system configured for the agent, or undefined if no memory system is configured.",
     },
   ]}
 />
@@ -43,7 +44,7 @@ await agent.getMemory();
 
 ```typescript copy
 await agent.getMemory({
-  runtimeContext: new RuntimeContext()
+  runtimeContext: new RuntimeContext(),
 });
 ```
 
@@ -56,12 +57,13 @@ await agent.getMemory({
       type: "RuntimeContext",
       isOptional: true,
       defaultValue: "new RuntimeContext()",
-      description: "Runtime context for dependency injection and contextual information.",
+      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)
+- [Agent memory](/docs/agents/agent-memory)
+- [Runtime Context](/docs/server-db/runtime-context)

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

@@ -34,7 +34,8 @@ await agent.getModel();
     {
       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.",
+      description:
+        "The language model configured for the agent, either as a direct instance or a promise that resolves to the model.",
     },
   ]}
 />
@@ -43,7 +44,7 @@ await agent.getModel();
 
 ```typescript copy
 await agent.getModel({
-  runtimeContext: new RuntimeContext()
+  runtimeContext: new RuntimeContext(),
 });
 ```
 
@@ -56,12 +57,13 @@ await agent.getModel({
       type: "RuntimeContext",
       isOptional: true,
       defaultValue: "undefined",
-      description: "Runtime context for dependency injection and contextual information.",
+      description:
+        "Runtime context for dependency injection and contextual information.",
     },
   ]}
 />
 
 ## Related
 
-- [Agents overview](../../docs/agents/overview.mdx)
-- [Runtime Context](../../docs/server-db/runtime-context.mdx)
+- [Agents overview](/docs/agents/overview)
+- [Runtime Context](/docs/server-db/runtime-context)

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

@@ -34,7 +34,8 @@ await agent.getScorers();
     {
       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.",
+      description:
+        "The scoring configuration configured for the agent, either as a direct object or a promise that resolves to the scorers.",
     },
   ]}
 />
@@ -43,7 +44,7 @@ await agent.getScorers();
 
 ```typescript copy
 await agent.getScorers({
-  runtimeContext: new RuntimeContext()
+  runtimeContext: new RuntimeContext(),
 });
 ```
 
@@ -56,12 +57,13 @@ await agent.getScorers({
       type: "RuntimeContext",
       isOptional: true,
       defaultValue: "new RuntimeContext()",
-      description: "Runtime context for dependency injection and contextual information.",
+      description:
+        "Runtime context for dependency injection and contextual information.",
     },
   ]}
 />
 
 ## Related
 
-- [Agents overview](../../docs/agents/overview.mdx)
-- [Runtime Context](../../docs/server-db/runtime-context.mdx)
+- [Agents overview](/docs/agents/overview)
+- [Runtime Context](/docs/server-db/runtime-context)

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

@@ -34,7 +34,8 @@ await agent.getTools();
     {
       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.",
+      description:
+        "The tools configured for the agent, either as a direct object or a promise that resolves to the tools.",
     },
   ]}
 />
@@ -43,7 +44,7 @@ await agent.getTools();
 
 ```typescript copy
 await agent.getTools({
-  runtimeContext: new RuntimeContext()
+  runtimeContext: new RuntimeContext(),
 });
 ```
 
@@ -56,12 +57,13 @@ await agent.getTools({
       type: "RuntimeContext",
       isOptional: true,
       defaultValue: "new RuntimeContext()",
-      description: "Runtime context for dependency injection and contextual information.",
+      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)
+- [Using tools with agents](/docs/agents/using-tools)
+- [Creating tools](/docs/tools-mcp/overview)

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

@@ -34,7 +34,8 @@ await agent.getVoice();
     {
       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.",
+      description:
+        "A promise that resolves to the voice provider configured for the agent, or a default voice provider if none was configured.",
     },
   ]}
 />
@@ -43,7 +44,7 @@ await agent.getVoice();
 
 ```typescript copy
 await agent.getVoice({
-  runtimeContext: new RuntimeContext()
+  runtimeContext: new RuntimeContext(),
 });
 ```
 
@@ -56,12 +57,13 @@ await agent.getVoice({
       type: "RuntimeContext",
       isOptional: true,
       defaultValue: "new RuntimeContext()",
-      description: "Runtime context for dependency injection and contextual information.",
+      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)
+- [Adding voice to agents](/docs/agents/adding-voice)
+- [Voice providers](../voice/mastra-voice)

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

@@ -34,7 +34,8 @@ await agent.getWorkflows();
     {
       name: "workflows",
       type: "Promise<Record<string, Workflow>>",
-      description: "A promise that resolves to a record of workflow names to their corresponding Workflow instances.",
+      description:
+        "A promise that resolves to a record of workflow names to their corresponding Workflow instances.",
     },
   ]}
 />
@@ -43,7 +44,7 @@ await agent.getWorkflows();
 
 ```typescript copy
 await agent.getWorkflows({
-  runtimeContext: new RuntimeContext()
+  runtimeContext: new RuntimeContext(),
 });
 ```
 
@@ -56,12 +57,13 @@ await agent.getWorkflows({
       type: "RuntimeContext",
       isOptional: true,
       defaultValue: "new RuntimeContext()",
-      description: "Runtime context for dependency injection and contextual information.",
+      description:
+        "Runtime context for dependency injection and contextual information.",
     },
   ]}
 />
 
 ## Related
 
-- [Agents overview](../../docs/agents/overview.mdx)
-- [Workflows overview](../../docs/workflows/overview.mdx)
+- [Agents overview](/docs/agents/overview)
+- [Workflows overview](/docs/workflows/overview)

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

@@ -34,7 +34,8 @@ await agent.listAgents();
     {
       name: "agents",
       type: "Promise<Record<string, Agent>>",
-      description: "A promise that resolves to a record of agent names to their corresponding Agent instances.",
+      description:
+        "A promise that resolves to a record of agent names to their corresponding Agent instances.",
     },
   ]}
 />
@@ -45,7 +46,7 @@ await agent.listAgents();
 import { RuntimeContext } from "@mastra/core/runtime-context";
 
 await agent.listAgents({
-  runtimeContext: new RuntimeContext()
+  runtimeContext: new RuntimeContext(),
 });
 ```
 
@@ -58,11 +59,12 @@ await agent.listAgents({
       type: "RuntimeContext",
       isOptional: true,
       defaultValue: "new RuntimeContext()",
-      description: "Runtime context for dependency injection and contextual information.",
+      description:
+        "Runtime context for dependency injection and contextual information.",
     },
   ]}
 />
 
 ## Related
 
-- [Agents overview](../../docs/agents/overview.mdx)
+- [Agents overview](/docs/agents/overview)

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

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

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

@@ -0,0 +1,69 @@
+---
+title: "Reference: Agent.listTools() | Agents | Mastra Docs"
+description: "Documentation for the `Agent.listTools()` method in Mastra agents, which retrieves the tools that the agent can use."
+---
+
+# 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 copy
+await agent.listTools();
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "options",
+      type: "{ runtimeContext?: RuntimeContext }",
+      isOptional: true,
+      defaultValue: "{}",
+      description: "Optional configuration object containing request 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.listTools({
+  runtimeContext: new RuntimeContext(),
+});
+```
+
+### Options parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "runtimeContext",
+      type: "RuntimeContext",
+      isOptional: true,
+      defaultValue: "new RuntimeContext()",
+      description:
+        "Request Context for dependency injection and contextual information.",
+    },
+  ]}
+/>
+
+## Related
+
+- [Using tools with agents](/docs/agents/using-tools)
+- [Creating tools](/docs/tools-mcp/overview)

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

@@ -0,0 +1,69 @@
+---
+title: "Reference: Agent.listWorkflows() | Agents | Mastra Docs"
+description: "Documentation for the `Agent.listWorkflows()` method in Mastra agents, which retrieves the workflows that the agent can execute."
+---
+
+# 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 copy
+await agent.listWorkflows();
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "options",
+      type: "{ runtimeContext?: RuntimeContext }",
+      isOptional: true,
+      defaultValue: "{}",
+      description: "Optional configuration object containing request 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.listWorkflows({
+  runtimeContext: new RuntimeContext(),
+});
+```
+
+### Options parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "runtimeContext",
+      type: "RuntimeContext",
+      isOptional: true,
+      defaultValue: "new RuntimeContext()",
+      description:
+        "Request Context for dependency injection and contextual information.",
+    },
+  ]}
+/>
+
+## Related
+
+- [Agents overview](/docs/agents/overview)
+- [Workflows overview](/docs/workflows/overview)