@mastra/mcp-docs-server 1.2.15-alpha.9 → 1.2.15
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/agents/agent-approval.md +14 -0
- package/.docs/docs/agents/code-mode.md +17 -2
- package/.docs/docs/agents/networks.md +2 -2
- package/.docs/docs/agents/overview.md +2 -2
- package/.docs/docs/agents/processors.md +3 -3
- package/.docs/docs/agents/using-tools.md +1 -1
- package/.docs/docs/browser/overview.md +8 -8
- package/.docs/docs/browser/recording.md +4 -4
- package/.docs/docs/capabilities/{channels/overview.md → channels.md} +70 -7
- package/.docs/docs/capabilities/subagents.md +6 -3
- package/.docs/docs/datasets/running-experiments.md +49 -0
- package/.docs/docs/deployment/cloud-providers.md +9 -9
- package/.docs/docs/deployment/overview.md +9 -9
- package/.docs/docs/deployment/sandbox.md +3 -3
- package/.docs/docs/deployment/web-framework.md +6 -6
- package/.docs/docs/deployment/workers.md +1 -1
- package/.docs/docs/deployment/workflow-runners.md +2 -2
- package/.docs/docs/getting-started/develop.md +1 -1
- package/.docs/docs/harness/agent-controller.md +45 -4
- package/.docs/docs/harness/overview.md +2 -4
- package/.docs/docs/index.md +8 -8
- package/.docs/docs/long-running-agents/durable-agents.md +3 -3
- package/.docs/docs/long-running-agents/goals.md +1 -1
- package/.docs/docs/long-running-agents/schedules.md +1 -1
- package/.docs/docs/long-running-agents/signal-providers.md +3 -16
- package/.docs/docs/long-running-agents/signals.md +2 -2
- package/.docs/docs/mastra-platform/database.md +2 -2
- package/.docs/docs/mastra-platform/deploy.md +27 -0
- package/.docs/docs/mastra-platform/server.md +1 -1
- package/.docs/docs/mastra-platform/trace-intelligence.md +9 -13
- package/.docs/docs/mcp/overview.md +42 -0
- package/.docs/docs/memory/memory-processors.md +5 -5
- package/.docs/docs/memory/message-history.md +3 -3
- package/.docs/docs/memory/multi-user-threads.md +1 -1
- package/.docs/docs/memory/observational-memory.md +2 -2
- package/.docs/docs/memory/semantic-recall.md +2 -1
- package/.docs/docs/memory/working-memory.md +1 -0
- package/.docs/docs/observability/integrations/exporters/mastra-platform.md +1 -1
- package/.docs/docs/observability/integrations/exporters/mastra-storage.md +16 -15
- package/.docs/docs/observability/integrations/overview.md +3 -3
- package/.docs/docs/server/auth/fga.md +1 -1
- package/.docs/docs/server/auth/simple-auth.md +1 -1
- package/.docs/docs/server/auth/workers.md +2 -0
- package/.docs/docs/server/auth.md +10 -8
- package/.docs/docs/server/custom-adapters.md +1 -1
- package/.docs/docs/server/custom-api-routes.md +35 -0
- package/.docs/docs/server/mastra-client.md +2 -2
- package/.docs/docs/server/mastra-server.md +1 -1
- package/.docs/docs/storage/overview.md +14 -12
- package/.docs/docs/studio/observability.md +1 -1
- package/.docs/docs/workflows/dynamic-workflows.md +1 -1
- package/.docs/docs/workflows/overview.md +2 -2
- package/.docs/docs/workflows/snapshots.md +12 -10
- package/.docs/docs/workflows/time-travel.md +2 -0
- package/.docs/docs/workspace/filesystem.md +15 -15
- package/.docs/docs/workspace/sandbox.md +17 -17
- package/.docs/docs/workspace/search.md +1 -1
- package/.docs/guides/agent-frameworks/ai-sdk.md +2 -2
- package/.docs/guides/deployment/mastra-workers.md +4 -2
- package/.docs/guides/getting-started/quickstart.md +3 -3
- package/.docs/guides/guide/signal-provider.md +1 -1
- package/.docs/guides/index.md +8 -8
- package/.docs/guides/voice/overview.md +55 -106
- package/.docs/guides/voice/speech-to-text.md +7 -7
- package/.docs/guides/voice/text-to-speech.md +9 -10
- package/.docs/{guides/build-your-ui → integrations/agentic-ui}/ai-sdk-ui.md +5 -5
- package/.docs/{guides/build-your-ui → integrations/agentic-ui}/assistant-ui.md +1 -1
- package/.docs/{guides/build-your-ui/copilotkit/overview.md → integrations/agentic-ui/copilotkit.md} +257 -4
- package/.docs/{docs/server → integrations}/auth/auth0.md +1 -1
- package/.docs/{docs/server → integrations}/auth/clerk.md +2 -2
- package/.docs/{docs/server → integrations}/auth/firebase.md +1 -1
- package/.docs/{docs/server → integrations}/auth/okta.md +24 -4
- package/.docs/{docs/server → integrations}/auth/supabase.md +2 -2
- package/.docs/{docs/server → integrations}/auth/workos.md +1 -1
- package/.docs/{docs/browser → integrations/browsers}/agent-browser.md +2 -2
- package/.docs/{docs/browser → integrations/browsers}/browser-viewer.md +3 -3
- package/.docs/{docs/browser → integrations/browsers}/firecrawl.md +2 -2
- package/.docs/{docs/browser → integrations/browsers}/stagehand.md +1 -1
- package/.docs/{docs/capabilities → integrations}/channels/discord.md +2 -2
- package/.docs/integrations/channels/github.md +103 -0
- package/.docs/{docs/capabilities → integrations}/channels/imessage.md +12 -4
- package/.docs/{docs/capabilities → integrations}/channels/slack.md +4 -4
- package/.docs/{docs/capabilities → integrations}/channels/teams.md +2 -2
- package/.docs/{docs/capabilities → integrations}/channels/telegram.md +2 -2
- package/.docs/{docs/capabilities → integrations}/channels/whatsapp.md +2 -2
- package/.docs/{reference/storage/dsql.md → integrations/databases/aurora-dsql.md} +1 -1
- package/.docs/{reference/storage → integrations/databases}/clickhouse.md +2 -2
- package/.docs/{reference/storage → integrations/databases}/cloudflare-d1.md +1 -1
- package/.docs/{reference/storage/cloudflare.md → integrations/databases/cloudflare-kv.md} +1 -1
- package/.docs/{reference/storage → integrations/databases}/convex.md +1 -1
- package/.docs/{reference/storage → integrations/databases}/duckdb.md +5 -5
- package/.docs/{reference/storage → integrations/databases}/dynamodb.md +1 -1
- package/.docs/{reference/storage/lance.md → integrations/databases/lancedb.md} +1 -1
- package/.docs/{reference/storage → integrations/databases}/libsql.md +2 -2
- package/.docs/{reference/storage → integrations/databases}/mongodb.md +1 -1
- package/.docs/{reference/storage → integrations/databases}/mssql.md +1 -1
- package/.docs/integrations/databases/neon.md +220 -0
- package/.docs/integrations/databases/oracledb.md +239 -0
- package/.docs/{reference/storage → integrations/databases}/postgresql.md +1 -1
- package/.docs/{reference/storage → integrations/databases}/redis.md +1 -1
- package/.docs/{reference/storage → integrations/databases}/spanner.md +1 -1
- package/.docs/{reference/storage → integrations/databases}/upstash.md +1 -1
- package/.docs/{guides/deployment → integrations/deploy}/amazon-ec2.md +1 -1
- package/.docs/{guides/deployment → integrations/deploy}/aws-bedrock-agentcore.md +1 -1
- package/.docs/{guides/deployment → integrations/deploy}/aws-lambda.md +2 -2
- package/.docs/{guides/deployment → integrations/deploy}/azure-app-services.md +2 -2
- package/.docs/{guides/deployment → integrations/deploy}/cloudflare.md +2 -2
- package/.docs/{guides/deployment → integrations/deploy}/digital-ocean.md +3 -3
- package/.docs/{guides/deployment → integrations/deploy}/kubernetes.md +2 -2
- package/.docs/{guides/deployment → integrations/deploy}/netlify.md +3 -3
- package/.docs/{guides/deployment → integrations/deploy}/vercel.md +3 -3
- package/.docs/{reference/workspace/s3-filesystem.md → integrations/file-storage/amazon-s3.md} +5 -5
- package/.docs/{reference/workspace/archil-filesystem.md → integrations/file-storage/archil.md} +3 -3
- package/.docs/{reference/workspace/azure-blob-filesystem.md → integrations/file-storage/azure-blob.md} +2 -2
- package/.docs/{reference/workspace/gcs-filesystem.md → integrations/file-storage/google-cloud-storage.md} +5 -5
- package/.docs/{reference/workspace/mesa-filesystem.md → integrations/file-storage/mesa.md} +2 -2
- package/.docs/{reference/workspace/files-sdk-filesystem.md → integrations/file-storage/vercel-files.md} +5 -5
- package/.docs/{guides/getting-started → integrations/frameworks}/astro.md +1 -1
- package/.docs/{guides/getting-started → integrations/frameworks}/electron.md +3 -3
- package/.docs/{guides/getting-started → integrations/frameworks}/next-js.md +2 -2
- package/.docs/{guides/getting-started → integrations/frameworks}/nuxt.md +1 -1
- package/.docs/{guides/getting-started → integrations/frameworks}/sveltekit.md +1 -1
- package/.docs/{guides/getting-started → integrations/frameworks}/vite-react.md +1 -1
- package/.docs/{docs/observability/integrations/exporters → integrations/observability}/arize.md +1 -1
- package/.docs/{docs/observability/integrations/exporters → integrations/observability}/arthur.md +1 -1
- package/.docs/{docs/observability/integrations/exporters → integrations/observability}/braintrust.md +1 -1
- package/.docs/{docs/observability/integrations/exporters → integrations/observability}/confident-ai.md +1 -1
- package/.docs/integrations/observability/datadog.md +538 -0
- package/.docs/{docs/observability/integrations/exporters → integrations/observability}/laminar.md +1 -1
- package/.docs/{docs/observability/integrations/exporters → integrations/observability}/langfuse.md +1 -1
- package/.docs/{docs/observability/integrations/exporters → integrations/observability}/langsmith.md +1 -1
- package/.docs/{docs/observability/integrations/exporters/otel.md → integrations/observability/opentelemetry.md} +278 -46
- package/.docs/{docs/observability/integrations/exporters → integrations/observability}/posthog.md +1 -1
- package/.docs/{docs/observability/integrations/exporters → integrations/observability}/sentry.md +1 -1
- package/.docs/{reference/workspace/apple-container-sandbox.md → integrations/sandboxes/apple-container.md} +1 -1
- package/.docs/{reference/workspace/daytona-sandbox.md → integrations/sandboxes/daytona.md} +23 -2
- package/.docs/{reference/workspace/docker-sandbox.md → integrations/sandboxes/docker.md} +1 -1
- package/.docs/{reference/workspace/e2b-sandbox.md → integrations/sandboxes/e2b.md} +3 -3
- package/.docs/{reference/workspace/modal-sandbox.md → integrations/sandboxes/modal.md} +2 -2
- package/.docs/{reference/workspace/railway-sandbox.md → integrations/sandboxes/railway.md} +8 -0
- package/.docs/{reference/workspace/vercel-sandbox.md → integrations/sandboxes/vercel.md} +141 -12
- package/.docs/{reference → integrations}/tools/brightdata.md +1 -1
- package/.docs/{reference → integrations}/tools/perplexity.md +1 -1
- package/.docs/{reference → integrations}/tools/tavily.md +1 -1
- package/.docs/{reference → integrations}/voice/aws-nova-sonic.md +1 -1
- package/.docs/{reference → integrations}/voice/cloudflare.md +3 -3
- package/.docs/{reference/voice/google-gemini-live.md → integrations/voice/google.md} +305 -30
- package/.docs/{reference/voice/inworld-realtime.md → integrations/voice/inworld.md} +163 -25
- package/.docs/{reference → integrations}/voice/livekit.md +437 -34
- package/.docs/{reference/voice/openai-realtime.md → integrations/voice/openai.md} +117 -20
- package/.docs/integrations.md +147 -0
- package/.docs/models/embeddings.md +3 -3
- package/.docs/models/environment-variables.md +1 -0
- package/.docs/models/gateways/custom-gateways.md +4 -0
- package/.docs/models/gateways/neon.md +1 -1
- package/.docs/models/gateways/netlify.md +1 -1
- package/.docs/models/gateways/openrouter.md +9 -3
- package/.docs/models/gateways/vercel.md +7 -4
- package/.docs/models/index.md +3 -3
- package/.docs/models/providers/302ai.md +1 -1
- package/.docs/models/providers/abacus.md +1 -1
- package/.docs/models/providers/abliteration-ai.md +1 -1
- package/.docs/models/providers/agentrouter.md +1 -1
- package/.docs/models/providers/ai-router.md +1 -1
- package/.docs/models/providers/aiand.md +1 -1
- package/.docs/models/providers/aki-io.md +1 -1
- package/.docs/models/providers/alibaba-cn.md +1 -1
- package/.docs/models/providers/alibaba-coding-plan-cn.md +1 -1
- package/.docs/models/providers/alibaba-coding-plan.md +1 -1
- package/.docs/models/providers/alibaba-token-plan-cn.md +1 -1
- package/.docs/models/providers/alibaba-token-plan.md +1 -1
- package/.docs/models/providers/alibaba.md +7 -5
- package/.docs/models/providers/ambient.md +2 -2
- package/.docs/models/providers/anyapi.md +1 -1
- package/.docs/models/providers/atomic-chat.md +1 -1
- package/.docs/models/providers/auriko.md +1 -1
- package/.docs/models/providers/bailing.md +1 -1
- package/.docs/models/providers/baseten.md +2 -2
- package/.docs/models/providers/berget.md +1 -1
- package/.docs/models/providers/blueclaw.md +1 -1
- package/.docs/models/providers/chutes.md +1 -1
- package/.docs/models/providers/clarifai.md +1 -1
- package/.docs/models/providers/claudinio.md +1 -1
- package/.docs/models/providers/cline-pass.md +1 -1
- package/.docs/models/providers/cloudferro-sherlock.md +1 -1
- package/.docs/models/providers/cloudflare-workers-ai.md +1 -1
- package/.docs/models/providers/coralbricks.md +75 -0
- package/.docs/models/providers/cortecs.md +3 -5
- package/.docs/models/providers/crof.md +1 -1
- package/.docs/models/providers/crossmodel.md +2 -3
- package/.docs/models/providers/daoxe.md +1 -1
- package/.docs/models/providers/databricks.md +1 -1
- package/.docs/models/providers/deepinfra.md +6 -5
- package/.docs/models/providers/digitalocean.md +5 -5
- package/.docs/models/providers/dinference.md +1 -1
- package/.docs/models/providers/drun.md +1 -1
- package/.docs/models/providers/ebcloud.md +1 -1
- package/.docs/models/providers/empiriolabs.md +3 -2
- package/.docs/models/providers/evroc.md +3 -4
- package/.docs/models/providers/fastrouter.md +1 -1
- package/.docs/models/providers/firepass.md +1 -1
- package/.docs/models/providers/fireworks-ai.md +1 -1
- package/.docs/models/providers/firmware.md +1 -1
- package/.docs/models/providers/freemodel.md +1 -1
- package/.docs/models/providers/friendli.md +1 -1
- package/.docs/models/providers/frogbot.md +1 -1
- package/.docs/models/providers/github-models.md +1 -1
- package/.docs/models/providers/gmicloud.md +1 -1
- package/.docs/models/providers/google.md +1 -1
- package/.docs/models/providers/greenpt.md +1 -1
- package/.docs/models/providers/helicone.md +1 -1
- package/.docs/models/providers/hetzner.md +8 -5
- package/.docs/models/providers/hpc-ai.md +1 -1
- package/.docs/models/providers/huggingface.md +1 -1
- package/.docs/models/providers/hyper.md +7 -7
- package/.docs/models/providers/iflowcn.md +1 -1
- package/.docs/models/providers/impossibl.md +1 -1
- package/.docs/models/providers/inception.md +1 -1
- package/.docs/models/providers/inceptron.md +1 -1
- package/.docs/models/providers/inference.md +1 -1
- package/.docs/models/providers/inferx.md +1 -1
- package/.docs/models/providers/infomaniak.md +1 -1
- package/.docs/models/providers/io-intelligence.md +1 -1
- package/.docs/models/providers/io-net.md +1 -1
- package/.docs/models/providers/jiekou.md +1 -1
- package/.docs/models/providers/kenari.md +1 -1
- package/.docs/models/providers/kilo.md +16 -11
- package/.docs/models/providers/kimi-for-coding.md +1 -1
- package/.docs/models/providers/kiro.md +1 -1
- package/.docs/models/providers/kuae-cloud-coding-plan.md +1 -1
- package/.docs/models/providers/lilac.md +1 -1
- package/.docs/models/providers/llama.md +1 -1
- package/.docs/models/providers/llmgateway.md +2 -7
- package/.docs/models/providers/llmtr.md +1 -1
- package/.docs/models/providers/lmstudio.md +1 -1
- package/.docs/models/providers/longcat.md +1 -1
- package/.docs/models/providers/lucidquery.md +1 -1
- package/.docs/models/providers/lynkr.md +1 -1
- package/.docs/models/providers/meganova.md +1 -1
- package/.docs/models/providers/meta.md +1 -1
- package/.docs/models/providers/minimax-cn-coding-plan.md +1 -1
- package/.docs/models/providers/minimax-cn.md +1 -1
- package/.docs/models/providers/minimax-coding-plan.md +1 -1
- package/.docs/models/providers/minimax.md +1 -1
- package/.docs/models/providers/mixlayer.md +1 -1
- package/.docs/models/providers/moark.md +1 -1
- package/.docs/models/providers/modal.md +1 -1
- package/.docs/models/providers/model-oracle-ai.md +1 -1
- package/.docs/models/providers/modelis.md +1 -1
- package/.docs/models/providers/modelscope.md +1 -1
- package/.docs/models/providers/moonshotai-cn.md +1 -1
- package/.docs/models/providers/moonshotai.md +1 -1
- package/.docs/models/providers/morph.md +1 -1
- package/.docs/models/providers/nano-gpt.md +8 -4
- package/.docs/models/providers/nearai.md +1 -1
- package/.docs/models/providers/nebius.md +3 -2
- package/.docs/models/providers/neuralwatt.md +1 -1
- package/.docs/models/providers/nova.md +1 -1
- package/.docs/models/providers/novita-ai.md +1 -1
- package/.docs/models/providers/nvidia.md +3 -2
- package/.docs/models/providers/ofox.md +4 -3
- package/.docs/models/providers/ollama-cloud.md +1 -1
- package/.docs/models/providers/opencode-go.md +1 -1
- package/.docs/models/providers/opencode.md +65 -64
- package/.docs/models/providers/orcarouter.md +1 -1
- package/.docs/models/providers/ovhcloud.md +1 -1
- package/.docs/models/providers/perplexity-agent.md +1 -1
- package/.docs/models/providers/pioneer.md +1 -1
- package/.docs/models/providers/poe.md +1 -1
- package/.docs/models/providers/poolside.md +1 -1
- package/.docs/models/providers/privatemode-ai.md +12 -10
- package/.docs/models/providers/qihang-ai.md +1 -1
- package/.docs/models/providers/qiniu-ai.md +1 -1
- package/.docs/models/providers/regolo-ai.md +26 -21
- package/.docs/models/providers/requesty.md +3 -3
- package/.docs/models/providers/routing-run.md +1 -1
- package/.docs/models/providers/sakana.md +1 -1
- package/.docs/models/providers/sarvam.md +1 -1
- package/.docs/models/providers/scaleway.md +1 -1
- package/.docs/models/providers/scx.md +1 -1
- package/.docs/models/providers/siliconflow-cn.md +1 -1
- package/.docs/models/providers/siliconflow.md +1 -1
- package/.docs/models/providers/snowflake-cortex.md +6 -2
- package/.docs/models/providers/stackit.md +1 -1
- package/.docs/models/providers/stepfun-ai-step-plan.md +1 -1
- package/.docs/models/providers/stepfun-ai.md +1 -1
- package/.docs/models/providers/stepfun-step-plan.md +1 -1
- package/.docs/models/providers/stepfun.md +1 -1
- package/.docs/models/providers/subconscious.md +1 -1
- package/.docs/models/providers/submodel.md +1 -1
- package/.docs/models/providers/synthetic.md +1 -1
- package/.docs/models/providers/tencent-coding-plan.md +1 -1
- package/.docs/models/providers/tencent-token-plan.md +1 -1
- package/.docs/models/providers/tencent-tokenhub.md +1 -1
- package/.docs/models/providers/tensorx.md +1 -1
- package/.docs/models/providers/the-grid-ai.md +1 -1
- package/.docs/models/providers/thinkingmachines.md +1 -1
- package/.docs/models/providers/tinfoil.md +2 -2
- package/.docs/models/providers/togetherai.md +1 -1
- package/.docs/models/providers/trustedrouter.md +1 -1
- package/.docs/models/providers/umans-ai-coding-plan.md +1 -1
- package/.docs/models/providers/umans-ai.md +1 -1
- package/.docs/models/providers/unorouter.md +1 -1
- package/.docs/models/providers/upstage.md +1 -1
- package/.docs/models/providers/venice.md +1 -1
- package/.docs/models/providers/vivgrid.md +1 -1
- package/.docs/models/providers/vultr.md +1 -1
- package/.docs/models/providers/wafer.ai.md +1 -1
- package/.docs/models/providers/wandb.md +3 -2
- package/.docs/models/providers/xiaomi-token-plan-ams.md +1 -1
- package/.docs/models/providers/xiaomi-token-plan-cn.md +1 -1
- package/.docs/models/providers/xiaomi-token-plan-sgp.md +1 -1
- package/.docs/models/providers/xiaomi.md +1 -1
- package/.docs/models/providers/xpersona.md +1 -1
- package/.docs/models/providers/zai-coding-plan.md +1 -1
- package/.docs/models/providers/zai.md +1 -1
- package/.docs/models/providers/zeldoc.md +8 -8
- package/.docs/models/providers/zenifra.md +1 -1
- package/.docs/models/providers/zenmux.md +1 -16
- package/.docs/models/providers/zhipuai-coding-plan.md +1 -1
- package/.docs/models/providers/zhipuai.md +1 -1
- package/.docs/models/providers.md +1 -0
- package/.docs/reference/agent-controller/agent-controller-class.md +35 -4
- package/.docs/reference/agent-controller/session.md +5 -3
- package/.docs/reference/agents/channels.md +2 -2
- package/.docs/reference/agents/durable-agent.md +2 -0
- package/.docs/reference/agents/generateLegacy.md +2 -2
- package/.docs/reference/agents/getDefaultOptions.md +1 -1
- package/.docs/reference/agents/getDefaultStreamOptions.md +1 -1
- package/.docs/reference/agents/inngest-agent.md +3 -1
- package/.docs/reference/agents/network.md +1 -1
- package/.docs/reference/ai-sdk/handle-network-stream.md +1 -1
- package/.docs/reference/ai-sdk/network-route.md +1 -1
- package/.docs/reference/auth/auth0.md +1 -1
- package/.docs/reference/auth/better-auth.md +1 -1
- package/.docs/reference/auth/clerk.md +1 -1
- package/.docs/reference/auth/firebase.md +1 -1
- package/.docs/reference/auth/google.md +1 -1
- package/.docs/reference/auth/okta.md +5 -1
- package/.docs/reference/auth/supabase.md +1 -1
- package/.docs/reference/auth/workos.md +1 -1
- package/.docs/reference/browser/agent-browser.md +2 -2
- package/.docs/reference/browser/browser-viewer.md +1 -1
- package/.docs/reference/browser/firecrawl-browser.md +1 -1
- package/.docs/reference/browser/mastra-browser.md +1 -1
- package/.docs/reference/browser/stagehand-browser.md +2 -2
- package/.docs/reference/channels/channel-provider.md +1 -1
- package/.docs/reference/channels/slack-provider.md +2 -2
- package/.docs/reference/cli/mastra.md +6 -6
- package/.docs/reference/client-js/agents.md +2 -1
- package/.docs/reference/client-js/workflows.md +3 -3
- package/.docs/reference/code-sdk/mount-agent-controller.md +1 -1
- package/.docs/reference/configuration.md +21 -27
- package/.docs/reference/core/addDynamicWorkflow.md +2 -2
- package/.docs/reference/core/addDynamicWorkflows.md +2 -2
- package/.docs/reference/core/getStorage.md +1 -1
- package/.docs/reference/core/getVector.md +2 -2
- package/.docs/reference/core/listVectors.md +2 -2
- package/.docs/reference/core/setStorage.md +1 -1
- package/.docs/reference/datasets/startExperiment.md +8 -0
- package/.docs/reference/file-based-agents/config.md +2 -0
- package/.docs/reference/file-based-agents/instructions.md +2 -0
- package/.docs/reference/file-based-agents/logger.md +2 -0
- package/.docs/reference/file-based-agents/memory.md +2 -0
- package/.docs/reference/file-based-agents/observability.md +2 -0
- package/.docs/reference/file-based-agents/processors.md +2 -0
- package/.docs/reference/file-based-agents/schedules.md +2 -0
- package/.docs/reference/file-based-agents/scorers.md +2 -0
- package/.docs/reference/file-based-agents/server.md +2 -0
- package/.docs/reference/file-based-agents/skills.md +2 -0
- package/.docs/reference/file-based-agents/storage.md +3 -1
- package/.docs/reference/file-based-agents/studio.md +3 -1
- package/.docs/reference/file-based-agents/subagents.md +2 -0
- package/.docs/reference/file-based-agents/tools.md +2 -0
- package/.docs/reference/file-based-agents/workflows.md +2 -0
- package/.docs/reference/file-based-agents/workspace.md +2 -0
- package/.docs/reference/index.md +29 -54
- package/.docs/{guides/getting-started → reference}/manual-install.md +2 -2
- package/.docs/{guides → reference}/migrations/ai-sdk-v4-to-v5.md +1 -1
- package/.docs/{guides → reference}/migrations/mastra-cloud.md +2 -2
- package/.docs/{guides → reference}/migrations/upgrade-to-v1/cli.md +1 -1
- package/.docs/{guides → reference}/migrations/upgrade-to-v1/memory.md +1 -1
- package/.docs/{guides → reference}/migrations/upgrade-to-v1/overview.md +41 -41
- package/.docs/{guides → reference}/migrations/upgrade-to-v1/tools.md +1 -1
- package/.docs/{guides → reference}/migrations/upgrade-to-v1/tracing.md +10 -10
- package/.docs/reference/observability/tracing/bridges/datadog.md +2 -2
- package/.docs/reference/observability/tracing/bridges/otel.md +2 -2
- package/.docs/reference/observability/tracing/exporters/arize.md +1 -1
- package/.docs/reference/observability/tracing/exporters/arthur.md +1 -1
- package/.docs/reference/observability/tracing/exporters/confident-ai.md +1 -1
- package/.docs/reference/observability/tracing/exporters/datadog.md +1 -1
- package/.docs/reference/observability/tracing/exporters/mastra-platform-exporter.md +12 -0
- package/.docs/reference/observability/tracing/exporters/otel.md +2 -2
- package/.docs/reference/processors/pii-detector.md +2 -0
- package/.docs/reference/processors/prompt-injection-detector.md +2 -0
- package/.docs/reference/processors/regex-filter-processor.md +20 -0
- package/.docs/reference/processors/response-cache.md +2 -0
- package/.docs/reference/processors/tool-search-processor.md +33 -1
- package/.docs/reference/pubsub/lease-provider.md +1 -1
- package/.docs/{guides → reference}/rag/chunking-and-embedding.md +16 -19
- package/.docs/reference/rag/database-config.md +1 -1
- package/.docs/{guides/rag/graph-rag.md → reference/rag/graph-rag-guide.md} +1 -1
- package/.docs/reference/rag/metadata-filters.md +13 -4
- package/.docs/{guides → reference}/rag/overview.md +2 -2
- package/.docs/{guides → reference}/rag/retrieval.md +18 -1
- package/.docs/{guides → reference}/rag/vector-databases.md +42 -1
- package/.docs/reference/schedules/overview.md +2 -0
- package/.docs/reference/server/create-route.md +27 -1
- package/.docs/reference/server/register-api-route.md +2 -0
- package/.docs/reference/signals/create-notification-inbox-tool.md +2 -0
- package/.docs/reference/signals/signal-provider.md +2 -0
- package/.docs/reference/signals/task-signal-provider.md +2 -0
- package/.docs/reference/signals/webhook-signal-provider.md +2 -0
- package/.docs/reference/storage/composite.md +4 -4
- package/.docs/reference/storage/retention.md +4 -4
- package/.docs/reference/streaming/ChunkType.md +3 -3
- package/.docs/reference/streaming/agents/stream.md +1 -1
- package/.docs/reference/streaming/agents/streamLegacy.md +3 -3
- package/.docs/reference/streaming/agents/streamUntilIdle.md +1 -1
- package/.docs/reference/tools/create-code-mode.md +3 -1
- package/.docs/reference/tools/isolated-vm-transport.md +1 -1
- package/.docs/reference/tools/mcp-client.md +51 -0
- package/.docs/reference/tools/mcp-server.md +1 -1
- package/.docs/reference/tools/quickjs-transport.md +92 -0
- package/.docs/reference/vectors/chroma.md +1 -1
- package/.docs/reference/vectors/convex.md +2 -2
- package/.docs/reference/vectors/oracledb.md +347 -0
- package/.docs/reference/workers/overview.md +10 -8
- package/.docs/reference/workflows/dynamic-workflow-definition.md +3 -1
- package/.docs/reference/workflows/run-methods/timeTravel.md +1 -0
- package/.docs/reference/workflows/workflow.md +18 -0
- package/.docs/reference/workspace/local-sandbox.md +1 -1
- package/.docs/reference/workspace/platform-filesystem.md +3 -3
- package/.docs/reference/workspace/platform-sandbox.md +11 -3
- package/.docs/reference/workspace/process-manager.md +3 -3
- package/.docs/reference/workspace/sandbox.md +10 -0
- package/CHANGELOG.md +90 -0
- package/dist/index.js +1 -1
- package/dist/{src-BZcgzbk9.js → src-D-W-bx5t.js} +2 -2
- package/dist/{src-BZcgzbk9.js.map → src-D-W-bx5t.js.map} +1 -1
- package/dist/stdio.js +1 -1
- package/package.json +6 -6
- package/.docs/docs/capabilities/channels/other-adapters.md +0 -68
- package/.docs/docs/observability/integrations/bridges/datadog.md +0 -219
- package/.docs/docs/observability/integrations/bridges/otel.md +0 -234
- package/.docs/docs/observability/integrations/exporters/datadog.md +0 -321
- package/.docs/guides/build-your-ui/copilotkit/channels.md +0 -86
- package/.docs/guides/build-your-ui/copilotkit/generative-ui.md +0 -174
- package/.docs/guides/guide/chef-michel.md +0 -211
- package/.docs/guides/guide/publishing-mcp-server.md +0 -137
- package/.docs/guides/guide/slack-assistant.md +0 -193
- package/.docs/guides/guide/stock-agent.md +0 -132
- package/.docs/guides/guide/web-search.md +0 -322
- package/.docs/guides/guide/whatsapp-chat-bot.md +0 -407
- package/.docs/guides/voice/realtime-voice.md +0 -430
- package/.docs/reference/voice/google.md +0 -290
- package/.docs/reference/voice/inworld.md +0 -137
- package/.docs/reference/voice/openai.md +0 -96
- package/.docs/reference/voice/playai.md +0 -82
- package/.docs/reference/workspace/vercel-serverless.md +0 -128
- /package/.docs/{guides/concepts → docs/guides}/multi-agent-systems.md +0 -0
- /package/.docs/{guides/concepts → docs/guides}/streaming.md +0 -0
- /package/.docs/{guides/build-your-ui → integrations/agentic-ui}/openui.md +0 -0
- /package/.docs/{docs/server → integrations}/auth/better-auth.md +0 -0
- /package/.docs/{docs/server → integrations}/auth/google.md +0 -0
- /package/.docs/{guides/deployment → integrations/deploy}/inngest.md +0 -0
- /package/.docs/{guides/deployment → integrations/deploy}/temporal.md +0 -0
- /package/.docs/{reference/workspace/agentfs-filesystem.md → integrations/file-storage/agentfs.md} +0 -0
- /package/.docs/{reference/workspace/google-drive-filesystem.md → integrations/file-storage/google-drive.md} +0 -0
- /package/.docs/{guides/getting-started → integrations/frameworks}/express.md +0 -0
- /package/.docs/{guides/getting-started → integrations/frameworks}/hono.md +0 -0
- /package/.docs/{guides/getting-started → integrations/frameworks}/nestjs.md +0 -0
- /package/.docs/{reference/workspace/agentcore-runtime-sandbox.md → integrations/sandboxes/agentcore.md} +0 -0
- /package/.docs/{reference/workspace/blaxel-sandbox.md → integrations/sandboxes/blaxel.md} +0 -0
- /package/.docs/{guides/guide → integrations/tools}/firecrawl.md +0 -0
- /package/.docs/{reference → integrations}/voice/azure.md +0 -0
- /package/.docs/{reference → integrations}/voice/deepgram.md +0 -0
- /package/.docs/{reference → integrations}/voice/elevenlabs.md +0 -0
- /package/.docs/{reference → integrations}/voice/mistral.md +0 -0
- /package/.docs/{reference → integrations}/voice/murf.md +0 -0
- /package/.docs/{reference → integrations}/voice/sarvam.md +0 -0
- /package/.docs/{reference → integrations}/voice/speechify.md +0 -0
- /package/.docs/{reference/voice/xai-realtime.md → integrations/voice/xai.md} +0 -0
- /package/.docs/{guides → reference}/migrations/agentnetwork.md +0 -0
- /package/.docs/{guides → reference}/migrations/network-to-supervisor.md +0 -0
- /package/.docs/{guides → reference}/migrations/upgrade-to-v1/agent.md +0 -0
- /package/.docs/{guides → reference}/migrations/upgrade-to-v1/client.md +0 -0
- /package/.docs/{guides → reference}/migrations/upgrade-to-v1/deployment.md +0 -0
- /package/.docs/{guides → reference}/migrations/upgrade-to-v1/evals.md +0 -0
- /package/.docs/{guides → reference}/migrations/upgrade-to-v1/mastra.md +0 -0
- /package/.docs/{guides → reference}/migrations/upgrade-to-v1/mcp.md +0 -0
- /package/.docs/{guides → reference}/migrations/upgrade-to-v1/processors.md +0 -0
- /package/.docs/{guides → reference}/migrations/upgrade-to-v1/rag.md +0 -0
- /package/.docs/{guides → reference}/migrations/upgrade-to-v1/storage.md +0 -0
- /package/.docs/{guides → reference}/migrations/upgrade-to-v1/vectors.md +0 -0
- /package/.docs/{guides → reference}/migrations/upgrade-to-v1/voice.md +0 -0
- /package/.docs/{guides → reference}/migrations/upgrade-to-v1/workflows.md +0 -0
- /package/.docs/{guides → reference}/migrations/vnext-to-standard-apis.md +0 -0
|
@@ -2,6 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
# Studio
|
|
4
4
|
|
|
5
|
+
> **Beta:** Breaking changes may occur without a major version bump until the API is stable.
|
|
6
|
+
|
|
5
7
|
Mastra configures [Studio](https://mastra.ai/docs/studio/overview) from a `studio.ts` file directly under `src/mastra/`. The file default-exports a `StudioConfig` object for Studio authentication and authorization: who can access Studio, and what authenticated users can do.
|
|
6
8
|
|
|
7
9
|
Use this page for the file-based convention. For auth providers, role-based access control (RBAC), and fine-grained authorization (FGA), see [Studio auth](https://mastra.ai/docs/studio/auth).
|
|
@@ -38,7 +40,7 @@ Studio opens without authentication in local development. Add `studio.ts` when y
|
|
|
38
40
|
|
|
39
41
|
## Add authentication
|
|
40
42
|
|
|
41
|
-
Use an auth provider to require sign-in before users can access Studio. This example uses [WorkOS](https://mastra.ai/
|
|
43
|
+
Use an auth provider to require sign-in before users can access Studio. This example uses [WorkOS](https://mastra.ai/integrations/auth/workos):
|
|
42
44
|
|
|
43
45
|
```typescript
|
|
44
46
|
import { MastraAuthWorkos } from '@mastra/auth-workos'
|
|
@@ -2,6 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
# Subagents
|
|
4
4
|
|
|
5
|
+
> **Beta:** Breaking changes may occur without a major version bump until the API is stable.
|
|
6
|
+
|
|
5
7
|
A file-based agent can declare **subagents**, specialist child agents it delegates to. The parent model sees each subagent as a delegation tool named after the subagent directory and calls that tool to hand off a task. The subagent's result returns to the parent conversation.
|
|
6
8
|
|
|
7
9
|
Use this page for the file-based convention. For broader delegation patterns, hooks, memory isolation, tool approval propagation, and scoring, see [Supervisor agents](https://mastra.ai/docs/capabilities/subagents).
|
|
@@ -2,6 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
# Tools
|
|
4
4
|
|
|
5
|
+
> **Beta:** Breaking changes may occur without a major version bump until the API is stable.
|
|
6
|
+
|
|
5
7
|
A file-based agent discovers tools from `.ts` and `.js` files directly under its `tools/` directory. Each discovered file is imported at build time, the file must default-export a [`createTool()`](https://mastra.ai/reference/tools/create-tool) result, and the filename without its extension becomes the tool key the model can call.
|
|
6
8
|
|
|
7
9
|
Use this page for the file-based convention. For tool schemas, execution options, output shaping, and approval options, see the [`createTool()` reference](https://mastra.ai/reference/tools/create-tool).
|
|
@@ -2,6 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
# Workflows
|
|
4
4
|
|
|
5
|
+
> **Beta:** Breaking changes may occur without a major version bump until the API is stable.
|
|
6
|
+
|
|
5
7
|
Mastra discovers project-level workflows from `.ts` and `.js` files under `src/mastra/workflows/`. This convention isn't scoped to one agent: every file with a default export becomes a registered workflow, and the filename becomes the workflow key.
|
|
6
8
|
|
|
7
9
|
Use this page for the file-based convention. For steps, schemas, control flow, streaming, state, and workflow execution, see [Workflows overview](https://mastra.ai/docs/workflows/overview).
|
|
@@ -2,6 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
# Workspace
|
|
4
4
|
|
|
5
|
+
> **Beta:** Breaking changes may occur without a major version bump until the API is stable.
|
|
6
|
+
|
|
5
7
|
A [workspace](https://mastra.ai/docs/workspace/overview) gives an agent filesystem access and command execution. File-based agents get a default workspace automatically when discovered through `mastra dev` or `mastra build`, so they can read and write files and run shell commands without extra configuration.
|
|
6
8
|
|
|
7
9
|
Use this page for the file-based convention. For workspace providers, tools, search, lifecycle, and sandbox details, see [Workspaces](https://mastra.ai/docs/workspace/overview).
|
package/.docs/reference/index.md
CHANGED
|
@@ -212,6 +212,28 @@ The Reference section provides documentation of Mastra's API, including paramete
|
|
|
212
212
|
- [.listThreads()](https://mastra.ai/reference/memory/listThreads)
|
|
213
213
|
- [.recall()](https://mastra.ai/reference/memory/recall)
|
|
214
214
|
- [.summarizeThread()](https://mastra.ai/reference/memory/summarizeThread)
|
|
215
|
+
- [AgentNetwork to .network()](https://mastra.ai/reference/migrations/agentnetwork)
|
|
216
|
+
- [AI SDK v4 to v5](https://mastra.ai/reference/migrations/ai-sdk-v4-to-v5)
|
|
217
|
+
- [Mastra Cloud to Mastra platform](https://mastra.ai/reference/migrations/mastra-cloud)
|
|
218
|
+
- [VNext to Standard APIs](https://mastra.ai/reference/migrations/vnext-to-standard-apis)
|
|
219
|
+
- [.network() to Supervisor Agents](https://mastra.ai/reference/migrations/network-to-supervisor)
|
|
220
|
+
- [Overview](https://mastra.ai/reference/migrations/upgrade-to-v1/overview)
|
|
221
|
+
- [Agents](https://mastra.ai/reference/migrations/upgrade-to-v1/agent)
|
|
222
|
+
- [CLI](https://mastra.ai/reference/migrations/upgrade-to-v1/cli)
|
|
223
|
+
- [Client SDK](https://mastra.ai/reference/migrations/upgrade-to-v1/client)
|
|
224
|
+
- [Deployment](https://mastra.ai/reference/migrations/upgrade-to-v1/deployment)
|
|
225
|
+
- [Evals](https://mastra.ai/reference/migrations/upgrade-to-v1/evals)
|
|
226
|
+
- [Mastra](https://mastra.ai/reference/migrations/upgrade-to-v1/mastra)
|
|
227
|
+
- [MCP](https://mastra.ai/reference/migrations/upgrade-to-v1/mcp)
|
|
228
|
+
- [Memory](https://mastra.ai/reference/migrations/upgrade-to-v1/memory)
|
|
229
|
+
- [Processors](https://mastra.ai/reference/migrations/upgrade-to-v1/processors)
|
|
230
|
+
- [RAG](https://mastra.ai/reference/migrations/upgrade-to-v1/rag)
|
|
231
|
+
- [Storage](https://mastra.ai/reference/migrations/upgrade-to-v1/storage)
|
|
232
|
+
- [Tools](https://mastra.ai/reference/migrations/upgrade-to-v1/tools)
|
|
233
|
+
- [Tracing](https://mastra.ai/reference/migrations/upgrade-to-v1/tracing)
|
|
234
|
+
- [Vectors](https://mastra.ai/reference/migrations/upgrade-to-v1/vectors)
|
|
235
|
+
- [Voice](https://mastra.ai/reference/migrations/upgrade-to-v1/voice)
|
|
236
|
+
- [Workflows](https://mastra.ai/reference/migrations/upgrade-to-v1/workflows)
|
|
215
237
|
- [Feedback](https://mastra.ai/reference/observability/feedback)
|
|
216
238
|
- [PinoLogger](https://mastra.ai/reference/logging/pino-logger)
|
|
217
239
|
- [Automatic Metrics](https://mastra.ai/reference/observability/metrics/automatic-metrics)
|
|
@@ -248,14 +270,19 @@ The Reference section provides documentation of Mastra's API, including paramete
|
|
|
248
270
|
- [PubSub](https://mastra.ai/reference/pubsub/base)
|
|
249
271
|
- [RedisStreamsPubSub](https://mastra.ai/reference/pubsub/redis-streams)
|
|
250
272
|
- [UnixSocketPubSub](https://mastra.ai/reference/pubsub/unix-socket-pubsub)
|
|
273
|
+
- [Overview](https://mastra.ai/reference/rag/overview)
|
|
274
|
+
- [Chunking and Embedding](https://mastra.ai/reference/rag/chunking-and-embedding)
|
|
251
275
|
- [DatabaseConfig](https://mastra.ai/reference/rag/database-config)
|
|
252
276
|
- [Embed](https://mastra.ai/reference/rag/embeddings)
|
|
253
277
|
- [ExtractParams](https://mastra.ai/reference/rag/extract-params)
|
|
254
278
|
- [GraphRAG](https://mastra.ai/reference/rag/graph-rag)
|
|
279
|
+
- [GraphRAG Guide](https://mastra.ai/reference/rag/graph-rag-guide)
|
|
255
280
|
- [MDocument](https://mastra.ai/reference/rag/document)
|
|
256
281
|
- [Metadata Filters](https://mastra.ai/reference/rag/metadata-filters)
|
|
257
282
|
- [rerank()](https://mastra.ai/reference/rag/rerank)
|
|
258
283
|
- [rerankWithScorer()](https://mastra.ai/reference/rag/rerankWithScorer)
|
|
284
|
+
- [Retrieval](https://mastra.ai/reference/rag/retrieval)
|
|
285
|
+
- [Vector Databases](https://mastra.ai/reference/rag/vector-databases)
|
|
259
286
|
- [.chunk()](https://mastra.ai/reference/rag/chunk)
|
|
260
287
|
- [Overview](https://mastra.ai/reference/schedules/overview)
|
|
261
288
|
- [createRoute()](https://mastra.ai/reference/server/create-route)
|
|
@@ -272,23 +299,8 @@ The Reference section provides documentation of Mastra's API, including paramete
|
|
|
272
299
|
- [TaskSignalProvider](https://mastra.ai/reference/signals/task-signal-provider)
|
|
273
300
|
- [WebhookSignalProvider](https://mastra.ai/reference/signals/webhook-signal-provider)
|
|
274
301
|
- [Overview](https://mastra.ai/reference/storage/overview)
|
|
275
|
-
- [Aurora DSQL Storage](https://mastra.ai/reference/storage/dsql)
|
|
276
|
-
- [ClickHouse Storage](https://mastra.ai/reference/storage/clickhouse)
|
|
277
|
-
- [Cloudflare D1 Storage](https://mastra.ai/reference/storage/cloudflare-d1)
|
|
278
|
-
- [Cloudflare KV Storage](https://mastra.ai/reference/storage/cloudflare)
|
|
279
302
|
- [Composite Storage](https://mastra.ai/reference/storage/composite)
|
|
280
|
-
- [Convex Storage](https://mastra.ai/reference/storage/convex)
|
|
281
|
-
- [DuckDB Storage](https://mastra.ai/reference/storage/duckdb)
|
|
282
|
-
- [DynamoDB Storage](https://mastra.ai/reference/storage/dynamodb)
|
|
283
|
-
- [Google Cloud Spanner Storage](https://mastra.ai/reference/storage/spanner)
|
|
284
|
-
- [LanceDB Storage](https://mastra.ai/reference/storage/lance)
|
|
285
|
-
- [libSQL Storage](https://mastra.ai/reference/storage/libsql)
|
|
286
|
-
- [MongoDB Storage](https://mastra.ai/reference/storage/mongodb)
|
|
287
|
-
- [MSSQL Storage](https://mastra.ai/reference/storage/mssql)
|
|
288
|
-
- [PostgreSQL Storage](https://mastra.ai/reference/storage/postgresql)
|
|
289
|
-
- [Redis Storage](https://mastra.ai/reference/storage/redis)
|
|
290
303
|
- [Retention (prune)](https://mastra.ai/reference/storage/retention)
|
|
291
|
-
- [Upstash Storage](https://mastra.ai/reference/storage/upstash)
|
|
292
304
|
- [ChunkType](https://mastra.ai/reference/streaming/ChunkType)
|
|
293
305
|
- [smoothStream()](https://mastra.ai/reference/streaming/smoothStream)
|
|
294
306
|
- [MastraModelOutput](https://mastra.ai/reference/streaming/agents/MastraModelOutput)
|
|
@@ -301,7 +313,6 @@ The Reference section provides documentation of Mastra's API, including paramete
|
|
|
301
313
|
- [.timeTravelStream()](https://mastra.ai/reference/streaming/workflows/timeTravelStream)
|
|
302
314
|
- [Overview](https://mastra.ai/reference/templates/overview)
|
|
303
315
|
- [askUserTool](https://mastra.ai/reference/tools/ask-user-tool)
|
|
304
|
-
- [Bright Data Tools](https://mastra.ai/reference/tools/brightdata)
|
|
305
316
|
- [createBedrockKBTool()](https://mastra.ai/reference/tools/bedrock-kb-tool)
|
|
306
317
|
- [createCodeMode()](https://mastra.ai/reference/tools/create-code-mode)
|
|
307
318
|
- [createDocumentChunkerTool()](https://mastra.ai/reference/tools/document-chunker-tool)
|
|
@@ -311,10 +322,9 @@ The Reference section provides documentation of Mastra's API, including paramete
|
|
|
311
322
|
- [IsolatedVmCodeModeTransport](https://mastra.ai/reference/tools/isolated-vm-transport)
|
|
312
323
|
- [MCPClient](https://mastra.ai/reference/tools/mcp-client)
|
|
313
324
|
- [MCPServer](https://mastra.ai/reference/tools/mcp-server)
|
|
314
|
-
- [
|
|
325
|
+
- [QuickJsCodeModeTransport](https://mastra.ai/reference/tools/quickjs-transport)
|
|
315
326
|
- [submitPlanTool](https://mastra.ai/reference/tools/submit-plan-tool)
|
|
316
327
|
- [Task tools](https://mastra.ai/reference/tools/task-tools)
|
|
317
|
-
- [Tavily Tools](https://mastra.ai/reference/tools/tavily)
|
|
318
328
|
- [Amazon S3 Vector Store](https://mastra.ai/reference/vectors/s3vectors)
|
|
319
329
|
- [Astra Vector Store](https://mastra.ai/reference/vectors/astra)
|
|
320
330
|
- [Chroma Vector Store](https://mastra.ai/reference/vectors/chroma)
|
|
@@ -327,32 +337,15 @@ The Reference section provides documentation of Mastra's API, including paramete
|
|
|
327
337
|
- [libSQL Vector Store](https://mastra.ai/reference/vectors/libsql)
|
|
328
338
|
- [MongoDB Vector Store](https://mastra.ai/reference/vectors/mongodb)
|
|
329
339
|
- [OpenSearch Vector Store](https://mastra.ai/reference/vectors/opensearch)
|
|
340
|
+
- [OracleDB Vector Store](https://mastra.ai/reference/vectors/oracledb)
|
|
330
341
|
- [PG Vector Store](https://mastra.ai/reference/vectors/pg)
|
|
331
342
|
- [Pinecone Vector Store](https://mastra.ai/reference/vectors/pinecone)
|
|
332
343
|
- [Qdrant Vector Store](https://mastra.ai/reference/vectors/qdrant)
|
|
333
344
|
- [Turbopuffer Vector Store](https://mastra.ai/reference/vectors/turbopuffer)
|
|
334
345
|
- [Upstash Vector Store](https://mastra.ai/reference/vectors/upstash)
|
|
335
|
-
- [AWS Nova Sonic](https://mastra.ai/reference/voice/aws-nova-sonic)
|
|
336
|
-
- [Azure](https://mastra.ai/reference/voice/azure)
|
|
337
|
-
- [Cloudflare](https://mastra.ai/reference/voice/cloudflare)
|
|
338
346
|
- [Composite Voice](https://mastra.ai/reference/voice/composite-voice)
|
|
339
|
-
- [Deepgram](https://mastra.ai/reference/voice/deepgram)
|
|
340
|
-
- [ElevenLabs](https://mastra.ai/reference/voice/elevenlabs)
|
|
341
347
|
- [Events](https://mastra.ai/reference/voice/voice.events)
|
|
342
|
-
- [Google](https://mastra.ai/reference/voice/google)
|
|
343
|
-
- [Google Gemini Live](https://mastra.ai/reference/voice/google-gemini-live)
|
|
344
|
-
- [Inworld](https://mastra.ai/reference/voice/inworld)
|
|
345
|
-
- [Inworld Realtime](https://mastra.ai/reference/voice/inworld-realtime)
|
|
346
|
-
- [LiveKit](https://mastra.ai/reference/voice/livekit)
|
|
347
348
|
- [Mastra Voice](https://mastra.ai/reference/voice/mastra-voice)
|
|
348
|
-
- [Mistral](https://mastra.ai/reference/voice/mistral)
|
|
349
|
-
- [Murf](https://mastra.ai/reference/voice/murf)
|
|
350
|
-
- [OpenAI](https://mastra.ai/reference/voice/openai)
|
|
351
|
-
- [OpenAI Realtime](https://mastra.ai/reference/voice/openai-realtime)
|
|
352
|
-
- [PlayAI](https://mastra.ai/reference/voice/playai)
|
|
353
|
-
- [Sarvam](https://mastra.ai/reference/voice/sarvam)
|
|
354
|
-
- [Speechify](https://mastra.ai/reference/voice/speechify)
|
|
355
|
-
- [xAI Realtime](https://mastra.ai/reference/voice/xai-realtime)
|
|
356
349
|
- [.addInstructions()](https://mastra.ai/reference/voice/voice.addInstructions)
|
|
357
350
|
- [.addTools()](https://mastra.ai/reference/voice/voice.addTools)
|
|
358
351
|
- [.answer()](https://mastra.ai/reference/voice/voice.answer)
|
|
@@ -390,29 +383,11 @@ The Reference section provides documentation of Mastra's API, including paramete
|
|
|
390
383
|
- [.start()](https://mastra.ai/reference/workflows/run-methods/start)
|
|
391
384
|
- [.startAsync()](https://mastra.ai/reference/workflows/run-methods/startAsync)
|
|
392
385
|
- [.timeTravel()](https://mastra.ai/reference/workflows/run-methods/timeTravel)
|
|
393
|
-
- [AgentCoreRuntimeSandbox](https://mastra.ai/reference/workspace/agentcore-runtime-sandbox)
|
|
394
|
-
- [AgentFSFilesystem](https://mastra.ai/reference/workspace/agentfs-filesystem)
|
|
395
|
-
- [AppleContainerSandbox](https://mastra.ai/reference/workspace/apple-container-sandbox)
|
|
396
|
-
- [ArchilFilesystem](https://mastra.ai/reference/workspace/archil-filesystem)
|
|
397
|
-
- [AzureBlobFilesystem](https://mastra.ai/reference/workspace/azure-blob-filesystem)
|
|
398
|
-
- [BlaxelSandbox](https://mastra.ai/reference/workspace/blaxel-sandbox)
|
|
399
|
-
- [DaytonaSandbox](https://mastra.ai/reference/workspace/daytona-sandbox)
|
|
400
|
-
- [DockerSandbox](https://mastra.ai/reference/workspace/docker-sandbox)
|
|
401
|
-
- [E2BSandbox](https://mastra.ai/reference/workspace/e2b-sandbox)
|
|
402
|
-
- [FilesSDKFilesystem](https://mastra.ai/reference/workspace/files-sdk-filesystem)
|
|
403
|
-
- [GCSFilesystem](https://mastra.ai/reference/workspace/gcs-filesystem)
|
|
404
|
-
- [GoogleDriveFilesystem](https://mastra.ai/reference/workspace/google-drive-filesystem)
|
|
405
386
|
- [LocalFilesystem](https://mastra.ai/reference/workspace/local-filesystem)
|
|
406
387
|
- [LocalSandbox](https://mastra.ai/reference/workspace/local-sandbox)
|
|
407
|
-
- [MesaFilesystem](https://mastra.ai/reference/workspace/mesa-filesystem)
|
|
408
|
-
- [ModalSandbox](https://mastra.ai/reference/workspace/modal-sandbox)
|
|
409
388
|
- [PlatformFilesystem](https://mastra.ai/reference/workspace/platform-filesystem)
|
|
410
389
|
- [PlatformSandbox](https://mastra.ai/reference/workspace/platform-sandbox)
|
|
411
|
-
- [RailwaySandbox](https://mastra.ai/reference/workspace/railway-sandbox)
|
|
412
|
-
- [S3Filesystem](https://mastra.ai/reference/workspace/s3-filesystem)
|
|
413
390
|
- [SandboxProcessManager](https://mastra.ai/reference/workspace/process-manager)
|
|
414
|
-
- [VercelSandbox](https://mastra.ai/reference/workspace/vercel-sandbox)
|
|
415
|
-
- [VercelServerlessSandbox](https://mastra.ai/reference/workspace/vercel-serverless)
|
|
416
391
|
- [Workspace Class](https://mastra.ai/reference/workspace/workspace-class)
|
|
417
392
|
- [WorkspaceFilesystem](https://mastra.ai/reference/workspace/filesystem)
|
|
418
393
|
- [WorkspaceSandbox](https://mastra.ai/reference/workspace/sandbox)
|
|
@@ -108,7 +108,7 @@ If you prefer not to use our automatic CLI tool, you can set up your project you
|
|
|
108
108
|
}
|
|
109
109
|
```
|
|
110
110
|
|
|
111
|
-
> **
|
|
111
|
+
> **Note:** Mastra requires modern `module` and `moduleResolution` settings. Using `CommonJS` or `node` will cause resolution errors.
|
|
112
112
|
|
|
113
113
|
3. Create an `.env` file:
|
|
114
114
|
|
|
@@ -157,7 +157,7 @@ If you prefer not to use our automatic CLI tool, you can set up your project you
|
|
|
157
157
|
})
|
|
158
158
|
```
|
|
159
159
|
|
|
160
|
-
> **
|
|
160
|
+
> **Note:** We've shortened and simplified the `weatherTool` example here. You can see the complete weather tool under [Giving an Agent a Tool](https://mastra.ai/docs/agents/using-tools).
|
|
161
161
|
|
|
162
162
|
5. Create a `weather-agent.ts` file:
|
|
163
163
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Migrate from AI SDK v4 to v5
|
|
4
4
|
|
|
5
|
-
Looking for integration docs? See [Using AI SDK](https://mastra.ai/
|
|
5
|
+
Looking for integration docs? See [Using AI SDK](https://mastra.ai/integrations/agentic-ui/ai-sdk-ui).
|
|
6
6
|
|
|
7
7
|
Follow the official [AI SDK v5 Migration Guide](https://v5.ai-sdk.dev/docs/migration-guides/migration-guide-5-0) for all AI SDK core breaking changes, package updates, and API changes.
|
|
8
8
|
|
|
@@ -95,7 +95,7 @@ If you prefer to work from the command line, or need to script the export, you c
|
|
|
95
95
|
|
|
96
96
|
> **Note:** These variables only appear for projects that were provisioned with Cloud Store. If you brought your own database to Mastra Cloud, you already have these credentials and can skip ahead to [Point your Mastra app at the new database](#point-your-mastra-app-at-the-new-database).
|
|
97
97
|
|
|
98
|
-
> **
|
|
98
|
+
> **Note:** If the variables are missing, the values do not decrypt, or the Turso CLI rejects the token, email <support@mastra.ai> from the address associated with your Mastra Cloud account and ask for the libSQL URL and auth token for the project you want to export. Include the project name/ID. Support can also run the dump on your behalf if CLI access is blocked on your network.
|
|
99
99
|
|
|
100
100
|
2. Install the Turso CLI.
|
|
101
101
|
|
|
@@ -179,7 +179,7 @@ export const mastra = new Mastra({
|
|
|
179
179
|
})
|
|
180
180
|
```
|
|
181
181
|
|
|
182
|
-
See the [libSQL storage reference](https://mastra.ai/
|
|
182
|
+
See the [libSQL storage reference](https://mastra.ai/integrations/databases/libsql) for the full set of options.
|
|
183
183
|
|
|
184
184
|
### Verify the migration
|
|
185
185
|
|
|
@@ -16,7 +16,7 @@ npx mastra migrate
|
|
|
16
16
|
|
|
17
17
|
The command bundles your project and connects to your configured storage before running any necessary migrations. It currently supports migrating duplicate span entries that may prevent unique constraint creation.
|
|
18
18
|
|
|
19
|
-
See the [Storage migration guide](https://mastra.ai/
|
|
19
|
+
See the [Storage migration guide](https://mastra.ai/reference/migrations/upgrade-to-v1/storage) for details on when this migration is needed.
|
|
20
20
|
|
|
21
21
|
## Removed
|
|
22
22
|
|
|
@@ -283,6 +283,6 @@ To migrate, move processor configuration from Memory to Agent using `inputProces
|
|
|
283
283
|
});
|
|
284
284
|
```
|
|
285
285
|
|
|
286
|
-
Additionally, the `@mastra/memory/processors` import path has been removed. Import processors from `@mastra/core/processors` instead. See the [processors migration guide](https://mastra.ai/
|
|
286
|
+
Additionally, the `@mastra/memory/processors` import path has been removed. Import processors from `@mastra/core/processors` instead. See the [processors migration guide](https://mastra.ai/reference/migrations/upgrade-to-v1/processors) for details.
|
|
287
287
|
|
|
288
288
|
For more information on using processors with agents, see the [Processors docs](https://mastra.ai/docs/agents/processors). For a complete example with memory, see the [TokenLimiter reference](https://mastra.ai/reference/processors/token-limiter-processor).
|
|
@@ -12,7 +12,7 @@ This guide covers the breaking changes when upgrading from Mastra 0.x to v1.0. T
|
|
|
12
12
|
|
|
13
13
|
> **Coming from Mastra Cloud?:** The legacy Mastra Cloud product has been replaced by the [Mastra platform](https://mastra.ai/docs/mastra-platform/overview), which splits hosting into two separate products: **Studio** (visual environment, observability) and **Server** (production API). Old Mastra Cloud access tokens don't work with Mastra platform. Create new ones with `mastra auth tokens create`.
|
|
14
14
|
>
|
|
15
|
-
> If you upgrade to v1 packages without also migrating your `telemetry:` config to `observability:` and creating a Studio project, observability data will stop flowing. Follow the [Mastra Cloud migration guide](https://mastra.ai/
|
|
15
|
+
> If you upgrade to v1 packages without also migrating your `telemetry:` config to `observability:` and creating a Studio project, observability data will stop flowing. Follow the [Mastra Cloud migration guide](https://mastra.ai/reference/migrations/mastra-cloud) end to end.
|
|
16
16
|
|
|
17
17
|
## Migration strategy
|
|
18
18
|
|
|
@@ -62,25 +62,25 @@ Work through the [migration checklist](#migration-checklist) below to update you
|
|
|
62
62
|
> npx @mastra/codemod@latest v1
|
|
63
63
|
> ```
|
|
64
64
|
|
|
65
|
-
> **Database Migration Required:** If you're using PostgreSQL or LibSQL storage, you'll need to run a database migration. See the [Storage migration guide](https://mastra.ai/
|
|
65
|
+
> **Database Migration Required:** If you're using PostgreSQL or LibSQL storage, you'll need to run a database migration. See the [Storage migration guide](https://mastra.ai/reference/migrations/upgrade-to-v1/storage) for details.
|
|
66
66
|
|
|
67
67
|
## Breaking changes by area
|
|
68
68
|
|
|
69
|
-
- **[Mastra Class](https://mastra.ai/
|
|
70
|
-
- **[Agent Class](https://mastra.ai/
|
|
71
|
-
- **[Tools](https://mastra.ai/
|
|
72
|
-
- **[Workflows](https://mastra.ai/
|
|
73
|
-
- **[Memory](https://mastra.ai/
|
|
74
|
-
- **[Storage](https://mastra.ai/
|
|
75
|
-
- **[Vectors](https://mastra.ai/
|
|
76
|
-
- **[RAG](https://mastra.ai/
|
|
77
|
-
- **[MCP](https://mastra.ai/
|
|
78
|
-
- **[Tracing](https://mastra.ai/
|
|
79
|
-
- **[Evals & Scorers](https://mastra.ai/
|
|
80
|
-
- **[CLI](https://mastra.ai/
|
|
81
|
-
- **[Deployment](https://mastra.ai/
|
|
82
|
-
- **[Client SDKs](https://mastra.ai/
|
|
83
|
-
- **[Voice Packages](https://mastra.ai/
|
|
69
|
+
- **[Mastra Class](https://mastra.ai/reference/migrations/upgrade-to-v1/mastra)** - Import restructuring and property access changes.
|
|
70
|
+
- **[Agent Class](https://mastra.ai/reference/migrations/upgrade-to-v1/agent)** - Voice methods moved to namespace and streaming API updates.
|
|
71
|
+
- **[Tools](https://mastra.ai/reference/migrations/upgrade-to-v1/tools)** - CreateTool execute signature changed to separate input and context.
|
|
72
|
+
- **[Workflows](https://mastra.ai/reference/migrations/upgrade-to-v1/workflows)** - Function name changes and legacy features removed.
|
|
73
|
+
- **[Memory](https://mastra.ai/reference/migrations/upgrade-to-v1/memory)** - Configuration now requires explicit parameters and defaults changed.
|
|
74
|
+
- **[Storage](https://mastra.ai/reference/migrations/upgrade-to-v1/storage)** - Pagination standardized and methods renamed to list pattern.
|
|
75
|
+
- **[Vectors](https://mastra.ai/reference/migrations/upgrade-to-v1/vectors)** - Vector store methods renamed to list pattern.
|
|
76
|
+
- **[RAG](https://mastra.ai/reference/migrations/upgrade-to-v1/rag)** - Parameter naming updated for clarity.
|
|
77
|
+
- **[MCP](https://mastra.ai/reference/migrations/upgrade-to-v1/mcp)** - Tool context reorganized and deprecated client classes removed.
|
|
78
|
+
- **[Tracing](https://mastra.ai/reference/migrations/upgrade-to-v1/tracing)** - OTEL telemetry replaced with dedicated observability package and exporters.
|
|
79
|
+
- **[Evals & Scorers](https://mastra.ai/reference/migrations/upgrade-to-v1/evals)** - Scorers API consolidated with new naming conventions.
|
|
80
|
+
- **[CLI](https://mastra.ai/reference/migrations/upgrade-to-v1/cli)** - Commands and flags removed for simpler interface.
|
|
81
|
+
- **[Deployment](https://mastra.ai/reference/migrations/upgrade-to-v1/deployment)** - CloudflareDeployer configuration updated to use standard wrangler.json property names.
|
|
82
|
+
- **[Client SDKs](https://mastra.ai/reference/migrations/upgrade-to-v1/client)** - Types and utilities renamed for consistency.
|
|
83
|
+
- **[Voice Packages](https://mastra.ai/reference/migrations/upgrade-to-v1/voice)** - Packages renamed from speech to voice.
|
|
84
84
|
|
|
85
85
|
## Migration checklist
|
|
86
86
|
|
|
@@ -96,30 +96,30 @@ Work through this checklist in order, starting with high-impact changes that aff
|
|
|
96
96
|
|
|
97
97
|
### High Impact Changes
|
|
98
98
|
|
|
99
|
-
- Update `createTool` tool signatures to `(inputData, context)` format - [Tools](https://mastra.ai/
|
|
100
|
-
- Restructure `@mastra/core` imports to use subpath imports - [Mastra Class](https://mastra.ai/
|
|
101
|
-
- Update pagination from `offset/limit` to `page/perPage` - [Storage](https://mastra.ai/
|
|
102
|
-
- Install `@mastra/observability` and wrap configuration with `new Observability()` - [Tracing](https://mastra.ai/
|
|
103
|
-
- Migrate from `telemetry:` to `observability:` configuration (if upgrading from 0.x OTEL) - [Tracing](https://mastra.ai/
|
|
99
|
+
- Update `createTool` tool signatures to `(inputData, context)` format - [Tools](https://mastra.ai/reference/migrations/upgrade-to-v1/tools)
|
|
100
|
+
- Restructure `@mastra/core` imports to use subpath imports - [Mastra Class](https://mastra.ai/reference/migrations/upgrade-to-v1/mastra)
|
|
101
|
+
- Update pagination from `offset/limit` to `page/perPage` - [Storage](https://mastra.ai/reference/migrations/upgrade-to-v1/storage)
|
|
102
|
+
- Install `@mastra/observability` and wrap configuration with `new Observability()` - [Tracing](https://mastra.ai/reference/migrations/upgrade-to-v1/tracing)
|
|
103
|
+
- Migrate from `telemetry:` to `observability:` configuration (if upgrading from 0.x OTEL) - [Tracing](https://mastra.ai/reference/migrations/upgrade-to-v1/tracing)
|
|
104
104
|
|
|
105
105
|
### Medium Impact Changes
|
|
106
106
|
|
|
107
|
-
- Rename `RuntimeContext` to `RequestContext` throughout codebase - [Agent Class](https://mastra.ai/
|
|
108
|
-
- Update storage methods from `get*` to `list*` pattern - [Storage](https://mastra.ai/
|
|
109
|
-
- Replace direct property access with getter methods - [Mastra Class](https://mastra.ai/
|
|
110
|
-
- Update memory scope if relying on default `thread` scope - [Memory](https://mastra.ai/
|
|
111
|
-
- Update vector store calls to use named arguments - [Storage](https://mastra.ai/
|
|
112
|
-
- Remove `format` parameter from agent methods - [Agent Class](https://mastra.ai/
|
|
113
|
-
- Update voice methods to use `agent.voice` namespace - [Agent Class](https://mastra.ai/
|
|
114
|
-
- Rename configuration property `processors` to `spanOutputProcessors` (if using custom processors) - [Tracing](https://mastra.ai/
|
|
115
|
-
|
|
116
|
-
### Low
|
|
117
|
-
|
|
118
|
-
- Rename `keepSeparator` to `separatorPosition` in chunk options - [RAG](https://mastra.ai/
|
|
119
|
-
- Rename `createRunAsync` to `createRun` - [Workflows](https://mastra.ai/
|
|
120
|
-
- Update voice package names from `@mastra/speech-*` to `@mastra/voice-*` - [Voice Packages](https://mastra.ai/
|
|
121
|
-
- Update scorer methods: `runExperiment` → `runEvals`, `getScorerByName` → `getScorerById` - [Evals & Scorers](https://mastra.ai/
|
|
122
|
-
- Remove deprecated CLI flags - [CLI](https://mastra.ai/
|
|
123
|
-
- Update client SDK types from `Get*` to `List*` - [Client SDKs](https://mastra.ai/
|
|
124
|
-
- Replace `runCount` with `retryCount` - [Workflows](https://mastra.ai/
|
|
125
|
-
- Update custom exporter method `exportEvent` to `exportTracingEvent` (if using custom exporters) - [Tracing](https://mastra.ai/
|
|
107
|
+
- Rename `RuntimeContext` to `RequestContext` throughout codebase - [Agent Class](https://mastra.ai/reference/migrations/upgrade-to-v1/agent), [Tools](https://mastra.ai/reference/migrations/upgrade-to-v1/tools), [Workflows](https://mastra.ai/reference/migrations/upgrade-to-v1/workflows)
|
|
108
|
+
- Update storage methods from `get*` to `list*` pattern - [Storage](https://mastra.ai/reference/migrations/upgrade-to-v1/storage)
|
|
109
|
+
- Replace direct property access with getter methods - [Mastra Class](https://mastra.ai/reference/migrations/upgrade-to-v1/mastra), [Agent Class](https://mastra.ai/reference/migrations/upgrade-to-v1/agent)
|
|
110
|
+
- Update memory scope if relying on default `thread` scope - [Memory](https://mastra.ai/reference/migrations/upgrade-to-v1/memory)
|
|
111
|
+
- Update vector store calls to use named arguments - [Storage](https://mastra.ai/reference/migrations/upgrade-to-v1/storage)
|
|
112
|
+
- Remove `format` parameter from agent methods - [Agent Class](https://mastra.ai/reference/migrations/upgrade-to-v1/agent)
|
|
113
|
+
- Update voice methods to use `agent.voice` namespace - [Agent Class](https://mastra.ai/reference/migrations/upgrade-to-v1/agent)
|
|
114
|
+
- Rename configuration property `processors` to `spanOutputProcessors` (if using custom processors) - [Tracing](https://mastra.ai/reference/migrations/upgrade-to-v1/tracing)
|
|
115
|
+
|
|
116
|
+
### Low-Impact Changes
|
|
117
|
+
|
|
118
|
+
- Rename `keepSeparator` to `separatorPosition` in chunk options - [RAG](https://mastra.ai/reference/migrations/upgrade-to-v1/rag)
|
|
119
|
+
- Rename `createRunAsync` to `createRun` - [Workflows](https://mastra.ai/reference/migrations/upgrade-to-v1/workflows)
|
|
120
|
+
- Update voice package names from `@mastra/speech-*` to `@mastra/voice-*` - [Voice Packages](https://mastra.ai/reference/migrations/upgrade-to-v1/voice)
|
|
121
|
+
- Update scorer methods: `runExperiment` → `runEvals`, `getScorerByName` → `getScorerById` - [Evals & Scorers](https://mastra.ai/reference/migrations/upgrade-to-v1/evals)
|
|
122
|
+
- Remove deprecated CLI flags - [CLI](https://mastra.ai/reference/migrations/upgrade-to-v1/cli)
|
|
123
|
+
- Update client SDK types from `Get*` to `List*` - [Client SDKs](https://mastra.ai/reference/migrations/upgrade-to-v1/client)
|
|
124
|
+
- Replace `runCount` with `retryCount` - [Workflows](https://mastra.ai/reference/migrations/upgrade-to-v1/workflows)
|
|
125
|
+
- Update custom exporter method `exportEvent` to `exportTracingEvent` (if using custom exporters) - [Tracing](https://mastra.ai/reference/migrations/upgrade-to-v1/tracing)
|
|
@@ -84,7 +84,7 @@ The `suspendPayload` gets validated against the `suspendSchema` when the tool is
|
|
|
84
84
|
|
|
85
85
|
To skip the `suspendSchema` or `resumeSchema` validation, don't define `suspendSchema` or `resumeSchema` in the tool creation.
|
|
86
86
|
|
|
87
|
-
> **Note:** For MCP-specific tool context changes, see the [MCP migration guide](https://mastra.ai/
|
|
87
|
+
> **Note:** For MCP-specific tool context changes, see the [MCP migration guide](https://mastra.ai/reference/migrations/upgrade-to-v1/mcp).
|
|
88
88
|
|
|
89
89
|
### `RuntimeContext` to `RequestContext`
|
|
90
90
|
|
|
@@ -6,7 +6,7 @@ The observability system has been restructured in v1 with a dedicated `@mastra/o
|
|
|
6
6
|
|
|
7
7
|
> **Observability data stops flowing on upgrade:** If you upgrade Mastra packages to v1 without migrating your `telemetry:` config to `observability:`, the old config is ignored at runtime. Your service will start cleanly with no error, but **no traces, logs, or metrics will be sent anywhere**. If you were sending data to Mastra Cloud, the dashboard will go empty.
|
|
8
8
|
>
|
|
9
|
-
> Complete this migration in the same change that bumps your Mastra packages, and verify traces appear in [Mastra Studio](https://mastra.ai/docs/studio/observability) before considering the upgrade complete. If you previously hosted on Mastra Cloud, also follow the [Mastra Cloud migration guide](https://mastra.ai/
|
|
9
|
+
> Complete this migration in the same change that bumps your Mastra packages, and verify traces appear in [Mastra Studio](https://mastra.ai/docs/studio/observability) before considering the upgrade complete. If you previously hosted on Mastra Cloud, also follow the [Mastra Cloud migration guide](https://mastra.ai/reference/migrations/mastra-cloud). The new platform requires a new access token and a Studio project before `MastraPlatformExporter` can route data to it.
|
|
10
10
|
|
|
11
11
|
> **Exporter rename:** `MastraPlatformExporter` (sends data to Mastra platform) replaces the previous `CloudExporter`, and `MastraStorageExporter` (persists data to Mastra Storage) replaces the previous `DefaultExporter`. The original classes remain available from `@mastra/observability` and behave identically, but they're deprecated. New code should use `MastraPlatformExporter` and `MastraStorageExporter`. Existing imports of `CloudExporter` or `DefaultExporter` continue to work until they're removed in a future major version.
|
|
12
12
|
|
|
@@ -354,14 +354,14 @@ No separate instrumentation files or special startup flags required.
|
|
|
354
354
|
|
|
355
355
|
If you were using OTEL-based telemetry with specific providers in 0.x, here's how to configure them in v1:
|
|
356
356
|
|
|
357
|
-
| Provider | Exporter | Guide
|
|
358
|
-
| --------------------------------------------------------- | ----------------- |
|
|
359
|
-
| Arize AX, Arize Phoenix | **Arize** | [Guide](https://mastra.ai/
|
|
360
|
-
| Braintrust | **Braintrust** | [Guide](https://mastra.ai/
|
|
361
|
-
| Langfuse | **Langfuse** | [Guide](https://mastra.ai/
|
|
362
|
-
| LangSmith | **LangSmith** | [Guide](https://mastra.ai/
|
|
363
|
-
| Dash0, Laminar, New Relic, SigNoz, Traceloop, Custom OTEL | **OpenTelemetry** | [Guide](https://mastra.ai/
|
|
364
|
-
| LangWatch | \<coming soon> | -
|
|
357
|
+
| Provider | Exporter | Guide | Reference |
|
|
358
|
+
| --------------------------------------------------------- | ----------------- | ------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
|
359
|
+
| Arize AX, Arize Phoenix | **Arize** | [Guide](https://mastra.ai/integrations/observability/arize) | [Reference](https://mastra.ai/reference/observability/tracing/exporters/arize) |
|
|
360
|
+
| Braintrust | **Braintrust** | [Guide](https://mastra.ai/integrations/observability/braintrust) | [Reference](https://mastra.ai/reference/observability/tracing/exporters/braintrust) |
|
|
361
|
+
| Langfuse | **Langfuse** | [Guide](https://mastra.ai/integrations/observability/langfuse) | [Reference](https://mastra.ai/reference/observability/tracing/exporters/langfuse) |
|
|
362
|
+
| LangSmith | **LangSmith** | [Guide](https://mastra.ai/integrations/observability/langsmith) | [Reference](https://mastra.ai/reference/observability/tracing/exporters/langsmith) |
|
|
363
|
+
| Dash0, Laminar, New Relic, SigNoz, Traceloop, Custom OTEL | **OpenTelemetry** | [Guide](https://mastra.ai/integrations/observability/opentelemetry) | [Reference](https://mastra.ai/reference/observability/tracing/exporters/otel) |
|
|
364
|
+
| LangWatch | \<coming soon> | - | - |
|
|
365
365
|
|
|
366
366
|
### Installation
|
|
367
367
|
|
|
@@ -417,4 +417,4 @@ yarn add @mastra/otel-exporter@latest
|
|
|
417
417
|
bun add @mastra/otel-exporter@latest
|
|
418
418
|
```
|
|
419
419
|
|
|
420
|
-
Plus the required protocol package for your provider (see [OTEL guide](https://mastra.ai/
|
|
420
|
+
Plus the required protocol package for your provider (see [OTEL guide](https://mastra.ai/integrations/observability/opentelemetry)).
|
|
@@ -157,7 +157,7 @@ const mastra = new Mastra({
|
|
|
157
157
|
|
|
158
158
|
The DatadogBridge requires `dd-trace` to be initialized before any other imports so its auto-instrumentation can patch HTTP, database, and framework libraries at load time.
|
|
159
159
|
|
|
160
|
-
See the [DatadogBridge Guide](https://mastra.ai/
|
|
160
|
+
See the [DatadogBridge Guide](https://mastra.ai/integrations/observability/datadog) for complete setup instructions, including dd-trace initialization, bundler externals, and agent configuration.
|
|
161
161
|
|
|
162
162
|
## Span mapping
|
|
163
163
|
|
|
@@ -208,6 +208,6 @@ The bridge reads configuration from these environment variables:
|
|
|
208
208
|
|
|
209
209
|
## Related
|
|
210
210
|
|
|
211
|
-
- [DatadogBridge Guide](https://mastra.ai/
|
|
211
|
+
- [DatadogBridge Guide](https://mastra.ai/integrations/observability/datadog) - Setup guide with examples
|
|
212
212
|
- [Tracing Overview](https://mastra.ai/docs/observability/tracing/overview) - General tracing concepts
|
|
213
213
|
- [DatadogExporter Reference](https://mastra.ai/reference/observability/tracing/exporters/datadog) - LLM Observability only, no `dd-trace` APM
|
|
@@ -120,7 +120,7 @@ const mastra = new Mastra({
|
|
|
120
120
|
|
|
121
121
|
The OtelBridge requires an active OpenTelemetry SDK to function. The bridge reads from OTEL's ambient context.
|
|
122
122
|
|
|
123
|
-
See the [OtelBridge Guide](https://mastra.ai/
|
|
123
|
+
See the [OtelBridge Guide](https://mastra.ai/integrations/observability/opentelemetry) for complete setup instructions, including how to configure OTEL instrumentation and run your application.
|
|
124
124
|
|
|
125
125
|
## Tags support
|
|
126
126
|
|
|
@@ -150,6 +150,6 @@ This format ensures compatibility with all OTEL-compatible backends and collecto
|
|
|
150
150
|
|
|
151
151
|
## Related
|
|
152
152
|
|
|
153
|
-
- [OtelBridge Guide](https://mastra.ai/
|
|
153
|
+
- [OtelBridge Guide](https://mastra.ai/integrations/observability/opentelemetry): Setup guide with examples
|
|
154
154
|
- [Tracing Overview](https://mastra.ai/docs/observability/tracing/overview): General tracing concepts
|
|
155
155
|
- [OtelExporter Reference](https://mastra.ai/reference/observability/tracing/exporters/otel): OTEL exporter for sending traces
|
|
@@ -138,6 +138,6 @@ Tags are stored using the OpenInference `tag.tags` attribute:
|
|
|
138
138
|
|
|
139
139
|
## Related
|
|
140
140
|
|
|
141
|
-
- [ArizeExporter Documentation](https://mastra.ai/
|
|
141
|
+
- [ArizeExporter Documentation](https://mastra.ai/integrations/observability/arize)
|
|
142
142
|
- [Phoenix Documentation](https://docs.arize.com/phoenix)
|
|
143
143
|
- [Arize AX Documentation](https://docs.arize.com/)
|
|
@@ -119,6 +119,6 @@ Tags are stored using the OpenInference `tag.tags` attribute:
|
|
|
119
119
|
|
|
120
120
|
## Related
|
|
121
121
|
|
|
122
|
-
- [ArthurExporter Documentation](https://mastra.ai/
|
|
122
|
+
- [ArthurExporter Documentation](https://mastra.ai/integrations/observability/arthur)
|
|
123
123
|
- [Arthur Engine documentation](https://docs.arthur.ai/)
|
|
124
124
|
- [Arthur Engine repository](https://github.com/arthur-ai/arthur-engine)
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Sends Tracing data to [Confident AI](https://www.confident-ai.com/) for evaluation and observability. Exported by `@mastra/deepeval`, which builds on the DeepEval SDK.
|
|
6
6
|
|
|
7
|
-
See [Confident AI exporter](https://mastra.ai/
|
|
7
|
+
See [Confident AI exporter](https://mastra.ai/integrations/observability/confident-ai) for setup and usage.
|
|
8
8
|
|
|
9
9
|
## Constructor
|
|
10
10
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Sends Tracing data to Datadog's LLM Observability product for monitoring and analytics.
|
|
6
6
|
|
|
7
|
-
> **
|
|
7
|
+
> **Note:** If you also use `dd-trace` APM auto-instrumentation and need it correctly parented under Mastra spans, use the [DatadogBridge](https://mastra.ai/reference/observability/tracing/bridges/datadog) instead. The exporter sends LLM Observability data after execution completes, so it doesn't participate in `dd-trace`'s live scope.
|
|
8
8
|
|
|
9
9
|
## Constructor
|
|
10
10
|
|
|
@@ -177,6 +177,18 @@ The exporter batches tracing spans, logs, metrics, scores, and feedback for effi
|
|
|
177
177
|
|
|
178
178
|
Errors raised by `MastraPlatformExporter` use the `MASTRA_PLATFORM_EXPORTER_*` `id` prefix. The deprecated `CloudExporter` continues to emit `CLOUD_EXPORTER_*` `id`s.
|
|
179
179
|
|
|
180
|
+
### Quota pause
|
|
181
|
+
|
|
182
|
+
When an organization has exhausted its observability quota, the Mastra platform rejects publish requests with `402 Payment Required` plus the `x-mastra-observability: disabled` header. When the exporter sees a `402` (or the header) on any publish route, it:
|
|
183
|
+
|
|
184
|
+
- Drops the rejected batch without retrying it
|
|
185
|
+
- Pauses all five signal types (traces, logs, metrics, scores, feedback) and drops buffered and new events instead of sending them
|
|
186
|
+
- Logs a warning that telemetry is paused
|
|
187
|
+
- Probes the platform periodically with an empty batch, using the interval from the `x-mastra-observability-retry-after` header (seconds), or every 5 minutes if the header is absent
|
|
188
|
+
- Resumes exporting automatically and logs a warning once the platform stops rejecting with `402`
|
|
189
|
+
|
|
190
|
+
The probe timer doesn't keep the Node.js process alive, so short-lived and serverless processes exit normally while paused.
|
|
191
|
+
|
|
180
192
|
### Endpoint routing
|
|
181
193
|
|
|
182
194
|
- Base origins derive signal endpoints automatically
|
|
@@ -200,6 +200,6 @@ Tags are stored as a JSON-stringified array in the `mastra.tags` span attribute
|
|
|
200
200
|
|
|
201
201
|
## Related
|
|
202
202
|
|
|
203
|
-
- [OtelExporter Guide](https://mastra.ai/
|
|
204
|
-
- [OtelBridge](https://mastra.ai/
|
|
203
|
+
- [OtelExporter Guide](https://mastra.ai/integrations/observability/opentelemetry): Setup guide with provider configurations
|
|
204
|
+
- [OtelBridge](https://mastra.ai/integrations/observability/opentelemetry): For bidirectional OTEL context integration
|
|
205
205
|
- [Tracing Overview](https://mastra.ai/docs/observability/tracing/overview): General tracing concepts
|
|
@@ -42,6 +42,8 @@ const processor = new PIIDetector({
|
|
|
42
42
|
|
|
43
43
|
**options.providerOptions** (`ProviderOptions`): Provider-specific options passed to the internal detection agent. Use this to control model behavior like reasoning effort for thinking models (e.g., { openai: { reasoningEffort: 'low' } })
|
|
44
44
|
|
|
45
|
+
**options.onDetection** (`(event: PIIDetectionEvent) => void | Promise<void>`): Called whenever a detection result is produced, with detectionResult, the analyzed input, whether it was flagged, and the strategyApplied (the configured strategy when flagged, otherwise none). Fires for every analyzed message in processInput and processOutputResult, and for every LLM buffer flush during streaming; the streaming regex pass only reports when PII is found. Errors thrown by the callback are logged and ignored
|
|
46
|
+
|
|
45
47
|
## Returns
|
|
46
48
|
|
|
47
49
|
**id** (`string`): Processor identifier set to 'pii-detector'
|
|
@@ -38,6 +38,8 @@ const processor = new PromptInjectionDetector({
|
|
|
38
38
|
|
|
39
39
|
**options.providerOptions** (`ProviderOptions`): Provider-specific options passed to the internal detection agent. Use this to control model behavior like reasoning effort for thinking models (e.g., { openai: { reasoningEffort: 'low' } })
|
|
40
40
|
|
|
41
|
+
**options.onDetection** (`(event: PromptInjectionDetectionEvent) => void | Promise<void>`): Called for every analyzed message with detectionResult, the analyzed input, whether it was flagged, and the strategyApplied (the configured strategy when flagged, otherwise none). Use it to emit custom metrics. Errors thrown by the callback are logged and ignored
|
|
42
|
+
|
|
41
43
|
## Returns
|
|
42
44
|
|
|
43
45
|
**id** (`string`): Processor identifier set to 'prompt-injection-detector'
|