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

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

@@ -0,0 +1,62 @@
+---
+title: "Reference: getScorers() | Agents | Mastra Docs"
+description: "Documentation for the `.getScorers()` method in Mastra agents, which retrieves the scoring configuration."
+---
+
+# 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();
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "options",
+      type: "{ runtimeContext?: RuntimeContext }",
+      isOptional: true,
+      defaultValue: "{}",
+      description: "Optional configuration object containing runtime context.",
+    },
+  ]}
+/>
+
+## Extended usage example
+
+```typescript showLineNumbers copy
+const scorers = 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.",
+    },
+  ]}
+/>
+
+## 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.",
+    },
+  ]}
+/>

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

@@ -1,154 +1,62 @@
 ---
-title: "Reference: Agent.getTools() | Agents | Mastra Docs"
+title: "Reference: getTools() | Agents | Mastra Docs"
 description: "Documentation for the `.getTools()` method in Mastra agents, which retrieves the tools that the agent can use."
 ---
 
-# Agent.getTools()
+# 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.
+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.
 
-## Syntax
+## Usage example
 
-```typescript
-getTools({ runtimeContext = new RuntimeContext() }: { runtimeContext?: RuntimeContext } = {}): ToolsInput | Promise<ToolsInput>
+```typescript showLineNumbers copy
+const tools = await agent.getTools();
 ```
 
 ## Parameters
 
-<br />
 <PropertiesTable
   content={[
     {
-      name: "runtimeContext",
-      type: "RuntimeContext",
+      name: "options",
+      type: "{ runtimeContext?: RuntimeContext }",
       isOptional: true,
-      description:
-        "Runtime context for dependency injection and contextual information.",
+      defaultValue: "{}",
+      description: "Optional configuration object containing runtime context.",
     },
   ]}
 />
 
-## Return Value
-
-Returns a `ToolsInput` object or a Promise that resolves to a `ToolsInput` object containing the agent's tools.
-
-## Description
-
-The `getTools()` method is used to access the tools that an agent can use. It resolves the tools, which can be either directly provided as an object or returned from a function.
-
-Tools are a key component of an agent's capabilities, allowing it to:
-
-- Perform specific actions (like fetching data or making calculations)
-- Access external systems and APIs
-- Execute code or commands
-- Interact with databases or other services
-
-## Examples
-
-### Basic Usage
+## Extended usage example
 
-```typescript
-import { Agent } from "@mastra/core/agent";
-import { createTool } from "@mastra/core/tools";
-import { openai } from "@ai-sdk/openai";
-import { z } from "zod";
-
-// Create tools using createTool
-const addTool = createTool({
-  id: "add",
-  description: "Add two numbers",
-  inputSchema: z.object({
-    a: z.number().describe("First number"),
-    b: z.number().describe("Second number"),
-  }),
-  outputSchema: z.number(),
-  execute: async ({ context }) => {
-    return context.a + context.b;
-  },
-});
-
-const multiplyTool = createTool({
-  id: "multiply",
-  description: "Multiply two numbers",
-  inputSchema: z.object({
-    a: z.number().describe("First number"),
-    b: z.number().describe("Second number"),
-  }),
-  outputSchema: z.number(),
-  execute: async ({ context }) => {
-    return context.a * context.b;
-  },
-});
-
-// Create an agent with the tools
-const agent = new Agent({
-  name: "calculator",
-  instructions:
-    "You are a calculator assistant that can perform mathematical operations.",
-  model: openai("gpt-4o"),
-  tools: {
-    add: addTool,
-    multiply: multiplyTool,
-  },
+```typescript showLineNumbers copy
+const tools = await agent.getTools({
+  runtimeContext: new RuntimeContext()
 });
-
-// Get the tools
-const tools = await agent.getTools();
-console.log(Object.keys(tools)); // ["add", "multiply"]
 ```
 
-### Using with RuntimeContext
-
-```typescript
-import { Agent } from "@mastra/core/agent";
-import { createTool } from "@mastra/core/tools";
-import { RuntimeContext } from "@mastra/core/runtime-context";
-import { openai } from "@ai-sdk/openai";
-import { z } from "zod";
-
-// Create an agent with dynamic tools
-const agent = new Agent({
-  name: "weather-assistant",
-  instructions:
-    "You are a weather assistant that can provide weather information.",
-  model: openai("gpt-4o"),
-  tools: ({ runtimeContext }) => {
-    // Get API key from runtime context
-    const apiKey = runtimeContext.get("weatherApiKey");
+### Options parameters
 
-    // Create a weather tool with the API key from context
-    const weatherTool = createTool({
-      id: "getWeather",
-      description: "Get the current weather for a location",
-      inputSchema: z.object({
-        location: z.string().describe("City name"),
-      }),
-      outputSchema: z.object({
-        temperature: z.number(),
-        conditions: z.string(),
-        humidity: z.number(),
-        windSpeed: z.number(),
-      }),
-      execute: async ({ context }) => {
-        // Use the API key from runtime context
-        const response = await fetch(
-          `https://api.weather.com/current?location=${context.location}&apiKey=${apiKey}`,
-        );
-        return response.json();
-      },
-    });
-
-    return {
-      getWeather: weatherTool,
-    };
-  },
-});
+<PropertiesTable
+  content={[
+    {
+      name: "runtimeContext",
+      type: "RuntimeContext",
+      isOptional: true,
+      defaultValue: "new RuntimeContext()",
+      description: "Runtime context for dependency injection and contextual information.",
+    },
+  ]}
+/>
 
-// Create a runtime context with API key
-const context = new RuntimeContext();
-context.set("weatherApiKey", "your-api-key");
+## Returns
 
-// Get the tools using the runtime context
-const tools = await agent.getTools({ runtimeContext: context });
-console.log(Object.keys(tools)); // ["getWeather"]
-```
+<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.",
+    },
+  ]}
+/>

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

@@ -1,109 +1,62 @@
 ---
-title: "Reference: Agent.getVoice() | Agents | Mastra Docs"
+title: "Reference: getVoice() | Agents | Mastra Docs"
 description: "Documentation for the `.getVoice()` method in Mastra agents, which retrieves the voice provider for speech capabilities."
 ---
 
-# Agent.getVoice()
+# 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.
+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.
 
-## Syntax
+## Usage example
 
-```typescript
-getVoice({ runtimeContext }: { runtimeContext?: RuntimeContext } = {}): CompositeVoice | Promise<CompositeVoice>
+```typescript showLineNumbers copy
+const voice = await agent.getVoice();
 ```
 
 ## Parameters
 
-<br />
 <PropertiesTable
   content={[
     {
-      name: "runtimeContext",
-      type: "RuntimeContext",
+      name: "options",
+      type: "{ runtimeContext?: RuntimeContext }",
       isOptional: true,
-      description:
-        "Runtime context for dependency injection and contextual information. Defaults to a new RuntimeContext instance if not provided.",
+      defaultValue: "{}",
+      description: "Optional configuration object containing runtime context.",
     },
   ]}
 />
 
-## Return Value
-
-Returns a `CompositeVoice` instance or a Promise that resolves to a `CompositeVoice` instance. If no voice provider was configured for the agent, it returns a default voice provider.
-
-## Description
-
-The `getVoice()` method is used to access the voice capabilities of an agent. It resolves the voice provider, which can be either directly provided or returned from a function.
-
-The voice provider enables:
-
-- Text-to-speech conversion (speaking)
-- Speech-to-text conversion (listening)
-- Retrieving available speakers/voices
-
-## Examples
+## Extended usage example
 
-### Basic Usage
-
-```typescript
-import { Agent } from "@mastra/core/agent";
-import { ElevenLabsVoice } from "@mastra/voice-elevenlabs";
-import { openai } from "@ai-sdk/openai";
-
-// Create an agent with a voice provider
-const agent = new Agent({
-  name: "voice-assistant",
-  instructions: "You are a helpful voice assistant.",
-  model: openai("gpt-4o"),
-  voice: new ElevenLabsVoice({
-    apiKey: process.env.ELEVENLABS_API_KEY,
-  }),
+```typescript showLineNumbers copy
+const voice = await agent.getVoice({
+  runtimeContext: new RuntimeContext()
 });
-
-// Get the voice provider
-const voice = await agent.getVoice();
-
-// Use the voice provider for text-to-speech
-const audioStream = await voice.speak("Hello, how can I help you today?");
-
-// Use the voice provider for speech-to-text
-const transcription = await voice.listen(audioStream);
-
-// Get available speakers
-const speakers = await voice.getSpeakers();
-console.log(speakers);
 ```
 
-### Using with RuntimeContext
+### Options parameters
 
-```typescript
-import { Agent } from "@mastra/core/agent";
-import { ElevenLabsVoice } from "@mastra/voice-elevenlabs";
-import { RuntimeContext } from "@mastra/core/runtime-context";
-import { openai } from "@ai-sdk/openai";
-
-// Create an agent with a dynamic voice provider
-const agent = new Agent({
-  name: "voice-assistant",
-  instructions: ({ runtimeContext }) => {
-    // Dynamic instructions based on runtime context
-    const instructions = runtimeContext.get("preferredVoiceInstructions");
-    return instructions || "You are a helpful voice assistant.";
-  },
-  model: openai("gpt-4o"),
-  voice: new ElevenLabsVoice({
-    apiKey: process.env.ELEVENLABS_API_KEY,
-  }),
-});
-
-// Create a runtime context with preferences
-const context = new RuntimeContext();
-context.set("preferredVoiceInstructions", "You are an evil voice assistant");
+<PropertiesTable
+  content={[
+    {
+      name: "runtimeContext",
+      type: "RuntimeContext",
+      isOptional: true,
+      defaultValue: "new RuntimeContext()",
+      description: "Runtime context for dependency injection and contextual information.",
+    },
+  ]}
+/>
 
-// Get the voice provider using the runtime context
-const voice = await agent.getVoice({ runtimeContext: context });
+## Returns
 
-// Use the voice provider
-const audioStream = await voice.speak("Hello, how can I help you today?");
-```
+<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.",
+    },
+  ]}
+/>

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

@@ -1,99 +1,62 @@
 ---
-title: "Reference: Agent.getWorkflows() | Agents | Mastra Docs"
+title: "Reference: getWorkflows() | Agents | Mastra Docs"
 description: "Documentation for the `.getWorkflows()` method in Mastra agents, which retrieves the workflows that the agent can execute."
 ---
 
-# Agent.getWorkflows()
+# 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.
+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.
 
-## Syntax
+## Usage example
 
-```typescript
-getWorkflows({ runtimeContext = new RuntimeContext() }: { runtimeContext?: RuntimeContext } = {}): Record<string, NewWorkflow> | Promise<Record<string, NewWorkflow>>
+```typescript showLineNumbers copy
+const workflows = await agent.getWorkflows();
 ```
 
 ## Parameters
 
-<br />
 <PropertiesTable
   content={[
     {
-      name: "runtimeContext",
-      type: "RuntimeContext",
+      name: "options",
+      type: "{ runtimeContext?: RuntimeContext }",
       isOptional: true,
-      description:
-        "Runtime context for dependency injection and contextual information.",
+      defaultValue: "{}",
+      description: "Optional configuration object containing runtime context.",
     },
   ]}
 />
 
-## Return Value
-
-Returns a `Record<string, NewWorkflow>` object or a Promise that resolves to a `Record<string, NewWorkflow>` object containing the agent's workflows.
-
-## Description
-
-The `getWorkflows()` method is used to access the workflows that an agent can execute. It resolves the workflows, which can be either directly provided as an object or returned from a function that receives runtime context.
-
-## Examples
-
-```typescript
-import { Agent } from "@mastra/core/agent";
-import { createWorkflow, createStep } from "@mastra/core/workflows";
-import { openai } from "@ai-sdk/openai";
-import { z } from "zod";
-
-const generateSuggestionsStep = createStep({
-  id: "generate-suggestions",
-  inputSchema: z.object({
-    topic: z.string().describe("The topic to research"),
-  }),
-  outputSchema: z.object({
-    summary: z.string(),
-  }),
-  execute: async ({ inputData, mastra }) => {
-    const researchAgent = mastra?.getAgent("researchAgent");
+## Extended usage example
 
-    if (!researchAgent) {
-      throw new Error("Research agent is not initialized");
-    }
-
-    const { topic } = inputData;
-
-    const result = await researchAgent.generate([
-      { role: "assistant", content: topic },
-    ]);
-
-    return { summary: result.text };
-  },
-});
-
-const researchWorkflow = createWorkflow({
-  id: "research-workflow",
-  inputSchema: z.object({
-    topic: z.string().describe("The topic to research"),
-  }),
-  outputSchema: z.object({
-    summary: z.string(),
-  }),
+```typescript showLineNumbers copy
+const workflows = await agent.getWorkflows({
+  runtimeContext: new RuntimeContext()
 });
+```
 
-researchWorkflow.then(generateSuggestionsStep).commit();
+### Options parameters
 
-// Create an agent with the workflow
-const agent = new Agent({
-  name: "research-organizer",
-  instructions:
-    "You are a research organizer that can delegate tasks to gather information and create summaries.",
-  model: openai("gpt-4o"),
-  workflows: {
-    research: researchWorkflow,
-  },
-});
+<PropertiesTable
+  content={[
+    {
+      name: "runtimeContext",
+      type: "RuntimeContext",
+      isOptional: true,
+      defaultValue: "new RuntimeContext()",
+      description: "Runtime context for dependency injection and contextual information.",
+    },
+  ]}
+/>
 
-// Get the workflows
-const workflows = await agent.getWorkflows();
+## Returns
 
-console.log(Object.keys(workflows)); // ["research"]
-```
+<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.",
+    },
+  ]}
+/>