@mastra/mcp-docs-server 1.0.0-beta.8 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.docs/organized/changelogs/%40internal%2Fchangeset-cli.md +1 -13
- package/.docs/organized/changelogs/%40internal%2Fexternal-types.md +1 -5
- package/.docs/organized/changelogs/%40internal%2Fplayground.md +40 -0
- package/.docs/organized/changelogs/%40internal%2Fstorage-test-utils.md +8 -8
- package/.docs/organized/changelogs/%40internal%2Ftypes-builder.md +1 -53
- package/.docs/organized/changelogs/%40mastra%2Fagent-builder.md +287 -287
- package/.docs/organized/changelogs/%40mastra%2Fai-sdk.md +315 -315
- package/.docs/organized/changelogs/%40mastra%2Fastra.md +53 -53
- package/.docs/organized/changelogs/%40mastra%2Fauth.md +38 -0
- package/.docs/organized/changelogs/%40mastra%2Fchroma.md +66 -66
- package/.docs/organized/changelogs/%40mastra%2Fclickhouse.md +522 -212
- package/.docs/organized/changelogs/%40mastra%2Fclient-js.md +658 -196
- package/.docs/organized/changelogs/%40mastra%2Fcloudflare-d1.md +439 -234
- package/.docs/organized/changelogs/%40mastra%2Fcloudflare.md +450 -211
- package/.docs/organized/changelogs/%40mastra%2Fcodemod.md +208 -0
- package/.docs/organized/changelogs/%40mastra%2Fconvex.md +448 -22
- package/.docs/organized/changelogs/%40mastra%2Fcore.md +3341 -271
- package/.docs/organized/changelogs/%40mastra%2Fcouchbase.md +60 -60
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloud.md +289 -289
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloudflare.md +90 -90
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-netlify.md +74 -74
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-vercel.md +70 -70
- package/.docs/organized/changelogs/%40mastra%2Fdeployer.md +247 -220
- package/.docs/organized/changelogs/%40mastra%2Fduckdb.md +70 -0
- package/.docs/organized/changelogs/%40mastra%2Fdynamodb.md +403 -225
- package/.docs/organized/changelogs/%40mastra%2Felasticsearch.md +72 -0
- package/.docs/organized/changelogs/%40mastra%2Fevals.md +145 -145
- package/.docs/organized/changelogs/%40mastra%2Ffastembed.md +54 -0
- package/.docs/organized/changelogs/%40mastra%2Flance.md +456 -226
- package/.docs/organized/changelogs/%40mastra%2Flibsql.md +604 -208
- package/.docs/organized/changelogs/%40mastra%2Floggers.md +71 -71
- package/.docs/organized/changelogs/%40mastra%2Fmcp-docs-server.md +247 -247
- package/.docs/organized/changelogs/%40mastra%2Fmcp-registry-registry.md +28 -28
- package/.docs/organized/changelogs/%40mastra%2Fmcp.md +285 -285
- package/.docs/organized/changelogs/%40mastra%2Fmemory.md +354 -156
- package/.docs/organized/changelogs/%40mastra%2Fmongodb.md +545 -212
- package/.docs/organized/changelogs/%40mastra%2Fmssql.md +481 -202
- package/.docs/organized/changelogs/%40mastra%2Fopensearch.md +194 -194
- package/.docs/organized/changelogs/%40mastra%2Fpg.md +759 -213
- package/.docs/organized/changelogs/%40mastra%2Fpinecone.md +198 -198
- package/.docs/organized/changelogs/%40mastra%2Fplayground-ui.md +636 -229
- package/.docs/organized/changelogs/%40mastra%2Fqdrant.md +163 -163
- package/.docs/organized/changelogs/%40mastra%2Frag.md +310 -310
- package/.docs/organized/changelogs/%40mastra%2Freact.md +328 -230
- package/.docs/organized/changelogs/%40mastra%2Fs3vectors.md +64 -0
- package/.docs/organized/changelogs/%40mastra%2Fschema-compat.md +160 -0
- package/.docs/organized/changelogs/%40mastra%2Fserver.md +829 -218
- package/.docs/organized/changelogs/%40mastra%2Fturbopuffer.md +57 -57
- package/.docs/organized/changelogs/%40mastra%2Fupstash.md +479 -232
- package/.docs/organized/changelogs/%40mastra%2Fvectorize.md +53 -53
- package/.docs/organized/changelogs/%40mastra%2Fvoice-azure.md +45 -45
- package/.docs/organized/changelogs/%40mastra%2Fvoice-cloudflare.md +45 -45
- package/.docs/organized/changelogs/%40mastra%2Fvoice-deepgram.md +47 -47
- package/.docs/organized/changelogs/%40mastra%2Fvoice-elevenlabs.md +110 -110
- package/.docs/organized/changelogs/%40mastra%2Fvoice-gladia.md +15 -0
- package/.docs/organized/changelogs/%40mastra%2Fvoice-google-gemini-live.md +98 -0
- package/.docs/organized/changelogs/%40mastra%2Fvoice-google.md +54 -54
- package/.docs/organized/changelogs/%40mastra%2Fvoice-murf.md +46 -46
- package/.docs/organized/changelogs/%40mastra%2Fvoice-openai-realtime.md +93 -93
- package/.docs/organized/changelogs/%40mastra%2Fvoice-openai.md +47 -47
- package/.docs/organized/changelogs/%40mastra%2Fvoice-playai.md +45 -45
- package/.docs/organized/changelogs/%40mastra%2Fvoice-sarvam.md +45 -45
- package/.docs/organized/changelogs/%40mastra%2Fvoice-speechify.md +45 -45
- package/.docs/organized/changelogs/create-mastra.md +227 -227
- package/.docs/organized/changelogs/mastra.md +277 -277
- package/.docs/organized/code-examples/a2a.md +2 -2
- package/.docs/organized/code-examples/agent-v6.md +221 -0
- package/.docs/organized/code-examples/agui.md +4 -4
- package/.docs/organized/code-examples/ai-elements.md +3 -3
- package/.docs/organized/code-examples/ai-sdk-useChat.md +2 -2
- package/.docs/organized/code-examples/ai-sdk-v5.md +3 -3
- package/.docs/organized/code-examples/assistant-ui.md +5 -5
- package/.docs/organized/code-examples/bird-checker-with-express.md +1 -1
- package/.docs/organized/code-examples/bird-checker-with-nextjs-and-eval.md +2 -2
- package/.docs/organized/code-examples/bird-checker-with-nextjs.md +3 -3
- package/.docs/organized/code-examples/client-side-tools.md +4 -4
- package/.docs/organized/code-examples/crypto-chatbot.md +5 -5
- package/.docs/organized/code-examples/experimental-auth-weather-agent.md +1 -1
- package/.docs/organized/code-examples/fireworks-r1.md +2 -2
- package/.docs/organized/code-examples/heads-up-game.md +7 -7
- package/.docs/organized/code-examples/inngest.md +1075 -0
- package/.docs/organized/code-examples/mcp-configuration.md +1 -1
- package/.docs/organized/code-examples/mcp-server-adapters.md +3 -4
- package/.docs/organized/code-examples/memory-per-resource-example.md +3 -3
- package/.docs/organized/code-examples/memory-todo-agent.md +1 -1
- package/.docs/organized/code-examples/memory-with-context.md +1 -1
- package/.docs/organized/code-examples/memory-with-processors.md +1 -1
- package/.docs/organized/code-examples/openapi-spec-writer.md +3 -3
- package/.docs/organized/code-examples/processors-with-ai-sdk.md +14 -0
- package/.docs/organized/code-examples/quick-start.md +1 -5
- package/.docs/organized/code-examples/server-app-access.md +3 -3
- package/.docs/organized/code-examples/server-express-adapter.md +1 -1
- package/.docs/organized/code-examples/server-fastify-adapter.md +83 -0
- package/.docs/organized/code-examples/server-hono-adapter.md +3 -3
- package/.docs/organized/code-examples/server-koa-adapter.md +94 -0
- package/.docs/organized/code-examples/stock-price-tool.md +21 -2
- package/.docs/organized/code-examples/workflow-ai-recruiter.md +1 -1
- package/.docs/organized/code-examples/workflow-with-inline-steps.md +1 -1
- package/.docs/organized/code-examples/workflow-with-memory.md +1 -1
- package/.docs/organized/code-examples/workflow-with-separate-steps.md +1 -1
- package/.docs/organized/code-examples/workflow-with-suspend-resume.md +1 -1
- package/.docs/raw/agents/adding-voice.mdx +24 -6
- package/.docs/raw/agents/agent-approval.mdx +209 -12
- package/.docs/raw/agents/agent-memory.mdx +36 -32
- package/.docs/raw/agents/guardrails.mdx +105 -56
- package/.docs/raw/agents/network-approval.mdx +281 -0
- package/.docs/raw/agents/networks.mdx +69 -13
- package/.docs/raw/agents/overview.mdx +43 -25
- package/.docs/raw/agents/processors.mdx +234 -17
- package/.docs/raw/agents/structured-output.mdx +78 -8
- package/.docs/raw/agents/using-tools.mdx +67 -6
- package/.docs/raw/course/01-first-agent/07-creating-your-agent.md +1 -2
- package/.docs/raw/course/01-first-agent/12-connecting-tool-to-agent.md +1 -1
- package/.docs/raw/course/01-first-agent/16-adding-memory-to-agent.md +1 -2
- package/.docs/raw/course/02-agent-tools-mcp/05-updating-your-agent.md +1 -1
- package/.docs/raw/course/02-agent-tools-mcp/10-updating-agent-instructions-zapier.md +1 -1
- package/.docs/raw/course/02-agent-tools-mcp/16-updating-agent-instructions-github.md +1 -1
- package/.docs/raw/course/02-agent-tools-mcp/21-updating-agent-instructions-hackernews.md +1 -1
- package/.docs/raw/course/02-agent-tools-mcp/27-updating-agent-instructions-filesystem.md +1 -1
- package/.docs/raw/course/02-agent-tools-mcp/31-enhancing-memory-configuration.md +3 -3
- package/.docs/raw/course/03-agent-memory/04-creating-basic-memory-agent.md +1 -2
- package/.docs/raw/course/03-agent-memory/07-understanding-memory-threads.md +35 -0
- package/.docs/raw/course/03-agent-memory/08-configuring-conversation-history.md +1 -2
- package/.docs/raw/course/03-agent-memory/13-vector-store-configuration.md +1 -1
- package/.docs/raw/course/03-agent-memory/16-configuring-semantic-recall.md +4 -5
- package/.docs/raw/course/03-agent-memory/18-advanced-configuration-semantic-recall.md +1 -1
- package/.docs/raw/course/03-agent-memory/21-configuring-working-memory.md +3 -4
- package/.docs/raw/course/03-agent-memory/22-custom-working-memory-templates.md +3 -4
- package/.docs/raw/course/03-agent-memory/25-combining-memory-features.md +3 -4
- package/.docs/raw/course/03-agent-memory/27-creating-learning-assistant.md +3 -4
- package/.docs/raw/course/04-workflows/11-creating-an-ai-agent.md +2 -3
- package/.docs/raw/deployment/cloud-providers.mdx +22 -0
- package/.docs/raw/deployment/mastra-server.mdx +140 -0
- package/.docs/raw/deployment/monorepo.mdx +106 -42
- package/.docs/raw/deployment/overview.mdx +35 -48
- package/.docs/raw/deployment/web-framework.mdx +17 -19
- package/.docs/raw/deployment/workflow-runners.mdx +16 -0
- package/.docs/raw/evals/built-in-scorers.mdx +2 -0
- package/.docs/raw/evals/custom-scorers.mdx +60 -12
- package/.docs/raw/evals/overview.mdx +6 -6
- package/.docs/raw/evals/running-in-ci.mdx +4 -2
- package/.docs/raw/getting-started/manual-install.mdx +20 -20
- package/.docs/raw/getting-started/mcp-docs-server.mdx +59 -2
- package/.docs/raw/getting-started/project-structure.mdx +2 -2
- package/.docs/raw/getting-started/start.mdx +17 -1
- package/.docs/raw/getting-started/studio.mdx +10 -37
- package/.docs/raw/guides/agent-frameworks/ai-sdk.mdx +151 -0
- package/.docs/raw/guides/build-your-ui/ai-sdk-ui.mdx +1034 -80
- package/.docs/raw/guides/build-your-ui/assistant-ui.mdx +8 -8
- package/.docs/raw/guides/build-your-ui/copilotkit.mdx +32 -11
- package/.docs/raw/{deployment/cloud-providers → guides/deployment}/amazon-ec2.mdx +9 -9
- package/.docs/raw/{deployment/cloud-providers → guides/deployment}/aws-lambda.mdx +13 -16
- package/.docs/raw/{deployment/cloud-providers → guides/deployment}/azure-app-services.mdx +5 -7
- package/.docs/raw/{deployment/cloud-providers → guides/deployment}/cloudflare-deployer.mdx +8 -5
- package/.docs/raw/{deployment/cloud-providers → guides/deployment}/digital-ocean.mdx +18 -23
- package/.docs/raw/guides/deployment/index.mdx +32 -0
- package/.docs/raw/guides/deployment/inngest.mdx +673 -0
- package/.docs/raw/{deployment/cloud-providers → guides/deployment}/netlify-deployer.mdx +7 -3
- package/.docs/raw/{deployment/cloud-providers → guides/deployment}/vercel-deployer.mdx +8 -5
- package/.docs/raw/guides/getting-started/astro.mdx +292 -451
- package/.docs/raw/guides/getting-started/express.mdx +72 -153
- package/.docs/raw/guides/getting-started/hono.mdx +227 -0
- package/.docs/raw/guides/getting-started/next-js.mdx +173 -61
- package/.docs/raw/guides/getting-started/nuxt.mdx +505 -0
- package/.docs/raw/guides/getting-started/quickstart.mdx +5 -5
- package/.docs/raw/guides/getting-started/sveltekit.mdx +238 -409
- package/.docs/raw/guides/getting-started/vite-react.mdx +317 -147
- package/.docs/raw/guides/guide/ai-recruiter.mdx +10 -10
- package/.docs/raw/guides/guide/chef-michel.mdx +9 -11
- package/.docs/raw/guides/guide/notes-mcp-server.mdx +15 -15
- package/.docs/raw/guides/guide/research-assistant.mdx +20 -20
- package/.docs/raw/guides/guide/stock-agent.mdx +5 -5
- package/.docs/raw/guides/guide/web-search.mdx +38 -38
- package/.docs/raw/guides/guide/whatsapp-chat-bot.mdx +7 -7
- package/.docs/raw/guides/index.mdx +0 -1
- package/.docs/raw/guides/migrations/ai-sdk-v4-to-v5.mdx +2 -2
- package/.docs/raw/guides/migrations/upgrade-to-v1/agent.mdx +105 -4
- package/.docs/raw/guides/migrations/upgrade-to-v1/cli.mdx +15 -1
- package/.docs/raw/guides/migrations/upgrade-to-v1/client.mdx +170 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/deployment.mdx +42 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/mastra.mdx +0 -35
- package/.docs/raw/guides/migrations/upgrade-to-v1/memory.mdx +40 -3
- package/.docs/raw/guides/migrations/upgrade-to-v1/overview.mdx +17 -2
- package/.docs/raw/guides/migrations/upgrade-to-v1/processors.mdx +11 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/rag.mdx +47 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/storage.mdx +271 -25
- package/.docs/raw/guides/migrations/upgrade-to-v1/tools.mdx +3 -3
- package/.docs/raw/guides/migrations/upgrade-to-v1/tracing.mdx +72 -17
- package/.docs/raw/guides/migrations/upgrade-to-v1/vectors.mdx +46 -1
- package/.docs/raw/guides/migrations/upgrade-to-v1/workflows.mdx +50 -7
- package/.docs/raw/guides/migrations/vnext-to-standard-apis.mdx +21 -23
- package/.docs/raw/index.mdx +2 -2
- package/.docs/raw/mastra-cloud/deployment.mdx +86 -0
- package/.docs/raw/mastra-cloud/observability.mdx +43 -0
- package/.docs/raw/mastra-cloud/overview.mdx +31 -0
- package/.docs/raw/mastra-cloud/setup.mdx +64 -0
- package/.docs/raw/mastra-cloud/studio.mdx +35 -0
- package/.docs/raw/mcp/overview.mdx +60 -25
- package/.docs/raw/mcp/publishing-mcp-server.mdx +7 -4
- package/.docs/raw/memory/memory-processors.mdx +17 -12
- package/.docs/raw/memory/message-history.mdx +72 -0
- package/.docs/raw/memory/overview.mdx +38 -76
- package/.docs/raw/memory/semantic-recall.mdx +65 -52
- package/.docs/raw/memory/storage.mdx +248 -0
- package/.docs/raw/memory/working-memory.mdx +24 -13
- package/.docs/raw/observability/logging.mdx +16 -15
- package/.docs/raw/observability/overview.mdx +27 -7
- package/.docs/raw/observability/tracing/bridges/otel.mdx +7 -4
- package/.docs/raw/observability/tracing/exporters/arize.mdx +61 -24
- package/.docs/raw/observability/tracing/exporters/braintrust.mdx +32 -22
- package/.docs/raw/observability/tracing/exporters/cloud.mdx +24 -5
- package/.docs/raw/observability/tracing/exporters/datadog.mdx +175 -0
- package/.docs/raw/observability/tracing/exporters/default.mdx +28 -7
- package/.docs/raw/observability/tracing/exporters/laminar.mdx +89 -0
- package/.docs/raw/observability/tracing/exporters/langfuse.mdx +31 -22
- package/.docs/raw/observability/tracing/exporters/langsmith.mdx +33 -3
- package/.docs/raw/observability/tracing/exporters/otel.mdx +194 -22
- package/.docs/raw/observability/tracing/exporters/posthog.mdx +32 -22
- package/.docs/raw/observability/tracing/exporters/sentry.mdx +198 -0
- package/.docs/raw/observability/tracing/overview.mdx +388 -108
- package/.docs/raw/observability/tracing/processors/sensitive-data-filter.mdx +27 -7
- package/.docs/raw/rag/chunking-and-embedding.mdx +22 -33
- package/.docs/raw/rag/graph-rag.mdx +223 -0
- package/.docs/raw/rag/overview.mdx +6 -3
- package/.docs/raw/rag/retrieval.mdx +53 -57
- package/.docs/raw/rag/vector-databases.mdx +55 -31
- package/.docs/raw/reference/agents/agent.mdx +17 -14
- package/.docs/raw/reference/agents/generate.mdx +172 -44
- package/.docs/raw/reference/agents/generateLegacy.mdx +5 -3
- package/.docs/raw/reference/agents/getDefaultGenerateOptions.mdx +5 -3
- package/.docs/raw/reference/agents/getDefaultOptions.mdx +5 -3
- package/.docs/raw/reference/agents/getDefaultStreamOptions.mdx +5 -3
- package/.docs/raw/reference/agents/getDescription.mdx +3 -1
- package/.docs/raw/reference/agents/getInstructions.mdx +5 -3
- package/.docs/raw/reference/agents/getLLM.mdx +5 -3
- package/.docs/raw/reference/agents/getMemory.mdx +5 -3
- package/.docs/raw/reference/agents/getModel.mdx +5 -3
- package/.docs/raw/reference/agents/getTools.mdx +4 -2
- package/.docs/raw/reference/agents/getVoice.mdx +4 -2
- package/.docs/raw/reference/agents/listAgents.mdx +4 -2
- package/.docs/raw/reference/agents/listScorers.mdx +5 -3
- package/.docs/raw/reference/agents/listTools.mdx +4 -2
- package/.docs/raw/reference/agents/listWorkflows.mdx +4 -2
- package/.docs/raw/reference/agents/network.mdx +113 -1
- package/.docs/raw/reference/ai-sdk/chat-route.mdx +6 -3
- package/.docs/raw/reference/ai-sdk/handle-chat-stream.mdx +4 -2
- package/.docs/raw/reference/ai-sdk/handle-network-stream.mdx +4 -2
- package/.docs/raw/reference/ai-sdk/handle-workflow-stream.mdx +5 -3
- package/.docs/raw/reference/ai-sdk/network-route.mdx +6 -3
- package/.docs/raw/reference/ai-sdk/to-ai-sdk-stream.mdx +10 -6
- package/.docs/raw/reference/ai-sdk/to-ai-sdk-v4-messages.mdx +130 -0
- package/.docs/raw/reference/ai-sdk/to-ai-sdk-v5-messages.mdx +110 -0
- package/.docs/raw/reference/ai-sdk/with-mastra.mdx +122 -0
- package/.docs/raw/reference/ai-sdk/workflow-route.mdx +7 -4
- package/.docs/raw/reference/auth/auth0.mdx +5 -3
- package/.docs/raw/reference/auth/clerk.mdx +5 -3
- package/.docs/raw/reference/auth/firebase.mdx +6 -5
- package/.docs/raw/reference/auth/jwt.mdx +5 -3
- package/.docs/raw/reference/auth/supabase.mdx +5 -3
- package/.docs/raw/reference/auth/workos.mdx +5 -3
- package/.docs/raw/reference/cli/create-mastra.mdx +12 -10
- package/.docs/raw/reference/cli/mastra.mdx +63 -15
- package/.docs/raw/reference/client-js/agents.mdx +311 -85
- package/.docs/raw/reference/client-js/error-handling.mdx +3 -3
- package/.docs/raw/reference/client-js/logs.mdx +2 -0
- package/.docs/raw/reference/client-js/mastra-client.mdx +6 -4
- package/.docs/raw/reference/client-js/memory.mdx +47 -2
- package/.docs/raw/reference/client-js/observability.mdx +2 -0
- package/.docs/raw/reference/client-js/telemetry.mdx +2 -0
- package/.docs/raw/reference/client-js/tools.mdx +2 -0
- package/.docs/raw/reference/client-js/vectors.mdx +2 -0
- package/.docs/raw/reference/client-js/workflows.mdx +47 -3
- package/.docs/raw/reference/configuration.mdx +761 -0
- package/.docs/raw/reference/core/addGateway.mdx +2 -0
- package/.docs/raw/reference/core/getAgent.mdx +3 -1
- package/.docs/raw/reference/core/getAgentById.mdx +3 -1
- package/.docs/raw/reference/core/getDeployer.mdx +3 -1
- package/.docs/raw/reference/core/getGateway.mdx +2 -0
- package/.docs/raw/reference/core/getGatewayById.mdx +2 -0
- package/.docs/raw/reference/core/getLogger.mdx +3 -1
- package/.docs/raw/reference/core/getMCPServer.mdx +3 -1
- package/.docs/raw/reference/core/getMCPServerById.mdx +3 -1
- package/.docs/raw/reference/core/getMemory.mdx +77 -0
- package/.docs/raw/reference/core/getScorer.mdx +2 -0
- package/.docs/raw/reference/core/getScorerById.mdx +2 -0
- package/.docs/raw/reference/core/getServer.mdx +6 -4
- package/.docs/raw/reference/core/getStorage.mdx +5 -3
- package/.docs/raw/reference/core/getStoredAgentById.mdx +185 -0
- package/.docs/raw/reference/core/getTelemetry.mdx +3 -1
- package/.docs/raw/reference/core/getVector.mdx +3 -1
- package/.docs/raw/reference/core/getWorkflow.mdx +3 -1
- package/.docs/raw/reference/core/listAgents.mdx +3 -1
- package/.docs/raw/reference/core/listGateways.mdx +2 -0
- package/.docs/raw/reference/core/listLogs.mdx +3 -1
- package/.docs/raw/reference/core/listLogsByRunId.mdx +3 -1
- package/.docs/raw/reference/core/listMCPServers.mdx +3 -1
- package/.docs/raw/reference/core/listMemory.mdx +74 -0
- package/.docs/raw/reference/core/listScorers.mdx +2 -0
- package/.docs/raw/reference/core/listStoredAgents.mdx +153 -0
- package/.docs/raw/reference/core/listVectors.mdx +3 -1
- package/.docs/raw/reference/core/listWorkflows.mdx +3 -1
- package/.docs/raw/reference/core/mastra-class.mdx +35 -20
- package/.docs/raw/reference/core/mastra-model-gateway.mdx +2 -0
- package/.docs/raw/reference/core/setLogger.mdx +3 -1
- package/.docs/raw/reference/core/setStorage.mdx +6 -4
- package/.docs/raw/reference/deployer/cloudflare.mdx +22 -53
- package/.docs/raw/reference/deployer/deployer.mdx +2 -1
- package/.docs/raw/reference/deployer/netlify.mdx +4 -1
- package/.docs/raw/reference/deployer/vercel.mdx +5 -4
- package/.docs/raw/reference/evals/answer-relevancy.mdx +4 -1
- package/.docs/raw/reference/evals/answer-similarity.mdx +4 -1
- package/.docs/raw/reference/evals/bias.mdx +4 -1
- package/.docs/raw/reference/evals/completeness.mdx +4 -1
- package/.docs/raw/reference/evals/content-similarity.mdx +4 -1
- package/.docs/raw/reference/evals/context-precision.mdx +4 -1
- package/.docs/raw/reference/evals/context-relevance.mdx +2 -0
- package/.docs/raw/reference/evals/create-scorer.mdx +11 -3
- package/.docs/raw/reference/evals/faithfulness.mdx +4 -1
- package/.docs/raw/reference/evals/hallucination.mdx +4 -1
- package/.docs/raw/reference/evals/keyword-coverage.mdx +4 -1
- package/.docs/raw/reference/evals/mastra-scorer.mdx +2 -0
- package/.docs/raw/reference/evals/noise-sensitivity.mdx +2 -0
- package/.docs/raw/reference/evals/prompt-alignment.mdx +9 -7
- package/.docs/raw/reference/evals/run-evals.mdx +3 -1
- package/.docs/raw/reference/evals/scorer-utils.mdx +3 -0
- package/.docs/raw/reference/evals/textual-difference.mdx +4 -1
- package/.docs/raw/reference/evals/tone-consistency.mdx +4 -1
- package/.docs/raw/reference/evals/tool-call-accuracy.mdx +25 -23
- package/.docs/raw/reference/evals/toxicity.mdx +4 -1
- package/.docs/raw/reference/index.mdx +2 -1
- package/.docs/raw/reference/logging/pino-logger.mdx +10 -8
- package/.docs/raw/reference/memory/clone-utilities.mdx +345 -0
- package/.docs/raw/reference/memory/cloneThread.mdx +237 -0
- package/.docs/raw/reference/memory/createThread.mdx +6 -4
- package/.docs/raw/reference/memory/deleteMessages.mdx +4 -2
- package/.docs/raw/reference/memory/getThreadById.mdx +3 -1
- package/.docs/raw/reference/memory/listThreads.mdx +187 -0
- package/.docs/raw/reference/memory/memory-class.mdx +27 -20
- package/.docs/raw/reference/memory/recall.mdx +6 -4
- package/.docs/raw/reference/observability/tracing/bridges/otel.mdx +6 -2
- package/.docs/raw/reference/observability/tracing/configuration.mdx +51 -0
- package/.docs/raw/reference/observability/tracing/exporters/arize.mdx +25 -6
- package/.docs/raw/reference/observability/tracing/exporters/braintrust.mdx +23 -2
- package/.docs/raw/reference/observability/tracing/exporters/cloud-exporter.mdx +10 -0
- package/.docs/raw/reference/observability/tracing/exporters/console-exporter.mdx +3 -0
- package/.docs/raw/reference/observability/tracing/exporters/datadog.mdx +172 -0
- package/.docs/raw/reference/observability/tracing/exporters/default-exporter.mdx +10 -0
- package/.docs/raw/reference/observability/tracing/exporters/laminar.mdx +139 -0
- package/.docs/raw/reference/observability/tracing/exporters/langfuse.mdx +26 -4
- package/.docs/raw/reference/observability/tracing/exporters/langsmith.mdx +10 -0
- package/.docs/raw/reference/observability/tracing/exporters/otel.mdx +51 -34
- package/.docs/raw/reference/observability/tracing/exporters/posthog.mdx +25 -4
- package/.docs/raw/reference/observability/tracing/exporters/sentry.mdx +224 -0
- package/.docs/raw/reference/observability/tracing/instances.mdx +2 -0
- package/.docs/raw/reference/observability/tracing/interfaces.mdx +20 -0
- package/.docs/raw/reference/observability/tracing/processors/sensitive-data-filter.mdx +2 -0
- package/.docs/raw/reference/observability/tracing/spans.mdx +2 -0
- package/.docs/raw/reference/processors/batch-parts-processor.mdx +4 -2
- package/.docs/raw/reference/processors/language-detector.mdx +6 -3
- package/.docs/raw/reference/processors/message-history-processor.mdx +5 -2
- package/.docs/raw/reference/processors/moderation-processor.mdx +6 -4
- package/.docs/raw/reference/processors/pii-detector.mdx +6 -4
- package/.docs/raw/reference/processors/processor-interface.mdx +326 -23
- package/.docs/raw/reference/processors/prompt-injection-detector.mdx +5 -3
- package/.docs/raw/reference/processors/semantic-recall-processor.mdx +7 -2
- package/.docs/raw/reference/processors/system-prompt-scrubber.mdx +5 -3
- package/.docs/raw/reference/processors/token-limiter-processor.mdx +62 -19
- package/.docs/raw/reference/processors/tool-call-filter.mdx +5 -3
- package/.docs/raw/reference/processors/unicode-normalizer.mdx +6 -3
- package/.docs/raw/reference/processors/working-memory-processor.mdx +6 -3
- package/.docs/raw/reference/rag/chunk.mdx +7 -6
- package/.docs/raw/reference/rag/database-config.mdx +8 -6
- package/.docs/raw/reference/rag/document.mdx +2 -0
- package/.docs/raw/reference/rag/embeddings.mdx +2 -0
- package/.docs/raw/reference/rag/extract-params.mdx +57 -3
- package/.docs/raw/reference/rag/graph-rag.mdx +2 -0
- package/.docs/raw/reference/rag/metadata-filters.mdx +27 -7
- package/.docs/raw/reference/rag/rerank.mdx +2 -0
- package/.docs/raw/reference/rag/rerankWithScorer.mdx +2 -0
- package/.docs/raw/reference/server/create-route.mdx +34 -18
- package/.docs/raw/reference/server/express-adapter.mdx +78 -50
- package/.docs/raw/reference/server/fastify-adapter.mdx +130 -0
- package/.docs/raw/reference/server/hono-adapter.mdx +78 -48
- package/.docs/raw/reference/server/koa-adapter.mdx +129 -0
- package/.docs/raw/reference/server/mastra-server.mdx +52 -34
- package/.docs/raw/reference/server/routes.mdx +73 -10
- package/.docs/raw/reference/storage/cloudflare-d1.mdx +10 -5
- package/.docs/raw/reference/storage/cloudflare.mdx +12 -2
- package/.docs/raw/reference/storage/composite.mdx +245 -0
- package/.docs/raw/reference/storage/convex.mdx +8 -6
- package/.docs/raw/reference/storage/dynamodb.mdx +134 -8
- package/.docs/raw/reference/storage/lance.mdx +9 -5
- package/.docs/raw/reference/storage/libsql.mdx +76 -54
- package/.docs/raw/reference/storage/mongodb.mdx +115 -16
- package/.docs/raw/reference/storage/mssql.mdx +11 -6
- package/.docs/raw/{server-db/storage.mdx → reference/storage/overview.mdx} +15 -111
- package/.docs/raw/reference/storage/postgresql.mdx +228 -83
- package/.docs/raw/reference/storage/upstash.mdx +78 -2
- package/.docs/raw/reference/streaming/ChunkType.mdx +31 -3
- package/.docs/raw/reference/streaming/agents/MastraModelOutput.mdx +67 -6
- package/.docs/raw/reference/streaming/agents/stream.mdx +48 -51
- package/.docs/raw/reference/streaming/agents/streamLegacy.mdx +5 -3
- package/.docs/raw/reference/streaming/workflows/observeStream.mdx +3 -1
- package/.docs/raw/reference/streaming/workflows/resumeStream.mdx +3 -1
- package/.docs/raw/reference/streaming/workflows/stream.mdx +37 -22
- package/.docs/raw/reference/streaming/workflows/timeTravelStream.mdx +6 -4
- package/.docs/raw/reference/templates/overview.mdx +3 -2
- package/.docs/raw/reference/tools/client.mdx +3 -0
- package/.docs/raw/reference/tools/create-tool.mdx +127 -5
- package/.docs/raw/reference/tools/document-chunker-tool.mdx +2 -0
- package/.docs/raw/reference/tools/graph-rag-tool.mdx +40 -3
- package/.docs/raw/reference/tools/mcp-client.mdx +110 -1
- package/.docs/raw/reference/tools/mcp-server.mdx +278 -24
- package/.docs/raw/reference/tools/vector-query-tool.mdx +68 -4
- package/.docs/raw/reference/vectors/astra.mdx +5 -3
- package/.docs/raw/reference/vectors/chroma.mdx +5 -3
- package/.docs/raw/reference/vectors/convex.mdx +14 -12
- package/.docs/raw/reference/vectors/couchbase.mdx +7 -5
- package/.docs/raw/reference/vectors/duckdb.mdx +12 -10
- package/.docs/raw/reference/vectors/elasticsearch.mdx +12 -4
- package/.docs/raw/reference/vectors/lance.mdx +6 -4
- package/.docs/raw/reference/vectors/libsql.mdx +66 -13
- package/.docs/raw/reference/vectors/mongodb.mdx +90 -10
- package/.docs/raw/reference/vectors/opensearch.mdx +30 -3
- package/.docs/raw/reference/vectors/pg.mdx +58 -6
- package/.docs/raw/reference/vectors/pinecone.mdx +23 -8
- package/.docs/raw/reference/vectors/qdrant.mdx +148 -4
- package/.docs/raw/reference/vectors/s3vectors.mdx +8 -6
- package/.docs/raw/reference/vectors/turbopuffer.mdx +6 -4
- package/.docs/raw/reference/vectors/upstash.mdx +60 -6
- package/.docs/raw/reference/vectors/vectorize.mdx +5 -3
- package/.docs/raw/reference/voice/azure.mdx +2 -0
- package/.docs/raw/reference/voice/cloudflare.mdx +2 -0
- package/.docs/raw/reference/voice/composite-voice.mdx +4 -0
- package/.docs/raw/reference/voice/deepgram.mdx +2 -0
- package/.docs/raw/reference/voice/elevenlabs.mdx +2 -0
- package/.docs/raw/reference/voice/google-gemini-live.mdx +3 -0
- package/.docs/raw/reference/voice/google.mdx +2 -0
- package/.docs/raw/reference/voice/mastra-voice.mdx +2 -0
- package/.docs/raw/reference/voice/murf.mdx +2 -0
- package/.docs/raw/reference/voice/openai-realtime.mdx +3 -0
- package/.docs/raw/reference/voice/openai.mdx +2 -0
- package/.docs/raw/reference/voice/playai.mdx +2 -0
- package/.docs/raw/reference/voice/sarvam.mdx +2 -0
- package/.docs/raw/reference/voice/speechify.mdx +2 -0
- package/.docs/raw/reference/voice/voice.addInstructions.mdx +3 -0
- package/.docs/raw/reference/voice/voice.addTools.mdx +3 -0
- package/.docs/raw/reference/voice/voice.answer.mdx +4 -0
- package/.docs/raw/reference/voice/voice.close.mdx +3 -0
- package/.docs/raw/reference/voice/voice.connect.mdx +5 -1
- package/.docs/raw/reference/voice/voice.events.mdx +2 -0
- package/.docs/raw/reference/voice/voice.getSpeakers.mdx +3 -0
- package/.docs/raw/reference/voice/voice.listen.mdx +6 -0
- package/.docs/raw/reference/voice/voice.off.mdx +2 -0
- package/.docs/raw/reference/voice/voice.on.mdx +5 -1
- package/.docs/raw/reference/voice/voice.send.mdx +4 -0
- package/.docs/raw/reference/voice/voice.speak.mdx +6 -0
- package/.docs/raw/reference/voice/voice.updateConfig.mdx +2 -0
- package/.docs/raw/reference/workflows/run-methods/cancel.mdx +55 -5
- package/.docs/raw/reference/workflows/run-methods/restart.mdx +3 -3
- package/.docs/raw/reference/workflows/run-methods/resume.mdx +6 -4
- package/.docs/raw/reference/workflows/run-methods/start.mdx +7 -5
- package/.docs/raw/reference/workflows/run-methods/startAsync.mdx +145 -0
- package/.docs/raw/reference/workflows/run-methods/timeTravel.mdx +10 -8
- package/.docs/raw/reference/workflows/run.mdx +11 -3
- package/.docs/raw/reference/workflows/step.mdx +56 -3
- package/.docs/raw/reference/workflows/workflow-methods/branch.mdx +3 -1
- package/.docs/raw/reference/workflows/workflow-methods/commit.mdx +3 -1
- package/.docs/raw/reference/workflows/workflow-methods/create-run.mdx +39 -2
- package/.docs/raw/reference/workflows/workflow-methods/dountil.mdx +3 -1
- package/.docs/raw/reference/workflows/workflow-methods/dowhile.mdx +3 -1
- package/.docs/raw/reference/workflows/workflow-methods/foreach.mdx +71 -4
- package/.docs/raw/reference/workflows/workflow-methods/map.mdx +9 -7
- package/.docs/raw/reference/workflows/workflow-methods/parallel.mdx +3 -1
- package/.docs/raw/reference/workflows/workflow-methods/sleep.mdx +4 -6
- package/.docs/raw/reference/workflows/workflow-methods/sleepUntil.mdx +4 -6
- package/.docs/raw/reference/workflows/workflow-methods/then.mdx +3 -1
- package/.docs/raw/reference/workflows/workflow.mdx +193 -2
- package/.docs/raw/{auth → server/auth}/auth0.mdx +40 -21
- package/.docs/raw/{auth → server/auth}/clerk.mdx +37 -16
- package/.docs/raw/{auth → server/auth}/firebase.mdx +47 -25
- package/.docs/raw/{auth → server/auth}/index.mdx +8 -6
- package/.docs/raw/{auth → server/auth}/jwt.mdx +22 -10
- package/.docs/raw/{auth → server/auth}/supabase.mdx +45 -25
- package/.docs/raw/{auth → server/auth}/workos.mdx +39 -20
- package/.docs/raw/{server-db → server}/custom-adapters.mdx +40 -24
- package/.docs/raw/{server-db → server}/custom-api-routes.mdx +6 -6
- package/.docs/raw/{server-db → server}/mastra-client.mdx +35 -38
- package/.docs/raw/server/mastra-server.mdx +86 -0
- package/.docs/raw/{server-db → server}/middleware.mdx +11 -9
- package/.docs/raw/{server-db → server}/request-context.mdx +85 -43
- package/.docs/raw/server/server-adapters.mdx +410 -0
- package/.docs/raw/streaming/events.mdx +16 -7
- package/.docs/raw/streaming/overview.mdx +30 -17
- package/.docs/raw/streaming/tool-streaming.mdx +15 -17
- package/.docs/raw/streaming/workflow-streaming.mdx +8 -8
- package/.docs/raw/tools-mcp/advanced-usage.mdx +4 -2
- package/.docs/raw/tools-mcp/mcp-overview.mdx +46 -12
- package/.docs/raw/tools-mcp/overview.mdx +14 -13
- package/.docs/raw/voice/overview.mdx +17 -2
- package/.docs/raw/voice/speech-to-speech.mdx +5 -0
- package/.docs/raw/voice/speech-to-text.mdx +4 -0
- package/.docs/raw/voice/text-to-speech.mdx +3 -0
- package/.docs/raw/workflows/agents-and-tools.mdx +70 -21
- package/.docs/raw/workflows/control-flow.mdx +369 -34
- package/.docs/raw/workflows/error-handling.mdx +192 -18
- package/.docs/raw/workflows/human-in-the-loop.mdx +8 -7
- package/.docs/raw/workflows/input-data-mapping.mdx +9 -7
- package/.docs/raw/workflows/overview.mdx +80 -34
- package/.docs/raw/workflows/snapshots.mdx +19 -45
- package/.docs/raw/workflows/suspend-and-resume.mdx +14 -14
- package/.docs/raw/workflows/time-travel.mdx +25 -21
- package/.docs/raw/workflows/workflow-state.mdx +7 -8
- package/CHANGELOG.md +254 -0
- package/README.md +36 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/logger.d.ts +3 -0
- package/dist/logger.d.ts.map +1 -1
- package/dist/stdio.js +746 -49
- package/dist/tools/course.d.ts.map +1 -1
- package/dist/tools/embedded-docs.d.ts +276 -0
- package/dist/tools/embedded-docs.d.ts.map +1 -0
- package/package.json +9 -8
- package/.docs/organized/changelogs/%40internal%2Fai-sdk-v4.md +0 -1
- package/.docs/raw/deployment/building-mastra.mdx +0 -73
- package/.docs/raw/deployment/cloud-providers/index.mdx +0 -55
- package/.docs/raw/deployment/mastra-cloud/dashboard.mdx +0 -100
- package/.docs/raw/deployment/mastra-cloud/observability.mdx +0 -53
- package/.docs/raw/deployment/mastra-cloud/overview.mdx +0 -65
- package/.docs/raw/deployment/mastra-cloud/setting-up.mdx +0 -105
- package/.docs/raw/memory/conversation-history.mdx +0 -24
- package/.docs/raw/memory/storage/memory-with-libsql.mdx +0 -140
- package/.docs/raw/memory/storage/memory-with-mongodb.mdx +0 -150
- package/.docs/raw/memory/storage/memory-with-pg.mdx +0 -138
- package/.docs/raw/memory/storage/memory-with-upstash.mdx +0 -146
- package/.docs/raw/memory/threads-and-resources.mdx +0 -95
- package/.docs/raw/reference/core/setTelemetry.mdx +0 -36
- package/.docs/raw/reference/memory/listThreadsByResourceId.mdx +0 -110
- package/.docs/raw/reference/memory/query.mdx +0 -189
- package/.docs/raw/reference/workflows/workflow-methods/sendEvent.mdx +0 -70
- package/.docs/raw/reference/workflows/workflow-methods/waitForEvent.mdx +0 -66
- package/.docs/raw/server-db/mastra-server.mdx +0 -97
- package/.docs/raw/server-db/server-adapters.mdx +0 -286
- package/.docs/raw/workflows/inngest-workflow.mdx +0 -363
|
@@ -44,7 +44,7 @@ project-root
|
|
|
44
44
|
|
|
45
45
|
Bootstrap your Mastra server:
|
|
46
46
|
|
|
47
|
-
```bash
|
|
47
|
+
```bash
|
|
48
48
|
npx create-mastra@beta
|
|
49
49
|
```
|
|
50
50
|
|
|
@@ -52,7 +52,7 @@ This command will launch an interactive wizard to help you scaffold a new Mastra
|
|
|
52
52
|
|
|
53
53
|
Navigate to your newly created Mastra server directory:
|
|
54
54
|
|
|
55
|
-
```bash
|
|
55
|
+
```bash
|
|
56
56
|
cd mastra-server # Replace with the actual directory name you provided
|
|
57
57
|
```
|
|
58
58
|
|
|
@@ -84,13 +84,13 @@ Ensure that you have set the appropriate environment variables for your LLM prov
|
|
|
84
84
|
|
|
85
85
|
Create a chat route for the Assistant UI frontend by using the `chatRoute()` helper from `@mastra/ai-sdk`. Add it to your Mastra project:
|
|
86
86
|
|
|
87
|
-
```bash
|
|
87
|
+
```bash
|
|
88
88
|
npm install @mastra/ai-sdk@beta
|
|
89
89
|
```
|
|
90
90
|
|
|
91
91
|
In your `src/mastra/index.ts` file, register the chat route:
|
|
92
92
|
|
|
93
|
-
```typescript
|
|
93
|
+
```typescript title="src/mastra/index.ts" {2,7-13}
|
|
94
94
|
import { Mastra } from '@mastra/core/mastra';
|
|
95
95
|
import { chatRoute } from '@mastra/ai-sdk';
|
|
96
96
|
// Rest of the imports...
|
|
@@ -115,7 +115,7 @@ This will make all agents available in AI SDK-compatible formats, including the
|
|
|
115
115
|
|
|
116
116
|
Run the Mastra server using the following command:
|
|
117
117
|
|
|
118
|
-
```bash
|
|
118
|
+
```bash
|
|
119
119
|
npm run dev
|
|
120
120
|
```
|
|
121
121
|
|
|
@@ -127,13 +127,13 @@ By default, the Mastra server will run on `http://localhost:4111`. Keep this ser
|
|
|
127
127
|
|
|
128
128
|
Go up one directory to your project root.
|
|
129
129
|
|
|
130
|
-
```bash
|
|
130
|
+
```bash
|
|
131
131
|
cd ..
|
|
132
132
|
```
|
|
133
133
|
|
|
134
134
|
Create a new `assistant-ui` project with the following command.
|
|
135
135
|
|
|
136
|
-
```bash
|
|
136
|
+
```bash
|
|
137
137
|
npx assistant-ui@latest create
|
|
138
138
|
```
|
|
139
139
|
|
|
@@ -175,7 +175,7 @@ Now, the Assistant UI frontend will send chat requests directly to your running
|
|
|
175
175
|
|
|
176
176
|
You're ready to connect the pieces! Make sure both the Mastra server and the Assistant UI frontend are running. Start the Next.js development server:
|
|
177
177
|
|
|
178
|
-
```bash
|
|
178
|
+
```bash
|
|
179
179
|
npm run dev
|
|
180
180
|
```
|
|
181
181
|
|
|
@@ -48,7 +48,7 @@ project-root
|
|
|
48
48
|
|
|
49
49
|
Bootstrap your Mastra server:
|
|
50
50
|
|
|
51
|
-
```bash
|
|
51
|
+
```bash
|
|
52
52
|
npx create-mastra@latest
|
|
53
53
|
```
|
|
54
54
|
|
|
@@ -56,7 +56,7 @@ This command will launch an interactive wizard to help you scaffold a new Mastra
|
|
|
56
56
|
|
|
57
57
|
Navigate to your newly created Mastra server directory:
|
|
58
58
|
|
|
59
|
-
```bash
|
|
59
|
+
```bash
|
|
60
60
|
cd mastra-server # Replace with the actual directory name you provided
|
|
61
61
|
```
|
|
62
62
|
|
|
@@ -88,13 +88,13 @@ Ensure that you have set the appropriate environment variables for your LLM prov
|
|
|
88
88
|
|
|
89
89
|
Create a chat route for the CopilotKit frontend by using the `registerCopilotKit()` helper from `@ag-ui/mastra`. Add it to your Mastra project (and its peer dependencies):
|
|
90
90
|
|
|
91
|
-
```bash
|
|
91
|
+
```bash
|
|
92
92
|
npm install --legacy-peer-deps @ag-ui/mastra @copilotkit/runtime @ag-ui/core @ag-ui/client @ag-ui/encoder @ag-ui/langgraph @ag-ui/proto
|
|
93
93
|
```
|
|
94
94
|
|
|
95
95
|
In your `src/mastra/index.ts` file, register the chat route:
|
|
96
96
|
|
|
97
|
-
```typescript
|
|
97
|
+
```typescript title="src/mastra/index.ts" {2,7-19}
|
|
98
98
|
import { Mastra } from '@mastra/core/mastra';
|
|
99
99
|
import { registerCopilotKit } from '@ag-ui/mastra/copilotkit';
|
|
100
100
|
// Rest of the imports...
|
|
@@ -125,7 +125,7 @@ This will make the `weatherAgent` available at `/chat` in a CopilotKit-compatibl
|
|
|
125
125
|
|
|
126
126
|
Run the Mastra server using the following command:
|
|
127
127
|
|
|
128
|
-
```bash
|
|
128
|
+
```bash
|
|
129
129
|
npm run dev
|
|
130
130
|
```
|
|
131
131
|
|
|
@@ -137,19 +137,19 @@ By default, the Mastra server will run on `http://localhost:4111`. Keep this ser
|
|
|
137
137
|
|
|
138
138
|
Go up one directory to your project root.
|
|
139
139
|
|
|
140
|
-
```bash
|
|
140
|
+
```bash
|
|
141
141
|
cd ..
|
|
142
142
|
```
|
|
143
143
|
|
|
144
144
|
Create a new Next.js project with the name `my-copilot-app`:
|
|
145
145
|
|
|
146
|
-
```bash
|
|
146
|
+
```bash
|
|
147
147
|
npx create-next-app@latest my-copilot-app
|
|
148
148
|
```
|
|
149
149
|
|
|
150
150
|
Navigate to your newly created Next.js project directory:
|
|
151
151
|
|
|
152
|
-
```bash
|
|
152
|
+
```bash
|
|
153
153
|
cd my-copilot-app
|
|
154
154
|
```
|
|
155
155
|
|
|
@@ -159,13 +159,13 @@ cd my-copilot-app
|
|
|
159
159
|
|
|
160
160
|
Install the CopilotKit UI packages which you'll use to display a chat interface:
|
|
161
161
|
|
|
162
|
-
```bash
|
|
162
|
+
```bash
|
|
163
163
|
npm install @copilotkit/react-ui @copilotkit/react-core
|
|
164
164
|
```
|
|
165
165
|
|
|
166
166
|
Open the home route of the Next.js app (usually `app/page.tsx` or `src/app/page.tsx`) and replace the existing contents with the following code to set up a basic CopilotKit chat interface:
|
|
167
167
|
|
|
168
|
-
```typescript
|
|
168
|
+
```typescript title="app/page.tsx"
|
|
169
169
|
import { CopilotChat } from "@copilotkit/react-ui";
|
|
170
170
|
import { CopilotKit } from "@copilotkit/react-core";
|
|
171
171
|
import "@copilotkit/react-ui/styles.css";
|
|
@@ -193,7 +193,7 @@ export default function Home() {
|
|
|
193
193
|
|
|
194
194
|
You're ready to connect the pieces! Make sure both the Mastra server and the CopilotKit frontend are running. Start the Next.js development server:
|
|
195
195
|
|
|
196
|
-
```bash
|
|
196
|
+
```bash
|
|
197
197
|
npm run dev
|
|
198
198
|
```
|
|
199
199
|
|
|
@@ -204,3 +204,24 @@ You should now be able to chat with your agent in the browser.
|
|
|
204
204
|
</Steps>
|
|
205
205
|
|
|
206
206
|
Congratulations! You have successfully integrated Mastra with CopilotKit using a separate server approach. Your CopilotKit frontend now communicates with a standalone Mastra agent server.
|
|
207
|
+
|
|
208
|
+
## Deployment
|
|
209
|
+
|
|
210
|
+
When deploying your Mastra server with CopilotKit, you must exclude `@copilotkit/runtime` from the bundle. This package contains dependencies that are not compatible with bundling and will cause 500 errors if included.
|
|
211
|
+
|
|
212
|
+
:::note
|
|
213
|
+
|
|
214
|
+
This issue doesn't occur during development with `mastra dev` since it doesn't require bundling. However, anyone running `mastra build` for deployment will encounter this issue.
|
|
215
|
+
|
|
216
|
+
:::
|
|
217
|
+
|
|
218
|
+
Add the `@copilotkit/runtime` package to your bundler externals configuration:
|
|
219
|
+
|
|
220
|
+
```typescript title="src/mastra/index.ts"
|
|
221
|
+
export const mastra = new Mastra({
|
|
222
|
+
bundler: {
|
|
223
|
+
externals: ['@copilotkit/runtime'],
|
|
224
|
+
},
|
|
225
|
+
// Rest of the configuration...
|
|
226
|
+
});
|
|
227
|
+
```
|
|
@@ -39,7 +39,7 @@ Connect to your EC2 instance and clone your repository:
|
|
|
39
39
|
<Tabs>
|
|
40
40
|
<TabItem value="public" label="Public Repository">
|
|
41
41
|
|
|
42
|
-
```bash
|
|
42
|
+
```bash
|
|
43
43
|
git clone https://github.com/<your-username>/<your-repository>.git
|
|
44
44
|
```
|
|
45
45
|
|
|
@@ -47,7 +47,7 @@ git clone https://github.com/<your-username>/<your-repository>.git
|
|
|
47
47
|
|
|
48
48
|
<TabItem value="private" label="Private Repository">
|
|
49
49
|
|
|
50
|
-
```bash
|
|
50
|
+
```bash
|
|
51
51
|
git clone https://<your-username>:<your-personal-access-token>@github.com/<your-username>/<your-repository>.git
|
|
52
52
|
```
|
|
53
53
|
|
|
@@ -56,7 +56,7 @@ git clone https://<your-username>:<your-personal-access-token>@github.com/<your-
|
|
|
56
56
|
|
|
57
57
|
Navigate to the repository directory:
|
|
58
58
|
|
|
59
|
-
```bash
|
|
59
|
+
```bash
|
|
60
60
|
cd "<your-repository>"
|
|
61
61
|
```
|
|
62
62
|
|
|
@@ -66,7 +66,7 @@ cd "<your-repository>"
|
|
|
66
66
|
|
|
67
67
|
Install dependencies:
|
|
68
68
|
|
|
69
|
-
```bash
|
|
69
|
+
```bash
|
|
70
70
|
npm install
|
|
71
71
|
```
|
|
72
72
|
|
|
@@ -76,13 +76,13 @@ npm install
|
|
|
76
76
|
|
|
77
77
|
Create a `.env` file and add your environment variables:
|
|
78
78
|
|
|
79
|
-
```bash
|
|
79
|
+
```bash
|
|
80
80
|
touch .env
|
|
81
81
|
```
|
|
82
82
|
|
|
83
83
|
Edit the `.env` file and add your environment variables:
|
|
84
84
|
|
|
85
|
-
```bash
|
|
85
|
+
```bash
|
|
86
86
|
OPENAI_API_KEY=<your-openai-api-key>
|
|
87
87
|
# Add other required environment variables
|
|
88
88
|
```
|
|
@@ -93,7 +93,7 @@ OPENAI_API_KEY=<your-openai-api-key>
|
|
|
93
93
|
|
|
94
94
|
Build the application:
|
|
95
95
|
|
|
96
|
-
```bash
|
|
96
|
+
```bash
|
|
97
97
|
npm run build
|
|
98
98
|
```
|
|
99
99
|
|
|
@@ -103,7 +103,7 @@ npm run build
|
|
|
103
103
|
|
|
104
104
|
Run the application:
|
|
105
105
|
|
|
106
|
-
```bash
|
|
106
|
+
```bash
|
|
107
107
|
node --env-file=".env" .mastra/output/index.mjs
|
|
108
108
|
```
|
|
109
109
|
|
|
@@ -121,7 +121,7 @@ You can now connect to your Mastra server from your client application using a `
|
|
|
121
121
|
|
|
122
122
|
Refer to the [`MastraClient` documentation](/reference/v1/client-js/mastra-client) for more information.
|
|
123
123
|
|
|
124
|
-
```typescript
|
|
124
|
+
```typescript
|
|
125
125
|
import { MastraClient } from "@mastra/client-js";
|
|
126
126
|
|
|
127
127
|
const mastraClient = new MastraClient({
|
|
@@ -29,18 +29,15 @@ Before deploying to AWS Lambda, ensure you have:
|
|
|
29
29
|
|
|
30
30
|
## Memory Configuration
|
|
31
31
|
|
|
32
|
-
:::
|
|
33
|
-
AWS Lambda uses an ephemeral file system,
|
|
34
|
-
meaning that any files written to the file system are short-lived and may be lost.
|
|
35
|
-
Avoid using a Mastra storage provider that uses the file system,
|
|
36
|
-
such as `LibSQLStore` with a file URL.
|
|
32
|
+
:::warning
|
|
33
|
+
AWS Lambda uses an ephemeral file system, meaning that any files written to the file system are short-lived and may be lost. Remove any usage of [LibSQLStore](/reference/v1/storage/libsql) with file URLs from your Mastra configuration. Use in-memory storage (`:memory:`) or external storage providers like Turso, PostgreSQL, or Upstash.
|
|
37
34
|
:::
|
|
38
35
|
|
|
39
36
|
Lambda functions have limitations with file system storage. Configure your Mastra application to use either in-memory or external storage providers:
|
|
40
37
|
|
|
41
38
|
### Option 1: In-Memory (Simplest)
|
|
42
39
|
|
|
43
|
-
```typescript title="src/mastra/index.ts"
|
|
40
|
+
```typescript title="src/mastra/index.ts"
|
|
44
41
|
import { LibSQLStore } from "@mastra/libsql";
|
|
45
42
|
|
|
46
43
|
const storage = new LibSQLStore({
|
|
@@ -53,7 +50,7 @@ const storage = new LibSQLStore({
|
|
|
53
50
|
|
|
54
51
|
For persistent memory across Lambda invocations, use external storage providers like `LibSQLStore` with Turso or other storage providers like `PostgreStore`:
|
|
55
52
|
|
|
56
|
-
```typescript title="src/mastra/index.ts"
|
|
53
|
+
```typescript title="src/mastra/index.ts"
|
|
57
54
|
import { LibSQLStore } from "@mastra/libsql";
|
|
58
55
|
|
|
59
56
|
const storage = new LibSQLStore({
|
|
@@ -69,7 +66,7 @@ For more memory configuration options, see the [Memory documentation](/docs/v1/m
|
|
|
69
66
|
|
|
70
67
|
Create a `Dockerfile` in your Mastra project root directory:
|
|
71
68
|
|
|
72
|
-
```dockerfile title="Dockerfile"
|
|
69
|
+
```dockerfile title="Dockerfile"
|
|
73
70
|
FROM node:22-alpine
|
|
74
71
|
|
|
75
72
|
WORKDIR /app
|
|
@@ -103,7 +100,7 @@ CMD ["node", ".mastra/output/index.mjs"]
|
|
|
103
100
|
|
|
104
101
|
Set up your environment variables for the deployment process:
|
|
105
102
|
|
|
106
|
-
```bash
|
|
103
|
+
```bash
|
|
107
104
|
export PROJECT_NAME="your-mastra-app"
|
|
108
105
|
export AWS_REGION="us-east-1"
|
|
109
106
|
export AWS_ACCOUNT_ID=$(aws sts get-caller-identity --query Account --output text)
|
|
@@ -115,7 +112,7 @@ export AWS_ACCOUNT_ID=$(aws sts get-caller-identity --query Account --output tex
|
|
|
115
112
|
|
|
116
113
|
Build your Docker image locally:
|
|
117
114
|
|
|
118
|
-
```bash
|
|
115
|
+
```bash
|
|
119
116
|
docker build -t "$PROJECT_NAME" .
|
|
120
117
|
```
|
|
121
118
|
|
|
@@ -125,7 +122,7 @@ docker build -t "$PROJECT_NAME" .
|
|
|
125
122
|
|
|
126
123
|
Create an Amazon ECR repository to store your Docker image:
|
|
127
124
|
|
|
128
|
-
```bash
|
|
125
|
+
```bash
|
|
129
126
|
aws ecr create-repository --repository-name "$PROJECT_NAME" --region "$AWS_REGION"
|
|
130
127
|
```
|
|
131
128
|
|
|
@@ -135,7 +132,7 @@ aws ecr create-repository --repository-name "$PROJECT_NAME" --region "$AWS_REGIO
|
|
|
135
132
|
|
|
136
133
|
Log in to Amazon ECR:
|
|
137
134
|
|
|
138
|
-
```bash
|
|
135
|
+
```bash
|
|
139
136
|
aws ecr get-login-password --region "$AWS_REGION" | docker login --username AWS --password-stdin "$AWS_ACCOUNT_ID.dkr.ecr.$AWS_REGION.amazonaws.com"
|
|
140
137
|
```
|
|
141
138
|
|
|
@@ -145,7 +142,7 @@ aws ecr get-login-password --region "$AWS_REGION" | docker login --username AWS
|
|
|
145
142
|
|
|
146
143
|
Tag your image with the ECR repository URI and push it:
|
|
147
144
|
|
|
148
|
-
```bash
|
|
145
|
+
```bash
|
|
149
146
|
docker tag "$PROJECT_NAME":latest "$AWS_ACCOUNT_ID.dkr.ecr.$AWS_REGION.amazonaws.com/$PROJECT_NAME":latest
|
|
150
147
|
docker push "$AWS_ACCOUNT_ID.dkr.ecr.$AWS_REGION.amazonaws.com/$PROJECT_NAME":latest
|
|
151
148
|
```
|
|
@@ -189,7 +186,7 @@ Add your environment variables in the Lambda function configuration:
|
|
|
189
186
|
2. Add the required variables for your Mastra application:
|
|
190
187
|
- `OPENAI_API_KEY`: Your OpenAI API key (if using OpenAI)
|
|
191
188
|
- `ANTHROPIC_API_KEY`: Your Anthropic API key (if using Anthropic)
|
|
192
|
-
- `TURSO_AUTH_TOKEN`: Your Turso auth token (if using
|
|
189
|
+
- `TURSO_AUTH_TOKEN`: Your Turso auth token (if using libSQL with Turso)
|
|
193
190
|
- Other provider-specific API keys as needed
|
|
194
191
|
|
|
195
192
|
</StepItem>
|
|
@@ -216,13 +213,13 @@ Once deployed, test your Lambda function:
|
|
|
216
213
|
2. Visit the URL in your browser to see your Mastra's server home screen
|
|
217
214
|
3. Test your agents and workflows using the generated API endpoints
|
|
218
215
|
|
|
219
|
-
For more information about available API endpoints, see the [Server documentation](/docs/v1/deployment/
|
|
216
|
+
For more information about available API endpoints, see the [Server documentation](/docs/v1/deployment/mastra-server).
|
|
220
217
|
|
|
221
218
|
## Connecting your client
|
|
222
219
|
|
|
223
220
|
Update your client application to use the Lambda function URL:
|
|
224
221
|
|
|
225
|
-
```typescript title="src/client.ts"
|
|
222
|
+
```typescript title="src/client.ts"
|
|
226
223
|
import { MastraClient } from "@mastra/client-js";
|
|
227
224
|
|
|
228
225
|
const mastraClient = new MastraClient({
|
|
@@ -17,6 +17,10 @@ For more information on how to create a new Mastra application,
|
|
|
17
17
|
refer to our [getting started guide](/guides/v1/getting-started/quickstart)
|
|
18
18
|
:::
|
|
19
19
|
|
|
20
|
+
:::warning
|
|
21
|
+
Azure App Services uses an ephemeral filesystem for some pricing tiers. Remove any usage of [LibSQLStore](/reference/v1/storage/libsql) with file URLs from your Mastra configuration. Use in-memory storage (`:memory:`) or external storage providers like Turso, PostgreSQL, or Upstash.
|
|
22
|
+
:::
|
|
23
|
+
|
|
20
24
|
## Prerequisites
|
|
21
25
|
|
|
22
26
|
- An [Azure account](https://azure.microsoft.com/) with an active subscription
|
|
@@ -143,7 +147,7 @@ You can now connect to your Mastra server from your client application using a `
|
|
|
143
147
|
|
|
144
148
|
Refer to the [`MastraClient` documentation](/reference/v1/client-js/mastra-client) for more information.
|
|
145
149
|
|
|
146
|
-
```typescript
|
|
150
|
+
```typescript
|
|
147
151
|
import { MastraClient } from "@mastra/client-js";
|
|
148
152
|
|
|
149
153
|
const mastraClient = new MastraClient({
|
|
@@ -151,12 +155,6 @@ const mastraClient = new MastraClient({
|
|
|
151
155
|
});
|
|
152
156
|
```
|
|
153
157
|
|
|
154
|
-
:::note
|
|
155
|
-
Azure App Services uses an ephemeral file system for some pricing tiers.
|
|
156
|
-
For production applications, avoid using Mastra storage providers that rely on the local file system,
|
|
157
|
-
such as `LibSQLStore` with a file URL. Consider using cloud-based storage solutions instead.
|
|
158
|
-
:::
|
|
159
|
-
|
|
160
158
|
## Next steps
|
|
161
159
|
|
|
162
160
|
- [Mastra Client SDK](/reference/v1/client-js/mastra-client)
|
|
@@ -7,20 +7,23 @@ description: "Learn how to deploy a Mastra application to Cloudflare using the M
|
|
|
7
7
|
|
|
8
8
|
The `CloudflareDeployer` class handles deployment of standalone Mastra applications to Cloudflare Workers. It manages configuration, deployment, and extends the base [Deployer](/reference/v1/deployer/) class with Cloudflare specific functionality.
|
|
9
9
|
|
|
10
|
+
:::warning
|
|
11
|
+
Cloudflare Workers do not support filesystem access. Remove any usage of [LibSQLStore](/reference/v1/storage/libsql) with file URLs from your Mastra configuration. Use in-memory storage (`:memory:`) or external storage providers like Turso, PostgreSQL, or Upstash.
|
|
12
|
+
:::
|
|
13
|
+
|
|
10
14
|
## Installation
|
|
11
15
|
|
|
12
|
-
```bash
|
|
16
|
+
```bash
|
|
13
17
|
npm install @mastra/deployer-cloudflare@beta
|
|
14
18
|
```
|
|
15
19
|
|
|
16
20
|
## Usage example
|
|
17
21
|
|
|
18
|
-
```typescript title="src/mastra/index.ts"
|
|
22
|
+
```typescript title="src/mastra/index.ts"
|
|
19
23
|
import { Mastra } from "@mastra/core";
|
|
20
24
|
import { CloudflareDeployer } from "@mastra/deployer-cloudflare";
|
|
21
25
|
|
|
22
26
|
export const mastra = new Mastra({
|
|
23
|
-
// ...
|
|
24
27
|
deployer: new CloudflareDeployer({
|
|
25
28
|
projectName: "hello-mastra",
|
|
26
29
|
env: {
|
|
@@ -38,13 +41,13 @@ Manual deployments are also possible using the [Cloudflare Wrangler CLI](https:/
|
|
|
38
41
|
|
|
39
42
|
With the Wrangler CLI installed, login and authenticate with your Cloudflare logins:
|
|
40
43
|
|
|
41
|
-
```bash
|
|
44
|
+
```bash
|
|
42
45
|
npx wrangler login
|
|
43
46
|
```
|
|
44
47
|
|
|
45
48
|
Run the following to build and deploy your application to Cloudflare
|
|
46
49
|
|
|
47
|
-
```bash
|
|
50
|
+
```bash
|
|
48
51
|
npm run build && wrangler deploy --config .mastra/output/wrangler.json
|
|
49
52
|
```
|
|
50
53
|
|
|
@@ -19,18 +19,18 @@ For more information on how to create a new Mastra application,
|
|
|
19
19
|
refer to our [getting started guide](/guides/v1/getting-started/quickstart)
|
|
20
20
|
:::
|
|
21
21
|
|
|
22
|
+
## Instructions
|
|
23
|
+
|
|
22
24
|
<Tabs>
|
|
23
25
|
|
|
24
26
|
<TabItem value="app-platform" label="App Platform">
|
|
25
27
|
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
### Prerequisites
|
|
28
|
+
<h3>Prerequisites</h3>
|
|
29
29
|
|
|
30
30
|
- A Git repository containing your Mastra application. This can be a [GitHub](https://github.com/) repository, [GitLab](https://gitlab.com/) repository, or any other compatible source provider.
|
|
31
31
|
- A [Digital Ocean account](https://www.digitalocean.com/)
|
|
32
32
|
|
|
33
|
-
|
|
33
|
+
<h3>Deployment Steps</h3>
|
|
34
34
|
|
|
35
35
|
<Steps>
|
|
36
36
|
|
|
@@ -97,22 +97,17 @@ Deployment
|
|
|
97
97
|
|
|
98
98
|
You can now access your deployed application at the URL provided by Digital Ocean.
|
|
99
99
|
|
|
100
|
-
:::
|
|
101
|
-
The Digital Ocean App Platform uses an ephemeral file system,
|
|
102
|
-
meaning that any files written to the file system are short-lived and may be lost.
|
|
103
|
-
Avoid using a Mastra storage provider that uses the file system,
|
|
104
|
-
such as `LibSQLStore` with a file URL.
|
|
100
|
+
:::warning
|
|
101
|
+
The Digital Ocean App Platform uses an ephemeral file system, meaning that any files written to the file system are short-lived and may be lost. Remove any usage of [LibSQLStore](/reference/v1/storage/libsql) with file URLs from your Mastra configuration. Use in-memory storage (`:memory:`) or external storage providers like Turso, PostgreSQL, or Upstash.
|
|
105
102
|
:::
|
|
106
103
|
|
|
107
104
|
</TabItem>
|
|
108
105
|
|
|
109
106
|
<TabItem value="droplets" label="Droplets">
|
|
110
107
|
|
|
111
|
-
## Droplets
|
|
112
|
-
|
|
113
108
|
Deploy your Mastra application to Digital Ocean's Droplets.
|
|
114
109
|
|
|
115
|
-
|
|
110
|
+
<h3>Prerequisites</h3>
|
|
116
111
|
|
|
117
112
|
- A [Digital Ocean account](https://www.digitalocean.com/)
|
|
118
113
|
- A [Droplet](https://docs.digitalocean.com/products/droplets/) running Ubuntu 24+
|
|
@@ -121,7 +116,7 @@ Deploy your Mastra application to Digital Ocean's Droplets.
|
|
|
121
116
|
- SSL certificate configured (e.g., using [Let's Encrypt](https://letsencrypt.org/))
|
|
122
117
|
- Node.js 22.13.0 or later installed on your droplet
|
|
123
118
|
|
|
124
|
-
|
|
119
|
+
<h3>Deployment Steps</h3>
|
|
125
120
|
|
|
126
121
|
<Steps>
|
|
127
122
|
|
|
@@ -134,7 +129,7 @@ Connect to your Droplet and clone your repository:
|
|
|
134
129
|
<Tabs>
|
|
135
130
|
<TabItem value="public" label="Public Repository">
|
|
136
131
|
|
|
137
|
-
```bash
|
|
132
|
+
```bash
|
|
138
133
|
git clone https://github.com/<your-username>/<your-repository>.git
|
|
139
134
|
```
|
|
140
135
|
|
|
@@ -142,7 +137,7 @@ git clone https://github.com/<your-username>/<your-repository>.git
|
|
|
142
137
|
|
|
143
138
|
<TabItem value="private" label="Private Repository">
|
|
144
139
|
|
|
145
|
-
```bash
|
|
140
|
+
```bash
|
|
146
141
|
git clone https://<your-username>:<your-personal-access-token>@github.com/<your-username>/<your-repository>.git
|
|
147
142
|
```
|
|
148
143
|
|
|
@@ -151,7 +146,7 @@ git clone https://<your-username>:<your-personal-access-token>@github.com/<your-
|
|
|
151
146
|
|
|
152
147
|
Navigate to the repository directory:
|
|
153
148
|
|
|
154
|
-
```bash
|
|
149
|
+
```bash
|
|
155
150
|
cd "<your-repository>"
|
|
156
151
|
```
|
|
157
152
|
|
|
@@ -161,7 +156,7 @@ cd "<your-repository>"
|
|
|
161
156
|
|
|
162
157
|
Install dependencies
|
|
163
158
|
|
|
164
|
-
```bash
|
|
159
|
+
```bash
|
|
165
160
|
npm install
|
|
166
161
|
```
|
|
167
162
|
|
|
@@ -173,13 +168,13 @@ Set up environment variables
|
|
|
173
168
|
|
|
174
169
|
Create a `.env` file and add your environment variables:
|
|
175
170
|
|
|
176
|
-
```bash
|
|
171
|
+
```bash
|
|
177
172
|
touch .env
|
|
178
173
|
```
|
|
179
174
|
|
|
180
175
|
Edit the `.env` file and add your environment variables:
|
|
181
176
|
|
|
182
|
-
```bash
|
|
177
|
+
```bash
|
|
183
178
|
OPENAI_API_KEY=<your-openai-api-key>
|
|
184
179
|
# Add other required environment variables
|
|
185
180
|
```
|
|
@@ -190,7 +185,7 @@ OPENAI_API_KEY=<your-openai-api-key>
|
|
|
190
185
|
|
|
191
186
|
Build the application
|
|
192
187
|
|
|
193
|
-
```bash
|
|
188
|
+
```bash
|
|
194
189
|
npm run build
|
|
195
190
|
```
|
|
196
191
|
|
|
@@ -200,7 +195,7 @@ npm run build
|
|
|
200
195
|
|
|
201
196
|
Run the application
|
|
202
197
|
|
|
203
|
-
```bash
|
|
198
|
+
```bash
|
|
204
199
|
node --env-file=".env" .mastra/output/index.mjs
|
|
205
200
|
```
|
|
206
201
|
|
|
@@ -220,9 +215,9 @@ Your Mastra application will run on port 4111 by default. Ensure your reverse pr
|
|
|
220
215
|
|
|
221
216
|
You can now connect to your Mastra server from your client application using a `MastraClient` from the `@mastra/client-js` package.
|
|
222
217
|
|
|
223
|
-
Refer to the [`MastraClient` documentation](/docs/v1/server
|
|
218
|
+
Refer to the [`MastraClient` documentation](/docs/v1/server/mastra-client) for more information.
|
|
224
219
|
|
|
225
|
-
```typescript
|
|
220
|
+
```typescript
|
|
226
221
|
import { MastraClient } from "@mastra/client-js";
|
|
227
222
|
|
|
228
223
|
const mastraClient = new MastraClient({
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Cloud Providers | Deployment"
|
|
3
|
+
description: "Deploy your Mastra applications to popular cloud providers."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Cloud Providers
|
|
7
|
+
|
|
8
|
+
Standalone Mastra applications can be deployed to popular cloud providers, see one of the following guides for more information:
|
|
9
|
+
|
|
10
|
+
- [Amazon EC2](/guides/v1/deployment/amazon-ec2)
|
|
11
|
+
- [AWS Lambda](/guides/v1/deployment/aws-lambda)
|
|
12
|
+
- [Azure App Services](/guides/v1/deployment/azure-app-services)
|
|
13
|
+
- [Cloudflare](/guides/v1/deployment/cloudflare-deployer)
|
|
14
|
+
- [Digital Ocean](/guides/v1/deployment/digital-ocean)
|
|
15
|
+
- [Netlify](/guides/v1/deployment/netlify-deployer)
|
|
16
|
+
- [Vercel](/guides/v1/deployment/vercel-deployer)
|
|
17
|
+
|
|
18
|
+
For self-hosted Node.js server deployment, see the [Creating A Mastra Server](/docs/v1/deployment/mastra-server) guide.
|
|
19
|
+
|
|
20
|
+
## Prerequisites
|
|
21
|
+
|
|
22
|
+
Before deploying to a cloud provider, ensure you have:
|
|
23
|
+
|
|
24
|
+
- A [Mastra application](/guides/v1/getting-started/quickstart)
|
|
25
|
+
- Node.js `v22.13.0` or later
|
|
26
|
+
- A GitHub repository for your application (required for most CI/CD setups)
|
|
27
|
+
- Domain name management access (for SSL and HTTPS)
|
|
28
|
+
- Basic familiarity with server setup (e.g. Nginx, environment variables)
|
|
29
|
+
|
|
30
|
+
:::warning
|
|
31
|
+
`LibSQLStore` writes to the local filesystem, which is not supported in cloud environments that use ephemeral file systems. If you're deploying to platforms like AWS Lambda, Netlify, Azure App Services, or Digital Ocean App Platform, you must remove all usage of [LibSQLStore](/reference/v1/storage/libsql) with file URLs. Use in-memory storage (`:memory:`) or external storage providers like Turso, PostgreSQL, or Upstash.
|
|
32
|
+
:::
|