@mastra/memory 1.5.1 → 1.5.2

package/dist/docs/references/docs-agents-networks.md

@@ -0,0 +1,299 @@
+# Agent Networks
+
+> **Supervisor Pattern Recommended:** The [supervisor pattern](https://mastra.ai/docs/agents/supervisor-agents) using `agent.stream()` or `agent.generate()` is now the recommended approach for coordinating multiple agents. It provides the same multi-agent coordination capabilities as `.network()` with significant improvements:
+>
+> - **Better control**: Iteration hooks, delegation hooks, and task completion scoring give you fine-grained control over execution
+> - **Simpler API**: Uses familiar `stream()` and `generate()` methods instead of a separate `.network()` API
+> - **More flexible**: Stop execution early, modify delegations, filter context, and provide feedback to guide the agent
+> - **Type-safe**: Full TypeScript support for all hooks and callbacks
+> - **Easier debugging**: Monitor progress with `onIterationComplete`, track delegations with `onDelegationStart`/`onDelegationComplete`
+>
+> See the [migration guide](https://mastra.ai/guides/migrations/network-to-supervisor) to upgrade from `.network()`.
+
+Agent networks in Mastra coordinate multiple agents, workflows, and tools to handle tasks that aren't clearly defined upfront but can be inferred from the user's message or context. A top-level **routing agent** (a Mastra agent with other agents, workflows, and tools configured) uses an LLM to interpret the request and decide which primitives (subagents, workflows, or tools) to call, in what order, and with what data.
+
+## When to use networks
+
+Use networks for complex tasks that require coordination across multiple primitives. Unlike workflows, which follow a predefined sequence, networks rely on LLM reasoning to interpret the request and decide what to run.
+
+## Core principles
+
+Mastra agent networks operate using these principles:
+
+- Memory is required when using `.network()` and is used to store task history and determine when a task is complete.
+- Primitives are selected based on their descriptions. Clear, specific descriptions improve routing. For workflows and tools, the input schema helps determine the right inputs at runtime.
+- If multiple primitives have overlapping functionality, the agent favors the more specific one, using a combination of schema and descriptions to decide which to run.
+
+## Creating an agent network
+
+An agent network is built around a top-level routing agent that delegates tasks to subagents, workflows, and tools defined in its configuration. Memory is configured on the routing agent using the `memory` option, and `instructions` define the agent's routing behavior.
+
+```typescript
+import { Agent } from '@mastra/core/agent'
+import { Memory } from '@mastra/memory'
+import { LibSQLStore } from '@mastra/libsql'
+
+import { researchAgent } from './research-agent'
+import { writingAgent } from './writing-agent'
+
+import { cityWorkflow } from '../workflows/city-workflow'
+import { weatherTool } from '../tools/weather-tool'
+
+export const routingAgent = new Agent({
+  id: 'routing-agent',
+  name: 'Routing Agent',
+  instructions: `
+      You are a network of writers and researchers.
+      The user will ask you to research a topic.
+      Always respond with a complete report—no bullet points.
+      Write in full paragraphs, like a blog post.
+      Do not answer with incomplete or uncertain information.`,
+  model: 'openai/gpt-5.1',
+  agents: {
+    researchAgent,
+    writingAgent,
+  },
+  workflows: {
+    cityWorkflow,
+  },
+  tools: {
+    weatherTool,
+  },
+  memory: new Memory({
+    storage: new LibSQLStore({
+      id: 'mastra-storage',
+      url: 'file:../mastra.db',
+    }),
+  }),
+})
+```
+
+### Writing descriptions for network primitives
+
+When configuring a Mastra agent network, each primitive (agent, workflow, or tool) needs a clear description to help the routing agent decide which to use. The routing agent uses each primitive's description and schema to determine what it does and how to use it. Clear descriptions and well-defined input and output schemas improve routing accuracy.
+
+#### Agent descriptions
+
+Each subagent in a network should include a clear `description` that explains what the agent does.
+
+```typescript
+export const researchAgent = new Agent({
+  id: 'research-agent',
+  name: 'Research Agent',
+  description: `This agent gathers concise research insights in bullet-point form.
+    It's designed to extract key facts without generating full
+    responses or narrative content.`,
+})
+```
+
+```typescript
+export const writingAgent = new Agent({
+  id: 'writing-agent',
+  name: 'Writing Agent',
+  description: `This agent turns researched material into well-structured
+    written content. It produces full-paragraph reports with no bullet points,
+    suitable for use in articles, summaries, or blog posts.`,
+})
+```
+
+#### Workflow descriptions
+
+Workflows in a network should include a `description` to explain their purpose, along with `inputSchema` and `outputSchema` to describe the expected data.
+
+```typescript
+export const cityWorkflow = createWorkflow({
+  id: 'city-workflow',
+  description: `This workflow handles city-specific research tasks.
+    It first gathers factual information about the city, then synthesizes
+    that research into a full written report. Use it when the user input
+    includes a city to be researched.`,
+  inputSchema: z.object({
+    city: z.string(),
+  }),
+  outputSchema: z.object({
+    text: z.string(),
+  }),
+})
+```
+
+#### Tool descriptions
+
+Tools in a network should include a `description` to explain their purpose, along with `inputSchema` and `outputSchema` to describe the expected data.
+
+```typescript
+export const weatherTool = createTool({
+  id: 'weather-tool',
+  description: ` Retrieves current weather information using the wttr.in API.
+    Accepts a city or location name as input and returns a short weather summary.
+    Use this tool whenever up-to-date weather data is requested.
+  `,
+  inputSchema: z.object({
+    location: z.string(),
+  }),
+  outputSchema: z.object({
+    weather: z.string(),
+  }),
+})
+```
+
+## Calling agent networks
+
+Call a Mastra agent network using `.network()` with a user message. The method returns a stream of events that you can iterate over to track execution progress and retrieve the final result.
+
+### Agent example
+
+In this example, the network interprets the message and would route the request to both the `researchAgent` and `writingAgent` to generate a complete response.
+
+```typescript
+const result = await routingAgent.network('Tell me three cool ways to use Mastra')
+
+for await (const chunk of result) {
+  console.log(chunk.type)
+  if (chunk.type === 'network-execution-event-step-finish') {
+    console.log(chunk.payload.result)
+  }
+}
+```
+
+#### Agent output
+
+The following `chunk.type` events are emitted during this request:
+
+```text
+routing-agent-start
+routing-agent-end
+agent-execution-start
+agent-execution-event-start
+agent-execution-event-step-start
+agent-execution-event-text-start
+agent-execution-event-text-delta
+agent-execution-event-text-end
+agent-execution-event-step-finish
+agent-execution-event-finish
+agent-execution-end
+network-execution-event-step-finish
+```
+
+## Workflow example
+
+In this example, the routing agent recognizes the city name in the message and runs the `cityWorkflow`. The workflow defines steps that call the `researchAgent` to gather facts, then the `writingAgent` to generate the final text.
+
+```typescript
+const result = await routingAgent.network('Tell me some historical facts about London')
+
+for await (const chunk of result) {
+  console.log(chunk.type)
+  if (chunk.type === 'network-execution-event-step-finish') {
+    console.log(chunk.payload.result)
+  }
+}
+```
+
+### Workflow output
+
+The following `chunk.type` events are emitted during this request:
+
+```text
+routing-agent-end
+workflow-execution-start
+workflow-execution-event-workflow-start
+workflow-execution-event-workflow-step-start
+workflow-execution-event-workflow-step-result
+workflow-execution-event-workflow-finish
+workflow-execution-end
+routing-agent-start
+network-execution-event-step-finish
+```
+
+### Tool example
+
+In this example, the routing agent skips the `researchAgent`, `writingAgent`, and `cityWorkflow`, and calls the `weatherTool` directly to complete the task.
+
+```typescript
+const result = await routingAgent.network("What's the weather in London?")
+
+for await (const chunk of result) {
+  console.log(chunk.type)
+  if (chunk.type === 'network-execution-event-step-finish') {
+    console.log(chunk.payload.result)
+  }
+}
+```
+
+#### Tool output
+
+The following `chunk.type` events are emitted during this request:
+
+```text
+routing-agent-start
+routing-agent-end
+tool-execution-start
+tool-execution-end
+network-execution-event-step-finish
+```
+
+## Structured output
+
+When you need typed, validated results from a network, use the `structuredOutput` option. After the network completes its task, it generates a structured response matching your schema.
+
+```typescript
+import { z } from 'zod'
+
+const resultSchema = z.object({
+  summary: z.string().describe('A brief summary of the findings'),
+  recommendations: z.array(z.string()).describe('List of recommendations'),
+  confidence: z.number().min(0).max(1).describe('Confidence score'),
+})
+
+const stream = await routingAgent.network('Research AI trends', {
+  structuredOutput: {
+    schema: resultSchema,
+  },
+})
+
+// Consume the stream
+for await (const chunk of stream) {
+  if (chunk.type === 'network-object') {
+    // Partial object during generation
+    console.log('Partial:', chunk.payload.object)
+  }
+  if (chunk.type === 'network-object-result') {
+    // Final structured object
+    console.log('Final:', chunk.payload.object)
+  }
+}
+
+// Get the typed result
+const result = await stream.object
+console.log(result?.summary)
+console.log(result?.recommendations)
+console.log(result?.confidence)
+```
+
+### Streaming partial objects
+
+For real-time updates during structured output generation, use `objectStream`:
+
+```typescript
+const stream = await routingAgent.network('Analyze market data', {
+  structuredOutput: { schema: resultSchema },
+})
+
+// Stream partial objects as they're generated
+for await (const partial of stream.objectStream) {
+  console.log('Building result:', partial)
+}
+
+// Get the final typed result
+const final = await stream.object
+```
+
+## Related
+
+- [Supervisor Agents](https://mastra.ai/docs/agents/supervisor-agents)
+- [Migration: .network() to Supervisor Pattern](https://mastra.ai/guides/migrations/network-to-supervisor)
+- [Guide: Research Coordinator](https://mastra.ai/guides/guide/research-coordinator)
+- [Agent Memory](https://mastra.ai/docs/agents/agent-memory)
+- [Agent Approval](https://mastra.ai/docs/agents/agent-approval)
+- [Workflows Overview](https://mastra.ai/docs/workflows/overview)
+- [Request Context](https://mastra.ai/docs/server/request-context)

package/dist/docs/references/docs-agents-supervisor-agents.md

@@ -0,0 +1,304 @@
+# Supervisor Agents
+
+A supervisor agent coordinates multiple subagents using `agent.stream()` or `agent.generate()`. You configure subagents on the supervisor's `agents` property, and the supervisor uses its instructions and each subagent's `description` to decide when and how to delegate tasks.
+
+## When to use supervisor agents
+
+Use supervisor agents when a task requires multiple agents with different specializations to work together. The supervisor handles delegation decisions, context passing, and result synthesis.
+
+Common use cases:
+
+- Research and writing workflows where one agent gathers data and another produces content
+- Multi-step tasks that need different expertise at each stage
+- Tasks where you need fine-grained control over delegation behavior
+
+## Quick start
+
+Define subagents with clear descriptions, then create a supervisor agent that references them:
+
+```typescript
+import { Agent } from '@mastra/core/agent'
+import { Memory } from '@mastra/memory'
+import { LibSQLStore } from '@mastra/libsql'
+
+const researchAgent = new Agent({
+  id: 'research-agent',
+  description: 'Gathers factual information and returns bullet-point summaries.',
+  model: 'openai/gpt-4o-mini',
+})
+
+const writingAgent = new Agent({
+  id: 'writing-agent',
+  description: 'Transforms research into well-structured articles.',
+  model: 'openai/gpt-4o-mini',
+})
+
+const supervisor = new Agent({
+  id: 'supervisor',
+  instructions: `You coordinate research and writing using specialized agents.
+    Delegate to research-agent for facts, then writing-agent for content.`,
+  model: 'openai/gpt-5.1',
+  agents: { researchAgent, writingAgent },
+  memory: new Memory({
+    storage: new LibSQLStore({ id: 'storage', url: 'file:mastra.db' }),
+  }),
+})
+
+const stream = await supervisor.stream('Research AI in education and write an article', {
+  maxSteps: 10,
+})
+
+for await (const chunk of stream.textStream) {
+  process.stdout.write(chunk)
+}
+```
+
+## Delegation hooks
+
+Delegation hooks let you intercept, modify, or reject delegations as they happen. Configure them under the `delegation` option, either in the agent's `defaultOptions` or per-call.
+
+### onDelegationStart
+
+Called before the supervisor delegates to a subagent. Return an object to control the delegation:
+
+- `proceed: true` — allow the delegation (default behavior)
+- `proceed: false` — reject the delegation with a `rejectionReason`
+- `modifiedPrompt` — rewrite the prompt sent to the subagent
+- `modifiedMaxSteps` — limit the subagent's iteration count
+
+```typescript
+const stream = await supervisor.stream('Research AI trends', {
+  maxSteps: 10,
+  delegation: {
+    onDelegationStart: async context => {
+      console.log(`Delegating to: ${context.primitiveId}`)
+
+      // Modify the prompt for a specific agent
+      if (context.primitiveId === 'research-agent') {
+        return {
+          proceed: true,
+          modifiedPrompt: `${context.prompt}\n\nFocus on 2024-2025 data.`,
+          modifiedMaxSteps: 5,
+        }
+      }
+
+      // Reject delegation after too many iterations
+      if (context.iteration > 8) {
+        return {
+          proceed: false,
+          rejectionReason: 'Max iterations reached. Synthesize current findings.',
+        }
+      }
+
+      return { proceed: true }
+    },
+  },
+})
+```
+
+The `context` object includes:
+
+| Property      | Description                               |
+| ------------- | ----------------------------------------- |
+| `primitiveId` | The ID of the subagent being delegated to |
+| `prompt`      | The prompt the supervisor is sending      |
+| `iteration`   | Current iteration number                  |
+
+### onDelegationComplete
+
+Called after a delegation finishes. Use it to inspect results, provide feedback, or stop execution:
+
+- `context.bail()` — stop the supervisor loop immediately
+- Return `{ feedback: '...' }` — add feedback that gets saved to the supervisor's memory and is visible to subsequent iterations
+
+```typescript
+const stream = await supervisor.stream('Research AI trends', {
+  maxSteps: 10,
+  delegation: {
+    onDelegationComplete: async context => {
+      console.log(`Completed: ${context.primitiveId}`)
+
+      // Bail on errors
+      if (context.error) {
+        context.bail()
+        return {
+          feedback: `Delegation to ${context.primitiveId} failed: ${context.error}. Try a different approach.`,
+        }
+      }
+    },
+  },
+})
+```
+
+The `context` object includes:
+
+| Property      | Description                          |
+| ------------- | ------------------------------------ |
+| `primitiveId` | The ID of the subagent that ran      |
+| `result`      | The subagent's response              |
+| `error`       | Error if the delegation failed       |
+| `bail()`      | Function to stop the supervisor loop |
+
+## Message filtering
+
+By default, subagents receive the full conversation context from the supervisor. Use `messageFilter` to control what messages are shared — for example, to remove sensitive data or limit context size.
+
+```typescript
+const stream = await supervisor.stream('Research AI trends', {
+  maxSteps: 10,
+  delegation: {
+    messageFilter: ({ messages, primitiveId, prompt }) => {
+      // Remove messages containing sensitive data
+      return messages
+        .filter(msg => {
+          const content =
+            typeof msg.content === 'string' ? msg.content : JSON.stringify(msg.content)
+          return !content.includes('confidential')
+        })
+        .slice(-10) // Only pass the last 10 messages
+    },
+  },
+})
+```
+
+The callback receives `messages` (the full conversation history), `primitiveId` (the subagent ID), and `prompt` (the delegation prompt). Return the filtered array of messages.
+
+## Iteration monitoring
+
+`onIterationComplete` is called after each iteration of the supervisor loop. Use it to log progress, inject feedback, or stop execution early.
+
+```typescript
+const stream = await supervisor.stream('Research AI trends', {
+  maxSteps: 10,
+  onIterationComplete: async context => {
+    console.log(`Iteration ${context.iteration}/${context.maxIterations}`)
+    console.log(`Finish reason: ${context.finishReason}`)
+
+    // Inject feedback to guide the agent
+    if (!context.text.includes('recommendations')) {
+      return {
+        continue: true,
+        feedback: 'Please include specific recommendations in your analysis.',
+      }
+    }
+
+    // Stop early when the response is sufficient
+    if (context.text.length > 1000 && context.finishReason === 'stop') {
+      return { continue: false }
+    }
+
+    return { continue: true }
+  },
+})
+```
+
+Return `{ continue: true }` to keep iterating, or `{ continue: false }` to stop. Include optional `feedback` to add guidance that's visible to the next iteration.
+
+## Memory isolation
+
+The supervisor pattern implements memory isolation — subagents receive the full conversation context for better decision-making, but only their specific delegation prompt and response are saved to their memory.
+
+How it works:
+
+1. **Full context forwarded** — When the supervisor delegates, the subagent receives all messages from the supervisor's conversation
+2. **Scoped memory saves** — Only the delegation prompt and the subagent's response are saved to the subagent's memory
+3. **Fresh thread per invocation** — Each delegation uses a unique thread ID, ensuring clean separation
+
+This ensures subagents have the context they need without cluttering their memory with the entire supervisor conversation.
+
+## Tool approval propagation
+
+Tool approvals propagate through the delegation chain. When a subagent uses a tool with `requireApproval: true` or calls `suspend()`, the approval request surfaces to the supervisor level.
+
+```typescript
+const sensitiveDataTool = createTool({
+  id: 'get-user-data',
+  requireApproval: true,
+  execute: async input => {
+    return await database.getUserData(input.userId)
+  },
+})
+
+const dataAgent = new Agent({
+  id: 'data-agent',
+  tools: { sensitiveDataTool },
+})
+
+const supervisor = new Agent({
+  id: 'supervisor',
+  agents: { dataAgent },
+  memory: new Memory(),
+})
+
+const stream = await supervisor.stream('Get data for user 123')
+
+for await (const chunk of stream.fullStream) {
+  if (chunk.type === 'tool-call-approval') {
+    console.log('Tool requires approval:', chunk.payload.toolName)
+  }
+}
+```
+
+## Task completion scoring
+
+Task completion scorers validate whether the task is complete after each iteration. If validation fails, the supervisor continues iterating. Feedback from failed scorers is included in the conversation context so subagents can see what was missing.
+
+```typescript
+import { createScorer } from '@mastra/core/evals'
+
+const taskCompleteScorer = createScorer({
+  id: 'task-complete',
+  name: 'Task Completeness',
+}).generateScore(async context => {
+  const text = (context.run.output || '').toString()
+  const hasAnalysis = text.includes('analysis')
+  const hasRecommendations = text.includes('recommendation')
+  return hasAnalysis && hasRecommendations ? 1 : 0
+})
+
+const stream = await supervisor.stream('Research AI in education', {
+  maxSteps: 10,
+  isTaskComplete: {
+    scorers: [taskCompleteScorer],
+    strategy: 'all',
+    onComplete: async result => {
+      console.log('Task complete:', result.complete)
+    },
+  },
+})
+```
+
+## Writing effective instructions
+
+Clear instructions are essential for effective delegation. Your supervisor's `instructions` should specify available resources, when to use each one, how to coordinate them, and success criteria.
+
+Each subagent should have a clear `description` that explains what it does, what format it returns, and when to use it. The supervisor uses these descriptions to make delegation decisions.
+
+```typescript
+const supervisor = new Agent({
+  instructions: `You coordinate research and writing tasks.
+
+Available resources:
+- researchAgent: Gathers factual data and sources (returns bullet points)
+- writingAgent: Transforms research into narrative content (returns full paragraphs)
+
+Delegation strategy:
+1. For research requests: Delegate to researchAgent first
+2. For writing requests: Delegate to writingAgent
+3. For complex requests: Delegate to researchAgent first, then writingAgent
+
+Success criteria:
+- All user questions are fully answered
+- Response is well-formatted and complete`,
+  agents: { researchAgent, writingAgent },
+})
+```
+
+## Related
+
+- [Agent Networks](https://mastra.ai/docs/agents/networks)
+- [Migration: .network() to Supervisor Pattern](https://mastra.ai/guides/migrations/network-to-supervisor)
+- [Guide: Research Coordinator](https://mastra.ai/guides/guide/research-coordinator)
+- [Agent.stream() Reference](https://mastra.ai/reference/streaming/agents/stream)
+- [Agent.generate() Reference](https://mastra.ai/reference/agents/generate)
+- [Agent Approval](https://mastra.ai/docs/agents/agent-approval)