@mastra/core 1.6.0 → 1.7.0

package/dist/docs/references/docs-agents-agent-approval.md

@@ -1,377 +0,0 @@
-# Agent Approval
-
-Agents sometimes require the same [human-in-the-loop](https://mastra.ai/docs/workflows/human-in-the-loop) oversight used in workflows when calling tools that handle sensitive operations, like deleting resources or performing running long processes. With agent approval you can suspend a tool call and provide feedback to the user, or approve or decline a tool call based on targeted application conditions.
-
-## Tool call approval
-
-Tool call approval can be enabled at the agent level and apply to every tool the agent uses, or at the tool level providing more granular control over individual tool calls.
-
-### Storage
-
-Agent approval uses a snapshot to capture the state of the request. Ensure you've enabled a storage provider in your main Mastra instance. If storage isn't enabled you'll see an error relating to snapshot not found.
-
-```typescript
-import { Mastra } from "@mastra/core/mastra";
-import { LibSQLStore } from "@mastra/libsql";
-
-export const mastra = new Mastra({
-  storage: new LibSQLStore({
-    id: "mastra-storage",
-    url: ":memory:"
-  })
-});
-```
-
-## Agent-level approval
-
-When calling an agent using `.stream()` set `requireToolApproval` to `true` which will prevent the agent from calling any of the tools defined in its configuration.
-
-```typescript
-const stream = await agent.stream("What's the weather in London?", {
-  requireToolApproval: true
-});
-```
-
-### Approving tool calls
-
-To approve a tool call, access `approveToolCall` from the `agent`, passing in the `runId` of the stream. This will let the agent know its now OK to call its tools.
-
-```typescript
-const handleApproval = async () => {
-  const approvedStream = await agent.approveToolCall({ runId: stream.runId });
-
-  for await (const chunk of approvedStream.textStream) {
-    process.stdout.write(chunk);
-  }
-  process.stdout.write("\n");
-};
-```
-
-### Declining tool calls
-
-To decline a tool call, access the `declineToolCall` from the `agent`. You will see the streamed response from the agent, but it won't call its tools.
-
-```typescript
-const handleDecline = async () => {
-  const declinedStream = await agent.declineToolCall({ runId: stream.runId });
-
-  for await (const chunk of declinedStream.textStream) {
-    process.stdout.write(chunk);
-  }
-  process.stdout.write("\n");
-};
-```
-
-## Tool approval with generate()
-
-Tool approval also works with the `generate()` method for non-streaming use cases. When using `generate()` with `requireToolApproval: true`, the method returns immediately when a tool requires approval instead of executing it.
-
-### How it works
-
-When a tool requires approval during a `generate()` call, the response includes:
-
-- `finishReason: 'suspended'` - indicates the agent is waiting for approval
-- `suspendPayload` - contains tool call details (`toolCallId`, `toolName`, `args`)
-- `runId` - needed to approve or decline the tool call
-
-### Approving tool calls
-
-To approve a tool call with `generate()`, use the `approveToolCallGenerate` method:
-
-```typescript
-const output = await agent.generate("Find user John", {
-  requireToolApproval: true,
-});
-
-if (output.finishReason === "suspended") {
-  console.log("Tool requires approval:", output.suspendPayload.toolName);
-  console.log("Arguments:", output.suspendPayload.args);
-
-  // Approve the tool call and get the final result
-  const result = await agent.approveToolCallGenerate({
-    runId: output.runId,
-    toolCallId: output.suspendPayload.toolCallId,
-  });
-
-  console.log("Final result:", result.text);
-}
-```
-
-### Declining tool calls
-
-To decline a tool call, use the `declineToolCallGenerate` method:
-
-```typescript
-if (output.finishReason === "suspended") {
-  const result = await agent.declineToolCallGenerate({
-    runId: output.runId,
-    toolCallId: output.suspendPayload.toolCallId,
-  });
-
-  // Agent will respond acknowledging the declined tool
-  console.log(result.text);
-}
-```
-
-### Stream vs Generate comparison
-
-| Aspect             | `stream()`                   | `generate()`                                     |
-| ------------------ | ---------------------------- | ------------------------------------------------ |
-| Response type      | Streaming chunks             | Complete response                                |
-| Approval detection | `tool-call-approval` chunk   | `finishReason: 'suspended'`                      |
-| Approve method     | `approveToolCall({ runId })` | `approveToolCallGenerate({ runId, toolCallId })` |
-| Decline method     | `declineToolCall({ runId })` | `declineToolCallGenerate({ runId, toolCallId })` |
-| Result             | Stream to iterate            | Full output object                               |
-
-## Tool-level approval
-
-There are two types of tool call approval. The first uses `requireApproval`, which is a property on the tool definition, while `requireToolApproval` is a parameter passed to `agent.stream()`. The second uses `suspend` and lets the agent provide context or confirmation prompts so the user can decide whether the tool call should continue.
-
-### Tool approval using `requireToolApproval`
-
-In this approach, `requireApproval` is configured on the tool definition (shown below) rather than on the agent.
-
-```typescript
-export const testTool = createTool({
-  id: "test-tool",
-  description: "Fetches weather for a location",
-  inputSchema: z.object({
-    location: z.string()
-  }),
-  outputSchema: z.object({
-    weather: z.string()
-  }),
-  resumeSchema: z.object({
-    approved: z.boolean()
-  }),
-  execute: async (inputData) => {
-    const response = await fetch(`https://wttr.in/${inputData.location}?format=3`);
-    const weather = await response.text();
-
-    return { weather };
-  },
-  requireApproval: true
-});
-```
-
-When `requireApproval` is true for a tool, the stream will include chunks of type `tool-call-approval` to indicate that the call is paused. To continue the call, invoke `resumeStream` with the required `resumeSchema` and the `runId`.
-
-```typescript
-const stream = await agent.stream("What's the weather in London?");
-
-for await (const chunk of stream.fullStream) {
-  if (chunk.type === "tool-call-approval") {
-    console.log("Approval required.");
-  }
-}
-
-const handleResume = async () => {
-  const resumedStream = await agent.resumeStream({ approved: true }, { runId: stream.runId });
-
-  for await (const chunk of resumedStream.textStream) {
-    process.stdout.write(chunk);
-  }
-  process.stdout.write("\n");
-};
-```
-
-### Tool approval using `suspend`
-
-With this approach, neither the agent nor the tool uses `requireApproval`. Instead, the tool implementation calls `suspend` to pause execution and return context or confirmation prompts to the user.
-
-```typescript
-export const testToolB = createTool({
-  id: "test-tool-b",
-  description: "Fetches weather for a location",
-  inputSchema: z.object({
-    location: z.string()
-  }),
-  outputSchema: z.object({
-    weather: z.string()
-  }),
-  resumeSchema: z.object({
-    approved: z.boolean()
-  }),
-  suspendSchema: z.object({
-    reason: z.string()
-  }),
-  execute: async (inputData, context) => {
-    const { resumeData: { approved } = {}, suspend } = context?.agent ?? {};
-
-    if (!approved) {
-      return suspend?.({ reason: "Approval required." });
-    }
-
-    const response = await fetch(`https://wttr.in/${inputData.location}?format=3`);
-    const weather = await response.text();
-
-    return { weather };
-  }
-});
-```
-
-With this approach the stream will include a `tool-call-suspended` chunk, and the `suspendPayload` will contain the `reason` defined by the tool's `suspendSchema`. To continue the call, invoke `resumeStream` with the required `resumeSchema` and the `runId`.
-
-```typescript
-const stream = await agent.stream("What's the weather in London?");
-
-for await (const chunk of stream.fullStream) {
-  if (chunk.type === "tool-call-suspended") {
-    console.log(chunk.payload.suspendPayload);
-  }
-}
-
-const handleResume = async () => {
-  const resumedStream = await agent.resumeStream({ approved: true }, { runId: stream.runId });
-
-  for await (const chunk of resumedStream.textStream) {
-    process.stdout.write(chunk);
-  }
-  process.stdout.write("\n");
-};
-```
-
-## Automatic tool resumption
-
-When using tools that call `suspend()`, you can enable automatic resumption so the agent resumes suspended tools based on the user's next message. This creates a conversational flow where users provide the required information naturally, without your application needing to call `resumeStream()` explicitly.
-
-### Enabling auto-resume
-
-Set `autoResumeSuspendedTools` to `true` in the agent's default options or when calling `stream()`:
-
-```typescript
-import { Agent } from "@mastra/core/agent";
-import { Memory } from "@mastra/memory";
-
-// Option 1: In agent configuration
-const agent = new Agent({
-  id: "my-agent",
-  name: "My Agent",
-  instructions: "You are a helpful assistant",
-  model: "openai/gpt-4o-mini",
-  tools: { weatherTool },
-  memory: new Memory(),
-  defaultOptions: {
-    autoResumeSuspendedTools: true,
-  },
-});
-
-// Option 2: Per-request
-const stream = await agent.stream("What's the weather?", {
-  autoResumeSuspendedTools: true,
-});
-```
-
-### How it works
-
-When `autoResumeSuspendedTools` is enabled:
-
-1. A tool suspends execution by calling `suspend()` with a payload (e.g., requesting more information)
-
-2. The suspension is persisted to memory along with the conversation
-
-3. When the user sends their next message on the same thread, the agent:
-
-   - Detects the suspended tool from message history
-   - Extracts `resumeData` from the user's message based on the tool's `resumeSchema`
-   - Automatically resumes the tool with the extracted data
-
-### Example
-
-```typescript
-import { createTool } from "@mastra/core/tools";
-import { z } from "zod";
-
-export const weatherTool = createTool({
-  id: "weather-info",
-  description: "Fetches weather information for a city",
-  suspendSchema: z.object({
-    message: z.string(),
-  }),
-  resumeSchema: z.object({
-    city: z.string(),
-  }),
-  execute: async (_inputData, context) => {
-    // Check if this is a resume with data
-    if (!context?.agent?.resumeData) {
-      // First call - suspend and ask for the city
-      return context?.agent?.suspend({
-        message: "What city do you want to know the weather for?",
-      });
-    }
-
-    // Resume call - city was extracted from user's message
-    const { city } = context.agent.resumeData;
-    const response = await fetch(`https://wttr.in/${city}?format=3`);
-    const weather = await response.text();
-
-    return { city, weather };
-  },
-});
-
-const agent = new Agent({
-  id: "my-agent",
-  name: "My Agent",
-  instructions: "You are a helpful assistant",
-  model: "openai/gpt-4o-mini",
-  tools: { weatherTool },
-  memory: new Memory(),
-  defaultOptions: {
-    autoResumeSuspendedTools: true,
-  },
-});
-
-const stream = await agent.stream("What's the weather like?");
-
-for await (const chunk of stream.fullStream) {
-  if (chunk.type === "tool-call-suspended") {
-    console.log(chunk.payload.suspendPayload);
-  }
-}
-
-const handleResume = async () => {
-  const resumedStream = await agent.stream("San Francisco");
-
-  for await (const chunk of resumedStream.textStream) {
-    process.stdout.write(chunk);
-  }
-  process.stdout.write("\n");
-};
-```
-
-**Conversation flow:**
-
-```text
-User: "What's the weather like?"
-Agent: "What city do you want to know the weather for?"
-
-User: "San Francisco"
-Agent: "The weather in San Francisco is: San Francisco: ☀️ +72°F"
-```
-
-The second message automatically resumes the suspended tool - the agent extracts `{ city: "San Francisco" }` from the user's message and passes it as `resumeData`.
-
-### Requirements
-
-For automatic tool resumption to work:
-
-- **Memory configured**: The agent needs memory to track suspended tools across messages
-- **Same thread**: The follow-up message must use the same memory thread and resource identifiers
-- **`resumeSchema` defined**: The tool must define a `resumeSchema` so the agent knows what data structure to extract from the user's message
-
-### Manual vs automatic resumption
-
-| Approach                               | Use case                                                                 |
-| -------------------------------------- | ------------------------------------------------------------------------ |
-| Manual (`resumeStream()`)              | Programmatic control, webhooks, button clicks, external triggers         |
-| Automatic (`autoResumeSuspendedTools`) | Conversational flows where users provide resume data in natural language |
-
-Both approaches work with the same tool definitions. Automatic resumption triggers only when suspended tools exist in the message history and the user sends a new message on the same thread.
-
-## Related
-
-- [Using Tools](https://mastra.ai/docs/agents/using-tools)
-- [Agent Overview](https://mastra.ai/docs/agents/overview)
-- [Tools Overview](https://mastra.ai/docs/mcp/overview)
-- [Agent Memory](https://mastra.ai/docs/agents/agent-memory)
-- [Request Context](https://mastra.ai/docs/server/request-context)

package/dist/docs/references/docs-agents-agent-memory.md

@@ -1,212 +0,0 @@
-# Agent memory
-
-Agents use memory to maintain context across interactions. LLMs are stateless and don't retain information between calls, so agents need memory to track message history and recall relevant information.
-
-Mastra agents can be configured to store message history, with optional [working memory](https://mastra.ai/docs/memory/working-memory) to maintain recent context, [semantic recall](https://mastra.ai/docs/memory/semantic-recall) to retrieve past messages based on meaning, or [observational memory](https://mastra.ai/docs/memory/observational-memory) for automatic long-term memory that compresses conversations as they grow.
-
-## When to use memory
-
-Use memory when your agent needs to maintain multi-turn conversations that reference prior exchanges, recall user preferences or facts from earlier in a session, or build context over time within a conversation thread. Skip memory for single-turn requests where each interaction is independent.
-
-## Setting up memory
-
-To enable memory in Mastra, install the `@mastra/memory` package along with a storage provider.
-
-**npm**:
-
-```bash
-npm install @mastra/memory@latest @mastra/libsql@latest
-```
-
-**pnpm**:
-
-```bash
-pnpm add @mastra/memory@latest @mastra/libsql@latest
-```
-
-**Yarn**:
-
-```bash
-yarn add @mastra/memory@latest @mastra/libsql@latest
-```
-
-**Bun**:
-
-```bash
-bun add @mastra/memory@latest @mastra/libsql@latest
-```
-
-## Storage providers
-
-Memory requires a storage provider to persist message history, including user messages and agent responses. For more details on available providers and how storage works in Mastra, see the [Storage](https://mastra.ai/docs/memory/storage) documentation.
-
-## Configuring memory
-
-1. Enable memory by creating a `Memory` instance and passing it to the agent’s `memory` option.
-
-   ```typescript
-   import { Agent } from "@mastra/core/agent";
-   import { Memory } from "@mastra/memory";
-
-   export const memoryAgent = new Agent({
-     id: 'memory-agent',
-     name: 'Memory Agent',
-     memory: new Memory({
-       options: {
-         lastMessages: 20,
-       },
-     }),
-   });
-   ```
-
-   > **Info:** Visit [Memory Class](https://mastra.ai/reference/memory/memory-class) for a full list of configuration options.
-
-2. Add a storage provider to your main Mastra instance to enable memory across all configured agents.
-
-   ```typescript
-   import { Mastra } from "@mastra/core";
-   import { LibSQLStore } from "@mastra/libsql";
-
-   export const mastra = new Mastra({
-     storage: new LibSQLStore({
-       id: 'mastra-storage',
-       url: ":memory:",
-     }),
-   });
-   ```
-
-   > **Info:** Visit [libSQL Storage](https://mastra.ai/reference/storage/libsql) for a full list of configuration options.
-
-Alternatively, add storage directly to an agent’s memory to keep data separate or use different providers per agent.
-
-```typescript
-import { Agent } from "@mastra/core/agent";
-import { Memory } from "@mastra/memory";
-import { LibSQLStore } from "@mastra/libsql";
-
-export const memoryAgent = new Agent({
-  id: 'memory-agent',
-  name: 'Memory Agent',
-  memory: new Memory({
-    storage: new LibSQLStore({
-      id: 'mastra-storage',
-      url: ":memory:",
-    }),
-  }),
-});
-```
-
-> **Mastra Cloud Store limitation:** Agent-level storage is not supported when using [Mastra Cloud Store](https://mastra.ai/docs/mastra-cloud/deployment). If you use Mastra Cloud Store, configure storage on the Mastra instance instead. This limitation does not apply if you bring your own database.
-
-## Message history
-
-Include a `memory` object with both `resource` and `thread` to track message history during agent calls.
-
-- `resource`: A stable identifier for the user or entity.
-- `thread`: An ID that isolates a specific conversation or session.
-
-These fields tell the agent where to store and retrieve context, enabling persistent, thread-aware memory across a conversation.
-
-```typescript
-const response = await memoryAgent.generate(
-  "Remember my favorite color is blue.",
-  {
-    memory: {
-      resource: "user-123",
-      thread: "conversation-123",
-    },
-  },
-);
-```
-
-To recall information stored in memory, call the agent with the same `resource` and `thread` values used in the original conversation.
-
-```typescript
-const response = await memoryAgent.generate("What's my favorite color?", {
-  memory: {
-    resource: "user-123",
-    thread: "conversation-123",
-  },
-});
-```
-
-> **Warning:** Each thread has an owner (`resourceId`) that cannot be changed after creation. Avoid reusing the same thread ID for threads with different owners, as this will cause errors when querying.
-
-To learn more about memory see the [Memory](https://mastra.ai/docs/memory/overview) documentation.
-
-## Observational Memory
-
-For long-running conversations, raw message history grows until it fills the context window, degrading agent performance. [Observational Memory](https://mastra.ai/docs/memory/observational-memory) solves this by running background agents that compress old messages into dense observations, keeping the context window small while preserving long-term memory.
-
-```typescript
-import { Agent } from "@mastra/core/agent";
-import { Memory } from "@mastra/memory";
-
-export const memoryAgent = new Agent({
-  id: 'memory-agent',
-  name: 'Memory Agent',
-  memory: new Memory({
-    options: {
-      observationalMemory: true,
-    },
-  }),
-});
-```
-
-Setting `observationalMemory: true` uses `google/gemini-2.5-flash` as the default model for the Observer and Reflector. To use a different model or customize thresholds, pass a config object:
-
-```typescript
-import { Agent } from "@mastra/core/agent";
-import { Memory } from "@mastra/memory";
-
-export const memoryAgent = new Agent({
-  id: 'memory-agent',
-  name: 'Memory Agent',
-  memory: new Memory({
-    options: {
-      observationalMemory: {
-        model: "deepseek/deepseek-reasoner",
-        observation: {
-          messageTokens: 20_000,
-        },
-      },
-    },
-  }),
-});
-```
-
-> **Info:** See [Observational Memory](https://mastra.ai/docs/memory/observational-memory) for details on how observations and reflections work, and [the reference](https://mastra.ai/reference/memory/observational-memory) for all configuration options.
-
-## Using `RequestContext`
-
-Use [RequestContext](https://mastra.ai/docs/server/request-context) to access request-specific values. This lets you conditionally select different memory or storage configurations based on the context of the request.
-
-```typescript
-export type UserTier = {
-  "user-tier": "enterprise" | "pro";
-};
-
-const premiumMemory = new Memory();
-
-const standardMemory = new Memory();
-
-export const memoryAgent = new Agent({
-  id: 'memory-agent',
-  name: 'Memory Agent',
-  memory: ({ requestContext }) => {
-    const userTier = requestContext.get("user-tier") as UserTier["user-tier"];
-
-    return userTier === "enterprise" ? premiumMemory : standardMemory;
-  },
-});
-```
-
-> **Info:** Visit [Request Context](https://mastra.ai/docs/server/request-context) for more information.
-
-## Related
-
-- [Observational Memory](https://mastra.ai/docs/memory/observational-memory)
-- [Working Memory](https://mastra.ai/docs/memory/working-memory)
-- [Semantic Recall](https://mastra.ai/docs/memory/semantic-recall)
-- [Storage](https://mastra.ai/docs/memory/storage)
-- [Request Context](https://mastra.ai/docs/server/request-context)