@mastra/mcp-docs-server 0.13.37 → 0.13.38

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

@@ -11,25 +11,25 @@ The `Agent` class is the foundation for creating AI agents in Mastra. It provide
 
 ### Basic string instructions
 
-```typescript filename="src/mastra/agents/string-agent.ts" showLineNumbers copy
+```typescript title="src/mastra/agents/string-agent.ts" showLineNumbers copy
 import { openai } from "@ai-sdk/openai";
 import { Agent } from "@mastra/core/agent";
 
 // String instructions
 export const agent = new Agent({
   name: "test-agent",
-  instructions: 'You are a helpful assistant that provides concise answers.',
-  model: openai("gpt-4o")
+  instructions: "You are a helpful assistant that provides concise answers.",
+  model: openai("gpt-4o"),
 });
 
 // System message object
 export const agent2 = new Agent({
   name: "test-agent-2",
-  instructions: { 
-    role: "system", 
-    content: "You are an expert programmer" 
+  instructions: {
+    role: "system",
+    content: "You are an expert programmer",
   },
-  model: openai("gpt-4o")
+  model: openai("gpt-4o"),
 });
 
 // Array of system messages
@@ -37,9 +37,9 @@ export const agent3 = new Agent({
   name: "test-agent-3",
   instructions: [
     { role: "system", content: "You are a helpful assistant" },
-    { role: "system", content: "You have expertise in TypeScript" }
+    { role: "system", content: "You have expertise in TypeScript" },
   ],
-  model: openai("gpt-4o")
+  model: openai("gpt-4o"),
 });
 ```
 
@@ -47,51 +47,52 @@ export const agent3 = new Agent({
 
 Use CoreSystemMessage format to access additional properties like `providerOptions` for provider-specific configurations:
 
-```typescript filename="src/mastra/agents/core-message-agent.ts" showLineNumbers copy
+```typescript title="src/mastra/agents/core-message-agent.ts" showLineNumbers copy
 import { openai } from "@ai-sdk/openai";
 import { Agent } from "@mastra/core/agent";
 
 export const agent = new Agent({
   name: "core-message-agent",
   instructions: {
-    role: 'system',
-    content: 'You are a helpful assistant specialized in technical documentation.',
+    role: "system",
+    content:
+      "You are a helpful assistant specialized in technical documentation.",
     providerOptions: {
-      openai: { 
-        reasoningEffort: 'low'
-      }
-    }
+      openai: {
+        reasoningEffort: "low",
+      },
+    },
   },
-  model: openai("gpt-5")
+  model: openai("gpt-5"),
 });
 ```
 
 ### Multiple CoreSystemMessages
 
-```typescript filename="src/mastra/agents/multi-message-agent.ts" showLineNumbers copy
+```typescript title="src/mastra/agents/multi-message-agent.ts" showLineNumbers copy
 import { anthropic } from "@ai-sdk/anthropic";
 import { Agent } from "@mastra/core/agent";
 
 // This could be customizable based on the user
-const preferredTone = { 
-  role: 'system', 
-  content: 'Always maintain a professional and empathetic tone.',
+const preferredTone = {
+  role: "system",
+  content: "Always maintain a professional and empathetic tone.",
 };
 
 export const agent = new Agent({
   name: "multi-message-agent",
   instructions: [
-    { role: 'system', content: 'You are a customer service representative.' },
+    { role: "system", content: "You are a customer service representative." },
     preferredTone,
-    { 
-      role: 'system', 
-      content: 'Escalate complex issues to human agents when needed.',
+    {
+      role: "system",
+      content: "Escalate complex issues to human agents when needed.",
       providerOptions: {
-        anthropic: { cacheControl: { type: 'ephemeral' } },
+        anthropic: { cacheControl: { type: "ephemeral" } },
       },
     },
   ],
-  model: anthropic('claude-sonnet-4-20250514'),
+  model: anthropic("claude-sonnet-4-20250514"),
 });
 ```
 
@@ -103,7 +104,8 @@ export const agent = new Agent({
       name: "id",
       type: "string",
       isOptional: true,
-      description: "Optional unique identifier for the agent. Defaults to `name` if not provided.",
+      description:
+        "Optional unique identifier for the agent. Defaults to `name` if not provided.",
     },
     {
       name: "name",
@@ -115,7 +117,8 @@ export const agent = new Agent({
       name: "description",
       type: "string",
       isOptional: true,
-      description: "Optional description of the agent's purpose and capabilities.",
+      description:
+        "Optional description of the agent's purpose and capabilities.",
     },
     {
       name: "instructions",
@@ -129,25 +132,29 @@ export const agent = new Agent({
       name: "model",
       type: "MastraLanguageModel | ({ runtimeContext: RuntimeContext }) => MastraLanguageModel | Promise<MastraLanguageModel>",
       isOptional: false,
-      description: "The language model used by the agent. Can be provided statically or resolved at runtime.",
+      description:
+        "The language model used by the agent. Can be provided statically or resolved at runtime.",
     },
     {
       name: "agents",
       type: "Record<string, Agent> | ({ runtimeContext: RuntimeContext }) => Record<string, Agent> | Promise<Record<string, Agent>>",
       isOptional: true,
-      description: "Sub-Agents that the agent can access. Can be provided statically or resolved dynamically.",
+      description:
+        "Sub-Agents that the agent can access. Can be provided statically or resolved dynamically.",
     },
     {
       name: "tools",
       type: "ToolsInput | ({ runtimeContext: RuntimeContext }) => ToolsInput | Promise<ToolsInput>",
       isOptional: true,
-      description: "Tools that the agent can access. Can be provided statically or resolved dynamically.",
+      description:
+        "Tools that the agent can access. Can be provided statically or resolved dynamically.",
     },
     {
       name: "workflows",
       type: "Record<string, Workflow> | ({ runtimeContext: RuntimeContext }) => Record<string, Workflow> | Promise<Record<string, Workflow>>",
       isOptional: true,
-      description: "Workflows that the agent can execute. Can be static or dynamically resolved.",
+      description:
+        "Workflows that the agent can execute. Can be static or dynamically resolved.",
     },
     {
       name: "defaultGenerateOptions",
@@ -165,19 +172,22 @@ export const agent = new Agent({
       name: "defaultStreamOptions",
       type: "AgentExecutionOptions | ({ runtimeContext: RuntimeContext }) => AgentExecutionOptions | Promise<AgentExecutionOptions>",
       isOptional: true,
-      description: "Default options used when calling `stream()` in vNext mode.",
+      description:
+        "Default options used when calling `stream()` in vNext mode.",
     },
     {
       name: "mastra",
       type: "Mastra",
       isOptional: true,
-      description: "Reference to the Mastra runtime instance (injected automatically).",
+      description:
+        "Reference to the Mastra runtime instance (injected automatically).",
     },
     {
       name: "scorers",
       type: "MastraScorers | ({ runtimeContext: RuntimeContext }) => MastraScorers | Promise<MastraScorers>",
       isOptional: true,
-      description: "Scoring configuration for runtime evaluation and telemetry. Can be static or dynamically provided.",
+      description:
+        "Scoring configuration for runtime evaluation and telemetry. Can be static or dynamically provided.",
     },
     {
       name: "evals",
@@ -189,7 +199,8 @@ export const agent = new Agent({
       name: "memory",
       type: "MastraMemory | ({ runtimeContext: RuntimeContext }) => MastraMemory | Promise<MastraMemory>",
       isOptional: true,
-      description: "Memory module used for storing and retrieving stateful context.",
+      description:
+        "Memory module used for storing and retrieving stateful context.",
     },
     {
       name: "voice",
@@ -201,13 +212,15 @@ export const agent = new Agent({
       name: "inputProcessors",
       type: "Processor[] | ({ runtimeContext: RuntimeContext }) => Processor[] | Promise<Processor[]>",
       isOptional: true,
-      description: "Input processors that can modify or validate messages before they are processed by the agent. Must implement the `processInput` function.",
+      description:
+        "Input processors that can modify or validate messages before they are processed by the agent. Must implement the `processInput` function.",
     },
     {
       name: "outputProcessors",
       type: "Processor[] | ({ runtimeContext: RuntimeContext }) => Processor[] | Promise<Processor[]>",
       isOptional: true,
-      description: "Output processors that can modify or validate messages from the agent, before it is sent to the client. Must implement either (or both) of the `processOutputResult` and `processOutputStream` functions.",
+      description:
+        "Output processors that can modify or validate messages from the agent, before it is sent to the client. Must implement either (or both) of the `processOutputResult` and `processOutputStream` functions.",
     },
   ]}
 />
@@ -226,5 +239,5 @@ export const agent = new Agent({
 
 ## Related
 
-- [Agents overview](../../docs/agents/overview.mdx)
-- [Calling Agents](../../examples/agents/calling-agents.mdx)
+- [Agents overview](/docs/agents/overview)
+- [Calling Agents](/examples/agents/calling-agents)