@mastra/mcp-docs-server 1.2.15-alpha.20 → 1.2.15-alpha.21
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/code-mode.md +1 -1
- package/.docs/docs/agents/networks.md +2 -2
- package/.docs/docs/agents/overview.md +2 -2
- package/.docs/docs/agents/using-tools.md +1 -1
- package/.docs/docs/browser/overview.md +8 -8
- package/.docs/docs/browser/recording.md +2 -2
- package/.docs/docs/capabilities/{channels/overview.md → channels.md} +70 -7
- package/.docs/docs/capabilities/subagents.md +2 -2
- 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/workflow-runners.md +2 -2
- package/.docs/docs/harness/agent-controller.md +2 -2
- package/.docs/docs/index.md +8 -8
- package/.docs/docs/long-running-agents/durable-agents.md +2 -2
- package/.docs/docs/long-running-agents/signal-providers.md +2 -15
- package/.docs/docs/long-running-agents/signals.md +1 -1
- package/.docs/docs/mastra-platform/database.md +2 -2
- package/.docs/docs/mastra-platform/server.md +1 -1
- package/.docs/docs/mcp/overview.md +42 -0
- package/.docs/docs/memory/memory-processors.md +5 -5
- package/.docs/docs/memory/message-history.md +1 -1
- package/.docs/docs/memory/observational-memory.md +1 -1
- package/.docs/docs/observability/integrations/exporters/mastra-storage.md +16 -16
- 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.md +8 -8
- package/.docs/docs/storage/overview.md +14 -13
- package/.docs/docs/studio/observability.md +1 -1
- package/.docs/docs/workflows/overview.md +1 -1
- package/.docs/docs/workflows/snapshots.md +11 -11
- 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 +1 -1
- package/.docs/guides/getting-started/quickstart.md +3 -3
- 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 +2 -2
- package/.docs/{guides/build-your-ui/copilotkit/overview.md → integrations/agentic-ui/copilotkit.md} +256 -3
- 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 +7 -5
- 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/{reference/storage → integrations/databases}/oracledb.md +1 -1
- 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}/aws-bedrock-agentcore.md +1 -1
- package/.docs/{guides/deployment → integrations/deploy}/aws-lambda.md +1 -1
- package/.docs/{guides/deployment → integrations/deploy}/azure-app-services.md +1 -1
- package/.docs/{guides/deployment → integrations/deploy}/cloudflare.md +1 -1
- package/.docs/{guides/deployment → integrations/deploy}/digital-ocean.md +1 -1
- package/.docs/{guides/deployment → integrations/deploy}/netlify.md +1 -1
- package/.docs/{guides/deployment → integrations/deploy}/vercel.md +2 -2
- 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} +1 -1
- 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 +1 -1
- 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} +276 -44
- 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} +2 -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/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 +2 -2
- package/.docs/models/gateways/openrouter.md +3 -1
- package/.docs/models/gateways/vercel.md +2 -1
- package/.docs/models/index.md +1 -1
- package/.docs/models/providers/kilo.md +9 -6
- package/.docs/models/providers/opencode.md +0 -1
- package/.docs/reference/agent-controller/agent-controller-class.md +32 -1
- package/.docs/reference/agents/channels.md +2 -2
- 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 +1 -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/supabase.md +1 -1
- package/.docs/reference/auth/workos.md +1 -1
- package/.docs/reference/browser/agent-browser.md +1 -1
- package/.docs/reference/browser/browser-viewer.md +1 -1
- package/.docs/reference/browser/firecrawl-browser.md +1 -1
- package/.docs/reference/browser/stagehand-browser.md +1 -1
- package/.docs/reference/channels/channel-provider.md +1 -1
- package/.docs/reference/channels/slack-provider.md +2 -2
- package/.docs/reference/cli/mastra.md +2 -2
- package/.docs/reference/configuration.md +1 -26
- 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/file-based-agents/storage.md +1 -1
- package/.docs/reference/file-based-agents/studio.md +1 -1
- package/.docs/reference/index.md +27 -55
- package/.docs/{guides → reference}/migrations/ai-sdk-v4-to-v5.md +1 -1
- package/.docs/{guides → reference}/migrations/mastra-cloud.md +1 -1
- 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/mastra-platform-exporter.md +12 -0
- package/.docs/reference/observability/tracing/exporters/otel.md +2 -2
- 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/{guides → reference}/rag/overview.md +2 -2
- package/.docs/{guides → reference}/rag/retrieval.md +1 -1
- package/.docs/{guides → reference}/rag/vector-databases.md +1 -1
- package/.docs/reference/storage/composite.md +3 -3
- package/.docs/reference/storage/retention.md +4 -4
- package/.docs/reference/streaming/ChunkType.md +3 -3
- package/.docs/reference/streaming/agents/streamLegacy.md +3 -3
- package/.docs/reference/tools/mcp-server.md +1 -1
- package/.docs/reference/vectors/convex.md +2 -2
- package/.docs/reference/vectors/oracledb.md +2 -2
- package/.docs/reference/workers/overview.md +8 -8
- package/.docs/reference/workspace/platform-filesystem.md +2 -2
- package/.docs/reference/workspace/platform-sandbox.md +2 -2
- package/.docs/reference/workspace/process-manager.md +3 -3
- package/CHANGELOG.md +9 -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 +5 -5
- 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}/assistant-ui.md +0 -0
- /package/.docs/{guides/build-your-ui → integrations/agentic-ui}/openui.md +0 -0
- /package/.docs/{docs/server → integrations}/auth/auth0.md +0 -0
- /package/.docs/{docs/server → integrations}/auth/better-auth.md +0 -0
- /package/.docs/{docs/server → integrations}/auth/clerk.md +0 -0
- /package/.docs/{docs/server → integrations}/auth/firebase.md +0 -0
- /package/.docs/{docs/server → integrations}/auth/google.md +0 -0
- /package/.docs/{docs/server → integrations}/auth/okta.md +0 -0
- /package/.docs/{docs/server → integrations}/auth/supabase.md +0 -0
- /package/.docs/{docs/server → integrations}/auth/workos.md +0 -0
- /package/.docs/{guides/deployment → integrations/deploy}/amazon-ec2.md +0 -0
- /package/.docs/{guides/deployment → integrations/deploy}/inngest.md +0 -0
- /package/.docs/{guides/deployment → integrations/deploy}/kubernetes.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/{reference/workspace/railway-sandbox.md → integrations/sandboxes/railway.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/getting-started → reference}/manual-install.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
|
@@ -32,5 +32,5 @@ await agent.getDefaultStreamOptionsLegacy({
|
|
|
32
32
|
|
|
33
33
|
## Related
|
|
34
34
|
|
|
35
|
-
- [Streaming with agents](https://mastra.ai/guides/
|
|
35
|
+
- [Streaming with agents](https://mastra.ai/docs/guides/streaming)
|
|
36
36
|
- [Request Context](https://mastra.ai/docs/server/request-context)
|
|
@@ -368,5 +368,5 @@ export const { GET, POST, PUT } = serveNext({ mastra, inngest })
|
|
|
368
368
|
|
|
369
369
|
- [DurableAgent reference](https://mastra.ai/reference/agents/durable-agent)
|
|
370
370
|
- [Agent class](https://mastra.ai/reference/agents/agent)
|
|
371
|
-
- [Inngest deployment guide](https://mastra.ai/
|
|
371
|
+
- [Inngest deployment guide](https://mastra.ai/integrations/deploy/inngest)
|
|
372
372
|
- [PubSub](https://mastra.ai/docs/server/pubsub)
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
The `.network()` method enables multi-agent collaboration and routing. This method accepts messages and optional execution options.
|
|
6
6
|
|
|
7
|
-
> **Deprecated:** The `.network()` primitive has been deprecated and will be removed in a future major release. Use [supervisor agents](https://mastra.ai/docs/capabilities/subagents) with `agent.stream()` or `agent.generate()` instead. See the [migration guide](https://mastra.ai/
|
|
7
|
+
> **Deprecated:** The `.network()` primitive has been deprecated and will be removed in a future major release. Use [supervisor agents](https://mastra.ai/docs/capabilities/subagents) with `agent.stream()` or `agent.generate()` instead. See the [migration guide](https://mastra.ai/reference/migrations/network-to-supervisor) to upgrade.
|
|
8
8
|
|
|
9
9
|
## Usage example
|
|
10
10
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# handleNetworkStream()
|
|
4
4
|
|
|
5
|
-
> **Deprecated:** Agent networks are deprecated and will be removed in a future release. Use [supervisor agents](https://mastra.ai/docs/capabilities/subagents) with `agent.stream()` or `agent.generate()` instead. See the [migration guide](https://mastra.ai/
|
|
5
|
+
> **Deprecated:** Agent networks are deprecated and will be removed in a future release. Use [supervisor agents](https://mastra.ai/docs/capabilities/subagents) with `agent.stream()` or `agent.generate()` instead. See the [migration guide](https://mastra.ai/reference/migrations/network-to-supervisor) to upgrade.
|
|
6
6
|
|
|
7
7
|
Framework-agnostic handler for streaming network execution in AI SDK-compatible format. Use this function directly when you need to handle network streaming outside Hono or Mastra's own [apiRoutes](https://mastra.ai/docs/server/custom-api-routes) feature.
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# networkRoute()
|
|
4
4
|
|
|
5
|
-
> **Deprecated:** Agent networks are deprecated and will be removed in a future release. Use [supervisor agents](https://mastra.ai/docs/capabilities/subagents) with `agent.stream()` or `agent.generate()` instead. See the [migration guide](https://mastra.ai/
|
|
5
|
+
> **Deprecated:** Agent networks are deprecated and will be removed in a future release. Use [supervisor agents](https://mastra.ai/docs/capabilities/subagents) with `agent.stream()` or `agent.generate()` instead. See the [migration guide](https://mastra.ai/reference/migrations/network-to-supervisor) to upgrade.
|
|
6
6
|
|
|
7
7
|
Creates a network route handler for streaming network execution using the AI SDK format. This function registers an HTTP `POST` endpoint that accepts messages, executes an agent network, and streams the response back to the client in AI SDK-compatible format. Agent networks allow a routing agent to delegate tasks to other agents. You have to use it inside a [custom API route](https://mastra.ai/docs/server/custom-api-routes).
|
|
8
8
|
|
|
@@ -404,4 +404,4 @@ The `browser_snapshot` tool returns an accessibility tree with element refs like
|
|
|
404
404
|
- [MastraBrowser](https://mastra.ai/reference/browser/mastra-browser): Base class reference
|
|
405
405
|
- [StagehandBrowser](https://mastra.ai/reference/browser/stagehand-browser): AI-powered alternative
|
|
406
406
|
- [Browser overview](https://mastra.ai/docs/browser/overview): Conceptual guide
|
|
407
|
-
- [agent-browser guide](https://mastra.ai/
|
|
407
|
+
- [agent-browser guide](https://mastra.ai/integrations/browsers/agent-browser): Usage guide
|
|
@@ -227,6 +227,6 @@ browse skills install
|
|
|
227
227
|
|
|
228
228
|
## Related
|
|
229
229
|
|
|
230
|
-
- [BrowserViewer guide](https://mastra.ai/
|
|
230
|
+
- [BrowserViewer guide](https://mastra.ai/integrations/browsers/browser-viewer): Setup and usage walkthrough
|
|
231
231
|
- [MastraBrowser](https://mastra.ai/reference/browser/mastra-browser): Base class API reference
|
|
232
232
|
- [Workspace overview](https://mastra.ai/docs/workspace/overview): Workspace configuration
|
|
@@ -66,6 +66,6 @@ In both cases, `FirecrawlBrowser` deletes the remote Firecrawl session when the
|
|
|
66
66
|
|
|
67
67
|
## Related
|
|
68
68
|
|
|
69
|
-
- [Firecrawl docs](https://mastra.ai/
|
|
69
|
+
- [Firecrawl docs](https://mastra.ai/integrations/browsers/firecrawl)
|
|
70
70
|
- [`AgentBrowser` reference](https://mastra.ai/reference/browser/agent-browser)
|
|
71
71
|
- [Browser overview](https://mastra.ai/docs/browser/overview)
|
|
@@ -317,4 +317,4 @@ Choose `AgentBrowser` for precise, reproducible automation. Choose `StagehandBro
|
|
|
317
317
|
- [MastraBrowser](https://mastra.ai/reference/browser/mastra-browser): Base class reference
|
|
318
318
|
- [AgentBrowser](https://mastra.ai/reference/browser/agent-browser): Deterministic alternative
|
|
319
319
|
- [Browser overview](https://mastra.ai/docs/browser/overview): Conceptual guide
|
|
320
|
-
- [Stagehand guide](https://mastra.ai/
|
|
320
|
+
- [Stagehand guide](https://mastra.ai/integrations/browsers/stagehand): Usage guide
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# SlackProvider
|
|
4
4
|
|
|
5
|
-
`SlackProvider` is the managed path for connecting agents to Slack. Register it on `Mastra.channels` and it provisions Slack apps via the Manifest API, runs the OAuth install flow, rotates configuration tokens, and routes Slack events to your agents. Use it when you want Mastra to own app creation and installation. For the lower-level path where you create the Slack app and configure scopes and webhooks yourself, use [`createSlackAdapter`](https://mastra.ai/
|
|
5
|
+
`SlackProvider` is the managed path for connecting agents to Slack. Register it on `Mastra.channels` and it provisions Slack apps via the Manifest API, runs the OAuth install flow, rotates configuration tokens, and routes Slack events to your agents. Use it when you want Mastra to own app creation and installation. For the lower-level path where you create the Slack app and configure scopes and webhooks yourself, use [`createSlackAdapter`](https://mastra.ai/integrations/channels/slack) on the agent's `channels.adapters` instead.
|
|
6
6
|
|
|
7
7
|
## Usage example
|
|
8
8
|
|
|
@@ -226,5 +226,5 @@ const result = await slack.connect('support-agent')
|
|
|
226
226
|
## Related
|
|
227
227
|
|
|
228
228
|
- [ChannelProvider](https://mastra.ai/reference/channels/channel-provider): the interface `SlackProvider` implements
|
|
229
|
-
- [Channels](https://mastra.ai/docs/capabilities/channels
|
|
229
|
+
- [Channels](https://mastra.ai/docs/capabilities/channels): concepts, platform setup, and the `createSlackAdapter` path
|
|
230
230
|
- [Channels reference](https://mastra.ai/reference/agents/channels): the `channels` config on the `Agent` constructor
|
|
@@ -1043,13 +1043,13 @@ Runs database migrations to update your storage schema. This command is useful w
|
|
|
1043
1043
|
The command bundles your project and connects to your configured storage backend. It then executes any pending migrations. Currently supports:
|
|
1044
1044
|
|
|
1045
1045
|
- **Duplicate spans migration**: Removes duplicate `(traceId, spanId)` entries and adds a unique constraint to ensure data integrity.
|
|
1046
|
-
- **ClickHouse legacy-to-vNext span migration**: Copies historical spans from the legacy `mastra_ai_spans` table to the vNext `mastra_span_events` schema. Runs in batches to stay within memory limits. See the [ClickHouse storage reference](https://mastra.ai/
|
|
1046
|
+
- **ClickHouse legacy-to-vNext span migration**: Copies historical spans from the legacy `mastra_ai_spans` table to the vNext `mastra_span_events` schema. Runs in batches to stay within memory limits. See the [ClickHouse storage reference](https://mastra.ai/integrations/databases/clickhouse) for details.
|
|
1047
1047
|
|
|
1048
1048
|
```bash
|
|
1049
1049
|
mastra migrate
|
|
1050
1050
|
```
|
|
1051
1051
|
|
|
1052
|
-
See the [Storage migration guide](https://mastra.ai/
|
|
1052
|
+
See the [Storage migration guide](https://mastra.ai/reference/migrations/upgrade-to-v1/storage) for details on when migrations are needed.
|
|
1053
1053
|
|
|
1054
1054
|
It accepts [common flags](#common-flags).
|
|
1055
1055
|
|
|
@@ -440,7 +440,7 @@ export const mastra = new Mastra({
|
|
|
440
440
|
|
|
441
441
|
Vector stores for semantic search and embeddings. Used in RAG pipelines, similarity search, and other embedding-based features. Mastra supports multiple vector databases including Pinecone, PostgreSQL with pgvector, OracleDB, MongoDB, and more.
|
|
442
442
|
|
|
443
|
-
Visit the [RAG documentation](https://mastra.ai/
|
|
443
|
+
Visit the [RAG documentation](https://mastra.ai/reference/rag/overview) to learn more.
|
|
444
444
|
|
|
445
445
|
> **Note:** Most users create vector stores directly when building RAG pipelines. This top-level configuration is for defining reusable vector store instances that can be shared across your application.
|
|
446
446
|
|
|
@@ -500,31 +500,6 @@ const mastra = new Mastra({
|
|
|
500
500
|
|
|
501
501
|
## Bundler options
|
|
502
502
|
|
|
503
|
-
### bundler.entries
|
|
504
|
-
|
|
505
|
-
**Type:** `Record<string, string>`\
|
|
506
|
-
**Default:** `{}`
|
|
507
|
-
|
|
508
|
-
Additional process entries to emit alongside the server bundle, as a map of output name to source path relative to your Mastra directory. Each entry becomes its own `<name>.mjs` in `.mastra/output`.
|
|
509
|
-
|
|
510
|
-
Use this for long-running processes that run beside your Mastra server rather than inside it, such as a [LiveKit voice worker](https://mastra.ai/guides/voice/realtime-voice). The entry shares the output directory, `package.json`, and installed dependencies with the server, so one `mastra build` produces one deployable artifact you can start with different commands.
|
|
511
|
-
|
|
512
|
-
```typescript
|
|
513
|
-
import { Mastra } from '@mastra/core'
|
|
514
|
-
|
|
515
|
-
export const mastra = new Mastra({
|
|
516
|
-
bundler: {
|
|
517
|
-
entries: { 'voice-worker': './voice-worker.ts' },
|
|
518
|
-
},
|
|
519
|
-
})
|
|
520
|
-
```
|
|
521
|
-
|
|
522
|
-
This emits `.mastra/output/voice-worker.mjs` next to `.mastra/output/index.mjs`. Dependencies imported only by the extra entry are analyzed too, so they're installed into the output.
|
|
523
|
-
|
|
524
|
-
Entry names can contain `/` to nest the output. They can't be `index`, which is the server bundle, `tools`, which is the tool aggregator, or start with `tools/`, which is reserved for tool bundles.
|
|
525
|
-
|
|
526
|
-
> **Note:** `mastra build` applies the [`bundler.externals`](#bundlerexternals) default of `true` only when you set no bundler options at all. Once you set `entries`, set `externals` explicitly as well if your extra entry depends on packages that can't be bundled, such as native modules.
|
|
527
|
-
|
|
528
503
|
### bundler.externals
|
|
529
504
|
|
|
530
505
|
**Type:** `boolean | string[]`\
|
|
@@ -21,4 +21,4 @@ This method doesn't accept any parameters.
|
|
|
21
21
|
## Related
|
|
22
22
|
|
|
23
23
|
- [Storage overview](https://mastra.ai/reference/storage/overview)
|
|
24
|
-
- [Storage reference](https://mastra.ai/
|
|
24
|
+
- [Storage reference](https://mastra.ai/integrations/databases/libsql)
|
|
@@ -20,5 +20,5 @@ mastra.getVector('testVectorStore')
|
|
|
20
20
|
|
|
21
21
|
## Related
|
|
22
22
|
|
|
23
|
-
- [Vector stores overview](https://mastra.ai/
|
|
24
|
-
- [RAG overview](https://mastra.ai/
|
|
23
|
+
- [Vector stores overview](https://mastra.ai/reference/rag/vector-databases)
|
|
24
|
+
- [RAG overview](https://mastra.ai/reference/rag/overview)
|
|
@@ -20,5 +20,5 @@ This method doesn't accept any parameters.
|
|
|
20
20
|
|
|
21
21
|
## Related
|
|
22
22
|
|
|
23
|
-
- [Vector stores overview](https://mastra.ai/
|
|
24
|
-
- [RAG overview](https://mastra.ai/
|
|
23
|
+
- [Vector stores overview](https://mastra.ai/reference/rag/vector-databases)
|
|
24
|
+
- [RAG overview](https://mastra.ai/reference/rag/overview)
|
|
@@ -10,7 +10,7 @@ Use this page for the file-based convention. For backend choice, storage domains
|
|
|
10
10
|
|
|
11
11
|
## Quickstart
|
|
12
12
|
|
|
13
|
-
Use [`LibSQLStore`](https://mastra.ai/
|
|
13
|
+
Use [`LibSQLStore`](https://mastra.ai/integrations/databases/libsql) for a local file-backed store:
|
|
14
14
|
|
|
15
15
|
```typescript
|
|
16
16
|
import { LibSQLStore } from '@mastra/libsql'
|
|
@@ -40,7 +40,7 @@ Studio opens without authentication in local development. Add `studio.ts` when y
|
|
|
40
40
|
|
|
41
41
|
## Add authentication
|
|
42
42
|
|
|
43
|
-
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):
|
|
44
44
|
|
|
45
45
|
```typescript
|
|
46
46
|
import { MastraAuthWorkos } from '@mastra/auth-workos'
|
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,24 +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
|
-
- [OracleDB Storage](https://mastra.ai/reference/storage/oracledb)
|
|
289
|
-
- [PostgreSQL Storage](https://mastra.ai/reference/storage/postgresql)
|
|
290
|
-
- [Redis Storage](https://mastra.ai/reference/storage/redis)
|
|
291
303
|
- [Retention (prune)](https://mastra.ai/reference/storage/retention)
|
|
292
|
-
- [Upstash Storage](https://mastra.ai/reference/storage/upstash)
|
|
293
304
|
- [ChunkType](https://mastra.ai/reference/streaming/ChunkType)
|
|
294
305
|
- [smoothStream()](https://mastra.ai/reference/streaming/smoothStream)
|
|
295
306
|
- [MastraModelOutput](https://mastra.ai/reference/streaming/agents/MastraModelOutput)
|
|
@@ -302,7 +313,6 @@ The Reference section provides documentation of Mastra's API, including paramete
|
|
|
302
313
|
- [.timeTravelStream()](https://mastra.ai/reference/streaming/workflows/timeTravelStream)
|
|
303
314
|
- [Overview](https://mastra.ai/reference/templates/overview)
|
|
304
315
|
- [askUserTool](https://mastra.ai/reference/tools/ask-user-tool)
|
|
305
|
-
- [Bright Data Tools](https://mastra.ai/reference/tools/brightdata)
|
|
306
316
|
- [createBedrockKBTool()](https://mastra.ai/reference/tools/bedrock-kb-tool)
|
|
307
317
|
- [createCodeMode()](https://mastra.ai/reference/tools/create-code-mode)
|
|
308
318
|
- [createDocumentChunkerTool()](https://mastra.ai/reference/tools/document-chunker-tool)
|
|
@@ -312,11 +322,9 @@ The Reference section provides documentation of Mastra's API, including paramete
|
|
|
312
322
|
- [IsolatedVmCodeModeTransport](https://mastra.ai/reference/tools/isolated-vm-transport)
|
|
313
323
|
- [MCPClient](https://mastra.ai/reference/tools/mcp-client)
|
|
314
324
|
- [MCPServer](https://mastra.ai/reference/tools/mcp-server)
|
|
315
|
-
- [Perplexity Tools](https://mastra.ai/reference/tools/perplexity)
|
|
316
325
|
- [QuickJsCodeModeTransport](https://mastra.ai/reference/tools/quickjs-transport)
|
|
317
326
|
- [submitPlanTool](https://mastra.ai/reference/tools/submit-plan-tool)
|
|
318
327
|
- [Task tools](https://mastra.ai/reference/tools/task-tools)
|
|
319
|
-
- [Tavily Tools](https://mastra.ai/reference/tools/tavily)
|
|
320
328
|
- [Amazon S3 Vector Store](https://mastra.ai/reference/vectors/s3vectors)
|
|
321
329
|
- [Astra Vector Store](https://mastra.ai/reference/vectors/astra)
|
|
322
330
|
- [Chroma Vector Store](https://mastra.ai/reference/vectors/chroma)
|
|
@@ -335,27 +343,9 @@ The Reference section provides documentation of Mastra's API, including paramete
|
|
|
335
343
|
- [Qdrant Vector Store](https://mastra.ai/reference/vectors/qdrant)
|
|
336
344
|
- [Turbopuffer Vector Store](https://mastra.ai/reference/vectors/turbopuffer)
|
|
337
345
|
- [Upstash Vector Store](https://mastra.ai/reference/vectors/upstash)
|
|
338
|
-
- [AWS Nova Sonic](https://mastra.ai/reference/voice/aws-nova-sonic)
|
|
339
|
-
- [Azure](https://mastra.ai/reference/voice/azure)
|
|
340
|
-
- [Cloudflare](https://mastra.ai/reference/voice/cloudflare)
|
|
341
346
|
- [Composite Voice](https://mastra.ai/reference/voice/composite-voice)
|
|
342
|
-
- [Deepgram](https://mastra.ai/reference/voice/deepgram)
|
|
343
|
-
- [ElevenLabs](https://mastra.ai/reference/voice/elevenlabs)
|
|
344
347
|
- [Events](https://mastra.ai/reference/voice/voice.events)
|
|
345
|
-
- [Google](https://mastra.ai/reference/voice/google)
|
|
346
|
-
- [Google Gemini Live](https://mastra.ai/reference/voice/google-gemini-live)
|
|
347
|
-
- [Inworld](https://mastra.ai/reference/voice/inworld)
|
|
348
|
-
- [Inworld Realtime](https://mastra.ai/reference/voice/inworld-realtime)
|
|
349
|
-
- [LiveKit](https://mastra.ai/reference/voice/livekit)
|
|
350
348
|
- [Mastra Voice](https://mastra.ai/reference/voice/mastra-voice)
|
|
351
|
-
- [Mistral](https://mastra.ai/reference/voice/mistral)
|
|
352
|
-
- [Murf](https://mastra.ai/reference/voice/murf)
|
|
353
|
-
- [OpenAI](https://mastra.ai/reference/voice/openai)
|
|
354
|
-
- [OpenAI Realtime](https://mastra.ai/reference/voice/openai-realtime)
|
|
355
|
-
- [PlayAI](https://mastra.ai/reference/voice/playai)
|
|
356
|
-
- [Sarvam](https://mastra.ai/reference/voice/sarvam)
|
|
357
|
-
- [Speechify](https://mastra.ai/reference/voice/speechify)
|
|
358
|
-
- [xAI Realtime](https://mastra.ai/reference/voice/xai-realtime)
|
|
359
349
|
- [.addInstructions()](https://mastra.ai/reference/voice/voice.addInstructions)
|
|
360
350
|
- [.addTools()](https://mastra.ai/reference/voice/voice.addTools)
|
|
361
351
|
- [.answer()](https://mastra.ai/reference/voice/voice.answer)
|
|
@@ -393,29 +383,11 @@ The Reference section provides documentation of Mastra's API, including paramete
|
|
|
393
383
|
- [.start()](https://mastra.ai/reference/workflows/run-methods/start)
|
|
394
384
|
- [.startAsync()](https://mastra.ai/reference/workflows/run-methods/startAsync)
|
|
395
385
|
- [.timeTravel()](https://mastra.ai/reference/workflows/run-methods/timeTravel)
|
|
396
|
-
- [AgentCoreRuntimeSandbox](https://mastra.ai/reference/workspace/agentcore-runtime-sandbox)
|
|
397
|
-
- [AgentFSFilesystem](https://mastra.ai/reference/workspace/agentfs-filesystem)
|
|
398
|
-
- [AppleContainerSandbox](https://mastra.ai/reference/workspace/apple-container-sandbox)
|
|
399
|
-
- [ArchilFilesystem](https://mastra.ai/reference/workspace/archil-filesystem)
|
|
400
|
-
- [AzureBlobFilesystem](https://mastra.ai/reference/workspace/azure-blob-filesystem)
|
|
401
|
-
- [BlaxelSandbox](https://mastra.ai/reference/workspace/blaxel-sandbox)
|
|
402
|
-
- [DaytonaSandbox](https://mastra.ai/reference/workspace/daytona-sandbox)
|
|
403
|
-
- [DockerSandbox](https://mastra.ai/reference/workspace/docker-sandbox)
|
|
404
|
-
- [E2BSandbox](https://mastra.ai/reference/workspace/e2b-sandbox)
|
|
405
|
-
- [FilesSDKFilesystem](https://mastra.ai/reference/workspace/files-sdk-filesystem)
|
|
406
|
-
- [GCSFilesystem](https://mastra.ai/reference/workspace/gcs-filesystem)
|
|
407
|
-
- [GoogleDriveFilesystem](https://mastra.ai/reference/workspace/google-drive-filesystem)
|
|
408
386
|
- [LocalFilesystem](https://mastra.ai/reference/workspace/local-filesystem)
|
|
409
387
|
- [LocalSandbox](https://mastra.ai/reference/workspace/local-sandbox)
|
|
410
|
-
- [MesaFilesystem](https://mastra.ai/reference/workspace/mesa-filesystem)
|
|
411
|
-
- [ModalSandbox](https://mastra.ai/reference/workspace/modal-sandbox)
|
|
412
388
|
- [PlatformFilesystem](https://mastra.ai/reference/workspace/platform-filesystem)
|
|
413
389
|
- [PlatformSandbox](https://mastra.ai/reference/workspace/platform-sandbox)
|
|
414
|
-
- [RailwaySandbox](https://mastra.ai/reference/workspace/railway-sandbox)
|
|
415
|
-
- [S3Filesystem](https://mastra.ai/reference/workspace/s3-filesystem)
|
|
416
390
|
- [SandboxProcessManager](https://mastra.ai/reference/workspace/process-manager)
|
|
417
|
-
- [VercelSandbox](https://mastra.ai/reference/workspace/vercel-sandbox)
|
|
418
|
-
- [VercelServerlessSandbox](https://mastra.ai/reference/workspace/vercel-serverless)
|
|
419
391
|
- [Workspace Class](https://mastra.ai/reference/workspace/workspace-class)
|
|
420
392
|
- [WorkspaceFilesystem](https://mastra.ai/reference/workspace/filesystem)
|
|
421
393
|
- [WorkspaceSandbox](https://mastra.ai/reference/workspace/sandbox)
|
|
@@ -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
|
|
|
@@ -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
|
|