@mastra/mcp-docs-server 1.2.4-alpha.1 → 1.2.4-alpha.6
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/.docs/docs/agent-builder/access-control.md +2 -0
- package/.docs/docs/agent-builder/browser.md +2 -0
- package/.docs/docs/agent-builder/channels.md +2 -0
- package/.docs/docs/agent-builder/configuration.md +2 -0
- package/.docs/docs/agent-builder/deploying.md +2 -0
- package/.docs/docs/agent-builder/integrations.md +2 -0
- package/.docs/docs/agent-builder/memory.md +2 -0
- package/.docs/docs/agent-builder/model-policy.md +2 -0
- package/.docs/docs/agent-builder/overview.md +2 -0
- package/.docs/docs/agent-builder/skill-registries.md +2 -0
- package/.docs/docs/agent-builder/workspace.md +2 -0
- package/.docs/docs/agent-controller/modes.md +2 -0
- package/.docs/docs/agent-controller/overview.md +3 -0
- package/.docs/docs/agent-controller/session.md +2 -0
- package/.docs/docs/agent-controller/subagents.md +3 -0
- package/.docs/docs/agent-controller/threads-and-state.md +3 -0
- package/.docs/docs/agent-controller/tool-approvals.md +2 -0
- package/.docs/docs/agents/a2a.md +2 -0
- package/.docs/docs/agents/acp.md +2 -0
- package/.docs/docs/agents/adding-voice.md +2 -0
- package/.docs/docs/agents/agent-approval.md +2 -0
- package/.docs/docs/agents/background-tasks.md +5 -3
- package/.docs/docs/agents/channels.md +6 -1
- package/.docs/docs/agents/code-mode.md +4 -0
- package/.docs/docs/agents/durable-agents.md +3 -1
- package/.docs/docs/agents/file-based-agents.md +13 -2
- package/.docs/docs/agents/goals.md +4 -0
- package/.docs/docs/agents/guardrails.md +2 -0
- package/.docs/docs/agents/heartbeats.md +3 -1
- package/.docs/docs/agents/networks.md +2 -0
- package/.docs/docs/agents/overview.md +112 -0
- package/.docs/docs/agents/processors.md +10 -2
- package/.docs/docs/agents/sdk-agents.md +2 -0
- package/.docs/docs/agents/signal-providers.md +2 -0
- package/.docs/docs/agents/signals.md +2 -0
- package/.docs/docs/agents/skills.md +2 -0
- package/.docs/docs/agents/structured-output.md +2 -0
- package/.docs/docs/agents/supervisor-agents.md +3 -0
- package/.docs/docs/agents/using-tools.md +5 -0
- package/.docs/docs/browser/agent-browser.md +2 -0
- package/.docs/docs/browser/browser-viewer.md +2 -0
- package/.docs/docs/browser/overview.md +2 -0
- package/.docs/docs/browser/recording.md +6 -2
- package/.docs/docs/browser/stagehand.md +2 -0
- package/.docs/docs/community/contributing-templates.md +2 -0
- package/.docs/docs/community/discord.md +2 -0
- package/.docs/docs/community/licensing.md +2 -0
- package/.docs/docs/deployment/cloud-providers.md +2 -0
- package/.docs/docs/deployment/mastra-server.md +2 -0
- package/.docs/docs/deployment/monorepo.md +2 -0
- package/.docs/docs/deployment/overview.md +2 -0
- package/.docs/docs/deployment/web-framework.md +2 -0
- package/.docs/docs/deployment/workflow-runners.md +2 -0
- package/.docs/docs/editor/overview.md +3 -0
- package/.docs/docs/editor/prompts.md +2 -0
- package/.docs/docs/editor/tools.md +2 -0
- package/.docs/docs/evals/built-in-scorers.md +2 -0
- package/.docs/docs/evals/custom-scorers.md +2 -0
- package/.docs/docs/evals/datasets/overview.md +2 -0
- package/.docs/docs/evals/datasets/running-experiments.md +2 -0
- package/.docs/docs/evals/evals-with-memory.md +2 -0
- package/.docs/docs/evals/gates-and-verdicts.md +2 -0
- package/.docs/docs/evals/overview.md +3 -0
- package/.docs/docs/evals/quick-checks.md +3 -0
- package/.docs/docs/evals/running-in-ci.md +2 -0
- package/.docs/docs/getting-started/build-with-ai.md +5 -5
- package/.docs/docs/getting-started/manual-install.md +17 -5
- package/.docs/docs/getting-started/project-structure.md +2 -0
- package/.docs/docs/index.md +112 -0
- package/.docs/docs/mastra-platform/configuration.md +2 -0
- package/.docs/docs/mastra-platform/database.md +2 -0
- package/.docs/docs/mastra-platform/github.md +2 -0
- package/.docs/docs/mastra-platform/observability.md +2 -0
- package/.docs/docs/mastra-platform/overview.md +2 -0
- package/.docs/docs/mastra-platform/server.md +2 -0
- package/.docs/docs/mastra-platform/studio.md +2 -0
- package/.docs/docs/mcp/mcp-apps.md +2 -0
- package/.docs/docs/mcp/overview.md +2 -0
- package/.docs/docs/memory/memory-processors.md +4 -0
- package/.docs/docs/memory/message-history.md +2 -0
- package/.docs/docs/memory/multi-user-threads.md +2 -0
- package/.docs/docs/memory/observational-memory.md +6 -0
- package/.docs/docs/memory/overview.md +5 -1
- package/.docs/docs/memory/semantic-recall.md +8 -0
- package/.docs/docs/memory/storage.md +6 -0
- package/.docs/docs/memory/working-memory.md +2 -0
- package/.docs/docs/observability/config.md +2 -0
- package/.docs/docs/observability/integrations/bridges/datadog.md +2 -0
- package/.docs/docs/observability/integrations/bridges/otel.md +2 -0
- package/.docs/docs/observability/integrations/exporters/arize.md +2 -0
- package/.docs/docs/observability/integrations/exporters/arthur.md +2 -0
- package/.docs/docs/observability/integrations/exporters/braintrust.md +2 -0
- package/.docs/docs/observability/integrations/exporters/datadog.md +2 -0
- package/.docs/docs/observability/integrations/exporters/laminar.md +2 -0
- package/.docs/docs/observability/integrations/exporters/langfuse.md +3 -0
- package/.docs/docs/observability/integrations/exporters/langsmith.md +2 -0
- package/.docs/docs/observability/integrations/exporters/mastra-platform.md +2 -0
- package/.docs/docs/observability/integrations/exporters/mastra-storage.md +2 -0
- package/.docs/docs/observability/integrations/exporters/otel.md +2 -0
- package/.docs/docs/observability/integrations/exporters/posthog.md +2 -0
- package/.docs/docs/observability/integrations/exporters/sentry.md +2 -0
- package/.docs/docs/observability/integrations/overview.md +2 -0
- package/.docs/docs/observability/integrations/processors/sensitive-data-filter.md +2 -0
- package/.docs/docs/observability/logging.md +2 -0
- package/.docs/docs/observability/metrics/overview.md +2 -0
- package/.docs/docs/observability/metrics/querying.md +2 -0
- package/.docs/docs/observability/overview.md +2 -0
- package/.docs/docs/observability/storage.md +2 -0
- package/.docs/docs/observability/tracing/overview.md +2 -0
- package/.docs/docs/rag/chunking-and-embedding.md +2 -0
- package/.docs/docs/rag/graph-rag.md +2 -0
- package/.docs/docs/rag/overview.md +2 -0
- package/.docs/docs/rag/retrieval.md +2 -0
- package/.docs/docs/rag/vector-databases.md +2 -0
- package/.docs/docs/server/auth/auth0.md +2 -0
- package/.docs/docs/server/auth/better-auth.md +2 -0
- package/.docs/docs/server/auth/clerk.md +2 -0
- package/.docs/docs/server/auth/composite-auth.md +2 -0
- package/.docs/docs/server/auth/custom-auth-provider.md +2 -0
- package/.docs/docs/server/auth/fga.md +2 -0
- package/.docs/docs/server/auth/firebase.md +2 -0
- package/.docs/docs/server/auth/google.md +2 -0
- package/.docs/docs/server/auth/jwt.md +2 -0
- package/.docs/docs/server/auth/okta.md +2 -0
- package/.docs/docs/server/auth/simple-auth.md +2 -0
- package/.docs/docs/server/auth/supabase.md +2 -0
- package/.docs/docs/server/auth/workos.md +2 -0
- package/.docs/docs/server/auth.md +2 -0
- package/.docs/docs/server/custom-adapters.md +2 -0
- package/.docs/docs/server/custom-api-routes.md +2 -0
- package/.docs/docs/server/mastra-client.md +2 -0
- package/.docs/docs/server/mastra-server.md +2 -0
- package/.docs/docs/server/middleware.md +2 -0
- package/.docs/docs/server/pubsub.md +2 -0
- package/.docs/docs/server/request-context.md +2 -0
- package/.docs/docs/server/server-adapters.md +2 -0
- package/.docs/docs/studio/auth.md +2 -0
- package/.docs/docs/studio/deployment.md +2 -0
- package/.docs/docs/studio/observability.md +2 -0
- package/.docs/docs/studio/overview.md +2 -0
- package/.docs/docs/voice/overview.md +2 -0
- package/.docs/docs/voice/speech-to-speech.md +2 -0
- package/.docs/docs/voice/speech-to-text.md +2 -0
- package/.docs/docs/voice/text-to-speech.md +2 -0
- package/.docs/docs/workflows/agents-and-tools.md +2 -0
- package/.docs/docs/workflows/control-flow.md +2 -0
- package/.docs/docs/workflows/error-handling.md +2 -0
- package/.docs/docs/workflows/human-in-the-loop.md +2 -0
- package/.docs/docs/workflows/overview.md +2 -0
- package/.docs/docs/workflows/scheduled-workflows.md +2 -0
- package/.docs/docs/workflows/snapshots.md +2 -0
- package/.docs/docs/workflows/suspend-and-resume.md +2 -0
- package/.docs/docs/workflows/time-travel.md +2 -0
- package/.docs/docs/workflows/workflow-state.md +2 -0
- package/.docs/docs/workspace/filesystem.md +5 -1
- package/.docs/docs/workspace/lsp.md +2 -0
- package/.docs/docs/workspace/overview.md +2 -0
- package/.docs/docs/workspace/sandbox.md +4 -0
- package/.docs/docs/workspace/search.md +2 -0
- package/.docs/docs/workspace/skills.md +2 -0
- package/.docs/guides/agent-frameworks/ai-sdk.md +2 -0
- package/.docs/guides/build-your-ui/ai-sdk-ui.md +2 -0
- package/.docs/guides/build-your-ui/assistant-ui.md +2 -0
- package/.docs/guides/build-your-ui/copilotkit.md +2 -0
- package/.docs/guides/build-your-ui/openui.md +2 -0
- package/.docs/guides/concepts/multi-agent-systems.md +2 -0
- package/.docs/guides/concepts/streaming.md +2 -0
- package/.docs/guides/deployment/amazon-ec2.md +2 -0
- package/.docs/guides/deployment/aws-bedrock-agentcore.md +2 -0
- package/.docs/guides/deployment/aws-lambda.md +2 -0
- package/.docs/guides/deployment/azure-app-services.md +2 -0
- package/.docs/guides/deployment/cloudflare.md +2 -0
- package/.docs/guides/deployment/digital-ocean.md +2 -0
- package/.docs/guides/deployment/inngest.md +2 -0
- package/.docs/guides/deployment/netlify.md +2 -0
- package/.docs/guides/deployment/temporal.md +2 -0
- package/.docs/guides/deployment/vercel.md +2 -0
- package/.docs/guides/getting-started/astro.md +2 -0
- package/.docs/guides/getting-started/electron.md +2 -0
- package/.docs/guides/getting-started/express.md +2 -0
- package/.docs/guides/getting-started/hono.md +2 -0
- package/.docs/guides/getting-started/nestjs.md +2 -0
- package/.docs/guides/getting-started/next-js.md +2 -0
- package/.docs/guides/getting-started/nuxt.md +2 -0
- package/.docs/guides/getting-started/quickstart.md +4 -0
- package/.docs/guides/getting-started/sveltekit.md +2 -0
- package/.docs/guides/getting-started/vite-react.md +2 -0
- package/.docs/guides/guide/ai-recruiter.md +2 -0
- package/.docs/guides/guide/chef-michel.md +2 -0
- package/.docs/guides/guide/code-review-bot.md +2 -0
- package/.docs/guides/guide/dev-assistant.md +2 -0
- package/.docs/guides/guide/docs-manager.md +2 -0
- package/.docs/guides/guide/firecrawl.md +2 -0
- package/.docs/guides/guide/github-actions-pr-description.md +2 -0
- package/.docs/guides/guide/notes-mcp-server.md +2 -0
- package/.docs/guides/guide/publishing-mcp-server.md +2 -0
- package/.docs/guides/guide/research-assistant.md +2 -0
- package/.docs/guides/guide/research-coordinator.md +2 -0
- package/.docs/guides/guide/signal-provider.md +2 -0
- package/.docs/guides/guide/slack-assistant.md +2 -0
- package/.docs/guides/guide/stock-agent.md +2 -0
- package/.docs/guides/guide/web-search.md +2 -0
- package/.docs/guides/guide/whatsapp-chat-bot.md +2 -0
- package/.docs/guides/index.md +2 -0
- package/.docs/guides/migrations/agentnetwork.md +3 -0
- package/.docs/guides/migrations/ai-sdk-v4-to-v5.md +2 -0
- package/.docs/guides/migrations/mastra-cloud.md +2 -0
- package/.docs/guides/migrations/network-to-supervisor.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/agent.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/cli.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/client.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/deployment.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/evals.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/mastra.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/mcp.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/memory.md +3 -0
- package/.docs/guides/migrations/upgrade-to-v1/overview.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/processors.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/rag.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/storage.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/tools.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/tracing.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/vectors.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/voice.md +3 -0
- package/.docs/guides/migrations/upgrade-to-v1/workflows.md +2 -0
- package/.docs/guides/migrations/vnext-to-standard-apis.md +2 -0
- package/.docs/models/embeddings.md +2 -0
- package/.docs/models/environment-variables.md +144 -0
- package/.docs/models/gateways/azure-openai.md +2 -0
- package/.docs/models/gateways/custom-gateways.md +2 -0
- package/.docs/models/gateways/mastra.md +2 -0
- package/.docs/models/gateways/netlify.md +5 -2
- package/.docs/models/gateways/openrouter.md +4 -1
- package/.docs/models/gateways/vercel.md +4 -1
- package/.docs/models/gateways.md +2 -0
- package/.docs/models/index.md +10 -8
- package/.docs/models/providers/302ai.md +2 -0
- package/.docs/models/providers/abacus.md +2 -0
- package/.docs/models/providers/abliteration-ai.md +2 -0
- package/.docs/models/providers/agentrouter.md +2 -0
- package/.docs/models/providers/aihubmix.md +2 -0
- package/.docs/models/providers/alibaba-cn.md +2 -0
- package/.docs/models/providers/alibaba-coding-plan-cn.md +2 -0
- package/.docs/models/providers/alibaba-coding-plan.md +2 -0
- package/.docs/models/providers/alibaba-token-plan-cn.md +2 -0
- package/.docs/models/providers/alibaba-token-plan.md +2 -0
- package/.docs/models/providers/alibaba.md +2 -0
- package/.docs/models/providers/amazon-bedrock.md +2 -0
- package/.docs/models/providers/ambient.md +2 -0
- package/.docs/models/providers/anthropic.md +2 -0
- package/.docs/models/providers/anyapi.md +2 -0
- package/.docs/models/providers/atomic-chat.md +2 -0
- package/.docs/models/providers/auriko.md +2 -0
- package/.docs/models/providers/azure.md +2 -0
- package/.docs/models/providers/bailing.md +2 -0
- package/.docs/models/providers/baseten.md +2 -0
- package/.docs/models/providers/berget.md +2 -0
- package/.docs/models/providers/cerebras.md +7 -4
- package/.docs/models/providers/chutes.md +2 -0
- package/.docs/models/providers/clarifai.md +2 -0
- package/.docs/models/providers/claudinio.md +2 -0
- package/.docs/models/providers/cloudferro-sherlock.md +2 -0
- package/.docs/models/providers/cloudflare-ai-gateway.md +2 -0
- package/.docs/models/providers/cloudflare-workers-ai.md +2 -0
- package/.docs/models/providers/cohere.md +2 -0
- package/.docs/models/providers/cortecs.md +2 -0
- package/.docs/models/providers/crof.md +2 -0
- package/.docs/models/providers/databricks.md +2 -0
- package/.docs/models/providers/deepinfra.md +2 -0
- package/.docs/models/providers/deepseek.md +2 -0
- package/.docs/models/providers/digitalocean.md +2 -0
- package/.docs/models/providers/dinference.md +2 -0
- package/.docs/models/providers/drun.md +2 -0
- package/.docs/models/providers/evroc.md +2 -0
- package/.docs/models/providers/fastrouter.md +2 -0
- package/.docs/models/providers/firepass.md +2 -0
- package/.docs/models/providers/fireworks-ai.md +2 -0
- package/.docs/models/providers/firmware.md +2 -0
- package/.docs/models/providers/freemodel.md +2 -0
- package/.docs/models/providers/friendli.md +2 -0
- package/.docs/models/providers/frogbot.md +2 -0
- package/.docs/models/providers/github-models.md +2 -0
- package/.docs/models/providers/gmicloud.md +5 -1
- package/.docs/models/providers/google-vertex.md +2 -0
- package/.docs/models/providers/google.md +5 -1
- package/.docs/models/providers/groq.md +2 -0
- package/.docs/models/providers/helicone.md +2 -0
- package/.docs/models/providers/hpc-ai.md +2 -0
- package/.docs/models/providers/huggingface.md +2 -0
- package/.docs/models/providers/iflowcn.md +2 -0
- package/.docs/models/providers/inception.md +2 -0
- package/.docs/models/providers/inceptron.md +2 -0
- package/.docs/models/providers/inference.md +2 -0
- package/.docs/models/providers/io-intelligence.md +2 -0
- package/.docs/models/providers/io-net.md +2 -0
- package/.docs/models/providers/jiekou.md +2 -0
- package/.docs/models/providers/kilo.md +2 -0
- package/.docs/models/providers/kimi-for-coding.md +2 -0
- package/.docs/models/providers/kiro.md +2 -0
- package/.docs/models/providers/kuae-cloud-coding-plan.md +2 -0
- package/.docs/models/providers/lilac.md +2 -0
- package/.docs/models/providers/llama.md +2 -0
- package/.docs/models/providers/llmgateway.md +4 -1
- package/.docs/models/providers/llmtr.md +2 -0
- package/.docs/models/providers/lmstudio.md +2 -0
- package/.docs/models/providers/lucidquery.md +2 -0
- package/.docs/models/providers/meganova.md +2 -0
- package/.docs/models/providers/minimax-cn-coding-plan.md +2 -0
- package/.docs/models/providers/minimax-cn.md +2 -0
- package/.docs/models/providers/minimax-coding-plan.md +2 -0
- package/.docs/models/providers/minimax.md +2 -0
- package/.docs/models/providers/mistral.md +2 -0
- package/.docs/models/providers/mixlayer.md +2 -0
- package/.docs/models/providers/moark.md +2 -0
- package/.docs/models/providers/modelscope.md +2 -0
- package/.docs/models/providers/moonshotai-cn.md +2 -0
- package/.docs/models/providers/moonshotai.md +2 -0
- package/.docs/models/providers/morph.md +2 -0
- package/.docs/models/providers/nano-gpt.md +2 -0
- package/.docs/models/providers/nearai.md +2 -0
- package/.docs/models/providers/nebius.md +2 -0
- package/.docs/models/providers/neon.md +2 -0
- package/.docs/models/providers/neuralwatt.md +2 -0
- package/.docs/models/providers/nova.md +2 -0
- package/.docs/models/providers/novita-ai.md +2 -0
- package/.docs/models/providers/nvidia.md +2 -0
- package/.docs/models/providers/ollama-cloud.md +2 -0
- package/.docs/models/providers/ollama.md +2 -0
- package/.docs/models/providers/openai.md +2 -0
- package/.docs/models/providers/opencode-go.md +2 -0
- package/.docs/models/providers/opencode.md +4 -1
- package/.docs/models/providers/orcarouter.md +2 -0
- package/.docs/models/providers/ovhcloud.md +2 -0
- package/.docs/models/providers/perplexity-agent.md +2 -0
- package/.docs/models/providers/perplexity.md +2 -0
- package/.docs/models/providers/poe.md +2 -0
- package/.docs/models/providers/poolside.md +2 -0
- package/.docs/models/providers/privatemode-ai.md +2 -0
- package/.docs/models/providers/qihang-ai.md +2 -0
- package/.docs/models/providers/qiniu-ai.md +2 -0
- package/.docs/models/providers/regolo-ai.md +2 -0
- package/.docs/models/providers/requesty.md +2 -0
- package/.docs/models/providers/routing-run.md +2 -0
- package/.docs/models/providers/sakana.md +2 -0
- package/.docs/models/providers/sarvam.md +2 -0
- package/.docs/models/providers/scaleway.md +2 -0
- package/.docs/models/providers/siliconflow-cn.md +2 -0
- package/.docs/models/providers/siliconflow.md +2 -0
- package/.docs/models/providers/snowflake-cortex.md +2 -0
- package/.docs/models/providers/stackit.md +2 -0
- package/.docs/models/providers/stepfun-ai.md +2 -0
- package/.docs/models/providers/stepfun.md +2 -0
- package/.docs/models/providers/subconscious.md +2 -0
- package/.docs/models/providers/submodel.md +2 -0
- package/.docs/models/providers/synthetic.md +4 -5
- package/.docs/models/providers/tencent-coding-plan.md +2 -0
- package/.docs/models/providers/tencent-token-plan.md +2 -0
- package/.docs/models/providers/tencent-tokenhub.md +2 -0
- package/.docs/models/providers/the-grid-ai.md +2 -0
- package/.docs/models/providers/tinfoil.md +2 -0
- package/.docs/models/providers/togetherai.md +2 -0
- package/.docs/models/providers/umans-ai-coding-plan.md +2 -0
- package/.docs/models/providers/umans-ai.md +2 -0
- package/.docs/models/providers/upstage.md +2 -0
- package/.docs/models/providers/venice.md +2 -0
- package/.docs/models/providers/vivgrid.md +2 -0
- package/.docs/models/providers/vultr.md +2 -0
- package/.docs/models/providers/wafer.ai.md +2 -0
- package/.docs/models/providers/wandb.md +2 -0
- package/.docs/models/providers/xai.md +2 -0
- package/.docs/models/providers/xiaomi-token-plan-ams.md +2 -0
- package/.docs/models/providers/xiaomi-token-plan-cn.md +2 -0
- package/.docs/models/providers/xiaomi-token-plan-sgp.md +2 -0
- package/.docs/models/providers/xiaomi.md +2 -0
- package/.docs/models/providers/xpersona.md +2 -0
- package/.docs/models/providers/zai-coding-plan.md +2 -0
- package/.docs/models/providers/zai.md +2 -0
- package/.docs/models/providers/zeldoc.md +2 -0
- package/.docs/models/providers/zenmux.md +2 -0
- package/.docs/models/providers/zhipuai-coding-plan.md +2 -0
- package/.docs/models/providers/zhipuai.md +3 -1
- package/.docs/models/providers.md +2 -0
- package/.docs/reference/acp/acp-agent.md +2 -0
- package/.docs/reference/acp/create-acp-tool.md +2 -0
- package/.docs/reference/agent-controller/agent-controller-class.md +2 -0
- package/.docs/reference/agent-controller/session.md +2 -0
- package/.docs/reference/agents/agent.md +35 -4
- package/.docs/reference/agents/channels.md +7 -0
- package/.docs/reference/agents/createSkill.md +2 -0
- package/.docs/reference/agents/durable-agent.md +2 -0
- package/.docs/reference/agents/generate.md +94 -92
- package/.docs/reference/agents/generateLegacy.md +2 -0
- package/.docs/reference/agents/getDefaultGenerateOptions.md +2 -0
- package/.docs/reference/agents/getDefaultOptions.md +2 -0
- package/.docs/reference/agents/getDefaultStreamOptions.md +2 -0
- package/.docs/reference/agents/getDescription.md +2 -0
- package/.docs/reference/agents/getInstructions.md +2 -0
- package/.docs/reference/agents/getLLM.md +2 -0
- package/.docs/reference/agents/getMemory.md +2 -0
- package/.docs/reference/agents/getMetadata.md +2 -0
- package/.docs/reference/agents/getModel.md +2 -0
- package/.docs/reference/agents/getSkill.md +2 -0
- package/.docs/reference/agents/getTools.md +2 -0
- package/.docs/reference/agents/getVoice.md +2 -0
- package/.docs/reference/agents/inngest-agent.md +2 -0
- package/.docs/reference/agents/listAgents.md +2 -0
- package/.docs/reference/agents/listScorers.md +2 -0
- package/.docs/reference/agents/listSkills.md +2 -0
- package/.docs/reference/agents/listSuspendedRuns.md +2 -0
- package/.docs/reference/agents/listTools.md +2 -0
- package/.docs/reference/agents/listWorkflows.md +2 -0
- package/.docs/reference/agents/network.md +2 -0
- package/.docs/reference/ai-sdk/chat-route.md +2 -0
- package/.docs/reference/ai-sdk/handle-chat-stream.md +2 -0
- package/.docs/reference/ai-sdk/handle-network-stream.md +2 -0
- package/.docs/reference/ai-sdk/handle-workflow-stream.md +2 -0
- package/.docs/reference/ai-sdk/network-route.md +2 -0
- package/.docs/reference/ai-sdk/to-ai-sdk-messages.md +2 -0
- package/.docs/reference/ai-sdk/to-ai-sdk-stream.md +2 -0
- package/.docs/reference/ai-sdk/to-ai-sdk-v4-messages.md +2 -0
- package/.docs/reference/ai-sdk/to-ai-sdk-v5-messages.md +2 -0
- package/.docs/reference/ai-sdk/with-mastra.md +2 -0
- package/.docs/reference/ai-sdk/workflow-route.md +2 -0
- package/.docs/reference/ai-sdk/workflow-snapshot-to-stream.md +2 -0
- package/.docs/reference/auth/auth0.md +2 -0
- package/.docs/reference/auth/better-auth.md +2 -0
- package/.docs/reference/auth/clerk.md +2 -0
- package/.docs/reference/auth/firebase.md +2 -0
- package/.docs/reference/auth/google.md +2 -0
- package/.docs/reference/auth/jwt.md +2 -0
- package/.docs/reference/auth/okta.md +2 -0
- package/.docs/reference/auth/supabase.md +2 -0
- package/.docs/reference/auth/workos.md +2 -0
- package/.docs/reference/browser/agent-browser.md +2 -0
- package/.docs/reference/browser/browser-viewer.md +2 -0
- package/.docs/reference/browser/mastra-browser.md +2 -0
- package/.docs/reference/browser/stagehand-browser.md +2 -0
- package/.docs/reference/channels/channel-provider.md +2 -0
- package/.docs/reference/channels/slack-provider.md +2 -0
- package/.docs/reference/cli/create-mastra.md +2 -0
- package/.docs/reference/cli/mastra.md +2 -0
- package/.docs/reference/client-js/agent-builder.md +2 -0
- package/.docs/reference/client-js/agents.md +2 -0
- package/.docs/reference/client-js/conversations.md +2 -0
- package/.docs/reference/client-js/error-handling.md +2 -0
- package/.docs/reference/client-js/logs.md +2 -0
- package/.docs/reference/client-js/mastra-client.md +2 -0
- package/.docs/reference/client-js/memory.md +2 -0
- package/.docs/reference/client-js/observability.md +2 -0
- package/.docs/reference/client-js/responses.md +2 -0
- package/.docs/reference/client-js/telemetry.md +2 -0
- package/.docs/reference/client-js/tools.md +2 -0
- package/.docs/reference/client-js/vectors.md +2 -0
- package/.docs/reference/client-js/workflows.md +2 -0
- package/.docs/reference/coding-agent/build-base-prompt.md +2 -0
- package/.docs/reference/coding-agent/create-coding-agent.md +2 -0
- package/.docs/reference/configuration.md +2 -0
- package/.docs/reference/core/addGateway.md +2 -0
- package/.docs/reference/core/getAgent.md +2 -0
- package/.docs/reference/core/getAgentById.md +2 -0
- package/.docs/reference/core/getDeployer.md +2 -0
- package/.docs/reference/core/getEditor.md +2 -0
- package/.docs/reference/core/getGateway.md +2 -0
- package/.docs/reference/core/getGatewayById.md +2 -0
- package/.docs/reference/core/getLogger.md +2 -0
- package/.docs/reference/core/getMCPServer.md +2 -0
- package/.docs/reference/core/getMCPServerById.md +2 -0
- package/.docs/reference/core/getMemory.md +2 -0
- package/.docs/reference/core/getScorer.md +2 -0
- package/.docs/reference/core/getScorerById.md +2 -0
- package/.docs/reference/core/getServer.md +2 -0
- package/.docs/reference/core/getStorage.md +2 -0
- package/.docs/reference/core/getTelemetry.md +2 -0
- package/.docs/reference/core/getVector.md +2 -0
- package/.docs/reference/core/getWorkflow.md +2 -0
- package/.docs/reference/core/listAgents.md +2 -0
- package/.docs/reference/core/listGateways.md +2 -0
- package/.docs/reference/core/listLogs.md +2 -0
- package/.docs/reference/core/listLogsByRunId.md +2 -0
- package/.docs/reference/core/listMCPServers.md +2 -0
- package/.docs/reference/core/listMemory.md +2 -0
- package/.docs/reference/core/listScorers.md +2 -0
- package/.docs/reference/core/listVectors.md +2 -0
- package/.docs/reference/core/listWorkflows.md +2 -0
- package/.docs/reference/core/mastra-class.md +2 -0
- package/.docs/reference/core/mastra-model-gateway.md +2 -0
- package/.docs/reference/core/removeWorkspace.md +2 -0
- package/.docs/reference/core/setLogger.md +2 -0
- package/.docs/reference/core/setStorage.md +2 -0
- package/.docs/reference/datasets/addItem.md +2 -0
- package/.docs/reference/datasets/addItems.md +2 -0
- package/.docs/reference/datasets/compareExperiments.md +2 -0
- package/.docs/reference/datasets/create.md +2 -0
- package/.docs/reference/datasets/dataset.md +2 -0
- package/.docs/reference/datasets/datasets-manager.md +2 -0
- package/.docs/reference/datasets/delete.md +2 -0
- package/.docs/reference/datasets/deleteExperiment.md +2 -0
- package/.docs/reference/datasets/deleteItem.md +2 -0
- package/.docs/reference/datasets/deleteItems.md +2 -0
- package/.docs/reference/datasets/get.md +2 -0
- package/.docs/reference/datasets/getDetails.md +2 -0
- package/.docs/reference/datasets/getExperiment.md +2 -0
- package/.docs/reference/datasets/getItem.md +2 -0
- package/.docs/reference/datasets/getItemHistory.md +2 -0
- package/.docs/reference/datasets/list.md +2 -0
- package/.docs/reference/datasets/listExperimentResults.md +2 -0
- package/.docs/reference/datasets/listExperiments.md +2 -0
- package/.docs/reference/datasets/listItems.md +2 -0
- package/.docs/reference/datasets/listVersions.md +2 -0
- package/.docs/reference/datasets/startExperiment.md +2 -0
- package/.docs/reference/datasets/startExperimentAsync.md +2 -0
- package/.docs/reference/datasets/update.md +2 -0
- package/.docs/reference/datasets/updateItem.md +2 -0
- package/.docs/reference/deployer/cloudflare.md +2 -0
- package/.docs/reference/deployer/netlify.md +2 -0
- package/.docs/reference/deployer/vercel.md +2 -0
- package/.docs/reference/deployer.md +2 -0
- package/.docs/reference/editor/agent-builder/agent-builder-options.md +2 -0
- package/.docs/reference/editor/agent-builder/builder-agent-defaults.md +2 -0
- package/.docs/reference/editor/agent-builder/builder-models.md +2 -0
- package/.docs/reference/editor/blob-store-provider.md +2 -0
- package/.docs/reference/editor/browser-provider.md +2 -0
- package/.docs/reference/editor/filesystem-provider.md +2 -0
- package/.docs/reference/editor/mastra-editor.md +2 -0
- package/.docs/reference/editor/processor-provider.md +2 -0
- package/.docs/reference/editor/sandbox-provider.md +2 -0
- package/.docs/reference/editor/storage-browser-ref.md +2 -0
- package/.docs/reference/editor/storage-workspace-ref.md +2 -0
- package/.docs/reference/editor/tool-provider.md +2 -0
- package/.docs/reference/evals/answer-relevancy.md +2 -0
- package/.docs/reference/evals/answer-similarity.md +2 -0
- package/.docs/reference/evals/bias.md +2 -0
- package/.docs/reference/evals/checks.md +2 -0
- package/.docs/reference/evals/completeness.md +2 -0
- package/.docs/reference/evals/content-similarity.md +2 -0
- package/.docs/reference/evals/context-precision.md +2 -0
- package/.docs/reference/evals/context-relevance.md +2 -0
- package/.docs/reference/evals/create-scorer.md +2 -0
- package/.docs/reference/evals/faithfulness.md +2 -0
- package/.docs/reference/evals/filter-run.md +2 -0
- package/.docs/reference/evals/hallucination.md +3 -0
- package/.docs/reference/evals/keyword-coverage.md +2 -0
- package/.docs/reference/evals/mastra-scorer.md +2 -0
- package/.docs/reference/evals/noise-sensitivity.md +2 -0
- package/.docs/reference/evals/prompt-alignment.md +3 -0
- package/.docs/reference/evals/rubric.md +2 -0
- package/.docs/reference/evals/run-evals.md +2 -0
- package/.docs/reference/evals/scorer-utils.md +2 -0
- package/.docs/reference/evals/textual-difference.md +2 -0
- package/.docs/reference/evals/tone-consistency.md +2 -0
- package/.docs/reference/evals/tool-call-accuracy.md +2 -0
- package/.docs/reference/evals/toxicity.md +2 -0
- package/.docs/reference/evals/trajectory-accuracy.md +2 -0
- package/.docs/reference/index.md +5 -0
- package/.docs/reference/logging/pino-logger.md +2 -0
- package/.docs/reference/mastra-platform/api.md +2 -0
- package/.docs/reference/memory/clone-utilities.md +2 -0
- package/.docs/reference/memory/cloneThread.md +2 -0
- package/.docs/reference/memory/createThread.md +2 -0
- package/.docs/reference/memory/deleteMessages.md +2 -0
- package/.docs/reference/memory/getThreadById.md +2 -0
- package/.docs/reference/memory/listThreads.md +2 -0
- package/.docs/reference/memory/memory-class.md +3 -0
- package/.docs/reference/memory/observational-memory.md +10 -0
- package/.docs/reference/memory/recall.md +2 -0
- package/.docs/reference/memory/serialized-memory-config.md +2 -0
- package/.docs/reference/observability/metrics/automatic-metrics.md +2 -0
- package/.docs/reference/observability/tracing/bridges/datadog.md +2 -0
- package/.docs/reference/observability/tracing/bridges/otel.md +2 -0
- package/.docs/reference/observability/tracing/configuration.md +2 -0
- package/.docs/reference/observability/tracing/exporters/arize.md +2 -0
- package/.docs/reference/observability/tracing/exporters/arthur.md +2 -0
- package/.docs/reference/observability/tracing/exporters/braintrust.md +2 -0
- package/.docs/reference/observability/tracing/exporters/cloud-exporter.md +2 -0
- package/.docs/reference/observability/tracing/exporters/console-exporter.md +2 -0
- package/.docs/reference/observability/tracing/exporters/datadog.md +2 -0
- package/.docs/reference/observability/tracing/exporters/default-exporter.md +2 -0
- package/.docs/reference/observability/tracing/exporters/laminar.md +2 -0
- package/.docs/reference/observability/tracing/exporters/langfuse.md +3 -0
- package/.docs/reference/observability/tracing/exporters/langsmith.md +2 -0
- package/.docs/reference/observability/tracing/exporters/mastra-platform-exporter.md +2 -0
- package/.docs/reference/observability/tracing/exporters/mastra-storage-exporter.md +2 -0
- package/.docs/reference/observability/tracing/exporters/otel.md +2 -0
- package/.docs/reference/observability/tracing/exporters/posthog.md +2 -0
- package/.docs/reference/observability/tracing/exporters/sentry.md +2 -0
- package/.docs/reference/observability/tracing/instances.md +2 -0
- package/.docs/reference/observability/tracing/interfaces.md +2 -0
- package/.docs/reference/observability/tracing/processors/sensitive-data-filter.md +2 -0
- package/.docs/reference/observability/tracing/span-filtering.md +2 -0
- package/.docs/reference/observability/tracing/spans.md +2 -0
- package/.docs/reference/processors/batch-parts-processor.md +3 -0
- package/.docs/reference/processors/cost-guard-processor.md +3 -0
- package/.docs/reference/processors/language-detector.md +2 -0
- package/.docs/reference/processors/message-history-processor.md +3 -0
- package/.docs/reference/processors/moderation-processor.md +4 -0
- package/.docs/reference/processors/pii-detector.md +4 -0
- package/.docs/reference/processors/prefill-error-handler.md +4 -0
- package/.docs/reference/processors/processor-interface.md +5 -2
- package/.docs/reference/processors/prompt-injection-detector.md +3 -0
- package/.docs/reference/processors/provider-history-compat.md +4 -0
- package/.docs/reference/processors/regex-filter-processor.md +3 -0
- package/.docs/reference/processors/response-cache.md +3 -0
- package/.docs/reference/processors/semantic-recall-processor.md +3 -0
- package/.docs/reference/processors/skill-search-processor.md +3 -0
- package/.docs/reference/processors/stream-error-retry-processor.md +4 -0
- package/.docs/reference/processors/system-prompt-scrubber.md +3 -0
- package/.docs/reference/processors/token-limiter-processor.md +5 -0
- package/.docs/reference/processors/tool-call-filter.md +4 -0
- package/.docs/reference/processors/tool-search-processor.md +4 -0
- package/.docs/reference/processors/unicode-normalizer.md +2 -0
- package/.docs/reference/processors/working-memory-processor.md +3 -0
- package/.docs/reference/pubsub/base.md +2 -0
- package/.docs/reference/pubsub/caching-pubsub.md +2 -0
- package/.docs/reference/pubsub/event-emitter.md +2 -0
- package/.docs/reference/pubsub/google-cloud-pubsub.md +2 -0
- package/.docs/reference/pubsub/lease-provider.md +2 -0
- package/.docs/reference/pubsub/redis-streams.md +2 -0
- package/.docs/reference/pubsub/unix-socket-pubsub.md +2 -0
- package/.docs/reference/rag/chunk.md +2 -0
- package/.docs/reference/rag/database-config.md +2 -0
- package/.docs/reference/rag/document.md +2 -0
- package/.docs/reference/rag/embeddings.md +2 -0
- package/.docs/reference/rag/extract-params.md +2 -0
- package/.docs/reference/rag/graph-rag.md +2 -0
- package/.docs/reference/rag/metadata-filters.md +2 -0
- package/.docs/reference/rag/rerank.md +2 -0
- package/.docs/reference/rag/rerankWithScorer.md +2 -0
- package/.docs/reference/server/create-route.md +2 -0
- package/.docs/reference/server/express-adapter.md +2 -0
- package/.docs/reference/server/fastify-adapter.md +2 -0
- package/.docs/reference/server/hono-adapter.md +2 -0
- package/.docs/reference/server/koa-adapter.md +2 -0
- package/.docs/reference/server/mastra-server.md +2 -0
- package/.docs/reference/server/nestjs-adapter.md +2 -0
- package/.docs/reference/server/register-api-route.md +2 -0
- package/.docs/reference/server/routes.md +2 -0
- package/.docs/reference/signals/create-notification-inbox-tool.md +2 -0
- package/.docs/reference/signals/signal-provider.md +3 -0
- package/.docs/reference/signals/task-signal-provider.md +3 -0
- package/.docs/reference/signals/webhook-signal-provider.md +3 -0
- package/.docs/reference/storage/clickhouse.md +2 -0
- package/.docs/reference/storage/cloudflare-d1.md +2 -0
- package/.docs/reference/storage/cloudflare.md +2 -0
- package/.docs/reference/storage/composite.md +2 -0
- package/.docs/reference/storage/convex.md +2 -0
- package/.docs/reference/storage/dsql.md +2 -0
- package/.docs/reference/storage/duckdb.md +2 -0
- package/.docs/reference/storage/dynamodb.md +2 -0
- package/.docs/reference/storage/lance.md +2 -0
- package/.docs/reference/storage/libsql.md +2 -0
- package/.docs/reference/storage/mongodb.md +2 -0
- package/.docs/reference/storage/mssql.md +2 -0
- package/.docs/reference/storage/overview.md +2 -0
- package/.docs/reference/storage/postgresql.md +2 -0
- package/.docs/reference/storage/redis.md +2 -0
- package/.docs/reference/storage/retention.md +180 -0
- package/.docs/reference/storage/spanner.md +2 -0
- package/.docs/reference/storage/upstash.md +2 -0
- package/.docs/reference/streaming/ChunkType.md +2 -0
- package/.docs/reference/streaming/agents/MastraModelOutput.md +2 -0
- package/.docs/reference/streaming/agents/stream.md +2 -0
- package/.docs/reference/streaming/agents/streamLegacy.md +2 -0
- package/.docs/reference/streaming/agents/streamUntilIdle.md +2 -0
- package/.docs/reference/streaming/workflows/observeStream.md +2 -0
- package/.docs/reference/streaming/workflows/resumeStream.md +2 -0
- package/.docs/reference/streaming/workflows/stream.md +2 -0
- package/.docs/reference/streaming/workflows/timeTravelStream.md +2 -0
- package/.docs/reference/templates/overview.md +3 -0
- package/.docs/reference/tools/brightdata.md +2 -0
- package/.docs/reference/tools/create-code-mode.md +3 -0
- package/.docs/reference/tools/create-tool.md +62 -58
- package/.docs/reference/tools/document-chunker-tool.md +2 -0
- package/.docs/reference/tools/graph-rag-tool.md +2 -0
- package/.docs/reference/tools/mcp-client.md +3 -0
- package/.docs/reference/tools/mcp-server.md +3 -1
- package/.docs/reference/tools/perplexity.md +2 -0
- package/.docs/reference/tools/tavily.md +2 -0
- package/.docs/reference/tools/vector-query-tool.md +2 -0
- package/.docs/reference/vectors/astra.md +2 -0
- package/.docs/reference/vectors/chroma.md +2 -0
- package/.docs/reference/vectors/convex.md +2 -0
- package/.docs/reference/vectors/couchbase.md +2 -0
- package/.docs/reference/vectors/duckdb.md +2 -0
- package/.docs/reference/vectors/elasticsearch.md +2 -0
- package/.docs/reference/vectors/lance.md +2 -0
- package/.docs/reference/vectors/libsql.md +2 -0
- package/.docs/reference/vectors/mongodb.md +2 -0
- package/.docs/reference/vectors/opensearch.md +2 -0
- package/.docs/reference/vectors/pg.md +2 -0
- package/.docs/reference/vectors/pinecone.md +2 -0
- package/.docs/reference/vectors/qdrant.md +2 -0
- package/.docs/reference/vectors/s3vectors.md +2 -0
- package/.docs/reference/vectors/turbopuffer.md +2 -0
- package/.docs/reference/vectors/upstash.md +2 -0
- package/.docs/reference/vectors/vectorize.md +2 -0
- package/.docs/reference/voice/aws-nova-sonic.md +2 -0
- package/.docs/reference/voice/azure.md +2 -0
- package/.docs/reference/voice/cloudflare.md +2 -0
- package/.docs/reference/voice/composite-voice.md +2 -0
- package/.docs/reference/voice/deepgram.md +2 -0
- package/.docs/reference/voice/elevenlabs.md +2 -0
- package/.docs/reference/voice/google-gemini-live.md +2 -0
- package/.docs/reference/voice/google.md +2 -0
- package/.docs/reference/voice/inworld-realtime.md +2 -0
- package/.docs/reference/voice/inworld.md +2 -0
- package/.docs/reference/voice/mastra-voice.md +2 -0
- package/.docs/reference/voice/murf.md +2 -0
- package/.docs/reference/voice/openai-realtime.md +2 -0
- package/.docs/reference/voice/openai.md +2 -0
- package/.docs/reference/voice/playai.md +2 -0
- package/.docs/reference/voice/sarvam.md +2 -0
- package/.docs/reference/voice/speechify.md +2 -0
- package/.docs/reference/voice/voice.addInstructions.md +3 -0
- package/.docs/reference/voice/voice.addTools.md +2 -0
- package/.docs/reference/voice/voice.answer.md +2 -0
- package/.docs/reference/voice/voice.close.md +2 -0
- package/.docs/reference/voice/voice.connect.md +2 -0
- package/.docs/reference/voice/voice.events.md +2 -0
- package/.docs/reference/voice/voice.getSpeakers.md +2 -0
- package/.docs/reference/voice/voice.listen.md +2 -0
- package/.docs/reference/voice/voice.off.md +2 -0
- package/.docs/reference/voice/voice.on.md +2 -0
- package/.docs/reference/voice/voice.send.md +2 -0
- package/.docs/reference/voice/voice.speak.md +2 -0
- package/.docs/reference/voice/voice.updateConfig.md +2 -0
- package/.docs/reference/voice/xai-realtime.md +2 -0
- package/.docs/reference/workflows/run-methods/cancel.md +2 -0
- package/.docs/reference/workflows/run-methods/restart.md +2 -0
- package/.docs/reference/workflows/run-methods/resume.md +2 -0
- package/.docs/reference/workflows/run-methods/start.md +2 -0
- package/.docs/reference/workflows/run-methods/startAsync.md +2 -0
- package/.docs/reference/workflows/run-methods/timeTravel.md +2 -0
- package/.docs/reference/workflows/run.md +2 -0
- package/.docs/reference/workflows/step.md +2 -0
- package/.docs/reference/workflows/workflow-methods/branch.md +2 -0
- package/.docs/reference/workflows/workflow-methods/commit.md +2 -0
- package/.docs/reference/workflows/workflow-methods/create-run.md +2 -0
- package/.docs/reference/workflows/workflow-methods/dountil.md +2 -0
- package/.docs/reference/workflows/workflow-methods/dowhile.md +2 -0
- package/.docs/reference/workflows/workflow-methods/foreach.md +2 -0
- package/.docs/reference/workflows/workflow-methods/map.md +2 -0
- package/.docs/reference/workflows/workflow-methods/parallel.md +2 -0
- package/.docs/reference/workflows/workflow-methods/sleep.md +2 -0
- package/.docs/reference/workflows/workflow-methods/sleepUntil.md +2 -0
- package/.docs/reference/workflows/workflow-methods/then.md +2 -0
- package/.docs/reference/workflows/workflow-state-reader.md +2 -0
- package/.docs/reference/workflows/workflow.md +2 -0
- package/.docs/reference/workspace/agentcore-runtime-sandbox.md +3 -0
- package/.docs/reference/workspace/agentfs-filesystem.md +3 -0
- package/.docs/reference/workspace/apple-container-sandbox.md +259 -0
- package/.docs/reference/workspace/archil-filesystem.md +3 -0
- package/.docs/reference/workspace/azure-blob-filesystem.md +3 -0
- package/.docs/reference/workspace/blaxel-sandbox.md +2 -0
- package/.docs/reference/workspace/daytona-sandbox.md +2 -0
- package/.docs/reference/workspace/docker-sandbox.md +3 -0
- package/.docs/reference/workspace/e2b-sandbox.md +3 -0
- package/.docs/reference/workspace/files-sdk-filesystem.md +3 -0
- package/.docs/reference/workspace/filesystem.md +2 -0
- package/.docs/reference/workspace/gcs-filesystem.md +3 -0
- package/.docs/reference/workspace/google-drive-filesystem.md +2 -0
- package/.docs/reference/workspace/local-filesystem.md +2 -0
- package/.docs/reference/workspace/local-sandbox.md +2 -0
- package/.docs/reference/workspace/mesa-filesystem.md +321 -0
- package/.docs/reference/workspace/modal-sandbox.md +2 -0
- package/.docs/reference/workspace/process-manager.md +2 -0
- package/.docs/reference/workspace/railway-sandbox.md +2 -0
- package/.docs/reference/workspace/s3-filesystem.md +3 -0
- package/.docs/reference/workspace/sandbox.md +2 -0
- package/.docs/reference/workspace/vercel-microvm-sandbox.md +2 -0
- package/.docs/reference/workspace/vercel.md +3 -0
- package/.docs/reference/workspace/workspace-class.md +2 -0
- package/CHANGELOG.md +23 -0
- package/package.json +4 -4
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Semantic recall
|
|
2
4
|
|
|
3
5
|
If you ask your friend what they did last weekend, they will search in their memory for events associated with "last weekend" and then tell you what they did. That's sort of like how semantic recall works in Mastra.
|
|
@@ -130,6 +132,7 @@ The following options control semantic recall behavior:
|
|
|
130
132
|
|
|
131
133
|
```typescript
|
|
132
134
|
const agent = new Agent({
|
|
135
|
+
id: 'agent',
|
|
133
136
|
memory: new Memory({
|
|
134
137
|
options: {
|
|
135
138
|
semanticRecall: {
|
|
@@ -151,6 +154,7 @@ The `filter` option restricts semantic recall results to messages with matching
|
|
|
151
154
|
|
|
152
155
|
```typescript
|
|
153
156
|
const agent = new Agent({
|
|
157
|
+
id: 'agent',
|
|
154
158
|
memory: new Memory({
|
|
155
159
|
options: {
|
|
156
160
|
semanticRecall: {
|
|
@@ -217,6 +221,7 @@ import { Agent } from '@mastra/core/agent'
|
|
|
217
221
|
import { ModelRouterEmbeddingModel } from '@mastra/core/llm'
|
|
218
222
|
|
|
219
223
|
const agent = new Agent({
|
|
224
|
+
id: 'agent',
|
|
220
225
|
memory: new Memory({
|
|
221
226
|
embedder: new ModelRouterEmbeddingModel('openai/text-embedding-3-small'),
|
|
222
227
|
options: {
|
|
@@ -238,6 +243,7 @@ import { Memory } from '@mastra/memory'
|
|
|
238
243
|
import { ModelRouterEmbeddingModel } from '@mastra/core/llm'
|
|
239
244
|
|
|
240
245
|
const agent = new Agent({
|
|
246
|
+
id: 'agent',
|
|
241
247
|
memory: new Memory({
|
|
242
248
|
embedder: new ModelRouterEmbeddingModel({
|
|
243
249
|
providerId: 'openrouter',
|
|
@@ -259,6 +265,7 @@ import { Agent } from '@mastra/core/agent'
|
|
|
259
265
|
import { ModelRouterEmbeddingModel } from '@mastra/core/llm'
|
|
260
266
|
|
|
261
267
|
const agent = new Agent({
|
|
268
|
+
id: 'agent',
|
|
262
269
|
memory: new Memory({
|
|
263
270
|
embedder: new ModelRouterEmbeddingModel('openai/text-embedding-3-small'),
|
|
264
271
|
}),
|
|
@@ -301,6 +308,7 @@ import { Agent } from '@mastra/core/agent'
|
|
|
301
308
|
import { fastembed } from '@mastra/fastembed'
|
|
302
309
|
|
|
303
310
|
const agent = new Agent({
|
|
311
|
+
id: 'agent',
|
|
304
312
|
memory: new Memory({
|
|
305
313
|
embedder: fastembed,
|
|
306
314
|
}),
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Storage
|
|
2
4
|
|
|
3
5
|
For agents to remember previous interactions, Mastra needs a storage adapter. Use one of the [supported providers](#supported-providers) and pass it to your Mastra instance.
|
|
@@ -100,6 +102,10 @@ export const mastra = new Mastra({
|
|
|
100
102
|
|
|
101
103
|
This is useful when different types of data have different performance or operational requirements, such as low-latency storage for memory, durable storage for workflows, and high-throughput storage for observability.
|
|
102
104
|
|
|
105
|
+
#### Retention
|
|
106
|
+
|
|
107
|
+
Storage grows without bound by default. To cap growth, declare per-table `maxAge` policies in the `retention` config and call `storage.prune()` from your own scheduler to delete old rows. Anything you don't configure is kept forever. See [Storage retention](https://mastra.ai/reference/storage/retention) for `prune()` and the full config shape.
|
|
108
|
+
|
|
103
109
|
### Agent-level storage
|
|
104
110
|
|
|
105
111
|
Agent-level storage overrides storage configured at the instance level. Add storage to a specific agent when you need to keep data separate or use different providers per agent.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Working Memory
|
|
2
4
|
|
|
3
5
|
While [message history](https://mastra.ai/docs/memory/message-history) and [semantic recall](https://mastra.ai/docs/memory/semantic-recall) help agents remember conversations, working memory allows them to maintain persistent information about users across interactions.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Arize exporter
|
|
2
4
|
|
|
3
5
|
[Arize](https://arize.com/) provides observability platforms for AI applications through [Phoenix](https://phoenix.arize.com/) (open-source) and [Arize AX](https://arize.com/generative-ai/) (enterprise). The Arize exporter sends traces using OpenTelemetry and [OpenInference](https://github.com/Arize-ai/openinference/tree/main/spec) semantic conventions, compatible with any OpenTelemetry platform that supports OpenInference.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Arthur exporter
|
|
2
4
|
|
|
3
5
|
[Arthur](https://arthur.ai/) provides an observability and evaluation platform for AI applications through [Arthur Engine](https://github.com/arthur-ai/arthur-engine) (open-source). The Arthur exporter sends traces using OpenTelemetry and [OpenInference](https://github.com/Arize-ai/openinference/tree/main/spec) semantic conventions.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Braintrust exporter
|
|
2
4
|
|
|
3
5
|
[Braintrust](https://www.braintrust.dev/) is an evaluation and monitoring platform that helps you measure and improve LLM application quality. The Braintrust exporter sends your traces to Braintrust, enabling systematic evaluation, scoring, and experimentation.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Datadog exporter
|
|
2
4
|
|
|
3
5
|
[Datadog](https://datadoghq.com/) is a comprehensive monitoring platform with dedicated LLM Observability features. The Datadog exporter sends your traces to Datadog's LLM Observability product, providing insights into model performance, token usage, and conversation flows.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Laminar exporter
|
|
2
4
|
|
|
3
5
|
[Laminar](https://laminar.sh/) is an open-source, OpenTelemetry-native observability platform for AI agents. Trace, debug, and monitor every Mastra agent run, model step, tool call, and sub-agent with a single `MastraExporter` wired into your `Observability` config.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Langfuse exporter
|
|
2
4
|
|
|
3
5
|
[Langfuse](https://langfuse.com/) is an open-source observability platform specifically designed for LLM applications. The Langfuse exporter sends your traces to Langfuse, providing detailed insights into model performance, token usage, and conversation flows.
|
|
@@ -237,6 +239,7 @@ const exporter = new LangfuseExporter()
|
|
|
237
239
|
const prompt = await exporter.client.prompt.get('customer-support', { type: 'text' })
|
|
238
240
|
|
|
239
241
|
export const supportAgent = new Agent({
|
|
242
|
+
id: 'support-agent',
|
|
240
243
|
name: 'support-agent',
|
|
241
244
|
instructions: prompt.compile(), // Use the prompt text from Langfuse
|
|
242
245
|
model: 'openai/gpt-5.5',
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# LangSmith exporter
|
|
2
4
|
|
|
3
5
|
[LangSmith](https://smith.langchain.com/) is LangChain's platform for monitoring and evaluating LLM applications. The LangSmith exporter sends your traces to LangSmith, providing insights into model performance, debugging capabilities, and evaluation workflows.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Mastra platform exporter
|
|
2
4
|
|
|
3
5
|
The `MastraPlatformExporter` sends traces, logs, metrics, scores, and feedback to the Mastra platform. Use it to route observability data from any Mastra app to a hosted project in the Mastra platform.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Mastra Storage exporter
|
|
2
4
|
|
|
3
5
|
The `MastraStorageExporter` persists traces to your configured storage backend, making them accessible through Studio. It requires no external services.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# OpenTelemetry exporter
|
|
2
4
|
|
|
3
5
|
The OpenTelemetry (OTEL) exporter sends your traces and logs to any OTEL-compatible observability platform using standardized [OpenTelemetry Semantic Conventions for GenAI](https://opentelemetry.io/docs/specs/semconv/gen-ai/). This ensures broad compatibility with platforms like Datadog, New Relic, SigNoz, MLflow, Latitude, Dash0, Traceloop, Laminar, and more.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# PostHog exporter
|
|
2
4
|
|
|
3
5
|
[PostHog](https://posthog.com/) is an analytics platform with AI observability features for monitoring LLM applications. The PostHog exporter sends your traces to PostHog as structured events, providing insights into token usage, costs, latency, and conversation flows.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Sentry exporter
|
|
2
4
|
|
|
3
5
|
[Sentry](https://sentry.io/) is an application monitoring platform with AI-specific tracing capabilities. The Sentry exporter sends your traces to Sentry using OpenTelemetry semantic conventions, providing insights into model performance, token usage, and tool executions.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Integrations overview
|
|
2
4
|
|
|
3
5
|
Mastra observability integrations control where observability data goes and how it's transformed on the way out. Use integrations to store data in Mastra storage, send it to Mastra platform, connect to external observability providers, or redact exported span data.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Sensitive data filter
|
|
2
4
|
|
|
3
5
|
The Sensitive Data Filter is a span processor that redacts sensitive information from your traces during the processing pipeline before export. This ensures that passwords, API keys, tokens, and other confidential data never leave your application or get stored in observability platforms.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Metrics overview
|
|
2
4
|
|
|
3
5
|
Mastra automatically emits performance and usage metrics from traced execution. There's no manual instrumentation needed. Metrics are derived from spans as they complete.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Querying metrics
|
|
2
4
|
|
|
3
5
|
Mastra exposes the same five OLAP queries (`getMetricAggregate`, `getMetricBreakdown`, `getMetricTimeSeries`, `getMetricPercentiles`, and discovery helpers) through three surfaces: an in-process store accessor, the runtime HTTP API, and the `mastra api metric` CLI. All three accept the same Zod-validated input shapes, so you can move from a one-off CLI investigation to a programmatic dashboard tool without re-learning the API.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Observability overview
|
|
2
4
|
|
|
3
5
|
Mastra's observability system gives you visibility into every agent run, workflow step, tool call, and model interaction. Agent behavior depends on model responses, prompts, tools, memory, and workflow state, so observability helps you inspect runtime decisions from day one. It captures three complementary signals that work together to help you understand what your application is doing and why.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Storage
|
|
2
4
|
|
|
3
5
|
Storage determines which observability signals persist, which queries are available, and whether metrics aggregation works. Use a dedicated observability store instead of your primary application store.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Tracing
|
|
2
4
|
|
|
3
5
|
Tracing is the observability signal that records how a request moves through agents, workflows, tools, and model calls. Mastra represents each operation as a span and groups related spans into a trace so you can inspect the full execution path.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# GraphRAG
|
|
2
4
|
|
|
3
5
|
Graph-based retrieval enhances traditional vector search by following relationships between chunks of information. This approach is useful when information is spread across multiple documents or when documents reference each other.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# RAG (Retrieval-Augmented Generation) in Mastra
|
|
2
4
|
|
|
3
5
|
RAG in Mastra helps you enhance LLM outputs by incorporating relevant context from your own data sources, improving accuracy and grounding responses in real information.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Storing embeddings in a vector database
|
|
2
4
|
|
|
3
5
|
After generating embeddings, you need to store them in a database that supports vector similarity search. Mastra provides a consistent interface for storing and querying embeddings across various vector databases.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Auth0
|
|
2
4
|
|
|
3
5
|
The `@mastra/auth-auth0` package provides authentication for Mastra using Auth0. It verifies incoming requests using Auth0-issued JWT tokens and integrates with the Mastra server using the `auth` option.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Better Auth
|
|
2
4
|
|
|
3
5
|
The `@mastra/auth-better-auth` package provides authentication for Mastra using Better Auth. It verifies incoming requests using your Better Auth instance and integrates with the Mastra server via the `server.auth` option.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Clerk
|
|
2
4
|
|
|
3
5
|
The `@mastra/auth-clerk` package provides authentication for Mastra using Clerk. It verifies incoming requests using Clerk's authentication system and integrates with the Mastra server using the `auth` option.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Composite Auth
|
|
2
4
|
|
|
3
5
|
The `CompositeAuth` class allows you to combine multiple authentication providers into a single auth handler. It tries each provider in order until one succeeds.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Custom auth provider
|
|
2
4
|
|
|
3
5
|
Custom auth providers allow you to implement authentication for identity systems that aren't covered by the built-in providers. Extend the `MastraAuthProvider` base class to integrate with any authentication system.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Fine-Grained Authorization (FGA)
|
|
2
4
|
|
|
3
5
|
> **Note:** Fine-Grained Authorization is part of the Mastra Enterprise Edition. Production deployments require a valid EE license. [Contact sales](https://mastra.ai/contact) for more information.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Firebase
|
|
2
4
|
|
|
3
5
|
The `@mastra/auth-firebase` package provides authentication for Mastra using Firebase Authentication. It verifies incoming requests using Firebase ID tokens and integrates with the Mastra server using the `auth` option.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Google
|
|
2
4
|
|
|
3
5
|
The `@mastra/auth-google` package provides authentication and role-based access control for Mastra using Google Workspace. It supports an OAuth 2.0 / OIDC login flow with encrypted session cookies, verifies Google ID tokens, and maps Google Workspace groups to Mastra permissions.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# JSON Web Token
|
|
2
4
|
|
|
3
5
|
The `MastraJwtAuth` class provides a lightweight authentication mechanism for Mastra using JSON Web Tokens (JWTs). It verifies incoming requests based on a shared secret and integrates with the Mastra server using the `auth` option.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Okta
|
|
2
4
|
|
|
3
5
|
The `@mastra/auth-okta` package provides authentication and role-based access control for Mastra using Okta. It supports an OAuth 2.0 / OIDC login flow with encrypted session cookies and maps Okta groups to Mastra permissions.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Simple Auth
|
|
2
4
|
|
|
3
5
|
The `SimpleAuth` class provides token-based authentication using a basic token-to-user mapping. It's included in `@mastra/core/server` and is useful for development, testing, and basic API key authentication scenarios.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Supabase
|
|
2
4
|
|
|
3
5
|
The `@mastra/auth-supabase` package provides authentication for Mastra using Supabase Auth. It verifies incoming requests using Supabase's authentication system and integrates with the Mastra server using the `auth` option.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# WorkOS
|
|
2
4
|
|
|
3
5
|
The `@mastra/auth-workos` package provides authentication for Mastra using WorkOS. It verifies incoming requests using WorkOS access tokens and integrates with the Mastra server using the `auth` option.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Auth overview
|
|
2
4
|
|
|
3
5
|
Mastra lets you choose how you handle authentication, so you can secure access to your API and [Studio](https://mastra.ai/docs/studio/overview) using the identity system that fits your stack.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Custom adapters
|
|
2
4
|
|
|
3
5
|
Create a custom adapter when the prebuilt server adapters (Hono, Express, Fastify, Koa) don't support your framework or you have specific request/response handling requirements.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Mastra client SDK
|
|
2
4
|
|
|
3
5
|
The Mastra Client SDK provides a concise and type-safe interface for interacting with your [Mastra Server](https://mastra.ai/docs/server/mastra-server) from your client environment.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Server overview
|
|
2
4
|
|
|
3
5
|
Mastra runs as an HTTP server that exposes your agents, workflows, and other functionality as API endpoints. The server handles request routing, middleware execution, authentication, and streaming responses.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Middleware
|
|
2
4
|
|
|
3
5
|
Mastra servers can execute custom middleware functions before or after an API route handler is invoked. This is useful for things like authentication, logging, injecting request-specific context or adding CORS headers.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# PubSub
|
|
2
4
|
|
|
3
5
|
Mastra uses a publish/subscribe (pub/sub) system as its internal event bus. Components publish events to named topics, and other components subscribe to those topics to react. The backend you configure decides how far those events travel: within one process, across processes on one host, or across separate instances.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Server adapters
|
|
2
4
|
|
|
3
5
|
Server adapters let you run Mastra with your own HTTP server instead of the Hono server generated by `mastra build`. They provide more control over the server setup, including custom middleware ordering, authentication, logging, and deployment configuration. You can still integrate Mastra into any Node.js application without changing how agents or workflows execute.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Studio auth
|
|
2
4
|
|
|
3
5
|
When you configure [authentication](https://mastra.ai/docs/server/auth) on your Mastra server, Studio automatically displays a login screen and enforces access control. One configuration secures both the Studio UI and your API routes.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Studio deployment
|
|
2
4
|
|
|
3
5
|
Studio is a React-based Single Page Application (SPA) that runs in the browser and connects to a running [Mastra server](https://mastra.ai/docs/deployment/mastra-server).
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Studio
|
|
2
4
|
|
|
3
5
|
Studio provides an interactive UI for building, testing, and managing your agents, workflows, and tools. Run it locally during development, add [authentication](https://mastra.ai/docs/studio/auth), or [deploy it](https://mastra.ai/docs/studio/deployment) to production so your team can manage agents, monitor performance, and gain insights through built-in observability.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Voice in Mastra
|
|
2
4
|
|
|
3
5
|
Mastra's Voice system provides a unified interface for voice interactions, enabling text-to-speech (TTS), speech-to-text (STT), and real-time speech-to-speech (STS) capabilities in your applications.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Speech-to-Text (STT)
|
|
2
4
|
|
|
3
5
|
Speech-to-Text (STT) in Mastra provides a standardized interface for converting audio input into text across multiple service providers. STT helps create voice-enabled applications that can respond to human speech, enabling hands-free interaction, accessibility for users with disabilities, and more natural human-computer interfaces.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Text-to-Speech (TTS)
|
|
2
4
|
|
|
3
5
|
Text-to-Speech (TTS) in Mastra offers a unified API for synthesizing spoken audio from text using various providers. By incorporating TTS into your applications, you can enhance user experience with natural voice interactions, improve accessibility for users with visual impairments, and create more engaging multimodal interfaces.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Agents and tools
|
|
2
4
|
|
|
3
5
|
Workflow steps can call agents to leverage LLM reasoning or call tools for type-safe logic. You can either invoke them from within a step's `execute()` function or compose them directly as steps using `createStep()`.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Control flow
|
|
2
4
|
|
|
3
5
|
Workflows run a sequence of predefined tasks, and you can control how that flow is executed. Tasks are divided into **steps**, which can be executed in different ways depending on your requirements. They can run sequentially, in parallel, or follow different paths based on conditions.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Error handling
|
|
2
4
|
|
|
3
5
|
Mastra workflows support error handling through result status checks after execution, retry policies for transient failures, and lifecycle callbacks for centralized error logging or alerting.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Human-in-the-loop (HITL)
|
|
2
4
|
|
|
3
5
|
Some workflows need to pause for human input before continuing. When a workflow is [suspended](https://mastra.ai/docs/workflows/suspend-and-resume), it can return a message explaining why it paused and what’s needed to proceed. The workflow can then either [resume](#resuming-workflows-with-human-input) or [bail](#handling-human-rejection-with-bail) based on the input received. This approach works well for manual approvals, rejections, gated decisions, or any step that requires human oversight.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Workflows overview
|
|
2
4
|
|
|
3
5
|
Workflows let you define complex sequences of tasks using clear, structured steps rather than relying on the reasoning of a single agent. They give you full control over how tasks are broken down, how data moves between them, and what gets executed when. Workflows run using the built-in execution engine by default, or can be deployed to [workflow runners](https://mastra.ai/docs/deployment/workflow-runners) like Inngest for managed infrastructure.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Scheduled workflows
|
|
2
4
|
|
|
3
5
|
Declare a `schedule` field on a workflow and Mastra will fire it on the cron you specify. The same workflow remains callable directly with `workflow.start()` — scheduled fires and manual runs share a single execution path.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Snapshots
|
|
2
4
|
|
|
3
5
|
In Mastra, a snapshot is a serializable representation of a workflow's complete execution state at a specific point in time. Snapshots capture all the information needed to resume a workflow from exactly where it left off, including:
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Suspend & resume
|
|
2
4
|
|
|
3
5
|
Workflows can be paused at any step to collect additional data, wait for API callbacks, throttle costly operations, or request [human-in-the-loop](https://mastra.ai/docs/workflows/human-in-the-loop) input. When a workflow is suspended, its current execution state is saved as a snapshot. You can later resume the workflow from a [specific step ID](https://mastra.ai/docs/workflows/snapshots), restoring the exact state captured in that snapshot. [Snapshots](https://mastra.ai/docs/workflows/snapshots) are stored in your configured storage provider and persist across deployments and application restarts.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Time travel
|
|
2
4
|
|
|
3
5
|
Time travel allows you to re-execute a workflow starting from any specific step, using either stored snapshot data or custom context you provide. This is useful for debugging failed workflows, testing individual steps with different inputs, or recovering from errors without re-running the entire workflow. You can also use time travel to execute a workflow that hasn't been run yet, starting from any specific step.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Workflow state
|
|
2
4
|
|
|
3
5
|
Workflow state lets you share values across steps without passing them through every step's inputSchema and outputSchema. This is useful for tracking progress, accumulating results, or sharing configuration across the entire workflow.
|