@mastra/core 1.2.0 → 1.2.1-alpha.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +10 -0
- package/dist/_types/@internal_ai-sdk-v4/dist/index.d.ts +30 -17
- package/dist/_types/@internal_ai-sdk-v5/dist/index.d.ts +10 -7
- package/dist/agent/index.cjs +13 -13
- package/dist/agent/index.js +2 -2
- package/dist/agent/message-list/index.cjs +18 -18
- package/dist/agent/message-list/index.js +1 -1
- package/dist/{chunk-VBOO4F4D.cjs → chunk-2DMSFLJY.cjs} +5 -5
- package/dist/{chunk-VBOO4F4D.cjs.map → chunk-2DMSFLJY.cjs.map} +1 -1
- package/dist/{chunk-ARQG4ZSD.cjs → chunk-5SOS47PH.cjs} +37 -37
- package/dist/chunk-5SOS47PH.cjs.map +1 -0
- package/dist/{chunk-NRMSZFAU.js → chunk-5YVR7B4R.js} +5 -5
- package/dist/{chunk-NRMSZFAU.js.map → chunk-5YVR7B4R.js.map} +1 -1
- package/dist/{chunk-G5NRZOPO.cjs → chunk-7MDVYPWX.cjs} +4 -4
- package/dist/{chunk-G5NRZOPO.cjs.map → chunk-7MDVYPWX.cjs.map} +1 -1
- package/dist/{chunk-AP3Z4EAP.cjs → chunk-A5QFWX67.cjs} +53 -53
- package/dist/{chunk-AP3Z4EAP.cjs.map → chunk-A5QFWX67.cjs.map} +1 -1
- package/dist/{chunk-4XLGMCCQ.js → chunk-AUF6U2BL.js} +3 -3
- package/dist/{chunk-4XLGMCCQ.js.map → chunk-AUF6U2BL.js.map} +1 -1
- package/dist/{chunk-POKH6N2J.cjs → chunk-AXN5P2GE.cjs} +4 -4
- package/dist/{chunk-POKH6N2J.cjs.map → chunk-AXN5P2GE.cjs.map} +1 -1
- package/dist/{chunk-YL6ETQ5I.cjs → chunk-B4M33FCS.cjs} +9 -9
- package/dist/{chunk-YL6ETQ5I.cjs.map → chunk-B4M33FCS.cjs.map} +1 -1
- package/dist/{chunk-DG6C6ZTL.cjs → chunk-CC3OOESY.cjs} +44 -43
- package/dist/chunk-CC3OOESY.cjs.map +1 -0
- package/dist/{chunk-NYC6PYZF.js → chunk-E3VFKTIA.js} +36 -4
- package/dist/chunk-E3VFKTIA.js.map +1 -0
- package/dist/{chunk-3LRUJTH3.cjs → chunk-GVLPTDJA.cjs} +50 -13
- package/dist/chunk-GVLPTDJA.cjs.map +1 -0
- package/dist/{chunk-SS4AZHZW.cjs → chunk-HU2ONA2W.cjs} +9 -9
- package/dist/{chunk-SS4AZHZW.cjs.map → chunk-HU2ONA2W.cjs.map} +1 -1
- package/dist/chunk-HVG7MWNT.js +439 -0
- package/dist/chunk-HVG7MWNT.js.map +1 -0
- package/dist/chunk-JCEP2VPF.cjs +441 -0
- package/dist/chunk-JCEP2VPF.cjs.map +1 -0
- package/dist/{chunk-PPAJGWVW.js → chunk-MSWXEOZC.js} +3 -3
- package/dist/{chunk-PPAJGWVW.js.map → chunk-MSWXEOZC.js.map} +1 -1
- package/dist/{chunk-AQHO4OC2.cjs → chunk-QOFI2WBM.cjs} +6 -6
- package/dist/{chunk-AQHO4OC2.cjs.map → chunk-QOFI2WBM.cjs.map} +1 -1
- package/dist/{chunk-EY3WXGUD.js → chunk-RXD5EGQF.js} +43 -6
- package/dist/chunk-RXD5EGQF.js.map +1 -0
- package/dist/{chunk-XC7WIZBL.js → chunk-S6BH5HHY.js} +4 -3
- package/dist/chunk-S6BH5HHY.js.map +1 -0
- package/dist/{chunk-IPXNR6RQ.js → chunk-V2MLGA7T.js} +1884 -998
- package/dist/chunk-V2MLGA7T.js.map +1 -0
- package/dist/{chunk-Z4PGSIZ5.cjs → chunk-VTE2OBKS.cjs} +1890 -1004
- package/dist/chunk-VTE2OBKS.cjs.map +1 -0
- package/dist/{chunk-ZODRDMZ7.js → chunk-VX7UA3SO.js} +3 -3
- package/dist/{chunk-ZODRDMZ7.js.map → chunk-VX7UA3SO.js.map} +1 -1
- package/dist/{chunk-5HDIPOLV.js → chunk-WFUNLRQX.js} +6 -6
- package/dist/chunk-WFUNLRQX.js.map +1 -0
- package/dist/{chunk-V3LENMEW.js → chunk-X5ORARLG.js} +4 -4
- package/dist/{chunk-V3LENMEW.js.map → chunk-X5ORARLG.js.map} +1 -1
- package/dist/{chunk-Z2OKCLGV.cjs → chunk-XCPEEIHI.cjs} +41 -8
- package/dist/chunk-XCPEEIHI.cjs.map +1 -0
- package/dist/{chunk-57O4TPB3.js → chunk-Z6NRYYOH.js} +3 -3
- package/dist/{chunk-57O4TPB3.js.map → chunk-Z6NRYYOH.js.map} +1 -1
- package/dist/{chunk-RUMXBL6P.js → chunk-ZWM2CAIM.js} +5 -5
- package/dist/{chunk-RUMXBL6P.js.map → chunk-ZWM2CAIM.js.map} +1 -1
- package/dist/docs/SKILL.md +270 -64
- package/dist/docs/{SOURCE_MAP.json → assets/SOURCE_MAP.json} +156 -152
- package/dist/docs/{agents/10-adding-voice.md → references/docs-agents-adding-voice.md} +6 -5
- package/dist/docs/{agents/08-agent-approval.md → references/docs-agents-agent-approval.md} +19 -19
- package/dist/docs/{agents/03-agent-memory.md → references/docs-agents-agent-memory.md} +57 -55
- package/dist/docs/{agents/07-guardrails.md → references/docs-agents-guardrails.md} +21 -39
- package/dist/docs/{agents/09-network-approval.md → references/docs-agents-network-approval.md} +12 -11
- package/dist/docs/{agents/05-networks.md → references/docs-agents-networks.md} +7 -9
- package/dist/docs/{agents/01-overview.md → references/docs-agents-overview.md} +54 -72
- package/dist/docs/{agents/06-processors.md → references/docs-agents-processors.md} +29 -24
- package/dist/docs/{agents/04-structured-output.md → references/docs-agents-structured-output.md} +13 -22
- package/dist/docs/{agents/02-using-tools.md → references/docs-agents-using-tools.md} +12 -13
- package/dist/docs/{evals/02-custom-scorers.md → references/docs-evals-custom-scorers.md} +5 -7
- package/dist/docs/{evals/01-overview.md → references/docs-evals-overview.md} +26 -17
- package/dist/docs/{evals/03-running-in-ci.md → references/docs-evals-running-in-ci.md} +2 -4
- package/dist/docs/{mcp/01-overview.md → references/docs-mcp-overview.md} +135 -140
- package/dist/docs/references/docs-mcp-publishing-mcp-server.md +95 -0
- package/dist/docs/{memory/05-memory-processors.md → references/docs-memory-memory-processors.md} +6 -8
- package/dist/docs/references/docs-memory-observational-memory.md +166 -0
- package/dist/docs/{memory/01-overview.md → references/docs-memory-overview.md} +8 -8
- package/dist/docs/{memory/04-semantic-recall.md → references/docs-memory-semantic-recall.md} +33 -17
- package/dist/docs/{memory/02-storage.md → references/docs-memory-storage.md} +29 -39
- package/dist/docs/{memory/03-working-memory.md → references/docs-memory-working-memory.md} +16 -27
- package/dist/docs/{observability/02-logging.md → references/docs-observability-logging.md} +6 -10
- package/dist/docs/{observability/01-overview.md → references/docs-observability-overview.md} +4 -10
- package/dist/docs/{observability/04-otel.md → references/docs-observability-tracing-bridges-otel.md} +31 -14
- package/dist/docs/{observability/07-arize.md → references/docs-observability-tracing-exporters-arize.md} +38 -22
- package/dist/docs/{observability/08-braintrust.md → references/docs-observability-tracing-exporters-braintrust.md} +24 -6
- package/dist/docs/{observability/06-cloud.md → references/docs-observability-tracing-exporters-cloud.md} +7 -7
- package/dist/docs/{observability/09-datadog.md → references/docs-observability-tracing-exporters-datadog.md} +26 -8
- package/dist/docs/{observability/05-default.md → references/docs-observability-tracing-exporters-default.md} +11 -14
- package/dist/docs/{observability/10-laminar.md → references/docs-observability-tracing-exporters-laminar.md} +24 -6
- package/dist/docs/{observability/11-langfuse.md → references/docs-observability-tracing-exporters-langfuse.md} +31 -12
- package/dist/docs/{observability/12-langsmith.md → references/docs-observability-tracing-exporters-langsmith.md} +29 -11
- package/dist/docs/{observability/13-otel.md → references/docs-observability-tracing-exporters-otel.md} +107 -63
- package/dist/docs/{observability/14-posthog.md → references/docs-observability-tracing-exporters-posthog.md} +24 -6
- package/dist/docs/{observability/03-overview.md → references/docs-observability-tracing-overview.md} +45 -53
- package/dist/docs/{rag/02-chunking-and-embedding.md → references/docs-rag-chunking-and-embedding.md} +5 -11
- package/dist/docs/{rag/05-graph-rag.md → references/docs-rag-graph-rag.md} +0 -2
- package/dist/docs/{rag/01-overview.md → references/docs-rag-overview.md} +2 -7
- package/dist/docs/{rag/04-retrieval.md → references/docs-rag-retrieval.md} +26 -53
- package/dist/docs/{rag/03-vector-databases.md → references/docs-rag-vector-databases.md} +198 -202
- package/dist/docs/{server/13-auth0.md → references/docs-server-auth-auth0.md} +68 -79
- package/dist/docs/{server/09-clerk.md → references/docs-server-auth-clerk.md} +41 -52
- package/dist/docs/{server/14-composite-auth.md → references/docs-server-auth-composite-auth.md} +1 -3
- package/dist/docs/{server/15-custom-auth-provider.md → references/docs-server-auth-custom-auth-provider.md} +13 -15
- package/dist/docs/{server/11-firebase.md → references/docs-server-auth-firebase.md} +83 -97
- package/dist/docs/{server/08-jwt.md → references/docs-server-auth-jwt.md} +46 -35
- package/dist/docs/{server/07-simple-auth.md → references/docs-server-auth-simple-auth.md} +10 -11
- package/dist/docs/{server/10-supabase.md → references/docs-server-auth-supabase.md} +33 -44
- package/dist/docs/{server/12-workos.md → references/docs-server-auth-workos.md} +45 -56
- package/dist/docs/{server/02-custom-adapters.md → references/docs-server-custom-adapters.md} +25 -31
- package/dist/docs/{server/05-custom-api-routes.md → references/docs-server-custom-api-routes.md} +7 -7
- package/dist/docs/{server/06-mastra-client.md → references/docs-server-mastra-client.md} +32 -20
- package/dist/docs/{server/01-mastra-server.md → references/docs-server-mastra-server.md} +5 -11
- package/dist/docs/{server/03-middleware.md → references/docs-server-middleware.md} +8 -15
- package/dist/docs/{server/04-request-context.md → references/docs-server-request-context.md} +29 -43
- package/dist/docs/{streaming/01-events.md → references/docs-streaming-events.md} +9 -16
- package/dist/docs/{streaming/02-tool-streaming.md → references/docs-streaming-tool-streaming.md} +6 -11
- package/dist/docs/{streaming/03-workflow-streaming.md → references/docs-streaming-workflow-streaming.md} +2 -6
- package/dist/docs/{tools-mcp/03-advanced-usage.md → references/docs-tools-mcp-advanced-usage.md} +23 -5
- package/dist/docs/{tools-mcp/01-mcp-overview.md → references/docs-tools-mcp-mcp-overview.md} +141 -146
- package/dist/docs/{tools-mcp/02-overview.md → references/docs-tools-mcp-overview.md} +4 -12
- package/dist/docs/{voice/01-overview.md → references/docs-voice-overview.md} +37 -81
- package/dist/docs/{voice/04-speech-to-speech.md → references/docs-voice-speech-to-speech.md} +1 -4
- package/dist/docs/{voice/03-speech-to-text.md → references/docs-voice-speech-to-text.md} +8 -11
- package/dist/docs/{voice/02-text-to-speech.md → references/docs-voice-text-to-speech.md} +12 -15
- package/dist/docs/{workflows/04-agents-and-tools.md → references/docs-workflows-agents-and-tools.md} +11 -21
- package/dist/docs/{workflows/03-control-flow.md → references/docs-workflows-control-flow.md} +58 -56
- package/dist/docs/{workflows/09-error-handling.md → references/docs-workflows-error-handling.md} +13 -15
- package/dist/docs/{workflows/07-human-in-the-loop.md → references/docs-workflows-human-in-the-loop.md} +11 -12
- package/dist/docs/{workflows/10-input-data-mapping.md → references/docs-workflows-input-data-mapping.md} +12 -14
- package/dist/docs/{workflows/01-overview.md → references/docs-workflows-overview.md} +31 -52
- package/dist/docs/{workflows/05-snapshots.md → references/docs-workflows-snapshots.md} +3 -5
- package/dist/docs/{workflows/06-suspend-and-resume.md → references/docs-workflows-suspend-and-resume.md} +12 -12
- package/dist/docs/{workflows/08-time-travel.md → references/docs-workflows-time-travel.md} +2 -5
- package/dist/docs/{workflows/02-workflow-state.md → references/docs-workflows-workflow-state.md} +4 -6
- package/dist/docs/{workspace/02-filesystem.md → references/docs-workspace-filesystem.md} +3 -8
- package/dist/docs/{workspace/01-overview.md → references/docs-workspace-overview.md} +10 -16
- package/dist/docs/{workspace/03-sandbox.md → references/docs-workspace-sandbox.md} +2 -4
- package/dist/docs/{workspace/05-search.md → references/docs-workspace-search.md} +20 -22
- package/dist/docs/{workspace/04-skills.md → references/docs-workspace-skills.md} +6 -9
- package/dist/docs/{guides/01-ai-sdk.md → references/guides-agent-frameworks-ai-sdk.md} +25 -9
- package/dist/docs/references/reference-agents-agent.md +142 -0
- package/dist/docs/references/reference-agents-generate.md +174 -0
- package/dist/docs/references/reference-agents-generateLegacy.md +176 -0
- package/dist/docs/references/reference-agents-getDefaultGenerateOptions.md +36 -0
- package/dist/docs/references/reference-agents-getDefaultOptions.md +34 -0
- package/dist/docs/references/reference-agents-getDefaultStreamOptions.md +36 -0
- package/dist/docs/references/reference-agents-getDescription.md +21 -0
- package/dist/docs/references/reference-agents-getInstructions.md +34 -0
- package/dist/docs/references/reference-agents-getLLM.md +37 -0
- package/dist/docs/references/reference-agents-getMemory.md +34 -0
- package/dist/docs/references/reference-agents-getModel.md +34 -0
- package/dist/docs/references/reference-agents-getTools.md +34 -0
- package/dist/docs/references/reference-agents-getVoice.md +34 -0
- package/dist/docs/references/reference-agents-listAgents.md +35 -0
- package/dist/docs/references/reference-agents-listScorers.md +34 -0
- package/dist/docs/references/reference-agents-listTools.md +34 -0
- package/dist/docs/references/reference-agents-listWorkflows.md +34 -0
- package/dist/docs/references/reference-agents-network.md +136 -0
- package/dist/docs/references/reference-ai-sdk-chat-route.md +82 -0
- package/dist/docs/references/reference-ai-sdk-network-route.md +74 -0
- package/dist/docs/references/reference-ai-sdk-to-ai-sdk-stream.md +232 -0
- package/dist/docs/references/reference-ai-sdk-with-mastra.md +59 -0
- package/dist/docs/references/reference-ai-sdk-workflow-route.md +79 -0
- package/dist/docs/references/reference-auth-auth0.md +73 -0
- package/dist/docs/references/reference-auth-clerk.md +36 -0
- package/dist/docs/references/reference-auth-firebase.md +80 -0
- package/dist/docs/references/reference-auth-jwt.md +26 -0
- package/dist/docs/references/reference-auth-supabase.md +33 -0
- package/dist/docs/references/reference-auth-workos.md +84 -0
- package/dist/docs/{cli/01-reference.md → references/reference-cli-mastra.md} +14 -28
- package/dist/docs/{client-js/01-reference.md → references/reference-client-js-agents.md} +3 -12
- package/dist/docs/{configuration.mdx/01-reference.md → references/reference-configuration.md} +71 -91
- package/dist/docs/references/reference-core-addGateway.md +42 -0
- package/dist/docs/references/reference-core-getAgent.md +21 -0
- package/dist/docs/references/reference-core-getAgentById.md +21 -0
- package/dist/docs/references/reference-core-getDeployer.md +22 -0
- package/dist/docs/references/reference-core-getGateway.md +38 -0
- package/dist/docs/references/reference-core-getGatewayById.md +41 -0
- package/dist/docs/references/reference-core-getLogger.md +22 -0
- package/dist/docs/references/reference-core-getMCPServer.md +45 -0
- package/dist/docs/references/reference-core-getMCPServerById.md +53 -0
- package/dist/docs/references/reference-core-getMemory.md +50 -0
- package/dist/docs/references/reference-core-getScorer.md +54 -0
- package/dist/docs/references/reference-core-getScorerById.md +54 -0
- package/dist/docs/references/reference-core-getServer.md +22 -0
- package/dist/docs/references/reference-core-getStorage.md +22 -0
- package/dist/docs/references/reference-core-getStoredAgentById.md +89 -0
- package/dist/docs/references/reference-core-getTelemetry.md +22 -0
- package/dist/docs/references/reference-core-getVector.md +22 -0
- package/dist/docs/references/reference-core-getWorkflow.md +40 -0
- package/dist/docs/references/reference-core-listAgents.md +21 -0
- package/dist/docs/references/reference-core-listGateways.md +40 -0
- package/dist/docs/references/reference-core-listLogs.md +38 -0
- package/dist/docs/references/reference-core-listLogsByRunId.md +36 -0
- package/dist/docs/references/reference-core-listMCPServers.md +51 -0
- package/dist/docs/references/reference-core-listMemory.md +56 -0
- package/dist/docs/references/reference-core-listScorers.md +29 -0
- package/dist/docs/references/reference-core-listStoredAgents.md +93 -0
- package/dist/docs/references/reference-core-listVectors.md +22 -0
- package/dist/docs/references/reference-core-listWorkflows.md +21 -0
- package/dist/docs/references/reference-core-mastra-class.md +66 -0
- package/dist/docs/references/reference-core-mastra-model-gateway.md +153 -0
- package/dist/docs/references/reference-core-setLogger.md +26 -0
- package/dist/docs/references/reference-core-setStorage.md +27 -0
- package/dist/docs/references/reference-deployer-cloudflare.md +56 -0
- package/dist/docs/references/reference-deployer-netlify.md +14 -0
- package/dist/docs/references/reference-deployer-vercel.md +39 -0
- package/dist/docs/references/reference-evals-answer-relevancy.md +105 -0
- package/dist/docs/references/reference-evals-answer-similarity.md +99 -0
- package/dist/docs/references/reference-evals-bias.md +120 -0
- package/dist/docs/references/reference-evals-completeness.md +137 -0
- package/dist/docs/references/reference-evals-content-similarity.md +101 -0
- package/dist/docs/references/reference-evals-context-precision.md +196 -0
- package/dist/docs/references/reference-evals-create-scorer.md +270 -0
- package/dist/docs/references/reference-evals-faithfulness.md +114 -0
- package/dist/docs/references/reference-evals-hallucination.md +220 -0
- package/dist/docs/references/reference-evals-keyword-coverage.md +128 -0
- package/dist/docs/references/reference-evals-mastra-scorer.md +123 -0
- package/dist/docs/references/reference-evals-run-evals.md +138 -0
- package/dist/docs/references/reference-evals-scorer-utils.md +330 -0
- package/dist/docs/references/reference-evals-textual-difference.md +113 -0
- package/dist/docs/references/reference-evals-tone-consistency.md +119 -0
- package/dist/docs/references/reference-evals-toxicity.md +123 -0
- package/dist/docs/{logging/01-reference.md → references/reference-logging-pino-logger.md} +16 -15
- package/dist/docs/references/reference-memory-deleteMessages.md +40 -0
- package/dist/docs/{memory/06-reference.md → references/reference-memory-memory-class.md} +28 -55
- package/dist/docs/references/reference-memory-observational-memory.md +217 -0
- package/dist/docs/references/reference-observability-tracing-bridges-otel.md +131 -0
- package/dist/docs/references/reference-observability-tracing-configuration.md +178 -0
- package/dist/docs/references/reference-observability-tracing-exporters-console-exporter.md +138 -0
- package/dist/docs/references/reference-observability-tracing-exporters-datadog.md +116 -0
- package/dist/docs/references/reference-observability-tracing-instances.md +109 -0
- package/dist/docs/references/reference-observability-tracing-interfaces.md +749 -0
- package/dist/docs/references/reference-observability-tracing-processors-sensitive-data-filter.md +144 -0
- package/dist/docs/references/reference-observability-tracing-spans.md +224 -0
- package/dist/docs/references/reference-processors-batch-parts-processor.md +61 -0
- package/dist/docs/references/reference-processors-language-detector.md +81 -0
- package/dist/docs/references/reference-processors-message-history-processor.md +85 -0
- package/dist/docs/references/reference-processors-moderation-processor.md +104 -0
- package/dist/docs/references/reference-processors-pii-detector.md +107 -0
- package/dist/docs/references/reference-processors-processor-interface.md +521 -0
- package/dist/docs/references/reference-processors-prompt-injection-detector.md +71 -0
- package/dist/docs/references/reference-processors-semantic-recall-processor.md +123 -0
- package/dist/docs/references/reference-processors-system-prompt-scrubber.md +80 -0
- package/dist/docs/references/reference-processors-token-limiter-processor.md +113 -0
- package/dist/docs/references/reference-processors-tool-call-filter.md +85 -0
- package/dist/docs/references/reference-processors-tool-search-processor.md +113 -0
- package/dist/docs/references/reference-processors-unicode-normalizer.md +62 -0
- package/dist/docs/references/reference-processors-working-memory-processor.md +154 -0
- package/dist/docs/references/reference-rag-database-config.md +264 -0
- package/dist/docs/references/reference-rag-embeddings.md +92 -0
- package/dist/docs/references/reference-server-mastra-server.md +298 -0
- package/dist/docs/references/reference-server-register-api-route.md +249 -0
- package/dist/docs/references/reference-storage-cloudflare-d1.md +218 -0
- package/dist/docs/references/reference-storage-composite.md +235 -0
- package/dist/docs/references/reference-storage-lance.md +131 -0
- package/dist/docs/references/reference-storage-libsql.md +135 -0
- package/dist/docs/references/reference-storage-mongodb.md +262 -0
- package/dist/docs/references/reference-storage-mssql.md +155 -0
- package/dist/docs/references/reference-storage-overview.md +121 -0
- package/dist/docs/references/reference-storage-postgresql.md +529 -0
- package/dist/docs/references/reference-storage-upstash.md +160 -0
- package/dist/docs/references/reference-streaming-ChunkType.md +292 -0
- package/dist/docs/references/reference-streaming-agents-MastraModelOutput.md +182 -0
- package/dist/docs/references/reference-streaming-agents-streamLegacy.md +142 -0
- package/dist/docs/references/reference-streaming-workflows-observeStream.md +42 -0
- package/dist/docs/references/reference-streaming-workflows-resumeStream.md +61 -0
- package/dist/docs/references/reference-streaming-workflows-stream.md +87 -0
- package/dist/docs/references/reference-streaming-workflows-timeTravelStream.md +142 -0
- package/dist/docs/{templates/01-reference.md → references/reference-templates-overview.md} +8 -17
- package/dist/docs/references/reference-tools-client.md +228 -0
- package/dist/docs/references/reference-tools-create-tool.md +237 -0
- package/dist/docs/references/reference-tools-graph-rag-tool.md +185 -0
- package/dist/docs/references/reference-tools-mcp-client.md +964 -0
- package/dist/docs/references/reference-tools-mcp-server.md +1275 -0
- package/dist/docs/references/reference-tools-vector-query-tool.md +459 -0
- package/dist/docs/references/reference-vectors-libsql.md +305 -0
- package/dist/docs/references/reference-vectors-mongodb.md +295 -0
- package/dist/docs/references/reference-vectors-pg.md +408 -0
- package/dist/docs/references/reference-vectors-upstash.md +294 -0
- package/dist/docs/references/reference-voice-composite-voice.md +121 -0
- package/dist/docs/references/reference-voice-mastra-voice.md +313 -0
- package/dist/docs/references/reference-voice-voice.addInstructions.md +56 -0
- package/dist/docs/references/reference-voice-voice.addTools.md +67 -0
- package/dist/docs/references/reference-voice-voice.connect.md +94 -0
- package/dist/docs/references/reference-voice-voice.events.md +37 -0
- package/dist/docs/references/reference-voice-voice.listen.md +164 -0
- package/dist/docs/references/reference-voice-voice.on.md +111 -0
- package/dist/docs/references/reference-voice-voice.speak.md +157 -0
- package/dist/docs/references/reference-workflows-run-methods-cancel.md +86 -0
- package/dist/docs/references/reference-workflows-run-methods-restart.md +33 -0
- package/dist/docs/references/reference-workflows-run-methods-resume.md +59 -0
- package/dist/docs/references/reference-workflows-run-methods-start.md +58 -0
- package/dist/docs/references/reference-workflows-run-methods-startAsync.md +67 -0
- package/dist/docs/references/reference-workflows-run-methods-timeTravel.md +142 -0
- package/dist/docs/references/reference-workflows-run.md +59 -0
- package/dist/docs/references/reference-workflows-step.md +117 -0
- package/dist/docs/references/reference-workflows-workflow-methods-branch.md +25 -0
- package/dist/docs/references/reference-workflows-workflow-methods-commit.md +17 -0
- package/dist/docs/references/reference-workflows-workflow-methods-create-run.md +63 -0
- package/dist/docs/references/reference-workflows-workflow-methods-dountil.md +25 -0
- package/dist/docs/references/reference-workflows-workflow-methods-dowhile.md +25 -0
- package/dist/docs/references/reference-workflows-workflow-methods-foreach.md +88 -0
- package/dist/docs/references/reference-workflows-workflow-methods-map.md +93 -0
- package/dist/docs/references/reference-workflows-workflow-methods-parallel.md +21 -0
- package/dist/docs/references/reference-workflows-workflow-methods-sleep.md +35 -0
- package/dist/docs/references/reference-workflows-workflow-methods-sleepUntil.md +35 -0
- package/dist/docs/references/reference-workflows-workflow-methods-then.md +21 -0
- package/dist/docs/references/reference-workflows-workflow.md +157 -0
- package/dist/docs/references/reference-workspace-filesystem.md +200 -0
- package/dist/docs/references/reference-workspace-local-filesystem.md +300 -0
- package/dist/docs/references/reference-workspace-local-sandbox.md +283 -0
- package/dist/docs/references/reference-workspace-sandbox.md +79 -0
- package/dist/docs/references/reference-workspace-workspace-class.md +247 -0
- package/dist/docs/references/reference.md +243 -0
- package/dist/evals/index.cjs +5 -5
- package/dist/evals/index.js +2 -2
- package/dist/evals/scoreTraces/index.cjs +3 -3
- package/dist/evals/scoreTraces/index.js +1 -1
- package/dist/index.cjs +4 -4
- package/dist/index.js +2 -2
- package/dist/llm/index.cjs +9 -5
- package/dist/llm/index.d.ts +1 -1
- package/dist/llm/index.d.ts.map +1 -1
- package/dist/llm/index.js +1 -1
- package/dist/llm/model/index.d.ts +1 -1
- package/dist/llm/model/index.d.ts.map +1 -1
- package/dist/loop/index.cjs +12 -12
- package/dist/loop/index.js +1 -1
- package/dist/mastra/index.cjs +2 -2
- package/dist/mastra/index.d.ts +17 -0
- package/dist/mastra/index.d.ts.map +1 -1
- package/dist/mastra/index.js +1 -1
- package/dist/memory/index.cjs +14 -14
- package/dist/memory/index.js +1 -1
- package/dist/memory/types.d.ts +3 -2
- package/dist/memory/types.d.ts.map +1 -1
- package/dist/processors/index.cjs +41 -41
- package/dist/processors/index.js +1 -1
- package/dist/relevance/index.cjs +3 -3
- package/dist/relevance/index.js +1 -1
- package/dist/storage/index.cjs +33 -33
- package/dist/storage/index.js +1 -1
- package/dist/stream/index.cjs +11 -11
- package/dist/stream/index.js +2 -2
- package/dist/test-utils/llm-mock.cjs +12 -12
- package/dist/test-utils/llm-mock.js +3 -3
- package/dist/{token-6GSAFR2W-TOUJCAPY.js → token-APYSY3BW-QJCV2XQG.js} +11 -11
- package/dist/token-APYSY3BW-QJCV2XQG.js.map +1 -0
- package/dist/{token-6GSAFR2W-GERJXNN5.cjs → token-APYSY3BW-UBKUGJQP.cjs} +14 -14
- package/dist/token-APYSY3BW-UBKUGJQP.cjs.map +1 -0
- package/dist/token-util-RMHT2CPJ-S2YMG7N3.js +8 -0
- package/dist/token-util-RMHT2CPJ-S2YMG7N3.js.map +1 -0
- package/dist/token-util-RMHT2CPJ-WV2T74WQ.cjs +10 -0
- package/dist/token-util-RMHT2CPJ-WV2T74WQ.cjs.map +1 -0
- package/dist/tool-loop-agent/index.cjs +4 -4
- package/dist/tool-loop-agent/index.js +1 -1
- package/dist/vector/index.cjs +11 -11
- package/dist/vector/index.js +3 -3
- package/dist/workflows/evented/index.cjs +10 -10
- package/dist/workflows/evented/index.js +1 -1
- package/dist/workflows/index.cjs +25 -25
- package/dist/workflows/index.js +1 -1
- package/package.json +4 -5
- package/dist/chunk-3LRUJTH3.cjs.map +0 -1
- package/dist/chunk-5HDIPOLV.js.map +0 -1
- package/dist/chunk-ARQG4ZSD.cjs.map +0 -1
- package/dist/chunk-DG6C6ZTL.cjs.map +0 -1
- package/dist/chunk-EY3WXGUD.js.map +0 -1
- package/dist/chunk-IPXNR6RQ.js.map +0 -1
- package/dist/chunk-NYC6PYZF.js.map +0 -1
- package/dist/chunk-X5HU5YVN.js +0 -250
- package/dist/chunk-X5HU5YVN.js.map +0 -1
- package/dist/chunk-XC7WIZBL.js.map +0 -1
- package/dist/chunk-Z2OKCLGV.cjs.map +0 -1
- package/dist/chunk-Z4PGSIZ5.cjs.map +0 -1
- package/dist/chunk-ZZF2IKZJ.cjs +0 -252
- package/dist/chunk-ZZF2IKZJ.cjs.map +0 -1
- package/dist/docs/README.md +0 -57
- package/dist/docs/agents/11-reference.md +0 -854
- package/dist/docs/ai-sdk/01-reference.md +0 -490
- package/dist/docs/auth/01-reference.md +0 -308
- package/dist/docs/core/01-reference.md +0 -1283
- package/dist/docs/deployer/01-reference.md +0 -128
- package/dist/docs/evals/04-reference.md +0 -2137
- package/dist/docs/index.mdx/01-reference.md +0 -14
- package/dist/docs/mcp/02-publishing-mcp-server.md +0 -111
- package/dist/docs/observability/15-reference.md +0 -1831
- package/dist/docs/processors/01-reference.md +0 -1418
- package/dist/docs/rag/06-reference.md +0 -342
- package/dist/docs/server/16-reference.md +0 -513
- package/dist/docs/storage/01-reference.md +0 -2022
- package/dist/docs/streaming/04-reference.md +0 -724
- package/dist/docs/tools/01-reference.md +0 -3136
- package/dist/docs/vectors/01-reference.md +0 -942
- package/dist/docs/voice/05-reference.md +0 -1043
- package/dist/docs/workflows/11-reference.md +0 -1044
- package/dist/docs/workspace/06-reference.md +0 -946
- package/dist/token-6GSAFR2W-GERJXNN5.cjs.map +0 -1
- package/dist/token-6GSAFR2W-TOUJCAPY.js.map +0 -1
- package/dist/token-util-NEHG7TUY-R2XAU2MF.cjs +0 -10
- package/dist/token-util-NEHG7TUY-R2XAU2MF.cjs.map +0 -1
- package/dist/token-util-NEHG7TUY-TZ426VZB.js +0 -8
- package/dist/token-util-NEHG7TUY-TZ426VZB.js.map +0 -1
|
@@ -164,7 +164,7 @@ The following files are created:
|
|
|
164
164
|
- **hybrid-question.mp3** – Hybrid agent's spoken question.
|
|
165
165
|
- **unified-response.mp3** – Unified agent's spoken response.
|
|
166
166
|
|
|
167
|
-
```typescript
|
|
167
|
+
```typescript
|
|
168
168
|
import "dotenv/config";
|
|
169
169
|
|
|
170
170
|
import path from "path";
|
|
@@ -323,15 +323,16 @@ const voice = new CompositeVoice({
|
|
|
323
323
|
```
|
|
324
324
|
|
|
325
325
|
For the complete list of supported AI SDK providers and their capabilities:
|
|
326
|
-
|
|
327
|
-
|
|
326
|
+
|
|
327
|
+
- [Transcription](https://ai-sdk.dev/docs/providers/openai/transcription)
|
|
328
|
+
- [Speech](https://ai-sdk.dev/docs/providers/elevenlabs/speech)
|
|
328
329
|
|
|
329
330
|
## Supported Voice Providers
|
|
330
331
|
|
|
331
332
|
Mastra supports multiple voice providers for text-to-speech (TTS) and speech-to-text (STT) capabilities:
|
|
332
333
|
|
|
333
|
-
| Provider | Package | Features | Reference
|
|
334
|
-
| --------------- | ------------------------------- | ------------------------- |
|
|
334
|
+
| Provider | Package | Features | Reference |
|
|
335
|
+
| --------------- | ------------------------------- | ------------------------- | ------------------------------------------------------------------ |
|
|
335
336
|
| OpenAI | `@mastra/voice-openai` | TTS, STT | [Documentation](https://mastra.ai/reference/voice/openai) |
|
|
336
337
|
| OpenAI Realtime | `@mastra/voice-openai-realtime` | Realtime speech-to-speech | [Documentation](https://mastra.ai/reference/voice/openai-realtime) |
|
|
337
338
|
| ElevenLabs | `@mastra/voice-elevenlabs` | High-quality TTS | [Documentation](https://mastra.ai/reference/voice/elevenlabs) |
|
|
@@ -1,5 +1,3 @@
|
|
|
1
|
-
> Learn how to require approvals, suspend tool execution, and automatically resume suspended tools while keeping humans in control of agent workflows.
|
|
2
|
-
|
|
3
1
|
# Agent Approval
|
|
4
2
|
|
|
5
3
|
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.
|
|
@@ -12,7 +10,7 @@ Tool call approval can be enabled at the agent level and apply to every tool the
|
|
|
12
10
|
|
|
13
11
|
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.
|
|
14
12
|
|
|
15
|
-
```typescript
|
|
13
|
+
```typescript
|
|
16
14
|
import { Mastra } from "@mastra/core/mastra";
|
|
17
15
|
import { LibSQLStore } from "@mastra/libsql";
|
|
18
16
|
|
|
@@ -117,13 +115,13 @@ if (output.finishReason === "suspended") {
|
|
|
117
115
|
|
|
118
116
|
### Stream vs Generate comparison
|
|
119
117
|
|
|
120
|
-
| Aspect
|
|
121
|
-
|
|
122
|
-
| Response type
|
|
123
|
-
| Approval detection | `tool-call-approval` chunk
|
|
124
|
-
| Approve method
|
|
125
|
-
| Decline method
|
|
126
|
-
| Result
|
|
118
|
+
| Aspect | `stream()` | `generate()` |
|
|
119
|
+
| ------------------ | ---------------------------- | ------------------------------------------------ |
|
|
120
|
+
| Response type | Streaming chunks | Complete response |
|
|
121
|
+
| Approval detection | `tool-call-approval` chunk | `finishReason: 'suspended'` |
|
|
122
|
+
| Approve method | `approveToolCall({ runId })` | `approveToolCallGenerate({ runId, toolCallId })` |
|
|
123
|
+
| Decline method | `declineToolCall({ runId })` | `declineToolCallGenerate({ runId, toolCallId })` |
|
|
124
|
+
| Result | Stream to iterate | Full output object |
|
|
127
125
|
|
|
128
126
|
## Tool-level approval
|
|
129
127
|
|
|
@@ -231,7 +229,6 @@ const handleResume = async () => {
|
|
|
231
229
|
}
|
|
232
230
|
process.stdout.write("\n");
|
|
233
231
|
};
|
|
234
|
-
|
|
235
232
|
```
|
|
236
233
|
|
|
237
234
|
## Automatic tool resumption
|
|
@@ -270,8 +267,11 @@ const stream = await agent.stream("What's the weather?", {
|
|
|
270
267
|
When `autoResumeSuspendedTools` is enabled:
|
|
271
268
|
|
|
272
269
|
1. A tool suspends execution by calling `suspend()` with a payload (e.g., requesting more information)
|
|
270
|
+
|
|
273
271
|
2. The suspension is persisted to memory along with the conversation
|
|
272
|
+
|
|
274
273
|
3. When the user sends their next message on the same thread, the agent:
|
|
274
|
+
|
|
275
275
|
- Detects the suspended tool from message history
|
|
276
276
|
- Extracts `resumeData` from the user's message based on the tool's `resumeSchema`
|
|
277
277
|
- Automatically resumes the tool with the extracted data
|
|
@@ -341,7 +341,7 @@ const handleResume = async () => {
|
|
|
341
341
|
|
|
342
342
|
**Conversation flow:**
|
|
343
343
|
|
|
344
|
-
```
|
|
344
|
+
```text
|
|
345
345
|
User: "What's the weather like?"
|
|
346
346
|
Agent: "What city do you want to know the weather for?"
|
|
347
347
|
|
|
@@ -361,17 +361,17 @@ For automatic tool resumption to work:
|
|
|
361
361
|
|
|
362
362
|
### Manual vs automatic resumption
|
|
363
363
|
|
|
364
|
-
| Approach
|
|
365
|
-
|
|
366
|
-
| Manual (`resumeStream()`)
|
|
364
|
+
| Approach | Use case |
|
|
365
|
+
| -------------------------------------- | ------------------------------------------------------------------------ |
|
|
366
|
+
| Manual (`resumeStream()`) | Programmatic control, webhooks, button clicks, external triggers |
|
|
367
367
|
| Automatic (`autoResumeSuspendedTools`) | Conversational flows where users provide resume data in natural language |
|
|
368
368
|
|
|
369
369
|
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.
|
|
370
370
|
|
|
371
371
|
## Related
|
|
372
372
|
|
|
373
|
-
- [Using Tools](
|
|
374
|
-
- [Agent Overview](
|
|
375
|
-
- [Tools Overview](
|
|
376
|
-
- [Agent Memory](
|
|
373
|
+
- [Using Tools](https://mastra.ai/docs/agents/using-tools)
|
|
374
|
+
- [Agent Overview](https://mastra.ai/docs/agents/overview)
|
|
375
|
+
- [Tools Overview](https://mastra.ai/docs/mcp/overview)
|
|
376
|
+
- [Agent Memory](https://mastra.ai/docs/agents/agent-memory)
|
|
377
377
|
- [Request Context](https://mastra.ai/docs/server/request-context)
|
|
@@ -1,10 +1,8 @@
|
|
|
1
|
-
> Learn how to add memory to agents to store message history and maintain context across interactions.
|
|
2
|
-
|
|
3
1
|
# Agent memory
|
|
4
2
|
|
|
5
3
|
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.
|
|
6
4
|
|
|
7
|
-
Mastra agents can be configured to store message history, with optional [working memory](
|
|
5
|
+
Mastra agents can be configured to store message history, with optional [working memory](https://mastra.ai/docs/memory/working-memory) to maintain recent context or [semantic recall](https://mastra.ai/docs/memory/semantic-recall) to retrieve past messages based on meaning.
|
|
8
6
|
|
|
9
7
|
## When to use memory
|
|
10
8
|
|
|
@@ -14,66 +12,74 @@ Use memory when your agent needs to maintain multi-turn conversations that refer
|
|
|
14
12
|
|
|
15
13
|
To enable memory in Mastra, install the `@mastra/memory` package along with a storage provider.
|
|
16
14
|
|
|
17
|
-
|
|
15
|
+
**npm**:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
18
|
npm install @mastra/memory@latest @mastra/libsql@latest
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
**pnpm**:
|
|
22
22
|
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
23
|
+
```bash
|
|
24
|
+
pnpm add @mastra/memory@latest @mastra/libsql@latest
|
|
25
|
+
```
|
|
26
26
|
|
|
27
|
-
|
|
27
|
+
**Yarn**:
|
|
28
28
|
|
|
29
|
-
|
|
29
|
+
```bash
|
|
30
|
+
yarn add @mastra/memory@latest @mastra/libsql@latest
|
|
31
|
+
```
|
|
30
32
|
|
|
31
|
-
|
|
32
|
-
import { Agent } from "@mastra/core/agent";
|
|
33
|
-
import { Memory } from "@mastra/memory";
|
|
33
|
+
**Bun**:
|
|
34
34
|
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
name: 'Memory Agent',
|
|
38
|
-
memory: new Memory({
|
|
39
|
-
options: {
|
|
40
|
-
lastMessages: 20,
|
|
41
|
-
},
|
|
42
|
-
}),
|
|
43
|
-
});
|
|
35
|
+
```bash
|
|
36
|
+
bun add @mastra/memory@latest @mastra/libsql@latest
|
|
44
37
|
```
|
|
45
38
|
|
|
46
|
-
|
|
39
|
+
## Storage providers
|
|
47
40
|
|
|
48
|
-
|
|
41
|
+
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.
|
|
49
42
|
|
|
50
|
-
|
|
43
|
+
## Configuring memory
|
|
51
44
|
|
|
52
|
-
|
|
45
|
+
1. Enable memory by creating a `Memory` instance and passing it to the agent’s `memory` option.
|
|
53
46
|
|
|
54
|
-
|
|
47
|
+
```typescript
|
|
48
|
+
import { Agent } from "@mastra/core/agent";
|
|
49
|
+
import { Memory } from "@mastra/memory";
|
|
55
50
|
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
51
|
+
export const memoryAgent = new Agent({
|
|
52
|
+
id: 'memory-agent',
|
|
53
|
+
name: 'Memory Agent',
|
|
54
|
+
memory: new Memory({
|
|
55
|
+
options: {
|
|
56
|
+
lastMessages: 20,
|
|
57
|
+
},
|
|
58
|
+
}),
|
|
59
|
+
});
|
|
60
|
+
```
|
|
59
61
|
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
url: ":memory:",
|
|
64
|
-
}),
|
|
65
|
-
});
|
|
66
|
-
```
|
|
62
|
+
> **Info:** Visit [Memory Class](https://mastra.ai/reference/memory/memory-class) for a full list of configuration options.
|
|
63
|
+
|
|
64
|
+
2. Add a storage provider to your main Mastra instance to enable memory across all configured agents.
|
|
67
65
|
|
|
68
|
-
|
|
66
|
+
```typescript
|
|
67
|
+
import { Mastra } from "@mastra/core";
|
|
68
|
+
import { LibSQLStore } from "@mastra/libsql";
|
|
69
69
|
|
|
70
|
-
|
|
70
|
+
export const mastra = new Mastra({
|
|
71
|
+
storage: new LibSQLStore({
|
|
72
|
+
id: 'mastra-storage',
|
|
73
|
+
url: ":memory:",
|
|
74
|
+
}),
|
|
75
|
+
});
|
|
76
|
+
```
|
|
71
77
|
|
|
72
|
-
|
|
78
|
+
> **Info:** Visit [libSQL Storage](https://mastra.ai/reference/storage/libsql) for a full list of configuration options.
|
|
73
79
|
|
|
74
80
|
Alternatively, add storage directly to an agent’s memory to keep data separate or use different providers per agent.
|
|
75
81
|
|
|
76
|
-
```typescript
|
|
82
|
+
```typescript
|
|
77
83
|
import { Agent } from "@mastra/core/agent";
|
|
78
84
|
import { Memory } from "@mastra/memory";
|
|
79
85
|
import { LibSQLStore } from "@mastra/libsql";
|
|
@@ -90,8 +96,7 @@ export const memoryAgent = new Agent({
|
|
|
90
96
|
});
|
|
91
97
|
```
|
|
92
98
|
|
|
93
|
-
> **Mastra Cloud Store limitation
|
|
94
|
-
Agent-level storage is not supported when using [Mastra Cloud Store](https://mastra.ai/docs/mastra-cloud/deployment#using-mastra-cloud-store). If you use Mastra Cloud Store, configure storage on the Mastra instance instead. This limitation does not apply if you bring your own database.
|
|
99
|
+
> **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.
|
|
95
100
|
|
|
96
101
|
## Message history
|
|
97
102
|
|
|
@@ -102,7 +107,7 @@ Include a `memory` object with both `resource` and `thread` to track message his
|
|
|
102
107
|
|
|
103
108
|
These fields tell the agent where to store and retrieve context, enabling persistent, thread-aware memory across a conversation.
|
|
104
109
|
|
|
105
|
-
```typescript
|
|
110
|
+
```typescript
|
|
106
111
|
const response = await memoryAgent.generate(
|
|
107
112
|
"Remember my favorite color is blue.",
|
|
108
113
|
{
|
|
@@ -116,7 +121,7 @@ const response = await memoryAgent.generate(
|
|
|
116
121
|
|
|
117
122
|
To recall information stored in memory, call the agent with the same `resource` and `thread` values used in the original conversation.
|
|
118
123
|
|
|
119
|
-
```typescript
|
|
124
|
+
```typescript
|
|
120
125
|
const response = await memoryAgent.generate("What's my favorite color?", {
|
|
121
126
|
memory: {
|
|
122
127
|
resource: "user-123",
|
|
@@ -125,16 +130,15 @@ const response = await memoryAgent.generate("What's my favorite color?", {
|
|
|
125
130
|
});
|
|
126
131
|
```
|
|
127
132
|
|
|
128
|
-
> **
|
|
129
|
-
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.
|
|
133
|
+
> **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.
|
|
130
134
|
|
|
131
|
-
To learn more about memory see the [Memory](
|
|
135
|
+
To learn more about memory see the [Memory](https://mastra.ai/docs/memory/overview) documentation.
|
|
132
136
|
|
|
133
137
|
## Using `RequestContext`
|
|
134
138
|
|
|
135
139
|
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.
|
|
136
140
|
|
|
137
|
-
```typescript
|
|
141
|
+
```typescript
|
|
138
142
|
export type UserTier = {
|
|
139
143
|
"user-tier": "enterprise" | "pro";
|
|
140
144
|
};
|
|
@@ -154,13 +158,11 @@ export const memoryAgent = new Agent({
|
|
|
154
158
|
});
|
|
155
159
|
```
|
|
156
160
|
|
|
157
|
-
> **
|
|
158
|
-
|
|
159
|
-
Visit [Request Context](https://mastra.ai/docs/server/request-context) for more information.
|
|
161
|
+
> **Info:** Visit [Request Context](https://mastra.ai/docs/server/request-context) for more information.
|
|
160
162
|
|
|
161
163
|
## Related
|
|
162
164
|
|
|
163
|
-
- [Working Memory](
|
|
164
|
-
- [Semantic Recall](
|
|
165
|
-
- [Storage](
|
|
165
|
+
- [Working Memory](https://mastra.ai/docs/memory/working-memory)
|
|
166
|
+
- [Semantic Recall](https://mastra.ai/docs/memory/semantic-recall)
|
|
167
|
+
- [Storage](https://mastra.ai/docs/memory/storage)
|
|
166
168
|
- [Request Context](https://mastra.ai/docs/server/request-context)
|
|
@@ -1,5 +1,3 @@
|
|
|
1
|
-
> Learn how to implement guardrails using input and output processors to secure and control AI interactions.
|
|
2
|
-
|
|
3
1
|
# Guardrails
|
|
4
2
|
|
|
5
3
|
Agents use processors to apply guardrails to inputs and outputs. They run before or after each interaction, giving you a way to review, transform, or block information as it passes between the user and the agent.
|
|
@@ -19,7 +17,7 @@ Use processors for content moderation, prompt injection prevention, response san
|
|
|
19
17
|
|
|
20
18
|
Import and instantiate the relevant processor class, and pass it to your agent’s configuration using either the `inputProcessors` or `outputProcessors` option:
|
|
21
19
|
|
|
22
|
-
```typescript
|
|
20
|
+
```typescript
|
|
23
21
|
import { Agent } from "@mastra/core/agent";
|
|
24
22
|
import { ModerationProcessor } from "@mastra/core/processors";
|
|
25
23
|
|
|
@@ -48,7 +46,7 @@ Input processors are applied before user messages reach the language model. They
|
|
|
48
46
|
|
|
49
47
|
The `UnicodeNormalizer` is an input processor that cleans and normalizes user input by unifying Unicode characters, standardizing whitespace, and removing problematic symbols, allowing the LLM to better understand user messages.
|
|
50
48
|
|
|
51
|
-
```typescript
|
|
49
|
+
```typescript
|
|
52
50
|
import { UnicodeNormalizer } from "@mastra/core/processors";
|
|
53
51
|
|
|
54
52
|
export const normalizedAgent = new Agent({
|
|
@@ -63,15 +61,13 @@ export const normalizedAgent = new Agent({
|
|
|
63
61
|
});
|
|
64
62
|
```
|
|
65
63
|
|
|
66
|
-
> **
|
|
67
|
-
|
|
68
|
-
Visit [UnicodeNormalizer](https://mastra.ai/reference/processors/unicode-normalizer) for a full list of configuration options.
|
|
64
|
+
> **Info:** Visit [UnicodeNormalizer](https://mastra.ai/reference/processors/unicode-normalizer) for a full list of configuration options.
|
|
69
65
|
|
|
70
66
|
### Preventing prompt injection
|
|
71
67
|
|
|
72
68
|
The `PromptInjectionDetector` is an input processor that scans user messages for prompt injection, jailbreak attempts, and system override patterns. It uses an LLM to classify risky input and can block or rewrite it before it reaches the model.
|
|
73
69
|
|
|
74
|
-
```typescript
|
|
70
|
+
```typescript
|
|
75
71
|
import { PromptInjectionDetector } from "@mastra/core/processors";
|
|
76
72
|
|
|
77
73
|
export const secureAgent = new Agent({
|
|
@@ -88,15 +84,13 @@ export const secureAgent = new Agent({
|
|
|
88
84
|
});
|
|
89
85
|
```
|
|
90
86
|
|
|
91
|
-
> **
|
|
92
|
-
|
|
93
|
-
Visit [PromptInjectionDetector](https://mastra.ai/reference/processors/prompt-injection-detector) for a full list of configuration options.
|
|
87
|
+
> **Info:** Visit [PromptInjectionDetector](https://mastra.ai/reference/processors/prompt-injection-detector) for a full list of configuration options.
|
|
94
88
|
|
|
95
89
|
### Detecting and translating language
|
|
96
90
|
|
|
97
91
|
The `LanguageDetector` is an input processor that detects and translates user messages into a target language, enabling multilingual support while maintaining consistent interaction. It uses an LLM to identify the language and perform the translation.
|
|
98
92
|
|
|
99
|
-
```typescript
|
|
93
|
+
```typescript
|
|
100
94
|
import { LanguageDetector } from "@mastra/core/processors";
|
|
101
95
|
|
|
102
96
|
export const multilingualAgent = new Agent({
|
|
@@ -113,9 +107,7 @@ export const multilingualAgent = new Agent({
|
|
|
113
107
|
});
|
|
114
108
|
```
|
|
115
109
|
|
|
116
|
-
> **
|
|
117
|
-
|
|
118
|
-
Visit [LanguageDetector](https://mastra.ai/reference/processors/language-detector) for a full list of configuration options.
|
|
110
|
+
> **Info:** Visit [LanguageDetector](https://mastra.ai/reference/processors/language-detector) for a full list of configuration options.
|
|
119
111
|
|
|
120
112
|
## Output processors
|
|
121
113
|
|
|
@@ -125,7 +117,7 @@ Output processors are applied after the language model generates a response, but
|
|
|
125
117
|
|
|
126
118
|
The `BatchPartsProcessor` is an output processor that combines multiple stream parts before emitting them to the client. This reduces network overhead and improves the user experience by consolidating small chunks into larger batches.
|
|
127
119
|
|
|
128
|
-
```typescript
|
|
120
|
+
```typescript
|
|
129
121
|
import { BatchPartsProcessor } from "@mastra/core/processors";
|
|
130
122
|
|
|
131
123
|
export const batchedAgent = new Agent({
|
|
@@ -141,15 +133,13 @@ export const batchedAgent = new Agent({
|
|
|
141
133
|
});
|
|
142
134
|
```
|
|
143
135
|
|
|
144
|
-
> **
|
|
145
|
-
|
|
146
|
-
Visit [BatchPartsProcessor](https://mastra.ai/reference/processors/batch-parts-processor) for a full list of configuration options.
|
|
136
|
+
> **Info:** Visit [BatchPartsProcessor](https://mastra.ai/reference/processors/batch-parts-processor) for a full list of configuration options.
|
|
147
137
|
|
|
148
138
|
### Limiting token usage
|
|
149
139
|
|
|
150
140
|
The `TokenLimiterProcessor` is an output processor that limits the number of tokens in model responses. It helps manage cost and performance by truncating or blocking messages when the limit is exceeded.
|
|
151
141
|
|
|
152
|
-
```typescript
|
|
142
|
+
```typescript
|
|
153
143
|
import { TokenLimiterProcessor } from "@mastra/core/processors";
|
|
154
144
|
|
|
155
145
|
export const limitedAgent = new Agent({
|
|
@@ -165,15 +155,13 @@ export const limitedAgent = new Agent({
|
|
|
165
155
|
});
|
|
166
156
|
```
|
|
167
157
|
|
|
168
|
-
> **
|
|
169
|
-
|
|
170
|
-
Visit [TokenLimiterProcessor](https://mastra.ai/reference/processors/token-limiter-processor) for a full list of configuration options.
|
|
158
|
+
> **Info:** Visit [TokenLimiterProcessor](https://mastra.ai/reference/processors/token-limiter-processor) for a full list of configuration options.
|
|
171
159
|
|
|
172
160
|
### Scrubbing system prompts
|
|
173
161
|
|
|
174
162
|
The `SystemPromptScrubber` is an output processor that detects and redacts system prompts or other internal instructions from model responses. It helps prevent unintended disclosure of prompt content or configuration details that could introduce security risks. It uses an LLM to identify and redact sensitive content based on configured detection types.
|
|
175
163
|
|
|
176
|
-
```typescript
|
|
164
|
+
```typescript
|
|
177
165
|
import { SystemPromptScrubber } from "@mastra/core/processors";
|
|
178
166
|
|
|
179
167
|
const scrubbedAgent = new Agent({
|
|
@@ -194,12 +182,9 @@ const scrubbedAgent = new Agent({
|
|
|
194
182
|
});
|
|
195
183
|
```
|
|
196
184
|
|
|
197
|
-
> **
|
|
198
|
-
|
|
199
|
-
Visit [SystemPromptScrubber](https://mastra.ai/reference/processors/system-prompt-scrubber) for a full list of configuration options.
|
|
185
|
+
> **Info:** Visit [SystemPromptScrubber](https://mastra.ai/reference/processors/system-prompt-scrubber) for a full list of configuration options.
|
|
200
186
|
|
|
201
|
-
> **Note:**
|
|
202
|
-
When streaming responses over HTTP, Mastra redacts sensitive request data (system prompts, tool definitions, API keys) from stream chunks at the server level by default. See [Stream data redaction](https://mastra.ai/docs/server/mastra-server#stream-data-redaction) for details.
|
|
187
|
+
> **Note:** When streaming responses over HTTP, Mastra redacts sensitive request data (system prompts, tool definitions, API keys) from stream chunks at the server level by default. See [Stream data redaction](https://mastra.ai/docs/server/mastra-server) for details.
|
|
203
188
|
|
|
204
189
|
## Hybrid processors
|
|
205
190
|
|
|
@@ -209,7 +194,7 @@ Hybrid processors can be applied either before messages are sent to the language
|
|
|
209
194
|
|
|
210
195
|
The `ModerationProcessor` is a hybrid processor that detects inappropriate or harmful content across categories like hate, harassment, and violence. It can be used to moderate either user input or model output, depending on where it's applied. It uses an LLM to classify the message and can block or rewrite it based on your configuration.
|
|
211
196
|
|
|
212
|
-
```typescript
|
|
197
|
+
```typescript
|
|
213
198
|
import { ModerationProcessor } from "@mastra/core/processors";
|
|
214
199
|
|
|
215
200
|
export const moderatedAgent = new Agent({
|
|
@@ -229,15 +214,13 @@ export const moderatedAgent = new Agent({
|
|
|
229
214
|
});
|
|
230
215
|
```
|
|
231
216
|
|
|
232
|
-
> **
|
|
233
|
-
|
|
234
|
-
Visit [ModerationProcessor](https://mastra.ai/reference/processors/moderation-processor) for a full list of configuration options.
|
|
217
|
+
> **Info:** Visit [ModerationProcessor](https://mastra.ai/reference/processors/moderation-processor) for a full list of configuration options.
|
|
235
218
|
|
|
236
219
|
### Detecting and redacting PII
|
|
237
220
|
|
|
238
221
|
The `PIIDetector` is a hybrid processor that detects and removes personally identifiable information such as emails, phone numbers, and credit cards. It can redact either user input or model output, depending on where it's applied. It uses an LLM to identify sensitive content based on configured detection types.
|
|
239
222
|
|
|
240
|
-
```typescript
|
|
223
|
+
```typescript
|
|
241
224
|
import { PIIDetector } from "@mastra/core/processors";
|
|
242
225
|
|
|
243
226
|
export const privateAgent = new Agent({
|
|
@@ -259,9 +242,7 @@ export const privateAgent = new Agent({
|
|
|
259
242
|
});
|
|
260
243
|
```
|
|
261
244
|
|
|
262
|
-
> **
|
|
263
|
-
|
|
264
|
-
Visit [PIIDetector](https://mastra.ai/reference/processors/pii-detector) for a full list of configuration options.
|
|
245
|
+
> **Info:** Visit [PIIDetector](https://mastra.ai/reference/processors/pii-detector) for a full list of configuration options.
|
|
265
246
|
|
|
266
247
|
## Applying multiple processors
|
|
267
248
|
|
|
@@ -275,7 +256,7 @@ A typical order might be:
|
|
|
275
256
|
|
|
276
257
|
The order affects behavior, so arrange processors to suit your goals.
|
|
277
258
|
|
|
278
|
-
```typescript
|
|
259
|
+
```typescript
|
|
279
260
|
import {
|
|
280
261
|
UnicodeNormalizer,
|
|
281
262
|
ModerationProcessor,
|
|
@@ -301,7 +282,7 @@ Many of the built-in processors support a `strategy` parameter that controls how
|
|
|
301
282
|
|
|
302
283
|
Most strategies allow the request to continue without interruption. When `block` is used, the processor calls its internal `abort()` function, which immediately stops the request and prevents any subsequent processors from running.
|
|
303
284
|
|
|
304
|
-
```typescript
|
|
285
|
+
```typescript
|
|
305
286
|
import { PIIDetector } from "@mastra/core/processors";
|
|
306
287
|
|
|
307
288
|
export const privateAgent = new Agent({
|
|
@@ -384,6 +365,7 @@ export class QualityChecker implements Processor {
|
|
|
384
365
|
```
|
|
385
366
|
|
|
386
367
|
The `abort()` function accepts an optional second parameter with:
|
|
368
|
+
|
|
387
369
|
- `retry: true` - Request the LLM retry the step
|
|
388
370
|
- `metadata: unknown` - Attach additional data for debugging/logging
|
|
389
371
|
|
package/dist/docs/{agents/09-network-approval.md → references/docs-agents-network-approval.md}
RENAMED
|
@@ -1,5 +1,3 @@
|
|
|
1
|
-
> Learn how to require approvals, suspend execution, and resume suspended networks while keeping humans in control of agent network workflows.
|
|
2
|
-
|
|
3
1
|
# Network Approval
|
|
4
2
|
|
|
5
3
|
Agent networks can require the same [human-in-the-loop](https://mastra.ai/docs/workflows/human-in-the-loop) oversight used in individual agents and workflows. When a tool, sub-agent, or workflow within a network requires approval or suspends execution, the network pauses and emits events that allow your application to collect user input before resuming.
|
|
@@ -8,7 +6,7 @@ Agent networks can require the same [human-in-the-loop](https://mastra.ai/docs/w
|
|
|
8
6
|
|
|
9
7
|
Network approval uses snapshots to capture execution state. Ensure you've enabled a storage provider in your Mastra instance. If storage isn't enabled you'll see an error relating to snapshot not found.
|
|
10
8
|
|
|
11
|
-
```typescript
|
|
9
|
+
```typescript
|
|
12
10
|
import { Mastra } from "@mastra/core/mastra";
|
|
13
11
|
import { LibSQLStore } from "@mastra/libsql";
|
|
14
12
|
|
|
@@ -37,7 +35,7 @@ let runId: string;
|
|
|
37
35
|
for await (const chunk of stream) {
|
|
38
36
|
runId = stream.runId;
|
|
39
37
|
// if the requirApproval is in a tool inside a subAgent or the subAgent has requireToolApproval set to true
|
|
40
|
-
if (chunk.type === "agent-execution-approval") {
|
|
38
|
+
if (chunk.type === "agent-execution-approval") {
|
|
41
39
|
console.log("Tool requires approval:", chunk.payload);
|
|
42
40
|
}
|
|
43
41
|
|
|
@@ -199,8 +197,11 @@ const stream = await routingAgent.network("Process this request", {
|
|
|
199
197
|
When `autoResumeSuspendedTools` is enabled:
|
|
200
198
|
|
|
201
199
|
1. A primitive suspends execution by calling `suspend()` with a payload
|
|
200
|
+
|
|
202
201
|
2. The suspension is persisted to memory along with the conversation
|
|
202
|
+
|
|
203
203
|
3. When the user sends their next message on the same thread, the network:
|
|
204
|
+
|
|
204
205
|
- Detects the suspended primitive from message history
|
|
205
206
|
- Extracts `resumeData` from the user's message based on the tool's `resumeSchema`
|
|
206
207
|
- Automatically resumes the primitive with the extracted data
|
|
@@ -241,7 +242,7 @@ for await (const chunk of resumedStream) {
|
|
|
241
242
|
|
|
242
243
|
**Conversation flow:**
|
|
243
244
|
|
|
244
|
-
```
|
|
245
|
+
```text
|
|
245
246
|
User: "Delete the old records"
|
|
246
247
|
Agent: "Please confirm: delete old records"
|
|
247
248
|
|
|
@@ -259,16 +260,16 @@ For automatic tool resumption to work:
|
|
|
259
260
|
|
|
260
261
|
### Manual vs automatic resumption
|
|
261
262
|
|
|
262
|
-
| Approach
|
|
263
|
-
|
|
264
|
-
| Manual (`resumeNetwork()`)
|
|
263
|
+
| Approach | Use case |
|
|
264
|
+
| -------------------------------------- | ------------------------------------------------------------------------ |
|
|
265
|
+
| Manual (`resumeNetwork()`) | Programmatic control, webhooks, button clicks, external triggers |
|
|
265
266
|
| Automatic (`autoResumeSuspendedTools`) | Conversational flows where users provide resume data in natural language |
|
|
266
267
|
|
|
267
268
|
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.
|
|
268
269
|
|
|
269
270
|
## Related
|
|
270
271
|
|
|
271
|
-
- [Agent Networks](
|
|
272
|
-
- [Agent Approval](
|
|
272
|
+
- [Agent Networks](https://mastra.ai/docs/agents/networks)
|
|
273
|
+
- [Agent Approval](https://mastra.ai/docs/agents/agent-approval)
|
|
273
274
|
- [Human-in-the-Loop](https://mastra.ai/docs/workflows/human-in-the-loop)
|
|
274
|
-
- [Agent Memory](
|
|
275
|
+
- [Agent Memory](https://mastra.ai/docs/agents/agent-memory)
|
|
@@ -1,5 +1,3 @@
|
|
|
1
|
-
> Learn how to coordinate multiple agents, workflows, and tools using agent networks for complex, non-deterministic task execution.
|
|
2
|
-
|
|
3
1
|
# Agent Networks
|
|
4
2
|
|
|
5
3
|
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 (sub-agents, workflows, or tools) to call, in what order, and with what data.
|
|
@@ -20,7 +18,7 @@ Mastra agent networks operate using these principles:
|
|
|
20
18
|
|
|
21
19
|
An agent network is built around a top-level routing agent that delegates tasks to agents, 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.
|
|
22
20
|
|
|
23
|
-
```typescript
|
|
21
|
+
```typescript
|
|
24
22
|
import { Agent } from "@mastra/core/agent";
|
|
25
23
|
import { Memory } from "@mastra/memory";
|
|
26
24
|
import { LibSQLStore } from "@mastra/libsql";
|
|
@@ -68,7 +66,7 @@ When configuring a Mastra agent network, each primitive (agent, workflow, or too
|
|
|
68
66
|
|
|
69
67
|
Each agent in a network should include a clear `description` that explains what the agent does.
|
|
70
68
|
|
|
71
|
-
```typescript
|
|
69
|
+
```typescript
|
|
72
70
|
export const researchAgent = new Agent({
|
|
73
71
|
id: "research-agent",
|
|
74
72
|
name: "Research Agent",
|
|
@@ -78,7 +76,7 @@ export const researchAgent = new Agent({
|
|
|
78
76
|
});
|
|
79
77
|
```
|
|
80
78
|
|
|
81
|
-
```typescript
|
|
79
|
+
```typescript
|
|
82
80
|
export const writingAgent = new Agent({
|
|
83
81
|
id: "writing-agent",
|
|
84
82
|
name: "Writing Agent",
|
|
@@ -92,7 +90,7 @@ export const writingAgent = new Agent({
|
|
|
92
90
|
|
|
93
91
|
Workflows in a network should include a `description` to explain their purpose, along with `inputSchema` and `outputSchema` to describe the expected data.
|
|
94
92
|
|
|
95
|
-
```typescript
|
|
93
|
+
```typescript
|
|
96
94
|
export const cityWorkflow = createWorkflow({
|
|
97
95
|
id: "city-workflow",
|
|
98
96
|
description: `This workflow handles city-specific research tasks.
|
|
@@ -112,7 +110,7 @@ export const cityWorkflow = createWorkflow({
|
|
|
112
110
|
|
|
113
111
|
Tools in a network should include a `description` to explain their purpose, along with `inputSchema` and `outputSchema` to describe the expected data.
|
|
114
112
|
|
|
115
|
-
```typescript
|
|
113
|
+
```typescript
|
|
116
114
|
export const weatherTool = createTool({
|
|
117
115
|
id: "weather-tool",
|
|
118
116
|
description: ` Retrieves current weather information using the wttr.in API.
|
|
@@ -286,7 +284,7 @@ const final = await stream.object;
|
|
|
286
284
|
|
|
287
285
|
## Related
|
|
288
286
|
|
|
289
|
-
- [Agent Memory](
|
|
290
|
-
- [Workflows Overview](
|
|
287
|
+
- [Agent Memory](https://mastra.ai/docs/agents/agent-memory)
|
|
288
|
+
- [Workflows Overview](https://mastra.ai/docs/workflows/overview)
|
|
291
289
|
- [Request Context](https://mastra.ai/docs/server/request-context)
|
|
292
290
|
- [Supervisor example](https://github.com/mastra-ai/mastra/tree/main/examples/supervisor-agent)
|