@mastra/mcp-docs-server 1.0.0-beta.13 → 1.0.0-beta.14
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/%40mastra%2Fagent-builder.md +19 -19
- package/.docs/organized/changelogs/%40mastra%2Fai-sdk.md +28 -28
- package/.docs/organized/changelogs/%40mastra%2Fclient-js.md +98 -98
- package/.docs/organized/changelogs/%40mastra%2Fconvex.md +30 -0
- package/.docs/organized/changelogs/%40mastra%2Fcore.md +171 -171
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloud.md +15 -15
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloudflare.md +16 -16
- package/.docs/organized/changelogs/%40mastra%2Fdeployer.md +15 -15
- package/.docs/organized/changelogs/%40mastra%2Fmcp-docs-server.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Fmemory.md +12 -12
- package/.docs/organized/changelogs/%40mastra%2Fplayground-ui.md +22 -22
- package/.docs/organized/changelogs/%40mastra%2Frag.md +17 -17
- package/.docs/organized/changelogs/%40mastra%2Freact.md +9 -2
- package/.docs/organized/changelogs/%40mastra%2Fserver.md +94 -94
- package/.docs/organized/changelogs/create-mastra.md +3 -3
- package/.docs/organized/changelogs/mastra.md +17 -17
- package/.docs/organized/code-examples/agent-v6.md +151 -0
- package/.docs/organized/code-examples/ai-elements.md +1 -1
- package/.docs/raw/agents/adding-voice.mdx +2 -3
- package/.docs/raw/agents/agent-approval.mdx +5 -6
- package/.docs/raw/agents/agent-memory.mdx +22 -30
- package/.docs/raw/agents/guardrails.mdx +60 -50
- package/.docs/raw/agents/networks.mdx +8 -12
- package/.docs/raw/agents/overview.mdx +39 -23
- package/.docs/raw/agents/processors.mdx +20 -19
- package/.docs/raw/agents/structured-output.mdx +11 -7
- package/.docs/raw/agents/using-tools.mdx +4 -5
- package/.docs/raw/deployment/mastra-server.mdx +3 -3
- package/.docs/raw/deployment/overview.mdx +7 -0
- package/.docs/raw/deployment/web-framework.mdx +4 -6
- package/.docs/raw/evals/custom-scorers.mdx +9 -6
- package/.docs/raw/evals/overview.mdx +3 -6
- package/.docs/raw/evals/running-in-ci.mdx +2 -2
- package/.docs/raw/getting-started/manual-install.mdx +20 -20
- package/.docs/raw/getting-started/mcp-docs-server.mdx +2 -2
- package/.docs/raw/guides/agent-frameworks/ai-sdk.mdx +4 -4
- package/.docs/raw/guides/build-your-ui/ai-sdk-ui.mdx +30 -30
- package/.docs/raw/guides/build-your-ui/assistant-ui.mdx +8 -8
- package/.docs/raw/guides/build-your-ui/copilotkit.mdx +11 -11
- package/.docs/raw/guides/deployment/amazon-ec2.mdx +9 -9
- package/.docs/raw/guides/deployment/aws-lambda.mdx +11 -11
- package/.docs/raw/guides/deployment/azure-app-services.mdx +2 -2
- package/.docs/raw/guides/deployment/cloudflare-deployer.mdx +5 -6
- package/.docs/raw/guides/deployment/digital-ocean.mdx +10 -10
- package/.docs/raw/guides/deployment/index.mdx +1 -1
- package/.docs/raw/guides/deployment/inngest.mdx +386 -0
- package/.docs/raw/guides/deployment/netlify-deployer.mdx +4 -4
- package/.docs/raw/guides/deployment/vercel-deployer.mdx +5 -6
- package/.docs/raw/guides/getting-started/astro.mdx +292 -451
- package/.docs/raw/guides/getting-started/express.mdx +7 -7
- package/.docs/raw/guides/getting-started/hono.mdx +18 -18
- package/.docs/raw/guides/getting-started/next-js.mdx +19 -20
- package/.docs/raw/guides/getting-started/quickstart.mdx +4 -4
- package/.docs/raw/guides/getting-started/sveltekit.mdx +238 -409
- package/.docs/raw/guides/getting-started/vite-react.mdx +21 -21
- 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 +13 -13
- package/.docs/raw/guides/guide/stock-agent.mdx +5 -5
- package/.docs/raw/guides/guide/web-search.mdx +8 -8
- package/.docs/raw/guides/guide/whatsapp-chat-bot.mdx +7 -7
- package/.docs/raw/guides/migrations/ai-sdk-v4-to-v5.mdx +2 -2
- package/.docs/raw/guides/migrations/upgrade-to-v1/agent.mdx +1 -1
- package/.docs/raw/guides/migrations/upgrade-to-v1/workflows.mdx +0 -2
- package/.docs/raw/guides/migrations/vnext-to-standard-apis.mdx +21 -23
- package/.docs/raw/index.mdx +2 -2
- package/.docs/raw/mastra-cloud/setting-up.mdx +6 -2
- package/.docs/raw/mcp/overview.mdx +31 -13
- package/.docs/raw/mcp/publishing-mcp-server.mdx +2 -2
- package/.docs/raw/memory/memory-processors.mdx +9 -9
- package/.docs/raw/memory/message-history.mdx +69 -0
- package/.docs/raw/memory/overview.mdx +34 -76
- package/.docs/raw/memory/semantic-recall.mdx +58 -49
- package/.docs/raw/memory/storage.mdx +188 -0
- package/.docs/raw/memory/working-memory.mdx +7 -7
- package/.docs/raw/observability/logging.mdx +9 -10
- package/.docs/raw/observability/overview.mdx +0 -1
- package/.docs/raw/observability/tracing/bridges/otel.mdx +2 -2
- package/.docs/raw/observability/tracing/exporters/default.mdx +3 -3
- package/.docs/raw/observability/tracing/exporters/langfuse.mdx +1 -2
- package/.docs/raw/observability/tracing/overview.mdx +23 -25
- package/.docs/raw/observability/tracing/processors/sensitive-data-filter.mdx +3 -3
- package/.docs/raw/rag/chunking-and-embedding.mdx +6 -6
- package/.docs/raw/rag/graph-rag.mdx +7 -7
- package/.docs/raw/rag/overview.mdx +1 -1
- package/.docs/raw/rag/retrieval.mdx +21 -22
- package/.docs/raw/rag/vector-databases.mdx +22 -22
- package/.docs/raw/reference/agents/agent.mdx +3 -3
- package/.docs/raw/reference/agents/generate.mdx +1 -1
- package/.docs/raw/reference/agents/generateLegacy.mdx +2 -2
- package/.docs/raw/reference/agents/getDefaultGenerateOptions.mdx +2 -2
- package/.docs/raw/reference/agents/getDefaultOptions.mdx +2 -2
- package/.docs/raw/reference/agents/getDefaultStreamOptions.mdx +2 -2
- package/.docs/raw/reference/agents/getDescription.mdx +1 -1
- package/.docs/raw/reference/agents/getInstructions.mdx +2 -2
- package/.docs/raw/reference/agents/getLLM.mdx +2 -2
- package/.docs/raw/reference/agents/getMemory.mdx +2 -2
- package/.docs/raw/reference/agents/getModel.mdx +2 -2
- package/.docs/raw/reference/agents/getTools.mdx +2 -2
- package/.docs/raw/reference/agents/getVoice.mdx +2 -2
- package/.docs/raw/reference/agents/listAgents.mdx +2 -2
- package/.docs/raw/reference/agents/listScorers.mdx +2 -2
- package/.docs/raw/reference/agents/listTools.mdx +2 -2
- package/.docs/raw/reference/agents/listWorkflows.mdx +2 -2
- package/.docs/raw/reference/agents/network.mdx +1 -1
- package/.docs/raw/reference/ai-sdk/chat-route.mdx +2 -2
- package/.docs/raw/reference/ai-sdk/handle-chat-stream.mdx +1 -1
- package/.docs/raw/reference/ai-sdk/handle-network-stream.mdx +1 -1
- package/.docs/raw/reference/ai-sdk/handle-workflow-stream.mdx +1 -1
- package/.docs/raw/reference/ai-sdk/network-route.mdx +2 -2
- package/.docs/raw/reference/ai-sdk/to-ai-sdk-stream.mdx +6 -6
- package/.docs/raw/reference/ai-sdk/to-ai-sdk-v4-messages.mdx +3 -3
- package/.docs/raw/reference/ai-sdk/to-ai-sdk-v5-messages.mdx +3 -3
- package/.docs/raw/reference/ai-sdk/with-mastra.mdx +1 -1
- package/.docs/raw/reference/ai-sdk/workflow-route.mdx +2 -2
- package/.docs/raw/reference/auth/auth0.mdx +1 -2
- package/.docs/raw/reference/auth/clerk.mdx +1 -2
- package/.docs/raw/reference/auth/firebase.mdx +2 -4
- package/.docs/raw/reference/auth/jwt.mdx +1 -2
- package/.docs/raw/reference/auth/supabase.mdx +1 -2
- package/.docs/raw/reference/auth/workos.mdx +1 -2
- package/.docs/raw/reference/cli/create-mastra.mdx +10 -10
- package/.docs/raw/reference/cli/mastra.mdx +9 -9
- package/.docs/raw/reference/client-js/agents.mdx +1 -2
- package/.docs/raw/reference/client-js/mastra-client.mdx +1 -1
- package/.docs/raw/reference/core/getAgent.mdx +1 -1
- package/.docs/raw/reference/core/getAgentById.mdx +1 -1
- package/.docs/raw/reference/core/getDeployer.mdx +1 -1
- package/.docs/raw/reference/core/getLogger.mdx +1 -1
- package/.docs/raw/reference/core/getMCPServer.mdx +1 -1
- package/.docs/raw/reference/core/getMCPServerById.mdx +1 -1
- package/.docs/raw/reference/core/getMemory.mdx +2 -2
- package/.docs/raw/reference/core/getServer.mdx +1 -1
- package/.docs/raw/reference/core/getStorage.mdx +2 -2
- package/.docs/raw/reference/core/getStoredAgentById.mdx +3 -3
- package/.docs/raw/reference/core/getTelemetry.mdx +1 -1
- package/.docs/raw/reference/core/getVector.mdx +1 -1
- package/.docs/raw/reference/core/getWorkflow.mdx +1 -1
- package/.docs/raw/reference/core/listAgents.mdx +1 -1
- package/.docs/raw/reference/core/listLogs.mdx +1 -1
- package/.docs/raw/reference/core/listLogsByRunId.mdx +1 -1
- package/.docs/raw/reference/core/listMCPServers.mdx +1 -1
- package/.docs/raw/reference/core/listMemory.mdx +2 -2
- package/.docs/raw/reference/core/listStoredAgents.mdx +4 -4
- package/.docs/raw/reference/core/listVectors.mdx +1 -1
- package/.docs/raw/reference/core/listWorkflows.mdx +1 -1
- package/.docs/raw/reference/core/setLogger.mdx +1 -1
- package/.docs/raw/reference/core/setStorage.mdx +2 -2
- package/.docs/raw/reference/core/setTelemetry.mdx +1 -1
- package/.docs/raw/reference/deployer/cloudflare.mdx +1 -2
- package/.docs/raw/reference/deployer/deployer.mdx +0 -1
- package/.docs/raw/reference/deployer/netlify.mdx +1 -1
- package/.docs/raw/reference/deployer/vercel.mdx +2 -4
- package/.docs/raw/reference/evals/answer-relevancy.mdx +1 -1
- package/.docs/raw/reference/evals/answer-similarity.mdx +1 -1
- package/.docs/raw/reference/evals/bias.mdx +1 -1
- package/.docs/raw/reference/evals/completeness.mdx +1 -1
- package/.docs/raw/reference/evals/content-similarity.mdx +1 -1
- package/.docs/raw/reference/evals/context-precision.mdx +1 -1
- package/.docs/raw/reference/evals/faithfulness.mdx +1 -1
- package/.docs/raw/reference/evals/hallucination.mdx +1 -1
- package/.docs/raw/reference/evals/keyword-coverage.mdx +1 -1
- package/.docs/raw/reference/evals/prompt-alignment.mdx +7 -7
- package/.docs/raw/reference/evals/textual-difference.mdx +1 -1
- package/.docs/raw/reference/evals/tone-consistency.mdx +1 -1
- package/.docs/raw/reference/evals/tool-call-accuracy.mdx +10 -10
- package/.docs/raw/reference/evals/toxicity.mdx +1 -1
- package/.docs/raw/reference/logging/pino-logger.mdx +6 -7
- package/.docs/raw/reference/memory/createThread.mdx +2 -2
- package/.docs/raw/reference/memory/deleteMessages.mdx +2 -2
- package/.docs/raw/reference/memory/listThreadsByResourceId.mdx +2 -2
- package/.docs/raw/reference/memory/memory-class.mdx +3 -3
- package/.docs/raw/reference/memory/query.mdx +2 -2
- package/.docs/raw/reference/memory/recall.mdx +2 -2
- package/.docs/raw/reference/observability/tracing/exporters/langfuse.mdx +1 -1
- package/.docs/raw/reference/processors/batch-parts-processor.mdx +2 -2
- package/.docs/raw/reference/processors/language-detector.mdx +2 -2
- package/.docs/raw/reference/processors/message-history-processor.mdx +2 -2
- package/.docs/raw/reference/processors/moderation-processor.mdx +3 -3
- package/.docs/raw/reference/processors/pii-detector.mdx +3 -3
- package/.docs/raw/reference/processors/processor-interface.mdx +13 -13
- package/.docs/raw/reference/processors/prompt-injection-detector.mdx +2 -2
- package/.docs/raw/reference/processors/semantic-recall-processor.mdx +2 -2
- package/.docs/raw/reference/processors/system-prompt-scrubber.mdx +2 -2
- package/.docs/raw/reference/processors/token-limiter-processor.mdx +2 -2
- package/.docs/raw/reference/processors/tool-call-filter.mdx +3 -3
- package/.docs/raw/reference/processors/unicode-normalizer.mdx +2 -2
- package/.docs/raw/reference/processors/working-memory-processor.mdx +3 -3
- package/.docs/raw/reference/rag/chunk.mdx +1 -1
- package/.docs/raw/reference/rag/extract-params.mdx +2 -2
- package/.docs/raw/reference/rag/metadata-filters.mdx +7 -7
- package/.docs/raw/reference/server/create-route.mdx +13 -13
- package/.docs/raw/reference/server/express-adapter.mdx +6 -7
- package/.docs/raw/reference/server/hono-adapter.mdx +6 -7
- package/.docs/raw/reference/server/mastra-server.mdx +20 -20
- package/.docs/raw/reference/storage/cloudflare-d1.mdx +3 -3
- package/.docs/raw/reference/storage/cloudflare.mdx +2 -2
- package/.docs/raw/reference/storage/convex.mdx +6 -6
- package/.docs/raw/reference/storage/dynamodb.mdx +4 -4
- package/.docs/raw/reference/storage/lance.mdx +3 -3
- package/.docs/raw/reference/storage/libsql.mdx +69 -54
- package/.docs/raw/reference/storage/mongodb.mdx +80 -7
- package/.docs/raw/reference/storage/mssql.mdx +4 -4
- package/.docs/raw/{memory → reference}/storage/overview.mdx +12 -110
- package/.docs/raw/reference/storage/postgresql.mdx +78 -7
- package/.docs/raw/reference/storage/upstash.mdx +74 -2
- package/.docs/raw/reference/streaming/agents/stream.mdx +5 -5
- package/.docs/raw/reference/streaming/agents/streamLegacy.mdx +2 -2
- package/.docs/raw/reference/streaming/workflows/observeStream.mdx +1 -1
- package/.docs/raw/reference/streaming/workflows/resumeStream.mdx +1 -1
- package/.docs/raw/reference/streaming/workflows/stream.mdx +2 -2
- package/.docs/raw/reference/streaming/workflows/timeTravelStream.mdx +4 -4
- package/.docs/raw/reference/templates/overview.mdx +1 -2
- package/.docs/raw/reference/tools/create-tool.mdx +1 -4
- package/.docs/raw/reference/tools/vector-query-tool.mdx +1 -1
- package/.docs/raw/reference/vectors/astra.mdx +3 -3
- package/.docs/raw/reference/vectors/chroma.mdx +3 -3
- package/.docs/raw/reference/vectors/convex.mdx +12 -12
- package/.docs/raw/reference/vectors/couchbase.mdx +5 -5
- package/.docs/raw/reference/vectors/duckdb.mdx +10 -10
- package/.docs/raw/reference/vectors/elasticsearch.mdx +4 -4
- package/.docs/raw/reference/vectors/lance.mdx +4 -4
- package/.docs/raw/reference/vectors/libsql.mdx +61 -11
- package/.docs/raw/reference/vectors/mongodb.mdx +58 -5
- package/.docs/raw/reference/vectors/pg.mdx +53 -6
- package/.docs/raw/reference/vectors/pinecone.mdx +3 -3
- package/.docs/raw/reference/vectors/qdrant.mdx +3 -3
- package/.docs/raw/reference/vectors/s3vectors.mdx +6 -6
- package/.docs/raw/reference/vectors/turbopuffer.mdx +4 -4
- package/.docs/raw/reference/vectors/upstash.mdx +55 -6
- package/.docs/raw/reference/vectors/vectorize.mdx +3 -3
- package/.docs/raw/reference/workflows/run-methods/cancel.mdx +2 -2
- package/.docs/raw/reference/workflows/run-methods/restart.mdx +1 -3
- package/.docs/raw/reference/workflows/run-methods/resume.mdx +2 -2
- package/.docs/raw/reference/workflows/run-methods/start.mdx +2 -2
- package/.docs/raw/reference/workflows/run-methods/startAsync.mdx +2 -2
- package/.docs/raw/reference/workflows/run-methods/timeTravel.mdx +5 -5
- package/.docs/raw/reference/workflows/run.mdx +1 -1
- package/.docs/raw/reference/workflows/step.mdx +3 -3
- package/.docs/raw/reference/workflows/workflow-methods/branch.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/commit.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/create-run.mdx +3 -3
- package/.docs/raw/reference/workflows/workflow-methods/dountil.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/dowhile.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/foreach.mdx +6 -6
- package/.docs/raw/reference/workflows/workflow-methods/map.mdx +7 -7
- package/.docs/raw/reference/workflows/workflow-methods/parallel.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/sendEvent.mdx +2 -2
- package/.docs/raw/reference/workflows/workflow-methods/sleep.mdx +2 -2
- package/.docs/raw/reference/workflows/workflow-methods/sleepUntil.mdx +2 -2
- package/.docs/raw/reference/workflows/workflow-methods/then.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/waitForEvent.mdx +2 -2
- package/.docs/raw/reference/workflows/workflow.mdx +3 -3
- package/.docs/raw/server/auth/auth0.mdx +20 -14
- package/.docs/raw/server/auth/clerk.mdx +16 -9
- package/.docs/raw/server/auth/firebase.mdx +21 -15
- package/.docs/raw/server/auth/jwt.mdx +14 -7
- package/.docs/raw/server/auth/supabase.mdx +16 -9
- package/.docs/raw/server/auth/workos.mdx +19 -13
- package/.docs/raw/server/custom-adapters.mdx +10 -10
- package/.docs/raw/server/custom-api-routes.mdx +2 -4
- package/.docs/raw/server/mastra-client.mdx +24 -13
- package/.docs/raw/server/mastra-server.mdx +3 -3
- package/.docs/raw/server/middleware.mdx +7 -7
- package/.docs/raw/server/request-context.mdx +31 -30
- package/.docs/raw/server/server-adapters.mdx +6 -6
- package/.docs/raw/streaming/events.mdx +14 -7
- package/.docs/raw/streaming/overview.mdx +21 -10
- package/.docs/raw/streaming/tool-streaming.mdx +6 -6
- package/.docs/raw/streaming/workflow-streaming.mdx +6 -8
- package/.docs/raw/tools-mcp/advanced-usage.mdx +2 -2
- package/.docs/raw/tools-mcp/mcp-overview.mdx +31 -12
- package/.docs/raw/tools-mcp/overview.mdx +9 -10
- package/.docs/raw/voice/overview.mdx +1 -1
- package/.docs/raw/workflows/agents-and-tools.mdx +28 -19
- package/.docs/raw/workflows/control-flow.mdx +27 -40
- package/.docs/raw/workflows/error-handling.mdx +15 -22
- package/.docs/raw/workflows/human-in-the-loop.mdx +6 -7
- package/.docs/raw/workflows/inngest-workflow.mdx +8 -9
- package/.docs/raw/workflows/input-data-mapping.mdx +7 -7
- package/.docs/raw/workflows/overview.mdx +33 -22
- package/.docs/raw/workflows/snapshots.mdx +14 -44
- package/.docs/raw/workflows/suspend-and-resume.mdx +7 -7
- package/.docs/raw/workflows/time-travel.mdx +16 -16
- package/.docs/raw/workflows/workflow-state.mdx +5 -8
- package/CHANGELOG.md +9 -0
- package/dist/logger.d.ts +3 -0
- package/dist/logger.d.ts.map +1 -1
- package/dist/stdio.js +53 -0
- package/package.json +4 -4
- 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
|
@@ -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({
|
|
@@ -30,14 +30,14 @@ Before deploying to AWS Lambda, ensure you have:
|
|
|
30
30
|
## Memory Configuration
|
|
31
31
|
|
|
32
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](/
|
|
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.
|
|
34
34
|
:::
|
|
35
35
|
|
|
36
36
|
Lambda functions have limitations with file system storage. Configure your Mastra application to use either in-memory or external storage providers:
|
|
37
37
|
|
|
38
38
|
### Option 1: In-Memory (Simplest)
|
|
39
39
|
|
|
40
|
-
```typescript title="src/mastra/index.ts"
|
|
40
|
+
```typescript title="src/mastra/index.ts"
|
|
41
41
|
import { LibSQLStore } from "@mastra/libsql";
|
|
42
42
|
|
|
43
43
|
const storage = new LibSQLStore({
|
|
@@ -50,7 +50,7 @@ const storage = new LibSQLStore({
|
|
|
50
50
|
|
|
51
51
|
For persistent memory across Lambda invocations, use external storage providers like `LibSQLStore` with Turso or other storage providers like `PostgreStore`:
|
|
52
52
|
|
|
53
|
-
```typescript title="src/mastra/index.ts"
|
|
53
|
+
```typescript title="src/mastra/index.ts"
|
|
54
54
|
import { LibSQLStore } from "@mastra/libsql";
|
|
55
55
|
|
|
56
56
|
const storage = new LibSQLStore({
|
|
@@ -66,7 +66,7 @@ For more memory configuration options, see the [Memory documentation](/docs/v1/m
|
|
|
66
66
|
|
|
67
67
|
Create a `Dockerfile` in your Mastra project root directory:
|
|
68
68
|
|
|
69
|
-
```dockerfile title="Dockerfile"
|
|
69
|
+
```dockerfile title="Dockerfile"
|
|
70
70
|
FROM node:22-alpine
|
|
71
71
|
|
|
72
72
|
WORKDIR /app
|
|
@@ -100,7 +100,7 @@ CMD ["node", ".mastra/output/index.mjs"]
|
|
|
100
100
|
|
|
101
101
|
Set up your environment variables for the deployment process:
|
|
102
102
|
|
|
103
|
-
```bash
|
|
103
|
+
```bash
|
|
104
104
|
export PROJECT_NAME="your-mastra-app"
|
|
105
105
|
export AWS_REGION="us-east-1"
|
|
106
106
|
export AWS_ACCOUNT_ID=$(aws sts get-caller-identity --query Account --output text)
|
|
@@ -112,7 +112,7 @@ export AWS_ACCOUNT_ID=$(aws sts get-caller-identity --query Account --output tex
|
|
|
112
112
|
|
|
113
113
|
Build your Docker image locally:
|
|
114
114
|
|
|
115
|
-
```bash
|
|
115
|
+
```bash
|
|
116
116
|
docker build -t "$PROJECT_NAME" .
|
|
117
117
|
```
|
|
118
118
|
|
|
@@ -122,7 +122,7 @@ docker build -t "$PROJECT_NAME" .
|
|
|
122
122
|
|
|
123
123
|
Create an Amazon ECR repository to store your Docker image:
|
|
124
124
|
|
|
125
|
-
```bash
|
|
125
|
+
```bash
|
|
126
126
|
aws ecr create-repository --repository-name "$PROJECT_NAME" --region "$AWS_REGION"
|
|
127
127
|
```
|
|
128
128
|
|
|
@@ -132,7 +132,7 @@ aws ecr create-repository --repository-name "$PROJECT_NAME" --region "$AWS_REGIO
|
|
|
132
132
|
|
|
133
133
|
Log in to Amazon ECR:
|
|
134
134
|
|
|
135
|
-
```bash
|
|
135
|
+
```bash
|
|
136
136
|
aws ecr get-login-password --region "$AWS_REGION" | docker login --username AWS --password-stdin "$AWS_ACCOUNT_ID.dkr.ecr.$AWS_REGION.amazonaws.com"
|
|
137
137
|
```
|
|
138
138
|
|
|
@@ -142,7 +142,7 @@ aws ecr get-login-password --region "$AWS_REGION" | docker login --username AWS
|
|
|
142
142
|
|
|
143
143
|
Tag your image with the ECR repository URI and push it:
|
|
144
144
|
|
|
145
|
-
```bash
|
|
145
|
+
```bash
|
|
146
146
|
docker tag "$PROJECT_NAME":latest "$AWS_ACCOUNT_ID.dkr.ecr.$AWS_REGION.amazonaws.com/$PROJECT_NAME":latest
|
|
147
147
|
docker push "$AWS_ACCOUNT_ID.dkr.ecr.$AWS_REGION.amazonaws.com/$PROJECT_NAME":latest
|
|
148
148
|
```
|
|
@@ -186,7 +186,7 @@ Add your environment variables in the Lambda function configuration:
|
|
|
186
186
|
2. Add the required variables for your Mastra application:
|
|
187
187
|
- `OPENAI_API_KEY`: Your OpenAI API key (if using OpenAI)
|
|
188
188
|
- `ANTHROPIC_API_KEY`: Your Anthropic API key (if using Anthropic)
|
|
189
|
-
- `TURSO_AUTH_TOKEN`: Your Turso auth token (if using
|
|
189
|
+
- `TURSO_AUTH_TOKEN`: Your Turso auth token (if using libSQL with Turso)
|
|
190
190
|
- Other provider-specific API keys as needed
|
|
191
191
|
|
|
192
192
|
</StepItem>
|
|
@@ -219,7 +219,7 @@ For more information about available API endpoints, see the [Server documentatio
|
|
|
219
219
|
|
|
220
220
|
Update your client application to use the Lambda function URL:
|
|
221
221
|
|
|
222
|
-
```typescript title="src/client.ts"
|
|
222
|
+
```typescript title="src/client.ts"
|
|
223
223
|
import { MastraClient } from "@mastra/client-js";
|
|
224
224
|
|
|
225
225
|
const mastraClient = new MastraClient({
|
|
@@ -18,7 +18,7 @@ refer to our [getting started guide](/guides/v1/getting-started/quickstart)
|
|
|
18
18
|
:::
|
|
19
19
|
|
|
20
20
|
:::warning
|
|
21
|
-
Azure App Services uses an ephemeral filesystem for some pricing tiers. Remove any usage of [LibSQLStore](/
|
|
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
22
|
:::
|
|
23
23
|
|
|
24
24
|
## Prerequisites
|
|
@@ -147,7 +147,7 @@ You can now connect to your Mastra server from your client application using a `
|
|
|
147
147
|
|
|
148
148
|
Refer to the [`MastraClient` documentation](/reference/v1/client-js/mastra-client) for more information.
|
|
149
149
|
|
|
150
|
-
```typescript
|
|
150
|
+
```typescript
|
|
151
151
|
import { MastraClient } from "@mastra/client-js";
|
|
152
152
|
|
|
153
153
|
const mastraClient = new MastraClient({
|
|
@@ -8,23 +8,22 @@ description: "Learn how to deploy a Mastra application to Cloudflare using the M
|
|
|
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
10
|
:::warning
|
|
11
|
-
Cloudflare Workers do not support filesystem access. Remove any usage of [LibSQLStore](/
|
|
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
12
|
:::
|
|
13
13
|
|
|
14
14
|
## Installation
|
|
15
15
|
|
|
16
|
-
```bash
|
|
16
|
+
```bash
|
|
17
17
|
npm install @mastra/deployer-cloudflare@beta
|
|
18
18
|
```
|
|
19
19
|
|
|
20
20
|
## Usage example
|
|
21
21
|
|
|
22
|
-
```typescript title="src/mastra/index.ts"
|
|
22
|
+
```typescript title="src/mastra/index.ts"
|
|
23
23
|
import { Mastra } from "@mastra/core";
|
|
24
24
|
import { CloudflareDeployer } from "@mastra/deployer-cloudflare";
|
|
25
25
|
|
|
26
26
|
export const mastra = new Mastra({
|
|
27
|
-
// ...
|
|
28
27
|
deployer: new CloudflareDeployer({
|
|
29
28
|
projectName: "hello-mastra",
|
|
30
29
|
env: {
|
|
@@ -42,13 +41,13 @@ Manual deployments are also possible using the [Cloudflare Wrangler CLI](https:/
|
|
|
42
41
|
|
|
43
42
|
With the Wrangler CLI installed, login and authenticate with your Cloudflare logins:
|
|
44
43
|
|
|
45
|
-
```bash
|
|
44
|
+
```bash
|
|
46
45
|
npx wrangler login
|
|
47
46
|
```
|
|
48
47
|
|
|
49
48
|
Run the following to build and deploy your application to Cloudflare
|
|
50
49
|
|
|
51
|
-
```bash
|
|
50
|
+
```bash
|
|
52
51
|
npm run build && wrangler deploy --config .mastra/output/wrangler.json
|
|
53
52
|
```
|
|
54
53
|
|
|
@@ -98,7 +98,7 @@ Deployment
|
|
|
98
98
|
You can now access your deployed application at the URL provided by Digital Ocean.
|
|
99
99
|
|
|
100
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](/
|
|
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.
|
|
102
102
|
:::
|
|
103
103
|
|
|
104
104
|
</TabItem>
|
|
@@ -131,7 +131,7 @@ Connect to your Droplet and clone your repository:
|
|
|
131
131
|
<Tabs>
|
|
132
132
|
<TabItem value="public" label="Public Repository">
|
|
133
133
|
|
|
134
|
-
```bash
|
|
134
|
+
```bash
|
|
135
135
|
git clone https://github.com/<your-username>/<your-repository>.git
|
|
136
136
|
```
|
|
137
137
|
|
|
@@ -139,7 +139,7 @@ git clone https://github.com/<your-username>/<your-repository>.git
|
|
|
139
139
|
|
|
140
140
|
<TabItem value="private" label="Private Repository">
|
|
141
141
|
|
|
142
|
-
```bash
|
|
142
|
+
```bash
|
|
143
143
|
git clone https://<your-username>:<your-personal-access-token>@github.com/<your-username>/<your-repository>.git
|
|
144
144
|
```
|
|
145
145
|
|
|
@@ -148,7 +148,7 @@ git clone https://<your-username>:<your-personal-access-token>@github.com/<your-
|
|
|
148
148
|
|
|
149
149
|
Navigate to the repository directory:
|
|
150
150
|
|
|
151
|
-
```bash
|
|
151
|
+
```bash
|
|
152
152
|
cd "<your-repository>"
|
|
153
153
|
```
|
|
154
154
|
|
|
@@ -158,7 +158,7 @@ cd "<your-repository>"
|
|
|
158
158
|
|
|
159
159
|
Install dependencies
|
|
160
160
|
|
|
161
|
-
```bash
|
|
161
|
+
```bash
|
|
162
162
|
npm install
|
|
163
163
|
```
|
|
164
164
|
|
|
@@ -170,13 +170,13 @@ Set up environment variables
|
|
|
170
170
|
|
|
171
171
|
Create a `.env` file and add your environment variables:
|
|
172
172
|
|
|
173
|
-
```bash
|
|
173
|
+
```bash
|
|
174
174
|
touch .env
|
|
175
175
|
```
|
|
176
176
|
|
|
177
177
|
Edit the `.env` file and add your environment variables:
|
|
178
178
|
|
|
179
|
-
```bash
|
|
179
|
+
```bash
|
|
180
180
|
OPENAI_API_KEY=<your-openai-api-key>
|
|
181
181
|
# Add other required environment variables
|
|
182
182
|
```
|
|
@@ -187,7 +187,7 @@ OPENAI_API_KEY=<your-openai-api-key>
|
|
|
187
187
|
|
|
188
188
|
Build the application
|
|
189
189
|
|
|
190
|
-
```bash
|
|
190
|
+
```bash
|
|
191
191
|
npm run build
|
|
192
192
|
```
|
|
193
193
|
|
|
@@ -197,7 +197,7 @@ npm run build
|
|
|
197
197
|
|
|
198
198
|
Run the application
|
|
199
199
|
|
|
200
|
-
```bash
|
|
200
|
+
```bash
|
|
201
201
|
node --env-file=".env" .mastra/output/index.mjs
|
|
202
202
|
```
|
|
203
203
|
|
|
@@ -219,7 +219,7 @@ You can now connect to your Mastra server from your client application using a `
|
|
|
219
219
|
|
|
220
220
|
Refer to the [`MastraClient` documentation](/docs/v1/server/mastra-client) for more information.
|
|
221
221
|
|
|
222
|
-
```typescript
|
|
222
|
+
```typescript
|
|
223
223
|
import { MastraClient } from "@mastra/client-js";
|
|
224
224
|
|
|
225
225
|
const mastraClient = new MastraClient({
|
|
@@ -28,5 +28,5 @@ Before deploying to a cloud provider, ensure you have:
|
|
|
28
28
|
- Basic familiarity with server setup (e.g. Nginx, environment variables)
|
|
29
29
|
|
|
30
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](/
|
|
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
32
|
:::
|