@mastra/mcp-docs-server 1.2.15-alpha.19 → 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/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 +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/server/custom-api-routes.md +35 -0
- 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/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 +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/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 +2 -2
- package/.docs/models/environment-variables.md +1 -0
- package/.docs/models/gateways/openrouter.md +4 -2
- package/.docs/models/gateways/vercel.md +2 -1
- package/.docs/models/index.md +1 -1
- package/.docs/models/providers/coralbricks.md +75 -0
- package/.docs/models/providers/evroc.md +2 -3
- package/.docs/models/providers/hyper.md +6 -6
- package/.docs/models/providers/kilo.md +7 -5
- package/.docs/models/providers/llmgateway.md +1 -2
- package/.docs/models/providers/nano-gpt.md +1 -3
- package/.docs/models/providers/opencode.md +0 -1
- package/.docs/models/providers/privatemode-ai.md +5 -4
- package/.docs/models/providers/snowflake-cortex.md +5 -1
- package/.docs/models/providers/wandb.md +2 -1
- package/.docs/models/providers/zenmux.md +0 -15
- package/.docs/models/providers.md +1 -0
- 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/server/create-route.md +27 -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/workflows/run-methods/timeTravel.md +1 -0
- package/.docs/reference/workspace/platform-filesystem.md +2 -2
- package/.docs/reference/workspace/platform-sandbox.md +10 -2
- package/.docs/reference/workspace/process-manager.md +3 -3
- package/.docs/reference/workspace/sandbox.md +10 -0
- package/CHANGELOG.md +16 -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/{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
|
@@ -313,11 +313,11 @@ Both scenarios are safe - guardrails prevent inappropriate content from being pe
|
|
|
313
313
|
|
|
314
314
|
Some storage providers enforce record size limits that base64-encoded file attachments can exceed:
|
|
315
315
|
|
|
316
|
-
| Provider
|
|
317
|
-
|
|
|
318
|
-
| [DynamoDB](https://mastra.ai/
|
|
319
|
-
| [Convex](https://mastra.ai/
|
|
320
|
-
| [Cloudflare D1](https://mastra.ai/
|
|
316
|
+
| Provider | Record size limit |
|
|
317
|
+
| ----------------------------------------------------------------------- | ----------------- |
|
|
318
|
+
| [DynamoDB](https://mastra.ai/integrations/databases/dynamodb) | 400 KB |
|
|
319
|
+
| [Convex](https://mastra.ai/integrations/databases/convex) | 1 MiB |
|
|
320
|
+
| [Cloudflare D1](https://mastra.ai/integrations/databases/cloudflare-d1) | 1 MiB |
|
|
321
321
|
|
|
322
322
|
PostgreSQL, MongoDB, and libSQL have higher limits and are usually unaffected.
|
|
323
323
|
|
|
@@ -12,7 +12,7 @@ You can also retrieve message history to display past conversations in your UI.
|
|
|
12
12
|
>
|
|
13
13
|
> Sending the full history is redundant because Mastra loads messages from storage, and it can cause message ordering bugs when client-side timestamps conflict with stored timestamps.
|
|
14
14
|
>
|
|
15
|
-
> For an AI SDK example, see [Using Mastra Memory](https://mastra.ai/
|
|
15
|
+
> For an AI SDK example, see [Using Mastra Memory](https://mastra.ai/integrations/agentic-ui/ai-sdk-ui).
|
|
16
16
|
|
|
17
17
|
## Threads and resources
|
|
18
18
|
|
|
@@ -92,7 +92,7 @@ See [configuration options](https://mastra.ai/reference/memory/observational-mem
|
|
|
92
92
|
>
|
|
93
93
|
> Observational memory still relies on stored conversation history. Sending the full history is redundant and can cause message ordering bugs when client-side timestamps conflict with stored timestamps.
|
|
94
94
|
>
|
|
95
|
-
> For an AI SDK example, see [Using Mastra Memory](https://mastra.ai/
|
|
95
|
+
> For an AI SDK example, see [Using Mastra Memory](https://mastra.ai/integrations/agentic-ui/ai-sdk-ui).
|
|
96
96
|
|
|
97
97
|
> **Note:** OM currently only supports `@mastra/pg`, `@mastra/libsql`, `@mastra/mysql`, `@mastra/mongodb`, `@mastra/convex`, and `@mastra/oracledb` storage adapters. It uses background agents for managing memory. When no model is set, the default model is `google/gemini-2.5-flash`.
|
|
98
98
|
|
|
@@ -6,7 +6,7 @@ The `MastraStorageExporter` persists traces to your configured storage backend,
|
|
|
6
6
|
|
|
7
7
|
> **Note:** `MastraStorageExporter` was previously called `DefaultExporter`. The original `DefaultExporter` class is still exported from `@mastra/observability` for backward compatibility, but it's deprecated. New code should use `MastraStorageExporter`.
|
|
8
8
|
|
|
9
|
-
> **Production Observability:** Observability data can quickly overwhelm general-purpose databases in production. For high-traffic applications, route the observability storage domain to [ClickHouse](https://mastra.ai/
|
|
9
|
+
> **Production Observability:** Observability data can quickly overwhelm general-purpose databases in production. For high-traffic applications, route the observability storage domain to [ClickHouse](https://mastra.ai/integrations/databases/clickhouse) through [composite storage](https://mastra.ai/reference/storage/composite). See [Production Recommendations](#production-recommendations) for details.
|
|
10
10
|
|
|
11
11
|
## Configuration
|
|
12
12
|
|
|
@@ -116,25 +116,25 @@ If you set the strategy to `'auto'`, the `MastraStorageExporter` automatically s
|
|
|
116
116
|
|
|
117
117
|
### Providers with Observability Support
|
|
118
118
|
|
|
119
|
-
| Storage Provider
|
|
120
|
-
|
|
|
121
|
-
| **[ClickHouse](https://mastra.ai/
|
|
122
|
-
| **[PostgreSQL](https://mastra.ai/
|
|
123
|
-
| **[MSSQL](https://mastra.ai/
|
|
124
|
-
| **[MongoDB](https://mastra.ai/
|
|
125
|
-
| **[OracleDB](https://mastra.ai/
|
|
126
|
-
| **[libSQL](https://mastra.ai/
|
|
119
|
+
| Storage Provider | Preferred Strategy | Supported Strategies | Recommended Use |
|
|
120
|
+
| --------------------------------------------------------------------- | ------------------ | ------------------------------- | ------------------------------------- |
|
|
121
|
+
| **[ClickHouse](https://mastra.ai/integrations/databases/clickhouse)** | insert-only | insert-only | Production (high-volume) |
|
|
122
|
+
| **[PostgreSQL](https://mastra.ai/integrations/databases/postgresql)** | batch-with-updates | batch-with-updates, insert-only | Production (low volume) |
|
|
123
|
+
| **[MSSQL](https://mastra.ai/integrations/databases/mssql)** | batch-with-updates | batch-with-updates, insert-only | Production (low volume) |
|
|
124
|
+
| **[MongoDB](https://mastra.ai/integrations/databases/mongodb)** | batch-with-updates | batch-with-updates, insert-only | Production (low volume) |
|
|
125
|
+
| **[OracleDB](https://mastra.ai/integrations/databases/oracledb)** | batch-with-updates | batch-with-updates, insert-only | Production (low volume) |
|
|
126
|
+
| **[libSQL](https://mastra.ai/integrations/databases/libsql)** | batch-with-updates | batch-with-updates, insert-only | Default storage, good for development |
|
|
127
127
|
|
|
128
128
|
### Providers without Observability Support
|
|
129
129
|
|
|
130
130
|
The following storage providers **don't support** the observability domain. If you're using one of these providers and need observability, use [composite storage](https://mastra.ai/reference/storage/composite) to route observability data to a supported provider:
|
|
131
131
|
|
|
132
|
-
- [Convex](https://mastra.ai/
|
|
133
|
-
- [DynamoDB](https://mastra.ai/
|
|
134
|
-
- [Cloudflare D1](https://mastra.ai/
|
|
135
|
-
- [Cloudflare Durable Objects](https://mastra.ai/
|
|
136
|
-
- [Upstash](https://mastra.ai/
|
|
137
|
-
- [LanceDB](https://mastra.ai/
|
|
132
|
+
- [Convex](https://mastra.ai/integrations/databases/convex)
|
|
133
|
+
- [DynamoDB](https://mastra.ai/integrations/databases/dynamodb)
|
|
134
|
+
- [Cloudflare D1](https://mastra.ai/integrations/databases/cloudflare-d1)
|
|
135
|
+
- [Cloudflare Durable Objects](https://mastra.ai/integrations/databases/cloudflare-kv)
|
|
136
|
+
- [Upstash](https://mastra.ai/integrations/databases/upstash)
|
|
137
|
+
- [LanceDB](https://mastra.ai/integrations/databases/lancedb)
|
|
138
138
|
|
|
139
139
|
### Strategy Benefits
|
|
140
140
|
|
|
@@ -148,7 +148,7 @@ Observability data grows quickly in production environments. A single agent inte
|
|
|
148
148
|
|
|
149
149
|
### Recommended: ClickHouse for High-Volume Production
|
|
150
150
|
|
|
151
|
-
[ClickHouse](https://mastra.ai/
|
|
151
|
+
[ClickHouse](https://mastra.ai/integrations/databases/clickhouse) is a columnar database designed for high-volume analytics workloads. It's the recommended choice for production observability because:
|
|
152
152
|
|
|
153
153
|
- **Optimized for writes**: Handles millions of inserts per second
|
|
154
154
|
- **Efficient compression**: Reduces storage costs for trace data
|
|
@@ -30,8 +30,8 @@ Exporters send observability data to a destination:
|
|
|
30
30
|
|
|
31
31
|
Bridges connect Mastra to an existing distributed tracing context:
|
|
32
32
|
|
|
33
|
-
- [OpenTelemetry bridge](https://mastra.ai/
|
|
34
|
-
- [Datadog bridge](https://mastra.ai/
|
|
33
|
+
- [OpenTelemetry bridge](https://mastra.ai/integrations/observability/opentelemetry): Integrate Mastra with an existing OpenTelemetry trace.
|
|
34
|
+
- [Datadog bridge](https://mastra.ai/integrations/observability/datadog): Send Mastra traces to Datadog and its LLM Observability product.
|
|
35
35
|
|
|
36
36
|
## Processors
|
|
37
37
|
|
|
@@ -44,4 +44,4 @@ Processors transform or redact spans before export:
|
|
|
44
44
|
- [Configuration](https://mastra.ai/docs/observability/overview)
|
|
45
45
|
- [Tracing](https://mastra.ai/docs/observability/tracing/overview)
|
|
46
46
|
- [Mastra Storage](https://mastra.ai/docs/observability/integrations/exporters/mastra-storage)
|
|
47
|
-
- [OpenTelemetry bridge](https://mastra.ai/
|
|
47
|
+
- [OpenTelemetry bridge](https://mastra.ai/integrations/observability/opentelemetry)
|
|
@@ -300,4 +300,4 @@ The actor signal is trusted input, so construct it server-side:
|
|
|
300
300
|
|
|
301
301
|
- [`IFGAProvider` reference](https://mastra.ai/reference/auth/fga)
|
|
302
302
|
- [Authentication overview](https://mastra.ai/docs/server/auth)
|
|
303
|
-
- [WorkOS authentication](https://mastra.ai/
|
|
303
|
+
- [WorkOS authentication](https://mastra.ai/integrations/auth/workos)
|
|
@@ -171,4 +171,4 @@ SimpleAuth is designed for simplicity, not production security:
|
|
|
171
171
|
- No cryptographic verification
|
|
172
172
|
- All tokens must be known at startup
|
|
173
173
|
|
|
174
|
-
For production applications, consider using [JWT](https://mastra.ai/docs/server/auth/jwt), [Clerk](https://mastra.ai/
|
|
174
|
+
For production applications, consider using [JWT](https://mastra.ai/docs/server/auth/jwt), [Clerk](https://mastra.ai/integrations/auth/clerk), [Auth0](https://mastra.ai/integrations/auth/auth0), or another identity provider.
|
|
@@ -30,14 +30,14 @@ See [Custom API Routes](https://mastra.ai/docs/server/custom-api-routes) for con
|
|
|
30
30
|
|
|
31
31
|
### Third-party integrations
|
|
32
32
|
|
|
33
|
-
- [Auth0](https://mastra.ai/
|
|
34
|
-
- [Better Auth](https://mastra.ai/
|
|
35
|
-
- [Clerk](https://mastra.ai/
|
|
36
|
-
- [Firebase](https://mastra.ai/
|
|
37
|
-
- [Google](https://mastra.ai/
|
|
38
|
-
- [Okta](https://mastra.ai/
|
|
39
|
-
- [Supabase](https://mastra.ai/
|
|
40
|
-
- [WorkOS](https://mastra.ai/
|
|
33
|
+
- [Auth0](https://mastra.ai/integrations/auth/auth0)
|
|
34
|
+
- [Better Auth](https://mastra.ai/integrations/auth/better-auth)
|
|
35
|
+
- [Clerk](https://mastra.ai/integrations/auth/clerk)
|
|
36
|
+
- [Firebase](https://mastra.ai/integrations/auth/firebase)
|
|
37
|
+
- [Google](https://mastra.ai/integrations/auth/google)
|
|
38
|
+
- [Okta](https://mastra.ai/integrations/auth/okta)
|
|
39
|
+
- [Supabase](https://mastra.ai/integrations/auth/supabase)
|
|
40
|
+
- [WorkOS](https://mastra.ai/integrations/auth/workos)
|
|
41
41
|
|
|
42
42
|
### Advanced
|
|
43
43
|
|
|
@@ -35,6 +35,41 @@ curl http://localhost:4111/my-custom-route
|
|
|
35
35
|
|
|
36
36
|
Each route's handler receives the Hono `Context`. Within the handler you can access the `Mastra` instance to fetch or call agents and workflows.
|
|
37
37
|
|
|
38
|
+
## Schema validation
|
|
39
|
+
|
|
40
|
+
Use [`createRoute()`](https://mastra.ai/reference/server/create-route) in `apiRoutes` to parse and validate path parameters, query parameters, and request bodies with Zod. The schemas also infer the handler parameters and generate OpenAPI metadata.
|
|
41
|
+
|
|
42
|
+
```typescript
|
|
43
|
+
import { Mastra } from '@mastra/core'
|
|
44
|
+
import { createRoute } from '@mastra/server/server-adapter'
|
|
45
|
+
import { z } from 'zod'
|
|
46
|
+
|
|
47
|
+
const createItemRoute = createRoute({
|
|
48
|
+
method: 'POST',
|
|
49
|
+
path: '/items',
|
|
50
|
+
responseType: 'json',
|
|
51
|
+
bodySchema: z.object({
|
|
52
|
+
name: z.string().min(1),
|
|
53
|
+
}),
|
|
54
|
+
responseSchema: z.object({
|
|
55
|
+
id: z.string(),
|
|
56
|
+
name: z.string(),
|
|
57
|
+
}),
|
|
58
|
+
handler: async ({ name }) => ({
|
|
59
|
+
id: crypto.randomUUID(),
|
|
60
|
+
name,
|
|
61
|
+
}),
|
|
62
|
+
})
|
|
63
|
+
|
|
64
|
+
export const mastra = new Mastra({
|
|
65
|
+
server: {
|
|
66
|
+
apiRoutes: [createItemRoute],
|
|
67
|
+
},
|
|
68
|
+
})
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
By default, Mastra returns a `400` response when validation fails. The `onValidationError` callback can override the status and response body. Validated values and the `Mastra` server context are passed directly to the handler.
|
|
72
|
+
|
|
38
73
|
## Middleware
|
|
39
74
|
|
|
40
75
|
To add route-specific middleware pass a `middleware` array when calling `registerApiRoute()`.
|
|
@@ -190,19 +190,20 @@ You can also route `observability` to a dedicated analytics backend. See the [ob
|
|
|
190
190
|
|
|
191
191
|
Each provider page includes installation instructions, configuration parameters, and usage examples:
|
|
192
192
|
|
|
193
|
-
- [
|
|
194
|
-
- [
|
|
195
|
-
- [
|
|
196
|
-
- [
|
|
197
|
-
- [
|
|
198
|
-
- [
|
|
199
|
-
- [
|
|
200
|
-
- [
|
|
201
|
-
- [
|
|
202
|
-
- [
|
|
203
|
-
- [
|
|
204
|
-
- [
|
|
205
|
-
- [
|
|
193
|
+
- [Cloudflare D1](https://mastra.ai/integrations/databases/cloudflare-d1)
|
|
194
|
+
- [Cloudflare KV & Durable Objects](https://mastra.ai/integrations/databases/cloudflare-kv)
|
|
195
|
+
- [Convex](https://mastra.ai/integrations/databases/convex)
|
|
196
|
+
- [DynamoDB](https://mastra.ai/integrations/databases/dynamodb)
|
|
197
|
+
- [Google Cloud Spanner](https://mastra.ai/integrations/databases/spanner)
|
|
198
|
+
- [LanceDB](https://mastra.ai/integrations/databases/lancedb)
|
|
199
|
+
- [libSQL](https://mastra.ai/integrations/databases/libsql)
|
|
200
|
+
- [Microsoft SQL Server](https://mastra.ai/integrations/databases/mssql)
|
|
201
|
+
- [MongoDB](https://mastra.ai/integrations/databases/mongodb)
|
|
202
|
+
- [Neon Postgres](https://mastra.ai/integrations/databases/neon)
|
|
203
|
+
- [OracleDB](https://mastra.ai/integrations/databases/oracledb)
|
|
204
|
+
- [PostgreSQL](https://mastra.ai/integrations/databases/postgresql)
|
|
205
|
+
- [Redis](https://mastra.ai/integrations/databases/redis)
|
|
206
|
+
- [Upstash](https://mastra.ai/integrations/databases/upstash)
|
|
206
207
|
|
|
207
208
|
> **Tip:** libSQL is the fastest path for local development because it doesn't require running a separate database server.
|
|
208
209
|
|
|
@@ -12,7 +12,7 @@ All require an observability storage backend to be configured.
|
|
|
12
12
|
|
|
13
13
|
## Quickstart
|
|
14
14
|
|
|
15
|
-
For detailed instructions, follow the [observability instructions](https://mastra.ai/docs/observability/overview). To get up and running quickly, add the `@mastra/observability` package to your project and configure it with [LibSQL](https://mastra.ai/
|
|
15
|
+
For detailed instructions, follow the [observability instructions](https://mastra.ai/docs/observability/overview). To get up and running quickly, add the `@mastra/observability` package to your project and configure it with [LibSQL](https://mastra.ai/integrations/databases/libsql) and [DuckDB](https://mastra.ai/reference/vectors/duckdb) for a local development setup that supports both traces and metrics.
|
|
16
16
|
|
|
17
17
|
**npm**:
|
|
18
18
|
|
|
@@ -407,7 +407,7 @@ Here's an example of a successful workflow result, showing the `input`, `steps`,
|
|
|
407
407
|
|
|
408
408
|
## Streaming
|
|
409
409
|
|
|
410
|
-
For generic `writer` API usage, see [Streaming](https://mastra.ai/guides/
|
|
410
|
+
For generic `writer` API usage, see [Streaming](https://mastra.ai/docs/guides/streaming).
|
|
411
411
|
|
|
412
412
|
### Inspecting workflow stream payloads
|
|
413
413
|
|
|
@@ -85,10 +85,10 @@ Snapshots are saved to the configured storage system. By default, they use libSQ
|
|
|
85
85
|
|
|
86
86
|
Read more about:
|
|
87
87
|
|
|
88
|
-
- [libSQL Storage](https://mastra.ai/
|
|
89
|
-
- [Upstash Storage](https://mastra.ai/
|
|
90
|
-
- [PostgreSQL Storage](https://mastra.ai/
|
|
91
|
-
- [OracleDB Storage](https://mastra.ai/
|
|
88
|
+
- [libSQL Storage](https://mastra.ai/integrations/databases/libsql)
|
|
89
|
+
- [Upstash Storage](https://mastra.ai/integrations/databases/upstash)
|
|
90
|
+
- [PostgreSQL Storage](https://mastra.ai/integrations/databases/postgresql)
|
|
91
|
+
- [OracleDB Storage](https://mastra.ai/integrations/databases/oracledb)
|
|
92
92
|
|
|
93
93
|
### Saving snapshots
|
|
94
94
|
|
|
@@ -140,13 +140,13 @@ export const mastra = new Mastra({
|
|
|
140
140
|
})
|
|
141
141
|
```
|
|
142
142
|
|
|
143
|
-
- [libSQL Storage](https://mastra.ai/
|
|
144
|
-
- [PostgreSQL Storage](https://mastra.ai/
|
|
145
|
-
- [OracleDB Storage](https://mastra.ai/
|
|
146
|
-
- [MongoDB Storage](https://mastra.ai/
|
|
147
|
-
- [Upstash Storage](https://mastra.ai/
|
|
148
|
-
- [Cloudflare D1](https://mastra.ai/
|
|
149
|
-
- [DynamoDB](https://mastra.ai/
|
|
143
|
+
- [libSQL Storage](https://mastra.ai/integrations/databases/libsql)
|
|
144
|
+
- [PostgreSQL Storage](https://mastra.ai/integrations/databases/postgresql)
|
|
145
|
+
- [OracleDB Storage](https://mastra.ai/integrations/databases/oracledb)
|
|
146
|
+
- [MongoDB Storage](https://mastra.ai/integrations/databases/mongodb)
|
|
147
|
+
- [Upstash Storage](https://mastra.ai/integrations/databases/upstash)
|
|
148
|
+
- [Cloudflare D1](https://mastra.ai/integrations/databases/cloudflare-d1)
|
|
149
|
+
- [DynamoDB](https://mastra.ai/integrations/databases/dynamodb)
|
|
150
150
|
- [More storage providers](https://mastra.ai/docs/storage/overview)
|
|
151
151
|
|
|
152
152
|
## Best practices
|
|
@@ -15,6 +15,8 @@ When you call `timeTravel()` on a workflow run:
|
|
|
15
15
|
3. Execution begins from the specified step with the provided or reconstructed input data
|
|
16
16
|
4. The workflow continues to completion from that point forward
|
|
17
17
|
|
|
18
|
+
If the workflow definition has changed since the run was recorded (for example, a step was renamed), or the recorded run never reached a step that precedes the target, time travel fails with a descriptive error before anything executes, and the stored snapshot is left unchanged.
|
|
19
|
+
|
|
18
20
|
Time travel requires storage to be configured since it relies on persisted workflow snapshots.
|
|
19
21
|
|
|
20
22
|
## Basic usage
|
|
@@ -21,15 +21,15 @@ A filesystem provider handles all file operations for a workspace:
|
|
|
21
21
|
Available providers:
|
|
22
22
|
|
|
23
23
|
- [`LocalFilesystem`](https://mastra.ai/reference/workspace/local-filesystem): Stores files in a directory on disk
|
|
24
|
-
- [`S3Filesystem`](https://mastra.ai/
|
|
25
|
-
- [`GCSFilesystem`](https://mastra.ai/
|
|
24
|
+
- [`S3Filesystem`](https://mastra.ai/integrations/file-storage/amazon-s3): Stores files in Amazon S3 or S3-compatible storage (R2, MinIO, Tigris)
|
|
25
|
+
- [`GCSFilesystem`](https://mastra.ai/integrations/file-storage/google-cloud-storage): Stores files in Google Cloud Storage
|
|
26
26
|
- [`PlatformFilesystem`](https://mastra.ai/reference/workspace/platform-filesystem): Stores files in a Mastra Platform workspace bucket
|
|
27
|
-
- [`GoogleDriveFilesystem`](https://mastra.ai/
|
|
28
|
-
- [`AzureBlobFilesystem`](https://mastra.ai/
|
|
29
|
-
- [`FilesSDKFilesystem`](https://mastra.ai/
|
|
30
|
-
- [`AgentFSFilesystem`](https://mastra.ai/
|
|
31
|
-
- [`MesaFilesystem`](https://mastra.ai/
|
|
32
|
-
- [`ArchilFilesystem`](https://mastra.ai/
|
|
27
|
+
- [`GoogleDriveFilesystem`](https://mastra.ai/integrations/file-storage/google-drive): Stores files inside a Google Drive folder
|
|
28
|
+
- [`AzureBlobFilesystem`](https://mastra.ai/integrations/file-storage/azure-blob): Stores files in Azure Blob Storage
|
|
29
|
+
- [`FilesSDKFilesystem`](https://mastra.ai/integrations/file-storage/vercel-files): Stores files in any [FilesSDK](https://files-sdk.dev) adapter (S3, R2, GCS, Azure Blob, Vercel Blob, local filesystem, and more): useful when you want one provider that can target multiple backends
|
|
30
|
+
- [`AgentFSFilesystem`](https://mastra.ai/integrations/file-storage/agentfs): Stores files in a Turso/SQLite database via AgentFS
|
|
31
|
+
- [`MesaFilesystem`](https://mastra.ai/integrations/file-storage/mesa): Stores files in versioned Mesa repos
|
|
32
|
+
- [`ArchilFilesystem`](https://mastra.ai/integrations/file-storage/archil): Stores files on Archil elastic, serverless disks
|
|
33
33
|
|
|
34
34
|
> **Tip:** `LocalFilesystem` is the simplest way to get started as it requires no external services. For cloud storage, use `S3Filesystem`, `GCSFilesystem`, or `AzureBlobFilesystem`. For versioned storage, use `MesaFilesystem`. For database-backed storage without external services, use `AgentFSFilesystem`.
|
|
35
35
|
|
|
@@ -227,12 +227,12 @@ When you configure a filesystem on a workspace, agents receive tools for reading
|
|
|
227
227
|
## Related
|
|
228
228
|
|
|
229
229
|
- [LocalFilesystem reference](https://mastra.ai/reference/workspace/local-filesystem)
|
|
230
|
-
- [S3Filesystem reference](https://mastra.ai/
|
|
231
|
-
- [GCSFilesystem reference](https://mastra.ai/
|
|
232
|
-
- [GoogleDriveFilesystem reference](https://mastra.ai/
|
|
233
|
-
- [AzureBlobFilesystem reference](https://mastra.ai/
|
|
234
|
-
- [FilesSDKFilesystem reference](https://mastra.ai/
|
|
235
|
-
- [AgentFSFilesystem reference](https://mastra.ai/
|
|
236
|
-
- [MesaFilesystem reference](https://mastra.ai/
|
|
230
|
+
- [S3Filesystem reference](https://mastra.ai/integrations/file-storage/amazon-s3)
|
|
231
|
+
- [GCSFilesystem reference](https://mastra.ai/integrations/file-storage/google-cloud-storage)
|
|
232
|
+
- [GoogleDriveFilesystem reference](https://mastra.ai/integrations/file-storage/google-drive)
|
|
233
|
+
- [AzureBlobFilesystem reference](https://mastra.ai/integrations/file-storage/azure-blob)
|
|
234
|
+
- [FilesSDKFilesystem reference](https://mastra.ai/integrations/file-storage/vercel-files)
|
|
235
|
+
- [AgentFSFilesystem reference](https://mastra.ai/integrations/file-storage/agentfs)
|
|
236
|
+
- [MesaFilesystem reference](https://mastra.ai/integrations/file-storage/mesa)
|
|
237
237
|
- [Workspace overview](https://mastra.ai/docs/workspace/overview)
|
|
238
238
|
- [Sandbox](https://mastra.ai/docs/workspace/sandbox)
|
|
@@ -20,17 +20,17 @@ A sandbox provider executes commands in a controlled environment:
|
|
|
20
20
|
## Supported providers
|
|
21
21
|
|
|
22
22
|
- [`LocalSandbox`](https://mastra.ai/reference/workspace/local-sandbox): Executes commands on the local machine
|
|
23
|
-
- [`AgentCoreRuntimeSandbox`](https://mastra.ai/
|
|
24
|
-
- [`AppleContainerSandbox`](https://mastra.ai/
|
|
25
|
-
- [`BlaxelSandbox`](https://mastra.ai/
|
|
26
|
-
- [`DaytonaSandbox`](https://mastra.ai/
|
|
27
|
-
- [`DockerSandbox`](https://mastra.ai/
|
|
28
|
-
- [`E2BSandbox`](https://mastra.ai/
|
|
29
|
-
- [`ModalSandbox`](https://mastra.ai/
|
|
23
|
+
- [`AgentCoreRuntimeSandbox`](https://mastra.ai/integrations/sandboxes/agentcore): Executes commands in AWS Bedrock AgentCore Runtime sessions
|
|
24
|
+
- [`AppleContainerSandbox`](https://mastra.ai/integrations/sandboxes/apple-container): Executes commands in local OCI Linux containers using Apple's `container` CLI
|
|
25
|
+
- [`BlaxelSandbox`](https://mastra.ai/integrations/sandboxes/blaxel): Executes commands in isolated Blaxel cloud sandboxes
|
|
26
|
+
- [`DaytonaSandbox`](https://mastra.ai/integrations/sandboxes/daytona): Executes commands in isolated Daytona cloud sandboxes
|
|
27
|
+
- [`DockerSandbox`](https://mastra.ai/integrations/sandboxes/docker): Executes commands in long-lived Docker containers on the local machine
|
|
28
|
+
- [`E2BSandbox`](https://mastra.ai/integrations/sandboxes/e2b): Executes commands in isolated E2B cloud sandboxes
|
|
29
|
+
- [`ModalSandbox`](https://mastra.ai/integrations/sandboxes/modal): Executes commands in isolated Modal cloud sandboxes
|
|
30
30
|
- [`PlatformSandbox`](https://mastra.ai/reference/workspace/platform-sandbox): Executes commands in a sandbox tied to a Mastra Platform environment
|
|
31
|
-
- [`RailwaySandbox`](https://mastra.ai/
|
|
32
|
-
- [`VercelSandbox`](https://mastra.ai/
|
|
33
|
-
- [`VercelServerlessSandbox`](https://mastra.ai/
|
|
31
|
+
- [`RailwaySandbox`](https://mastra.ai/integrations/sandboxes/railway): Executes commands in ephemeral, isolated Railway cloud sandboxes
|
|
32
|
+
- [`VercelSandbox`](https://mastra.ai/integrations/sandboxes/vercel): Executes commands in an ephemeral Vercel Sandbox Firecracker MicroVM
|
|
33
|
+
- [`VercelServerlessSandbox`](https://mastra.ai/integrations/sandboxes/vercel): Executes commands as stateless Vercel serverless functions
|
|
34
34
|
|
|
35
35
|
## Basic usage
|
|
36
36
|
|
|
@@ -234,13 +234,13 @@ Use `null` or `false` for cloud sandboxes (for example, E2B, Daytona, or Modal)
|
|
|
234
234
|
## Related
|
|
235
235
|
|
|
236
236
|
- [`SandboxProcessManager` reference](https://mastra.ai/reference/workspace/process-manager)
|
|
237
|
-
- [`AgentCoreRuntimeSandbox` reference](https://mastra.ai/
|
|
238
|
-
- [`AppleContainerSandbox` reference](https://mastra.ai/
|
|
239
|
-
- [`DaytonaSandbox` reference](https://mastra.ai/
|
|
240
|
-
- [`E2BSandbox` reference](https://mastra.ai/
|
|
237
|
+
- [`AgentCoreRuntimeSandbox` reference](https://mastra.ai/integrations/sandboxes/agentcore)
|
|
238
|
+
- [`AppleContainerSandbox` reference](https://mastra.ai/integrations/sandboxes/apple-container)
|
|
239
|
+
- [`DaytonaSandbox` reference](https://mastra.ai/integrations/sandboxes/daytona)
|
|
240
|
+
- [`E2BSandbox` reference](https://mastra.ai/integrations/sandboxes/e2b)
|
|
241
241
|
- [`LocalSandbox` reference](https://mastra.ai/reference/workspace/local-sandbox)
|
|
242
|
-
- [`ModalSandbox` reference](https://mastra.ai/
|
|
243
|
-
- [`VercelSandbox` reference](https://mastra.ai/
|
|
244
|
-
- [`VercelServerlessSandbox` reference](https://mastra.ai/
|
|
242
|
+
- [`ModalSandbox` reference](https://mastra.ai/integrations/sandboxes/modal)
|
|
243
|
+
- [`VercelSandbox` reference](https://mastra.ai/integrations/sandboxes/vercel)
|
|
244
|
+
- [`VercelServerlessSandbox` reference](https://mastra.ai/integrations/sandboxes/vercel)
|
|
245
245
|
- [Workspace overview](https://mastra.ai/docs/workspace/overview)
|
|
246
246
|
- [Filesystem](https://mastra.ai/docs/workspace/filesystem)
|
|
@@ -280,5 +280,5 @@ When you configure search on a workspace, agents receive tools for searching and
|
|
|
280
280
|
## Related
|
|
281
281
|
|
|
282
282
|
- [Workspace overview](https://mastra.ai/docs/workspace/overview)
|
|
283
|
-
- [RAG overview](https://mastra.ai/
|
|
283
|
+
- [RAG overview](https://mastra.ai/reference/rag/overview)
|
|
284
284
|
- [Workspace class reference](https://mastra.ai/reference/workspace/workspace-class)
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
If you're already using the [Vercel AI SDK](https://sdk.vercel.ai) directly and want to add Mastra capabilities like [processors](https://mastra.ai/docs/agents/processors) or [memory](https://mastra.ai/docs/memory/memory-processors) without switching to the full Mastra agent API, [`withMastra()`](https://mastra.ai/reference/ai-sdk/with-mastra) lets you wrap any AI SDK model with these features. This is useful when you want to keep your existing AI SDK code but add input/output processing, conversation persistence, or content filtering.
|
|
6
6
|
|
|
7
|
-
> **Tip:** If you want to use Mastra together with AI SDK UI (e.g. `useChat()`), visit the [AI SDK UI guide](https://mastra.ai/
|
|
7
|
+
> **Tip:** If you want to use Mastra together with AI SDK UI (e.g. `useChat()`), visit the [AI SDK UI guide](https://mastra.ai/integrations/agentic-ui/ai-sdk-ui).
|
|
8
8
|
|
|
9
9
|
## Installation
|
|
10
10
|
|
|
@@ -139,4 +139,4 @@ const { text } = await generateText({
|
|
|
139
139
|
- [`withMastra()`](https://mastra.ai/reference/ai-sdk/with-mastra): API reference for `withMastra()`
|
|
140
140
|
- [Processors](https://mastra.ai/docs/agents/processors): Learn about input and output processors
|
|
141
141
|
- [Memory](https://mastra.ai/docs/memory/overview): Overview of Mastra's memory system
|
|
142
|
-
- [AI SDK UI](https://mastra.ai/
|
|
142
|
+
- [AI SDK UI](https://mastra.ai/integrations/agentic-ui/ai-sdk-ui): Using AI SDK UI hooks with Mastra agents, workflows, and networks
|
|
@@ -575,4 +575,4 @@ Workers recover from crashes because the distributed PubSub backend persists una
|
|
|
575
575
|
- [CLI reference](https://mastra.ai/reference/cli/mastra): `mastra worker build` and `mastra worker start`
|
|
576
576
|
- [PubSub](https://mastra.ai/docs/server/pubsub): Event delivery backends
|
|
577
577
|
- [Deploy a Mastra server](https://mastra.ai/docs/deployment/mastra-server): Build output and server configuration
|
|
578
|
-
- [Deploy Mastra to Kubernetes](https://mastra.ai/
|
|
578
|
+
- [Deploy Mastra to Kubernetes](https://mastra.ai/integrations/deploy/kubernetes): Multi-pod deployment with durable agents
|
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
# Mastra Quickstart
|
|
4
4
|
|
|
5
|
-
**For AI agents:** Create a new Mastra project non-interactively with `npm create mastra@latest <project-name> -- --llm <provider>`, replacing `<provider>` with `openai`, `anthropic`, `google`, or `xai`. For a minimal project without an agent or model provider, use `npm create mastra@latest <project-name> -- --empty`. To build a Mastra project from scratch, see the [manual installation guide](https://mastra.ai/
|
|
5
|
+
**For AI agents:** Create a new Mastra project non-interactively with `npm create mastra@latest <project-name> -- --llm <provider>`, replacing `<provider>` with `openai`, `anthropic`, `google`, or `xai`. For a minimal project without an agent or model provider, use `npm create mastra@latest <project-name> -- --empty`. To build a Mastra project from scratch, see the [manual installation guide](https://mastra.ai/reference/manual-install).
|
|
6
6
|
|
|
7
7
|
The `create-mastra` CLI is the quickest way to start a Mastra project. It creates an agent harness with workspace tools, memory, task tracking, web access, schedules, storage, and observability.
|
|
8
8
|
|
|
9
|
-
For more control, see the [manual installation guide](https://mastra.ai/
|
|
9
|
+
For more control, see the [manual installation guide](https://mastra.ai/reference/manual-install). To add Mastra to an existing project, use [`mastra init`](https://mastra.ai/reference/cli/mastra).
|
|
10
10
|
|
|
11
11
|
> **📹 Watch:** Watch the [Mastra AI agent course](https://www.youtube.com/watch?v=lCmf_qrGfGA) for a guided introduction to building agents with Mastra.
|
|
12
12
|
|
|
@@ -82,7 +82,7 @@ Open [Studio at localhost:4111](http://localhost:4111), select the agent, and se
|
|
|
82
82
|
|
|
83
83
|
## Next steps
|
|
84
84
|
|
|
85
|
-
- Integrate Mastra with [Next.js](https://mastra.ai/
|
|
85
|
+
- Integrate Mastra with [Next.js](https://mastra.ai/integrations/frameworks/next-js), [React](https://mastra.ai/integrations/frameworks/vite-react), or [Astro](https://mastra.ai/integrations/frameworks/astro)
|
|
86
86
|
- Learn how to [build Mastra with AI](https://mastra.ai/reference/build-with-ai)
|
|
87
87
|
- Build an agent from scratch with a [guide](https://mastra.ai/guides)
|
|
88
88
|
- Watch the [Mastra YouTube channel](https://www.youtube.com/@mastra-ai)
|
package/.docs/guides/index.md
CHANGED
|
@@ -14,11 +14,11 @@ The `npm create mastra@latest` command is the fastest way to build your first ag
|
|
|
14
14
|
|
|
15
15
|
Add Mastra to an existing project, or scaffold a new Mastra-powered app if you’re starting from scratch.
|
|
16
16
|
|
|
17
|
-
- [Next.js](https://mastra.ai/
|
|
18
|
-
- [React](https://mastra.ai/
|
|
19
|
-
- [SvelteKit](https://mastra.ai/
|
|
20
|
-
- [Astro](https://mastra.ai/
|
|
21
|
-
- [Nuxt](https://mastra.ai/
|
|
22
|
-
- [Express](https://mastra.ai/
|
|
23
|
-
- [Hono](https://mastra.ai/
|
|
24
|
-
- [Electron](https://mastra.ai/
|
|
17
|
+
- [Next.js](https://mastra.ai/integrations/frameworks/next-js)
|
|
18
|
+
- [React](https://mastra.ai/integrations/frameworks/vite-react)
|
|
19
|
+
- [SvelteKit](https://mastra.ai/integrations/frameworks/sveltekit)
|
|
20
|
+
- [Astro](https://mastra.ai/integrations/frameworks/astro)
|
|
21
|
+
- [Nuxt](https://mastra.ai/integrations/frameworks/nuxt)
|
|
22
|
+
- [Express](https://mastra.ai/integrations/frameworks/express)
|
|
23
|
+
- [Hono](https://mastra.ai/integrations/frameworks/hono)
|
|
24
|
+
- [Electron](https://mastra.ai/integrations/frameworks/electron)
|