@mastra/mcp-docs-server 1.0.0-beta.11 → 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 +29 -29
- package/.docs/organized/changelogs/%40mastra%2Fai-sdk.md +51 -51
- package/.docs/organized/changelogs/%40mastra%2Fclickhouse.md +45 -45
- package/.docs/organized/changelogs/%40mastra%2Fclient-js.md +180 -180
- package/.docs/organized/changelogs/%40mastra%2Fcloudflare-d1.md +39 -39
- package/.docs/organized/changelogs/%40mastra%2Fcloudflare.md +39 -39
- package/.docs/organized/changelogs/%40mastra%2Fconvex.md +68 -0
- package/.docs/organized/changelogs/%40mastra%2Fcore.md +331 -331
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloud.md +31 -31
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloudflare.md +16 -16
- package/.docs/organized/changelogs/%40mastra%2Fdeployer.md +41 -41
- package/.docs/organized/changelogs/%40mastra%2Fdynamodb.md +39 -39
- package/.docs/organized/changelogs/%40mastra%2Ffastembed.md +6 -0
- package/.docs/organized/changelogs/%40mastra%2Flance.md +39 -39
- package/.docs/organized/changelogs/%40mastra%2Flibsql.md +45 -45
- package/.docs/organized/changelogs/%40mastra%2Fmcp-docs-server.md +24 -24
- package/.docs/organized/changelogs/%40mastra%2Fmemory.md +24 -24
- package/.docs/organized/changelogs/%40mastra%2Fmongodb.md +39 -39
- package/.docs/organized/changelogs/%40mastra%2Fmssql.md +39 -39
- package/.docs/organized/changelogs/%40mastra%2Fpg.md +45 -45
- package/.docs/organized/changelogs/%40mastra%2Fplayground-ui.md +96 -96
- package/.docs/organized/changelogs/%40mastra%2Frag.md +17 -17
- package/.docs/organized/changelogs/%40mastra%2Freact.md +49 -2
- package/.docs/organized/changelogs/%40mastra%2Fschema-compat.md +6 -0
- package/.docs/organized/changelogs/%40mastra%2Fserver.md +122 -122
- package/.docs/organized/changelogs/%40mastra%2Fupstash.md +39 -39
- package/.docs/organized/changelogs/create-mastra.md +31 -31
- package/.docs/organized/changelogs/mastra.md +51 -51
- package/.docs/organized/code-examples/agent-v6.md +151 -0
- package/.docs/organized/code-examples/ai-elements.md +1 -1
- package/.docs/organized/code-examples/quick-start.md +0 -4
- package/.docs/organized/code-examples/stock-price-tool.md +21 -2
- package/.docs/raw/agents/adding-voice.mdx +2 -3
- package/.docs/raw/agents/agent-approval.mdx +139 -6
- package/.docs/raw/agents/agent-memory.mdx +24 -32
- package/.docs/raw/agents/guardrails.mdx +61 -51
- package/.docs/raw/agents/networks.mdx +9 -13
- package/.docs/raw/agents/overview.mdx +40 -24
- package/.docs/raw/agents/processors.mdx +20 -19
- package/.docs/raw/agents/structured-output.mdx +11 -7
- package/.docs/raw/agents/using-tools.mdx +5 -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 +2 -2
- package/.docs/raw/course/03-agent-memory/04-creating-basic-memory-agent.md +1 -2
- package/.docs/raw/course/03-agent-memory/08-configuring-conversation-history.md +1 -2
- package/.docs/raw/course/03-agent-memory/16-configuring-semantic-recall.md +3 -4
- package/.docs/raw/course/03-agent-memory/21-configuring-working-memory.md +2 -3
- package/.docs/raw/course/03-agent-memory/22-custom-working-memory-templates.md +2 -3
- package/.docs/raw/course/03-agent-memory/25-combining-memory-features.md +1 -2
- package/.docs/raw/course/03-agent-memory/27-creating-learning-assistant.md +2 -3
- package/.docs/raw/course/04-workflows/11-creating-an-ai-agent.md +2 -3
- package/.docs/raw/deployment/cloud-providers.mdx +20 -0
- package/.docs/raw/deployment/{building-mastra.mdx → mastra-server.mdx} +5 -5
- package/.docs/raw/deployment/monorepo.mdx +23 -44
- package/.docs/raw/deployment/overview.mdx +32 -50
- package/.docs/raw/deployment/web-framework.mdx +15 -19
- 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/getting-started/start.mdx +10 -1
- package/.docs/raw/getting-started/studio.mdx +1 -1
- package/.docs/raw/guides/agent-frameworks/ai-sdk.mdx +4 -4
- package/.docs/raw/guides/build-your-ui/ai-sdk-ui.mdx +1033 -79
- 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/{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 +12 -15
- package/.docs/raw/guides/deployment/index.mdx +32 -0
- package/.docs/raw/guides/deployment/inngest.mdx +386 -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 +170 -61
- 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 +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 +17 -17
- 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/client.mdx +17 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/overview.mdx +6 -0
- 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/{deployment/mastra-cloud → mastra-cloud}/dashboard.mdx +2 -6
- package/.docs/raw/{deployment/mastra-cloud → mastra-cloud}/observability.mdx +1 -5
- package/.docs/raw/{deployment/mastra-cloud → mastra-cloud}/overview.mdx +2 -6
- package/.docs/raw/{deployment/mastra-cloud → mastra-cloud}/setting-up.mdx +8 -7
- 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 +10 -11
- package/.docs/raw/observability/overview.mdx +0 -1
- package/.docs/raw/observability/tracing/bridges/otel.mdx +2 -2
- package/.docs/raw/observability/tracing/exporters/cloud.mdx +1 -1
- 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 +18 -31
- package/.docs/raw/rag/graph-rag.mdx +220 -0
- package/.docs/raw/rag/overview.mdx +2 -3
- package/.docs/raw/rag/retrieval.mdx +34 -51
- package/.docs/raw/rag/vector-databases.mdx +29 -25
- 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 +3 -3
- package/.docs/raw/reference/agents/getDefaultOptions.mdx +3 -3
- package/.docs/raw/reference/agents/getDefaultStreamOptions.mdx +3 -3
- package/.docs/raw/reference/agents/getDescription.mdx +1 -1
- package/.docs/raw/reference/agents/getInstructions.mdx +3 -3
- package/.docs/raw/reference/agents/getLLM.mdx +3 -3
- package/.docs/raw/reference/agents/getMemory.mdx +3 -3
- package/.docs/raw/reference/agents/getModel.mdx +3 -3
- 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 +3 -3
- 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 +3 -3
- package/.docs/raw/reference/ai-sdk/handle-chat-stream.mdx +2 -2
- package/.docs/raw/reference/ai-sdk/handle-network-stream.mdx +2 -2
- package/.docs/raw/reference/ai-sdk/handle-workflow-stream.mdx +2 -2
- package/.docs/raw/reference/ai-sdk/network-route.mdx +3 -3
- 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 +127 -0
- package/.docs/raw/reference/ai-sdk/to-ai-sdk-v5-messages.mdx +107 -0
- package/.docs/raw/reference/ai-sdk/with-mastra.mdx +1 -1
- package/.docs/raw/reference/ai-sdk/workflow-route.mdx +3 -3
- package/.docs/raw/reference/auth/auth0.mdx +2 -3
- package/.docs/raw/reference/auth/clerk.mdx +2 -3
- package/.docs/raw/reference/auth/firebase.mdx +3 -5
- package/.docs/raw/reference/auth/jwt.mdx +2 -3
- package/.docs/raw/reference/auth/supabase.mdx +2 -3
- package/.docs/raw/reference/auth/workos.mdx +2 -3
- package/.docs/raw/reference/cli/create-mastra.mdx +10 -10
- package/.docs/raw/reference/cli/mastra.mdx +10 -10
- package/.docs/raw/reference/client-js/agents.mdx +1 -2
- package/.docs/raw/reference/client-js/mastra-client.mdx +2 -2
- package/.docs/raw/reference/client-js/workflows.mdx +20 -0
- 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 +3 -3
- 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 +7 -8
- 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/database-config.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 +14 -14
- package/.docs/raw/reference/server/express-adapter.mdx +10 -11
- package/.docs/raw/reference/server/hono-adapter.mdx +10 -11
- package/.docs/raw/reference/server/mastra-server.mdx +22 -22
- package/.docs/raw/reference/server/routes.mdx +28 -1
- 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/{server-db/storage.mdx → reference/storage/overview.mdx} +13 -111
- 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 +27 -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 +35 -22
- 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 +24 -5
- package/.docs/raw/reference/tools/graph-rag-tool.mdx +3 -3
- package/.docs/raw/reference/tools/vector-query-tool.mdx +4 -4
- 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 +143 -0
- 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 +37 -2
- 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 +17 -3
- package/.docs/raw/{auth → server/auth}/auth0.mdx +20 -14
- package/.docs/raw/{auth → server/auth}/clerk.mdx +16 -9
- package/.docs/raw/{auth → server/auth}/firebase.mdx +21 -15
- package/.docs/raw/{auth → server/auth}/index.mdx +6 -6
- package/.docs/raw/{auth → server/auth}/jwt.mdx +14 -7
- package/.docs/raw/{auth → server/auth}/supabase.mdx +16 -9
- package/.docs/raw/{auth → server/auth}/workos.mdx +19 -13
- package/.docs/raw/{server-db → server}/custom-adapters.mdx +13 -13
- package/.docs/raw/{server-db → server}/custom-api-routes.mdx +3 -5
- package/.docs/raw/{server-db → server}/mastra-client.mdx +26 -15
- package/.docs/raw/{server-db → server}/mastra-server.mdx +8 -8
- package/.docs/raw/{server-db → server}/middleware.mdx +9 -9
- package/.docs/raw/{server-db → server}/request-context.mdx +33 -32
- package/.docs/raw/{server-db → server}/server-adapters.mdx +12 -12
- 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 +10 -11
- 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 +172 -18
- 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 +34 -23
- 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 +23 -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/organized/changelogs/%40internal%2Fai-sdk-v4.md +0 -1
- package/.docs/raw/deployment/cloud-providers/index.mdx +0 -55
- 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
|
@@ -13,7 +13,7 @@ The `@mastra/express` package provides a server adapter for running Mastra with
|
|
|
13
13
|
|
|
14
14
|
:::info
|
|
15
15
|
|
|
16
|
-
For general adapter concepts (constructor options, initialization flow, etc.), see [Server Adapters](/docs/v1/server
|
|
16
|
+
For general adapter concepts (constructor options, initialization flow, etc.), see [Server Adapters](/docs/v1/server/server-adapters).
|
|
17
17
|
|
|
18
18
|
:::
|
|
19
19
|
|
|
@@ -25,8 +25,8 @@ For general adapter concepts (constructor options, initialization flow, etc.), s
|
|
|
25
25
|
|
|
26
26
|
Install the Express adapter and Express framework:
|
|
27
27
|
|
|
28
|
-
```bash
|
|
29
|
-
npm install @mastra/express express
|
|
28
|
+
```bash
|
|
29
|
+
npm install @mastra/express@beta express
|
|
30
30
|
```
|
|
31
31
|
|
|
32
32
|
</StepItem>
|
|
@@ -35,7 +35,7 @@ npm install @mastra/express express
|
|
|
35
35
|
|
|
36
36
|
Create your server file:
|
|
37
37
|
|
|
38
|
-
```typescript title="server.ts"
|
|
38
|
+
```typescript title="server.ts"
|
|
39
39
|
import express from 'express';
|
|
40
40
|
import { MastraServer } from '@mastra/express';
|
|
41
41
|
import { mastra } from './mastra';
|
|
@@ -63,7 +63,7 @@ Express requires `express.json()` middleware for JSON body parsing. Add it befor
|
|
|
63
63
|
|
|
64
64
|
## Full example
|
|
65
65
|
|
|
66
|
-
```typescript title="server.ts"
|
|
66
|
+
```typescript title="server.ts"
|
|
67
67
|
import express from 'express';
|
|
68
68
|
import { MastraServer } from '@mastra/express';
|
|
69
69
|
import { mastra } from './mastra';
|
|
@@ -166,7 +166,7 @@ app.listen(4111);
|
|
|
166
166
|
|
|
167
167
|
Add routes directly to the Express app:
|
|
168
168
|
|
|
169
|
-
```typescript title="server.ts"
|
|
169
|
+
```typescript title="server.ts"
|
|
170
170
|
const app = express();
|
|
171
171
|
app.use(express.json());
|
|
172
172
|
|
|
@@ -196,7 +196,7 @@ Routes added before `init()` run without Mastra context. Add routes after `init(
|
|
|
196
196
|
|
|
197
197
|
In Express middleware and routes, access Mastra context via `res.locals`:
|
|
198
198
|
|
|
199
|
-
```typescript
|
|
199
|
+
```typescript
|
|
200
200
|
app.get('/custom', (req, res) => {
|
|
201
201
|
const mastra = res.locals.mastra;
|
|
202
202
|
const requestContext = res.locals.requestContext;
|
|
@@ -223,7 +223,7 @@ Available properties on `res.locals`:
|
|
|
223
223
|
|
|
224
224
|
Add Express middleware before or after `init()`:
|
|
225
225
|
|
|
226
|
-
```typescript title="server.ts"
|
|
226
|
+
```typescript title="server.ts"
|
|
227
227
|
const app = express();
|
|
228
228
|
app.use(express.json());
|
|
229
229
|
|
|
@@ -239,14 +239,13 @@ await server.init();
|
|
|
239
239
|
// Middleware after init has access to Mastra context
|
|
240
240
|
app.use((req, res, next) => {
|
|
241
241
|
const mastra = res.locals.mastra;
|
|
242
|
-
// ...
|
|
243
242
|
next();
|
|
244
243
|
});
|
|
245
244
|
```
|
|
246
245
|
|
|
247
246
|
## Manual initialization
|
|
248
247
|
|
|
249
|
-
For custom middleware ordering, call each method separately instead of `init()`. See [Server Adapters: Manual initialization](/docs/v1/server
|
|
248
|
+
For custom middleware ordering, call each method separately instead of `init()`. See [Server Adapters: Manual initialization](/docs/v1/server/server-adapters#manual-initialization) for details.
|
|
250
249
|
|
|
251
250
|
## Examples
|
|
252
251
|
|
|
@@ -254,7 +253,7 @@ For custom middleware ordering, call each method separately instead of `init()`.
|
|
|
254
253
|
|
|
255
254
|
## Related
|
|
256
255
|
|
|
257
|
-
- [Server Adapters](/docs/v1/server
|
|
256
|
+
- [Server Adapters](/docs/v1/server/server-adapters) - Shared adapter concepts
|
|
258
257
|
- [Hono Adapter](/reference/v1/server/hono-adapter) - Alternative adapter
|
|
259
258
|
- [MastraServer Reference](/reference/v1/server/mastra-server) - Full API reference
|
|
260
259
|
- [createRoute() Reference](/reference/v1/server/create-route) - Creating type-safe custom routes
|
|
@@ -13,7 +13,7 @@ The `@mastra/hono` package provides a server adapter for running Mastra with [Ho
|
|
|
13
13
|
|
|
14
14
|
:::info
|
|
15
15
|
|
|
16
|
-
For general adapter concepts (constructor options, initialization flow, etc.), see [Server Adapters](/docs/v1/server
|
|
16
|
+
For general adapter concepts (constructor options, initialization flow, etc.), see [Server Adapters](/docs/v1/server/server-adapters).
|
|
17
17
|
|
|
18
18
|
:::
|
|
19
19
|
|
|
@@ -25,8 +25,8 @@ For general adapter concepts (constructor options, initialization flow, etc.), s
|
|
|
25
25
|
|
|
26
26
|
Install the Hono adapter and Hono framework:
|
|
27
27
|
|
|
28
|
-
```bash
|
|
29
|
-
npm install @mastra/hono hono
|
|
28
|
+
```bash
|
|
29
|
+
npm install @mastra/hono@beta hono
|
|
30
30
|
```
|
|
31
31
|
|
|
32
32
|
</StepItem>
|
|
@@ -35,7 +35,7 @@ npm install @mastra/hono hono
|
|
|
35
35
|
|
|
36
36
|
Create your server file:
|
|
37
37
|
|
|
38
|
-
```typescript title="server.ts"
|
|
38
|
+
```typescript title="server.ts"
|
|
39
39
|
import { Hono } from 'hono';
|
|
40
40
|
import { HonoBindings, HonoVariables, MastraServer } from '@mastra/hono';
|
|
41
41
|
import { mastra } from './mastra';
|
|
@@ -54,7 +54,7 @@ export default app;
|
|
|
54
54
|
|
|
55
55
|
## Full example
|
|
56
56
|
|
|
57
|
-
```typescript title="server.ts"
|
|
57
|
+
```typescript title="server.ts"
|
|
58
58
|
import { Hono } from 'hono';
|
|
59
59
|
import { HonoBindings, HonoVariables, MastraServer } from '@mastra/hono';
|
|
60
60
|
import { mastra } from './mastra';
|
|
@@ -147,7 +147,7 @@ export default app;
|
|
|
147
147
|
|
|
148
148
|
Add routes directly to the Hono app:
|
|
149
149
|
|
|
150
|
-
```typescript title="server.ts"
|
|
150
|
+
```typescript title="server.ts"
|
|
151
151
|
import { Hono } from 'hono';
|
|
152
152
|
import { HonoBindings, HonoVariables, MastraServer } from '@mastra/hono';
|
|
153
153
|
|
|
@@ -176,7 +176,7 @@ Routes added before `init()` run without Mastra context. Add routes after `init(
|
|
|
176
176
|
|
|
177
177
|
In Hono middleware and route handlers, access Mastra context via `c.get()`:
|
|
178
178
|
|
|
179
|
-
```typescript
|
|
179
|
+
```typescript
|
|
180
180
|
app.get('/custom', async (c) => {
|
|
181
181
|
const mastra = c.get('mastra');
|
|
182
182
|
const requestContext = c.get('requestContext');
|
|
@@ -203,7 +203,7 @@ Available context keys:
|
|
|
203
203
|
|
|
204
204
|
Add Hono middleware before or after `init()`:
|
|
205
205
|
|
|
206
|
-
```typescript title="server.ts"
|
|
206
|
+
```typescript title="server.ts"
|
|
207
207
|
import { Hono } from 'hono';
|
|
208
208
|
import { HonoBindings, HonoVariables, MastraServer } from '@mastra/hono';
|
|
209
209
|
|
|
@@ -221,14 +221,13 @@ await server.init();
|
|
|
221
221
|
// Middleware after init has access to Mastra context
|
|
222
222
|
app.use('*', async (c, next) => {
|
|
223
223
|
const mastra = c.get('mastra');
|
|
224
|
-
// ...
|
|
225
224
|
await next();
|
|
226
225
|
});
|
|
227
226
|
```
|
|
228
227
|
|
|
229
228
|
## Manual initialization
|
|
230
229
|
|
|
231
|
-
For custom middleware ordering, call each method separately instead of `init()`. See [Server Adapters: Manual initialization](/docs/v1/server
|
|
230
|
+
For custom middleware ordering, call each method separately instead of `init()`. See [Server Adapters: Manual initialization](/docs/v1/server/server-adapters#manual-initialization) for details.
|
|
232
231
|
|
|
233
232
|
## Examples
|
|
234
233
|
|
|
@@ -236,7 +235,7 @@ For custom middleware ordering, call each method separately instead of `init()`.
|
|
|
236
235
|
|
|
237
236
|
## Related
|
|
238
237
|
|
|
239
|
-
- [Server Adapters](/docs/v1/server
|
|
238
|
+
- [Server Adapters](/docs/v1/server/server-adapters) - Shared adapter concepts
|
|
240
239
|
- [Express Adapter](/reference/v1/server/express-adapter) - Alternative adapter
|
|
241
240
|
- [MastraServer Reference](/reference/v1/server/mastra-server) - Full API reference
|
|
242
241
|
- [createRoute() Reference](/reference/v1/server/create-route) - Creating type-safe custom routes
|
|
@@ -11,13 +11,13 @@ The `MastraServer` abstract class is the base for all server adapters. Extend th
|
|
|
11
11
|
|
|
12
12
|
## Import
|
|
13
13
|
|
|
14
|
-
```typescript
|
|
14
|
+
```typescript
|
|
15
15
|
import { MastraServer } from '@mastra/server/server-adapter';
|
|
16
16
|
```
|
|
17
17
|
|
|
18
18
|
## Type parameters
|
|
19
19
|
|
|
20
|
-
```typescript
|
|
20
|
+
```typescript
|
|
21
21
|
MastraServer<TApp, TRequest, TResponse>
|
|
22
22
|
```
|
|
23
23
|
|
|
@@ -29,7 +29,7 @@ MastraServer<TApp, TRequest, TResponse>
|
|
|
29
29
|
|
|
30
30
|
## Constructor
|
|
31
31
|
|
|
32
|
-
```typescript
|
|
32
|
+
```typescript
|
|
33
33
|
constructor(options: MastraServerOptions<TApp>)
|
|
34
34
|
```
|
|
35
35
|
|
|
@@ -119,7 +119,7 @@ These methods must be implemented by adapters:
|
|
|
119
119
|
|
|
120
120
|
Attach Mastra context to every request.
|
|
121
121
|
|
|
122
|
-
```typescript
|
|
122
|
+
```typescript
|
|
123
123
|
abstract registerContextMiddleware(): void
|
|
124
124
|
```
|
|
125
125
|
|
|
@@ -133,7 +133,7 @@ abstract registerContextMiddleware(): void
|
|
|
133
133
|
|
|
134
134
|
Register authentication and authorization middleware.
|
|
135
135
|
|
|
136
|
-
```typescript
|
|
136
|
+
```typescript
|
|
137
137
|
abstract registerAuthMiddleware(): void
|
|
138
138
|
```
|
|
139
139
|
|
|
@@ -141,7 +141,7 @@ abstract registerAuthMiddleware(): void
|
|
|
141
141
|
|
|
142
142
|
Register a single route with the framework.
|
|
143
143
|
|
|
144
|
-
```typescript
|
|
144
|
+
```typescript
|
|
145
145
|
abstract registerRoute(
|
|
146
146
|
app: TApp,
|
|
147
147
|
route: ServerRoute,
|
|
@@ -153,7 +153,7 @@ abstract registerRoute(
|
|
|
153
153
|
|
|
154
154
|
Extract parameters from the request.
|
|
155
155
|
|
|
156
|
-
```typescript
|
|
156
|
+
```typescript
|
|
157
157
|
abstract getParams(
|
|
158
158
|
route: ServerRoute,
|
|
159
159
|
request: TRequest
|
|
@@ -168,7 +168,7 @@ abstract getParams(
|
|
|
168
168
|
|
|
169
169
|
Send response based on route type.
|
|
170
170
|
|
|
171
|
-
```typescript
|
|
171
|
+
```typescript
|
|
172
172
|
abstract sendResponse(
|
|
173
173
|
route: ServerRoute,
|
|
174
174
|
response: TResponse,
|
|
@@ -180,7 +180,7 @@ abstract sendResponse(
|
|
|
180
180
|
|
|
181
181
|
Handle streaming responses.
|
|
182
182
|
|
|
183
|
-
```typescript
|
|
183
|
+
```typescript
|
|
184
184
|
abstract stream(
|
|
185
185
|
route: ServerRoute,
|
|
186
186
|
response: TResponse,
|
|
@@ -194,7 +194,7 @@ abstract stream(
|
|
|
194
194
|
|
|
195
195
|
Initialize the server by registering all middleware and routes.
|
|
196
196
|
|
|
197
|
-
```typescript
|
|
197
|
+
```typescript
|
|
198
198
|
async init(): Promise<void>
|
|
199
199
|
```
|
|
200
200
|
|
|
@@ -207,7 +207,7 @@ Calls in order:
|
|
|
207
207
|
|
|
208
208
|
Register all Mastra routes.
|
|
209
209
|
|
|
210
|
-
```typescript
|
|
210
|
+
```typescript
|
|
211
211
|
async registerRoutes(): Promise<void>
|
|
212
212
|
```
|
|
213
213
|
|
|
@@ -215,7 +215,7 @@ async registerRoutes(): Promise<void>
|
|
|
215
215
|
|
|
216
216
|
Get the framework app instance.
|
|
217
217
|
|
|
218
|
-
```typescript
|
|
218
|
+
```typescript
|
|
219
219
|
getApp<T = TApp>(): T
|
|
220
220
|
```
|
|
221
221
|
|
|
@@ -223,7 +223,7 @@ getApp<T = TApp>(): T
|
|
|
223
223
|
|
|
224
224
|
Validate path parameters with the route's Zod schema.
|
|
225
225
|
|
|
226
|
-
```typescript
|
|
226
|
+
```typescript
|
|
227
227
|
async parsePathParams(
|
|
228
228
|
route: ServerRoute,
|
|
229
229
|
params: Record<string, string>
|
|
@@ -234,7 +234,7 @@ async parsePathParams(
|
|
|
234
234
|
|
|
235
235
|
Validate query parameters with the route's Zod schema.
|
|
236
236
|
|
|
237
|
-
```typescript
|
|
237
|
+
```typescript
|
|
238
238
|
async parseQueryParams(
|
|
239
239
|
route: ServerRoute,
|
|
240
240
|
params: Record<string, string>
|
|
@@ -245,7 +245,7 @@ async parseQueryParams(
|
|
|
245
245
|
|
|
246
246
|
Validate request body with the route's Zod schema.
|
|
247
247
|
|
|
248
|
-
```typescript
|
|
248
|
+
```typescript
|
|
249
249
|
async parseBody(
|
|
250
250
|
route: ServerRoute,
|
|
251
251
|
body: unknown
|
|
@@ -256,7 +256,7 @@ async parseBody(
|
|
|
256
256
|
|
|
257
257
|
Register an endpoint that serves the OpenAPI specification.
|
|
258
258
|
|
|
259
|
-
```typescript
|
|
259
|
+
```typescript
|
|
260
260
|
async registerOpenAPIRoute(
|
|
261
261
|
app: TApp,
|
|
262
262
|
config: OpenAPIConfig,
|
|
@@ -270,7 +270,7 @@ async registerOpenAPIRoute(
|
|
|
270
270
|
|
|
271
271
|
Merge request context from multiple sources (query params and body).
|
|
272
272
|
|
|
273
|
-
```typescript
|
|
273
|
+
```typescript
|
|
274
274
|
protected mergeRequestContext(options: {
|
|
275
275
|
paramsRequestContext?: Record<string, any>;
|
|
276
276
|
bodyRequestContext?: Record<string, any>;
|
|
@@ -281,7 +281,7 @@ protected mergeRequestContext(options: {
|
|
|
281
281
|
|
|
282
282
|
### BodyLimitOptions
|
|
283
283
|
|
|
284
|
-
```typescript
|
|
284
|
+
```typescript
|
|
285
285
|
interface BodyLimitOptions {
|
|
286
286
|
maxSize: number;
|
|
287
287
|
onError: (error: unknown) => unknown;
|
|
@@ -290,7 +290,7 @@ interface BodyLimitOptions {
|
|
|
290
290
|
|
|
291
291
|
### StreamOptions
|
|
292
292
|
|
|
293
|
-
```typescript
|
|
293
|
+
```typescript
|
|
294
294
|
interface StreamOptions {
|
|
295
295
|
redact?: boolean;
|
|
296
296
|
}
|
|
@@ -298,7 +298,7 @@ interface StreamOptions {
|
|
|
298
298
|
|
|
299
299
|
## Example
|
|
300
300
|
|
|
301
|
-
```typescript
|
|
301
|
+
```typescript
|
|
302
302
|
import { MastraServer, ServerRoute } from '@mastra/server/server-adapter';
|
|
303
303
|
import type { Mastra } from '@mastra/core';
|
|
304
304
|
|
|
@@ -340,6 +340,6 @@ export class MyServer extends MastraServer<MyApp, MyRequest, MyResponse> {
|
|
|
340
340
|
|
|
341
341
|
## Related
|
|
342
342
|
|
|
343
|
-
- [Server Adapters](/docs/v1/server
|
|
344
|
-
- [Custom Adapters](/docs/v1/server
|
|
343
|
+
- [Server Adapters](/docs/v1/server/server-adapters) - Using adapters
|
|
344
|
+
- [Custom Adapters](/docs/v1/server/custom-adapters) - Creating custom adapters
|
|
345
345
|
- [createRoute()](/reference/v1/server/create-route) - Creating custom routes
|
|
@@ -58,16 +58,43 @@ Server adapters register these routes when you call `server.init()`. All routes
|
|
|
58
58
|
|--------|------|-------------|
|
|
59
59
|
| `GET` | `/api/workflows` | List all workflows |
|
|
60
60
|
| `GET` | `/api/workflows/:workflowId` | Get workflow by ID |
|
|
61
|
+
| `POST` | `/api/workflows/:workflowId/create-run` | Create a new workflow run |
|
|
62
|
+
| `POST` | `/api/workflows/:workflowId/start-async` | Start workflow and await result |
|
|
61
63
|
| `POST` | `/api/workflows/:workflowId/stream` | Stream workflow execution |
|
|
62
64
|
| `POST` | `/api/workflows/:workflowId/resume` | Resume suspended workflow |
|
|
63
65
|
| `POST` | `/api/workflows/:workflowId/resume-async` | Resume asynchronously |
|
|
64
66
|
| `GET` | `/api/workflows/:workflowId/runs` | List workflow runs |
|
|
65
67
|
| `GET` | `/api/workflows/:workflowId/runs/:runId` | Get specific run |
|
|
66
68
|
|
|
69
|
+
### Create run request body
|
|
70
|
+
|
|
71
|
+
```typescript
|
|
72
|
+
{
|
|
73
|
+
resourceId?: string; // Associate run with a resource (e.g., user ID)
|
|
74
|
+
disableScorers?: boolean; // Disable scorers for this run
|
|
75
|
+
}
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### Start-async request body
|
|
79
|
+
|
|
80
|
+
```typescript
|
|
81
|
+
{
|
|
82
|
+
resourceId?: string; // Associate run with a resource (e.g., user ID)
|
|
83
|
+
inputData?: unknown;
|
|
84
|
+
initialState?: unknown;
|
|
85
|
+
requestContext?: Record<string, unknown>;
|
|
86
|
+
tracingOptions?: {
|
|
87
|
+
spanName?: string;
|
|
88
|
+
attributes?: Record<string, unknown>;
|
|
89
|
+
};
|
|
90
|
+
}
|
|
91
|
+
```
|
|
92
|
+
|
|
67
93
|
### Stream workflow request body
|
|
68
94
|
|
|
69
95
|
```typescript
|
|
70
96
|
{
|
|
97
|
+
resourceId?: string; // Associate run with a resource (e.g., user ID)
|
|
71
98
|
inputData?: unknown;
|
|
72
99
|
initialState?: unknown;
|
|
73
100
|
requestContext?: Record<string, unknown>;
|
|
@@ -247,4 +274,4 @@ Common status codes:
|
|
|
247
274
|
## Related
|
|
248
275
|
|
|
249
276
|
- [createRoute()](/reference/v1/server/create-route) - Creating custom routes
|
|
250
|
-
- [Server Adapters](/docs/v1/server
|
|
277
|
+
- [Server Adapters](/docs/v1/server/server-adapters) - Using adapters
|
|
@@ -15,7 +15,7 @@ npm install @mastra/cloudflare-d1@beta
|
|
|
15
15
|
|
|
16
16
|
## Usage
|
|
17
17
|
|
|
18
|
-
```typescript
|
|
18
|
+
```typescript
|
|
19
19
|
import { D1Store } from "@mastra/cloudflare-d1";
|
|
20
20
|
|
|
21
21
|
type Env = {
|
|
@@ -99,7 +99,7 @@ The storage implementation handles schema creation and updates automatically. It
|
|
|
99
99
|
|
|
100
100
|
When you pass storage to the Mastra class, `init()` is called automatically before any storage operation:
|
|
101
101
|
|
|
102
|
-
```typescript
|
|
102
|
+
```typescript
|
|
103
103
|
import { Mastra } from "@mastra/core";
|
|
104
104
|
import { D1Store } from "@mastra/cloudflare-d1";
|
|
105
105
|
|
|
@@ -114,7 +114,7 @@ const mastra = new Mastra({
|
|
|
114
114
|
|
|
115
115
|
If you're using storage directly without Mastra, you must call `init()` explicitly to create the tables:
|
|
116
116
|
|
|
117
|
-
```typescript
|
|
117
|
+
```typescript
|
|
118
118
|
import { D1Store } from "@mastra/cloudflare-d1";
|
|
119
119
|
|
|
120
120
|
const storage = new D1Store({
|
|
@@ -9,13 +9,13 @@ The Cloudflare KV storage implementation provides a globally distributed, server
|
|
|
9
9
|
|
|
10
10
|
## Installation
|
|
11
11
|
|
|
12
|
-
```bash
|
|
12
|
+
```bash
|
|
13
13
|
npm install @mastra/cloudflare@beta
|
|
14
14
|
```
|
|
15
15
|
|
|
16
16
|
## Usage
|
|
17
17
|
|
|
18
|
-
```typescript
|
|
18
|
+
```typescript
|
|
19
19
|
import { CloudflareStore } from "@mastra/cloudflare";
|
|
20
20
|
|
|
21
21
|
// --- Example 1: Using Workers Binding ---
|
|
@@ -9,7 +9,7 @@ The Convex storage implementation provides a serverless storage solution using [
|
|
|
9
9
|
|
|
10
10
|
## Installation
|
|
11
11
|
|
|
12
|
-
```bash
|
|
12
|
+
```bash
|
|
13
13
|
npm install @mastra/convex@beta
|
|
14
14
|
```
|
|
15
15
|
|
|
@@ -21,7 +21,7 @@ Before using `ConvexStore`, you need to set up the Convex schema and storage han
|
|
|
21
21
|
|
|
22
22
|
In `convex/schema.ts`:
|
|
23
23
|
|
|
24
|
-
```typescript
|
|
24
|
+
```typescript
|
|
25
25
|
import { defineSchema } from 'convex/server';
|
|
26
26
|
import {
|
|
27
27
|
mastraThreadsTable,
|
|
@@ -32,7 +32,7 @@ import {
|
|
|
32
32
|
mastraVectorIndexesTable,
|
|
33
33
|
mastraVectorsTable,
|
|
34
34
|
mastraDocumentsTable,
|
|
35
|
-
} from '@mastra/convex/
|
|
35
|
+
} from '@mastra/convex/schema';
|
|
36
36
|
|
|
37
37
|
export default defineSchema({
|
|
38
38
|
mastra_threads: mastraThreadsTable,
|
|
@@ -50,7 +50,7 @@ export default defineSchema({
|
|
|
50
50
|
|
|
51
51
|
In `convex/mastra/storage.ts`:
|
|
52
52
|
|
|
53
|
-
```typescript
|
|
53
|
+
```typescript
|
|
54
54
|
import { mastraStorage } from '@mastra/convex/server';
|
|
55
55
|
|
|
56
56
|
export const handle = mastraStorage;
|
|
@@ -58,7 +58,7 @@ export const handle = mastraStorage;
|
|
|
58
58
|
|
|
59
59
|
### 3. Deploy to Convex
|
|
60
60
|
|
|
61
|
-
```bash
|
|
61
|
+
```bash
|
|
62
62
|
npx convex dev
|
|
63
63
|
# or for production
|
|
64
64
|
npx convex deploy
|
|
@@ -66,7 +66,7 @@ npx convex deploy
|
|
|
66
66
|
|
|
67
67
|
## Usage
|
|
68
68
|
|
|
69
|
-
```typescript
|
|
69
|
+
```typescript
|
|
70
70
|
import { ConvexStore } from "@mastra/convex";
|
|
71
71
|
|
|
72
72
|
const storage = new ConvexStore({
|
|
@@ -18,7 +18,7 @@ The DynamoDB storage implementation provides a scalable and performant NoSQL dat
|
|
|
18
18
|
|
|
19
19
|
## Installation
|
|
20
20
|
|
|
21
|
-
```bash
|
|
21
|
+
```bash
|
|
22
22
|
npm install @mastra/dynamodb@beta
|
|
23
23
|
# or
|
|
24
24
|
pnpm add @mastra/dynamodb@beta
|
|
@@ -36,7 +36,7 @@ Detailed instructions for setting up the table using AWS CloudFormation or AWS C
|
|
|
36
36
|
|
|
37
37
|
### Basic Usage
|
|
38
38
|
|
|
39
|
-
```typescript
|
|
39
|
+
```typescript
|
|
40
40
|
import { Memory } from "@mastra/memory";
|
|
41
41
|
import { DynamoDBStore } from "@mastra/dynamodb";
|
|
42
42
|
|
|
@@ -72,7 +72,7 @@ For local development, you can use [DynamoDB Local](https://docs.aws.amazon.com/
|
|
|
72
72
|
|
|
73
73
|
2. **Configure `DynamoDBStore` to use the local endpoint:**
|
|
74
74
|
|
|
75
|
-
```typescript copy
|
|
75
|
+
```typescript copy
|
|
76
76
|
import { DynamoDBStore } from "@mastra/dynamodb";
|
|
77
77
|
|
|
78
78
|
const storage = new DynamoDBStore({
|
|
@@ -134,7 +134,7 @@ For local development, you can use [DynamoDB Local](https://docs.aws.amazon.com/
|
|
|
134
134
|
|
|
135
135
|
The IAM role or user executing the code needs appropriate permissions to interact with the specified DynamoDB table and its indexes. Below is a sample policy. Replace `${YOUR_TABLE_NAME}` with your actual table name and `${YOUR_AWS_REGION}` and `${YOUR_AWS_ACCOUNT_ID}` with appropriate values.
|
|
136
136
|
|
|
137
|
-
```json
|
|
137
|
+
```json
|
|
138
138
|
{
|
|
139
139
|
"Version": "2012-10-17",
|
|
140
140
|
"Statement": [
|
|
@@ -17,7 +17,7 @@ npm install @mastra/lance@beta
|
|
|
17
17
|
|
|
18
18
|
### Basic Storage Usage
|
|
19
19
|
|
|
20
|
-
```typescript
|
|
20
|
+
```typescript
|
|
21
21
|
import { LanceStorage } from "@mastra/lance";
|
|
22
22
|
|
|
23
23
|
// Connect to a local database
|
|
@@ -77,7 +77,7 @@ The LanceStorage implementation automatically handles schema creation and update
|
|
|
77
77
|
|
|
78
78
|
When you pass storage to the Mastra class, `init()` is called automatically before any storage operation:
|
|
79
79
|
|
|
80
|
-
```typescript
|
|
80
|
+
```typescript
|
|
81
81
|
import { Mastra } from "@mastra/core";
|
|
82
82
|
import { LanceStorage } from "@mastra/lance";
|
|
83
83
|
|
|
@@ -90,7 +90,7 @@ const mastra = new Mastra({
|
|
|
90
90
|
|
|
91
91
|
If you're using storage directly without Mastra, you must call `init()` explicitly to create the tables:
|
|
92
92
|
|
|
93
|
-
```typescript
|
|
93
|
+
```typescript
|
|
94
94
|
import { LanceStorage } from "@mastra/lance";
|
|
95
95
|
|
|
96
96
|
const storage = await LanceStorage.create("my-storage", "/path/to/db");
|