@mastra/mcp-docs-server 0.0.0-error-handler-fix-20251020202607 → 0.0.0-execa-dynamic-import-20260304221256
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/course/01-first-agent/04-project-structure.md +19 -0
- package/.docs/course/01-first-agent/05-running-playground.md +19 -0
- package/.docs/course/01-first-agent/07-creating-your-agent.md +50 -0
- package/.docs/course/01-first-agent/08-exporting-your-agent.md +34 -0
- package/.docs/course/01-first-agent/09-testing-your-agent.md +12 -0
- package/.docs/course/01-first-agent/11-creating-transactions-tool.md +41 -0
- package/.docs/course/01-first-agent/12-connecting-tool-to-agent.md +29 -0
- package/.docs/course/01-first-agent/13-testing-your-tool.md +15 -0
- package/.docs/course/01-first-agent/15-installing-memory.md +13 -0
- package/.docs/course/01-first-agent/16-adding-memory-to-agent.md +33 -0
- package/.docs/course/01-first-agent/17-testing-memory.md +15 -0
- package/.docs/course/02-agent-tools-mcp/03-setting-up-mcp-configuration.md +21 -0
- package/.docs/course/02-agent-tools-mcp/04-initializing-mcp-tools.md +11 -0
- package/.docs/course/02-agent-tools-mcp/05-updating-your-agent.md +20 -0
- package/.docs/course/02-agent-tools-mcp/07-what-is-zapier-mcp.md +23 -0
- package/.docs/course/02-agent-tools-mcp/08-getting-zapier-mcp-url.md +21 -0
- package/.docs/course/02-agent-tools-mcp/09-updating-mcp-config-zapier.md +29 -0
- package/.docs/course/02-agent-tools-mcp/10-updating-agent-instructions-zapier.md +29 -0
- package/.docs/course/02-agent-tools-mcp/12-troubleshooting-zapier.md +19 -0
- package/.docs/course/02-agent-tools-mcp/13-what-is-github-mcp.md +14 -0
- package/.docs/course/02-agent-tools-mcp/14-getting-github-mcp-url.md +40 -0
- package/.docs/course/02-agent-tools-mcp/15-updating-mcp-config-github.md +36 -0
- package/.docs/course/02-agent-tools-mcp/16-updating-agent-instructions-github.md +33 -0
- package/.docs/course/02-agent-tools-mcp/18-troubleshooting-github.md +17 -0
- package/.docs/course/02-agent-tools-mcp/20-updating-mcp-config-hackernews.md +36 -0
- package/.docs/course/02-agent-tools-mcp/21-updating-agent-instructions-hackernews.md +38 -0
- package/.docs/course/02-agent-tools-mcp/26-updating-mcp-config-filesystem.md +43 -0
- package/.docs/course/02-agent-tools-mcp/27-updating-agent-instructions-filesystem.md +45 -0
- package/.docs/course/02-agent-tools-mcp/31-enhancing-memory-configuration.md +78 -0
- package/.docs/course/02-agent-tools-mcp/32-conclusion.md +17 -0
- package/.docs/course/03-agent-memory/03-installing-memory.md +13 -0
- package/.docs/course/03-agent-memory/04-creating-basic-memory-agent.md +36 -0
- package/.docs/course/03-agent-memory/05-updating-mastra-export.md +18 -0
- package/.docs/course/03-agent-memory/07-understanding-memory-threads.md +49 -0
- package/.docs/course/03-agent-memory/08-configuring-conversation-history.md +36 -0
- package/.docs/course/03-agent-memory/09-using-memory-in-application.md +19 -0
- package/.docs/course/03-agent-memory/10-storage-configuration.md +29 -0
- package/.docs/course/03-agent-memory/12-handling-memory-frontend.md +62 -0
- package/.docs/course/03-agent-memory/13-vector-store-configuration.md +29 -0
- package/.docs/course/03-agent-memory/16-configuring-semantic-recall.md +42 -0
- package/.docs/course/03-agent-memory/18-advanced-configuration-semantic-recall.md +29 -0
- package/.docs/course/03-agent-memory/21-configuring-working-memory.md +64 -0
- package/.docs/course/03-agent-memory/22-custom-working-memory-templates.md +89 -0
- package/.docs/course/03-agent-memory/25-combining-memory-features.md +80 -0
- package/.docs/course/03-agent-memory/26-updating-mastra-export-comprehensive.md +0 -0
- package/.docs/course/03-agent-memory/27-creating-learning-assistant.md +103 -0
- package/.docs/course/04-workflows/01-introduction-to-workflows.md +44 -0
- package/.docs/course/04-workflows/02-understanding-steps.md +53 -0
- package/.docs/course/04-workflows/03-creating-your-first-step.md +57 -0
- package/.docs/course/04-workflows/04-creating-a-second-step.md +58 -0
- package/.docs/course/04-workflows/05-chaining-steps-together.md +57 -0
- package/.docs/course/04-workflows/06-registering-with-mastra.md +24 -0
- package/.docs/course/04-workflows/07-using-playground.md +58 -0
- package/.docs/course/04-workflows/08-running-workflows-programmatically.md +73 -0
- package/.docs/course/04-workflows/09-adding-a-third-step.md +68 -0
- package/.docs/course/04-workflows/10-updating-the-workflow.md +55 -0
- package/.docs/course/04-workflows/11-creating-an-ai-agent.md +66 -0
- package/.docs/course/04-workflows/12-using-agent-in-workflow.md +89 -0
- package/.docs/course/04-workflows/13-creating-ai-enhanced-workflow.md +72 -0
- package/.docs/course/04-workflows/14-understanding-parallel-execution.md +38 -0
- package/.docs/course/04-workflows/15-creating-parallel-steps.md +111 -0
- package/.docs/course/04-workflows/16-building-parallel-workflow.md +100 -0
- package/.docs/course/04-workflows/17-testing-parallel-performance.md +36 -0
- package/.docs/course/04-workflows/18-understanding-conditional-branching.md +61 -0
- package/.docs/course/04-workflows/19-creating-conditional-steps.md +124 -0
- package/.docs/course/04-workflows/20-building-conditional-workflow.md +55 -0
- package/.docs/course/04-workflows/21-testing-conditional-logic.md +58 -0
- package/.docs/docs/agents/adding-voice.md +349 -0
- package/.docs/docs/agents/agent-approval.md +588 -0
- package/.docs/docs/agents/agent-memory.md +209 -0
- package/.docs/docs/agents/guardrails.md +374 -0
- package/.docs/docs/agents/network-approval.md +275 -0
- package/.docs/docs/agents/networks.md +299 -0
- package/.docs/docs/agents/overview.md +304 -0
- package/.docs/docs/agents/processors.md +622 -0
- package/.docs/docs/agents/structured-output.md +273 -0
- package/.docs/docs/agents/supervisor-agents.md +304 -0
- package/.docs/docs/agents/using-tools.md +248 -0
- package/.docs/docs/build-with-ai/mcp-docs-server.md +238 -0
- package/.docs/docs/build-with-ai/skills.md +35 -0
- package/.docs/docs/community/contributing-templates.md +3 -0
- package/.docs/docs/community/discord.md +9 -0
- package/.docs/docs/community/licensing.md +66 -0
- package/.docs/docs/deployment/cloud-providers.md +15 -0
- package/.docs/docs/deployment/mastra-server.md +122 -0
- package/.docs/docs/deployment/monorepo.md +142 -0
- package/.docs/docs/deployment/overview.md +62 -0
- package/.docs/docs/deployment/studio.md +247 -0
- package/.docs/docs/deployment/web-framework.md +52 -0
- package/.docs/docs/deployment/workflow-runners.md +9 -0
- package/.docs/docs/evals/built-in-scorers.md +47 -0
- package/.docs/docs/evals/custom-scorers.md +519 -0
- package/.docs/docs/evals/overview.md +141 -0
- package/.docs/docs/evals/running-in-ci.md +124 -0
- package/.docs/docs/getting-started/build-with-ai.md +68 -0
- package/.docs/docs/getting-started/manual-install.md +226 -0
- package/.docs/docs/getting-started/project-structure.md +60 -0
- package/.docs/docs/getting-started/start.md +28 -0
- package/.docs/docs/getting-started/studio.md +101 -0
- package/.docs/docs/index.md +43 -0
- package/.docs/docs/mastra-cloud/deployment.md +77 -0
- package/.docs/docs/mastra-cloud/observability.md +38 -0
- package/.docs/docs/mastra-cloud/overview.md +23 -0
- package/.docs/docs/mastra-cloud/setup.md +42 -0
- package/.docs/docs/mastra-cloud/studio.md +24 -0
- package/.docs/docs/mcp/overview.md +373 -0
- package/.docs/docs/mcp/publishing-mcp-server.md +95 -0
- package/.docs/docs/memory/memory-processors.md +314 -0
- package/.docs/docs/memory/message-history.md +260 -0
- package/.docs/docs/memory/observational-memory.md +255 -0
- package/.docs/docs/memory/overview.md +45 -0
- package/.docs/docs/memory/semantic-recall.md +288 -0
- package/.docs/docs/memory/storage.md +261 -0
- package/.docs/docs/memory/working-memory.md +400 -0
- package/.docs/docs/observability/datasets/overview.md +198 -0
- package/.docs/docs/observability/datasets/running-experiments.md +274 -0
- package/.docs/docs/observability/logging.md +99 -0
- package/.docs/docs/observability/overview.md +70 -0
- package/.docs/docs/observability/tracing/bridges/otel.md +209 -0
- package/.docs/docs/observability/tracing/exporters/arize.md +272 -0
- package/.docs/docs/observability/tracing/exporters/braintrust.md +111 -0
- package/.docs/docs/observability/tracing/exporters/cloud.md +127 -0
- package/.docs/docs/observability/tracing/exporters/datadog.md +187 -0
- package/.docs/docs/observability/tracing/exporters/default.md +209 -0
- package/.docs/docs/observability/tracing/exporters/laminar.md +100 -0
- package/.docs/docs/observability/tracing/exporters/langfuse.md +213 -0
- package/.docs/docs/observability/tracing/exporters/langsmith.md +198 -0
- package/.docs/docs/observability/tracing/exporters/otel.md +476 -0
- package/.docs/docs/observability/tracing/exporters/posthog.md +148 -0
- package/.docs/docs/observability/tracing/exporters/sentry.md +208 -0
- package/.docs/docs/observability/tracing/overview.md +1112 -0
- package/.docs/docs/observability/tracing/processors/sensitive-data-filter.md +300 -0
- package/.docs/docs/rag/chunking-and-embedding.md +183 -0
- package/.docs/docs/rag/graph-rag.md +215 -0
- package/.docs/docs/rag/overview.md +72 -0
- package/.docs/docs/rag/retrieval.md +515 -0
- package/.docs/docs/rag/vector-databases.md +645 -0
- package/.docs/docs/server/auth/auth0.md +220 -0
- package/.docs/docs/server/auth/better-auth.md +220 -0
- package/.docs/docs/server/auth/clerk.md +132 -0
- package/.docs/docs/server/auth/composite-auth.md +234 -0
- package/.docs/docs/server/auth/custom-auth-provider.md +513 -0
- package/.docs/docs/server/auth/firebase.md +272 -0
- package/.docs/docs/server/auth/jwt.md +110 -0
- package/.docs/docs/server/auth/simple-auth.md +180 -0
- package/.docs/docs/server/auth/supabase.md +117 -0
- package/.docs/docs/server/auth/workos.md +186 -0
- package/.docs/docs/server/auth.md +38 -0
- package/.docs/docs/server/custom-adapters.md +378 -0
- package/.docs/docs/server/custom-api-routes.md +267 -0
- package/.docs/docs/server/mastra-client.md +243 -0
- package/.docs/docs/server/mastra-server.md +71 -0
- package/.docs/docs/server/middleware.md +225 -0
- package/.docs/docs/server/request-context.md +471 -0
- package/.docs/docs/server/server-adapters.md +547 -0
- package/.docs/docs/streaming/events.md +237 -0
- package/.docs/docs/streaming/overview.md +175 -0
- package/.docs/docs/streaming/tool-streaming.md +175 -0
- package/.docs/docs/streaming/workflow-streaming.md +109 -0
- package/.docs/docs/voice/overview.md +959 -0
- package/.docs/docs/voice/speech-to-speech.md +102 -0
- package/.docs/docs/voice/speech-to-text.md +79 -0
- package/.docs/docs/voice/text-to-speech.md +83 -0
- package/.docs/docs/workflows/agents-and-tools.md +166 -0
- package/.docs/docs/workflows/control-flow.md +822 -0
- package/.docs/docs/workflows/error-handling.md +360 -0
- package/.docs/docs/workflows/human-in-the-loop.md +215 -0
- package/.docs/docs/workflows/overview.md +370 -0
- package/.docs/docs/workflows/snapshots.md +238 -0
- package/.docs/docs/workflows/suspend-and-resume.md +205 -0
- package/.docs/docs/workflows/time-travel.md +309 -0
- package/.docs/docs/workflows/workflow-state.md +181 -0
- package/.docs/docs/workspace/filesystem.md +164 -0
- package/.docs/docs/workspace/overview.md +239 -0
- package/.docs/docs/workspace/sandbox.md +65 -0
- package/.docs/docs/workspace/search.md +243 -0
- package/.docs/docs/workspace/skills.md +169 -0
- package/.docs/guides/agent-frameworks/ai-sdk.md +140 -0
- package/.docs/guides/build-your-ui/ai-sdk-ui.md +1499 -0
- package/.docs/guides/build-your-ui/assistant-ui.md +156 -0
- package/.docs/guides/build-your-ui/copilotkit.md +289 -0
- package/.docs/guides/deployment/amazon-ec2.md +130 -0
- package/.docs/guides/deployment/aws-lambda.md +248 -0
- package/.docs/guides/deployment/azure-app-services.md +114 -0
- package/.docs/guides/deployment/cloudflare.md +99 -0
- package/.docs/guides/deployment/digital-ocean.md +168 -0
- package/.docs/guides/deployment/inngest.md +682 -0
- package/.docs/guides/deployment/netlify.md +77 -0
- package/.docs/guides/deployment/vercel.md +120 -0
- package/.docs/guides/getting-started/astro.md +398 -0
- package/.docs/guides/getting-started/electron.md +504 -0
- package/.docs/guides/getting-started/express.md +251 -0
- package/.docs/guides/getting-started/hono.md +190 -0
- package/.docs/guides/getting-started/next-js.md +347 -0
- package/.docs/guides/getting-started/nuxt.md +497 -0
- package/.docs/guides/getting-started/quickstart.md +67 -0
- package/.docs/guides/getting-started/sveltekit.md +296 -0
- package/.docs/guides/getting-started/vite-react.md +425 -0
- package/.docs/guides/guide/ai-recruiter.md +226 -0
- package/.docs/guides/guide/chef-michel.md +211 -0
- package/.docs/guides/guide/code-review-bot.md +226 -0
- package/.docs/guides/guide/dev-assistant.md +307 -0
- package/.docs/guides/guide/docs-manager.md +238 -0
- package/.docs/guides/guide/github-actions-pr-description.md +236 -0
- package/.docs/guides/guide/notes-mcp-server.md +416 -0
- package/.docs/guides/guide/research-assistant.md +348 -0
- package/.docs/guides/guide/research-coordinator.md +416 -0
- package/.docs/guides/guide/stock-agent.md +132 -0
- package/.docs/guides/guide/web-search.md +320 -0
- package/.docs/guides/guide/whatsapp-chat-bot.md +405 -0
- package/.docs/guides/index.md +22 -0
- package/.docs/guides/migrations/agentnetwork.md +97 -0
- package/.docs/guides/migrations/ai-sdk-v4-to-v5.md +112 -0
- package/.docs/guides/migrations/network-to-supervisor.md +261 -0
- package/.docs/guides/migrations/upgrade-to-v1/agent.md +404 -0
- package/.docs/guides/migrations/upgrade-to-v1/cli.md +57 -0
- package/.docs/guides/migrations/upgrade-to-v1/client.md +337 -0
- package/.docs/guides/migrations/upgrade-to-v1/deployment.md +37 -0
- package/.docs/guides/migrations/upgrade-to-v1/evals.md +239 -0
- package/.docs/guides/migrations/upgrade-to-v1/mastra.md +143 -0
- package/.docs/guides/migrations/upgrade-to-v1/mcp.md +97 -0
- package/.docs/guides/migrations/upgrade-to-v1/memory.md +285 -0
- package/.docs/guides/migrations/upgrade-to-v1/overview.md +119 -0
- package/.docs/guides/migrations/upgrade-to-v1/processors.md +68 -0
- package/.docs/guides/migrations/upgrade-to-v1/rag.md +42 -0
- package/.docs/guides/migrations/upgrade-to-v1/storage.md +553 -0
- package/.docs/guides/migrations/upgrade-to-v1/tools.md +180 -0
- package/.docs/guides/migrations/upgrade-to-v1/tracing.md +412 -0
- package/.docs/guides/migrations/upgrade-to-v1/vectors.md +87 -0
- package/.docs/guides/migrations/upgrade-to-v1/voice.md +30 -0
- package/.docs/guides/migrations/upgrade-to-v1/workflows.md +341 -0
- package/.docs/guides/migrations/vnext-to-standard-apis.md +362 -0
- package/.docs/models/embeddings.md +161 -0
- package/.docs/models/gateways/azure-openai.md +128 -0
- package/.docs/models/gateways/custom-gateways.md +545 -0
- package/.docs/models/gateways/netlify.md +93 -0
- package/.docs/models/gateways/openrouter.md +222 -0
- package/.docs/models/gateways/vercel.md +235 -0
- package/.docs/models/gateways.md +14 -0
- package/.docs/models/index.md +286 -0
- package/.docs/models/providers/302ai.md +134 -0
- package/.docs/models/providers/abacus.md +125 -0
- package/.docs/models/providers/agentrouter.md +90 -0
- package/.docs/models/providers/aihubmix.md +113 -0
- package/.docs/models/providers/alibaba-cn.md +135 -0
- package/.docs/models/providers/alibaba.md +111 -0
- package/.docs/models/providers/amazon-bedrock.md +33 -0
- package/.docs/models/providers/anthropic.md +154 -0
- package/.docs/models/providers/azure.md +33 -0
- package/.docs/models/providers/bailing.md +72 -0
- package/.docs/models/providers/baseten.md +79 -0
- package/.docs/models/providers/berget.md +78 -0
- package/.docs/models/providers/cerebras.md +101 -0
- package/.docs/models/providers/chutes.md +137 -0
- package/.docs/models/providers/cloudferro-sherlock.md +74 -0
- package/.docs/models/providers/cloudflare-ai-gateway.md +33 -0
- package/.docs/models/providers/cloudflare-workers-ai.md +109 -0
- package/.docs/models/providers/cohere.md +33 -0
- package/.docs/models/providers/cortecs.md +91 -0
- package/.docs/models/providers/deepinfra.md +112 -0
- package/.docs/models/providers/deepseek.md +88 -0
- package/.docs/models/providers/evroc.md +83 -0
- package/.docs/models/providers/fastrouter.md +84 -0
- package/.docs/models/providers/fireworks-ai.md +83 -0
- package/.docs/models/providers/firmware.md +86 -0
- package/.docs/models/providers/friendli.md +77 -0
- package/.docs/models/providers/github-models.md +125 -0
- package/.docs/models/providers/google-vertex.md +33 -0
- package/.docs/models/providers/google.md +161 -0
- package/.docs/models/providers/groq.md +107 -0
- package/.docs/models/providers/helicone.md +161 -0
- package/.docs/models/providers/huggingface.md +90 -0
- package/.docs/models/providers/iflowcn.md +84 -0
- package/.docs/models/providers/inception.md +72 -0
- package/.docs/models/providers/inference.md +79 -0
- package/.docs/models/providers/io-intelligence.md +87 -0
- package/.docs/models/providers/io-net.md +87 -0
- package/.docs/models/providers/jiekou.md +131 -0
- package/.docs/models/providers/kilo.md +333 -0
- package/.docs/models/providers/kimi-for-coding.md +100 -0
- package/.docs/models/providers/kuae-cloud-coding-plan.md +71 -0
- package/.docs/models/providers/llama.md +77 -0
- package/.docs/models/providers/lmstudio.md +73 -0
- package/.docs/models/providers/lucidquery.md +72 -0
- package/.docs/models/providers/meganova.md +89 -0
- package/.docs/models/providers/minimax-cn-coding-plan.md +102 -0
- package/.docs/models/providers/minimax-cn.md +102 -0
- package/.docs/models/providers/minimax-coding-plan.md +102 -0
- package/.docs/models/providers/minimax.md +104 -0
- package/.docs/models/providers/mistral.md +124 -0
- package/.docs/models/providers/moark.md +72 -0
- package/.docs/models/providers/modelscope.md +77 -0
- package/.docs/models/providers/moonshotai-cn.md +76 -0
- package/.docs/models/providers/moonshotai.md +76 -0
- package/.docs/models/providers/morph.md +73 -0
- package/.docs/models/providers/nano-gpt.md +103 -0
- package/.docs/models/providers/nebius.md +116 -0
- package/.docs/models/providers/nova.md +72 -0
- package/.docs/models/providers/novita-ai.md +154 -0
- package/.docs/models/providers/nvidia.md +141 -0
- package/.docs/models/providers/ollama-cloud.md +103 -0
- package/.docs/models/providers/ollama.md +33 -0
- package/.docs/models/providers/openai.md +193 -0
- package/.docs/models/providers/opencode-go.md +73 -0
- package/.docs/models/providers/opencode.md +100 -0
- package/.docs/models/providers/ovhcloud.md +83 -0
- package/.docs/models/providers/perplexity-agent.md +113 -0
- package/.docs/models/providers/perplexity.md +101 -0
- package/.docs/models/providers/poe.md +184 -0
- package/.docs/models/providers/privatemode-ai.md +75 -0
- package/.docs/models/providers/qihang-ai.md +79 -0
- package/.docs/models/providers/qiniu-ai.md +146 -0
- package/.docs/models/providers/requesty.md +90 -0
- package/.docs/models/providers/scaleway.md +84 -0
- package/.docs/models/providers/siliconflow-cn.md +142 -0
- package/.docs/models/providers/siliconflow.md +140 -0
- package/.docs/models/providers/stackit.md +78 -0
- package/.docs/models/providers/stepfun.md +73 -0
- package/.docs/models/providers/submodel.md +79 -0
- package/.docs/models/providers/synthetic.md +96 -0
- package/.docs/models/providers/togetherai.md +116 -0
- package/.docs/models/providers/upstage.md +73 -0
- package/.docs/models/providers/venice.md +95 -0
- package/.docs/models/providers/vivgrid.md +106 -0
- package/.docs/models/providers/vultr.md +75 -0
- package/.docs/models/providers/wandb.md +80 -0
- package/.docs/models/providers/xai.md +141 -0
- package/.docs/models/providers/xiaomi.md +71 -0
- package/.docs/models/providers/zai-coding-plan.md +80 -0
- package/.docs/models/providers/zai.md +79 -0
- package/.docs/models/providers/zenmux.md +165 -0
- package/.docs/models/providers/zhipuai-coding-plan.md +79 -0
- package/.docs/models/providers/zhipuai.md +79 -0
- package/.docs/models/providers.md +88 -0
- package/.docs/reference/agents/agent.md +141 -0
- package/.docs/reference/agents/generate.md +186 -0
- package/.docs/reference/agents/generateLegacy.md +173 -0
- package/.docs/reference/agents/getDefaultGenerateOptions.md +36 -0
- package/.docs/reference/agents/getDefaultOptions.md +34 -0
- package/.docs/reference/agents/getDefaultStreamOptions.md +36 -0
- package/.docs/reference/agents/getDescription.md +21 -0
- package/.docs/reference/agents/getInstructions.md +34 -0
- package/.docs/reference/agents/getLLM.md +37 -0
- package/.docs/reference/agents/getMemory.md +34 -0
- package/.docs/reference/agents/getModel.md +34 -0
- package/.docs/reference/agents/getTools.md +29 -0
- package/.docs/reference/agents/getVoice.md +34 -0
- package/.docs/reference/agents/listAgents.md +35 -0
- package/.docs/reference/agents/listScorers.md +34 -0
- package/.docs/reference/agents/listTools.md +34 -0
- package/.docs/reference/agents/listWorkflows.md +34 -0
- package/.docs/reference/agents/network.md +170 -0
- package/.docs/reference/ai-sdk/chat-route.md +82 -0
- package/.docs/reference/ai-sdk/handle-chat-stream.md +53 -0
- package/.docs/reference/ai-sdk/handle-network-stream.md +37 -0
- package/.docs/reference/ai-sdk/handle-workflow-stream.md +55 -0
- package/.docs/reference/ai-sdk/network-route.md +74 -0
- package/.docs/reference/ai-sdk/to-ai-sdk-stream.md +231 -0
- package/.docs/reference/ai-sdk/to-ai-sdk-v4-messages.md +79 -0
- package/.docs/reference/ai-sdk/to-ai-sdk-v5-messages.md +76 -0
- package/.docs/reference/ai-sdk/with-mastra.md +63 -0
- package/.docs/reference/ai-sdk/workflow-route.md +79 -0
- package/.docs/reference/auth/auth0.md +73 -0
- package/.docs/reference/auth/better-auth.md +71 -0
- package/.docs/reference/auth/clerk.md +36 -0
- package/.docs/reference/auth/firebase.md +80 -0
- package/.docs/reference/auth/jwt.md +26 -0
- package/.docs/reference/auth/supabase.md +33 -0
- package/.docs/reference/auth/workos.md +84 -0
- package/.docs/reference/cli/create-mastra.md +137 -0
- package/.docs/reference/cli/mastra.md +336 -0
- package/.docs/reference/client-js/agents.md +437 -0
- package/.docs/reference/client-js/error-handling.md +16 -0
- package/.docs/reference/client-js/logs.md +24 -0
- package/.docs/reference/client-js/mastra-client.md +63 -0
- package/.docs/reference/client-js/memory.md +221 -0
- package/.docs/reference/client-js/observability.md +72 -0
- package/.docs/reference/client-js/telemetry.md +20 -0
- package/.docs/reference/client-js/tools.md +44 -0
- package/.docs/reference/client-js/vectors.md +79 -0
- package/.docs/reference/client-js/workflows.md +199 -0
- package/.docs/reference/configuration.md +752 -0
- package/.docs/reference/core/addGateway.md +42 -0
- package/.docs/reference/core/getAgent.md +21 -0
- package/.docs/reference/core/getAgentById.md +21 -0
- package/.docs/reference/core/getDeployer.md +22 -0
- package/.docs/reference/core/getGateway.md +38 -0
- package/.docs/reference/core/getGatewayById.md +41 -0
- package/.docs/reference/core/getLogger.md +22 -0
- package/.docs/reference/core/getMCPServer.md +47 -0
- package/.docs/reference/core/getMCPServerById.md +55 -0
- package/.docs/reference/core/getMemory.md +50 -0
- package/.docs/reference/core/getScorer.md +54 -0
- package/.docs/reference/core/getScorerById.md +54 -0
- package/.docs/reference/core/getServer.md +22 -0
- package/.docs/reference/core/getStorage.md +22 -0
- package/.docs/reference/core/getStoredAgentById.md +89 -0
- package/.docs/reference/core/getTelemetry.md +22 -0
- package/.docs/reference/core/getVector.md +22 -0
- package/.docs/reference/core/getWorkflow.md +42 -0
- package/.docs/reference/core/listAgents.md +21 -0
- package/.docs/reference/core/listGateways.md +40 -0
- package/.docs/reference/core/listLogs.md +38 -0
- package/.docs/reference/core/listLogsByRunId.md +36 -0
- package/.docs/reference/core/listMCPServers.md +55 -0
- package/.docs/reference/core/listMemory.md +56 -0
- package/.docs/reference/core/listScorers.md +29 -0
- package/.docs/reference/core/listStoredAgents.md +93 -0
- package/.docs/reference/core/listVectors.md +22 -0
- package/.docs/reference/core/listWorkflows.md +21 -0
- package/.docs/reference/core/mastra-class.md +66 -0
- package/.docs/reference/core/mastra-model-gateway.md +153 -0
- package/.docs/reference/core/setLogger.md +26 -0
- package/.docs/reference/core/setStorage.md +27 -0
- package/.docs/reference/datasets/addItem.md +37 -0
- package/.docs/reference/datasets/addItems.md +35 -0
- package/.docs/reference/datasets/compareExperiments.md +52 -0
- package/.docs/reference/datasets/create.md +51 -0
- package/.docs/reference/datasets/dataset.md +82 -0
- package/.docs/reference/datasets/datasets-manager.md +94 -0
- package/.docs/reference/datasets/delete.md +25 -0
- package/.docs/reference/datasets/deleteExperiment.md +27 -0
- package/.docs/reference/datasets/deleteItem.md +27 -0
- package/.docs/reference/datasets/deleteItems.md +29 -0
- package/.docs/reference/datasets/get.md +31 -0
- package/.docs/reference/datasets/getDetails.md +47 -0
- package/.docs/reference/datasets/getExperiment.md +30 -0
- package/.docs/reference/datasets/getItem.md +33 -0
- package/.docs/reference/datasets/getItemHistory.md +31 -0
- package/.docs/reference/datasets/list.md +31 -0
- package/.docs/reference/datasets/listExperimentResults.md +39 -0
- package/.docs/reference/datasets/listExperiments.md +33 -0
- package/.docs/reference/datasets/listItems.md +46 -0
- package/.docs/reference/datasets/listVersions.md +33 -0
- package/.docs/reference/datasets/startExperiment.md +62 -0
- package/.docs/reference/datasets/startExperimentAsync.md +43 -0
- package/.docs/reference/datasets/update.md +48 -0
- package/.docs/reference/datasets/updateItem.md +38 -0
- package/.docs/reference/deployer/cloudflare.md +79 -0
- package/.docs/reference/deployer/netlify.md +80 -0
- package/.docs/reference/deployer/vercel.md +116 -0
- package/.docs/reference/deployer.md +100 -0
- package/.docs/reference/evals/answer-relevancy.md +105 -0
- package/.docs/reference/evals/answer-similarity.md +99 -0
- package/.docs/reference/evals/bias.md +120 -0
- package/.docs/reference/evals/completeness.md +136 -0
- package/.docs/reference/evals/content-similarity.md +101 -0
- package/.docs/reference/evals/context-precision.md +196 -0
- package/.docs/reference/evals/context-relevance.md +531 -0
- package/.docs/reference/evals/create-scorer.md +270 -0
- package/.docs/reference/evals/faithfulness.md +114 -0
- package/.docs/reference/evals/hallucination.md +213 -0
- package/.docs/reference/evals/keyword-coverage.md +128 -0
- package/.docs/reference/evals/mastra-scorer.md +123 -0
- package/.docs/reference/evals/noise-sensitivity.md +675 -0
- package/.docs/reference/evals/prompt-alignment.md +614 -0
- package/.docs/reference/evals/run-evals.md +179 -0
- package/.docs/reference/evals/scorer-utils.md +326 -0
- package/.docs/reference/evals/textual-difference.md +113 -0
- package/.docs/reference/evals/tone-consistency.md +119 -0
- package/.docs/reference/evals/tool-call-accuracy.md +533 -0
- package/.docs/reference/evals/toxicity.md +123 -0
- package/.docs/reference/harness/harness-class.md +760 -0
- package/.docs/reference/index.md +277 -0
- package/.docs/reference/logging/pino-logger.md +117 -0
- package/.docs/reference/memory/clone-utilities.md +199 -0
- package/.docs/reference/memory/cloneThread.md +142 -0
- package/.docs/reference/memory/createThread.md +68 -0
- package/.docs/reference/memory/deleteMessages.md +38 -0
- package/.docs/reference/memory/getThreadById.md +24 -0
- package/.docs/reference/memory/listThreads.md +145 -0
- package/.docs/reference/memory/memory-class.md +147 -0
- package/.docs/reference/memory/observational-memory.md +577 -0
- package/.docs/reference/memory/recall.md +91 -0
- package/.docs/reference/observability/tracing/bridges/otel.md +131 -0
- package/.docs/reference/observability/tracing/configuration.md +178 -0
- package/.docs/reference/observability/tracing/exporters/arize.md +141 -0
- package/.docs/reference/observability/tracing/exporters/braintrust.md +93 -0
- package/.docs/reference/observability/tracing/exporters/cloud-exporter.md +163 -0
- package/.docs/reference/observability/tracing/exporters/console-exporter.md +138 -0
- package/.docs/reference/observability/tracing/exporters/datadog.md +116 -0
- package/.docs/reference/observability/tracing/exporters/default-exporter.md +174 -0
- package/.docs/reference/observability/tracing/exporters/laminar.md +78 -0
- package/.docs/reference/observability/tracing/exporters/langfuse.md +134 -0
- package/.docs/reference/observability/tracing/exporters/langsmith.md +108 -0
- package/.docs/reference/observability/tracing/exporters/otel.md +199 -0
- package/.docs/reference/observability/tracing/exporters/posthog.md +92 -0
- package/.docs/reference/observability/tracing/exporters/sentry.md +184 -0
- package/.docs/reference/observability/tracing/instances.md +107 -0
- package/.docs/reference/observability/tracing/interfaces.md +743 -0
- package/.docs/reference/observability/tracing/processors/sensitive-data-filter.md +144 -0
- package/.docs/reference/observability/tracing/spans.md +224 -0
- package/.docs/reference/processors/batch-parts-processor.md +61 -0
- package/.docs/reference/processors/language-detector.md +82 -0
- package/.docs/reference/processors/message-history-processor.md +85 -0
- package/.docs/reference/processors/moderation-processor.md +104 -0
- package/.docs/reference/processors/pii-detector.md +108 -0
- package/.docs/reference/processors/processor-interface.md +521 -0
- package/.docs/reference/processors/prompt-injection-detector.md +72 -0
- package/.docs/reference/processors/semantic-recall-processor.md +117 -0
- package/.docs/reference/processors/system-prompt-scrubber.md +80 -0
- package/.docs/reference/processors/token-limiter-processor.md +115 -0
- package/.docs/reference/processors/tool-call-filter.md +85 -0
- package/.docs/reference/processors/tool-search-processor.md +111 -0
- package/.docs/reference/processors/unicode-normalizer.md +62 -0
- package/.docs/reference/processors/working-memory-processor.md +152 -0
- package/.docs/reference/rag/chunk.md +221 -0
- package/.docs/reference/rag/database-config.md +261 -0
- package/.docs/reference/rag/document.md +114 -0
- package/.docs/reference/rag/embeddings.md +92 -0
- package/.docs/reference/rag/extract-params.md +168 -0
- package/.docs/reference/rag/graph-rag.md +111 -0
- package/.docs/reference/rag/metadata-filters.md +216 -0
- package/.docs/reference/rag/rerank.md +75 -0
- package/.docs/reference/rag/rerankWithScorer.md +80 -0
- package/.docs/reference/server/create-route.md +262 -0
- package/.docs/reference/server/express-adapter.md +176 -0
- package/.docs/reference/server/fastify-adapter.md +90 -0
- package/.docs/reference/server/hono-adapter.md +162 -0
- package/.docs/reference/server/koa-adapter.md +127 -0
- package/.docs/reference/server/mastra-server.md +298 -0
- package/.docs/reference/server/register-api-route.md +249 -0
- package/.docs/reference/server/routes.md +306 -0
- package/.docs/reference/storage/cloudflare-d1.md +218 -0
- package/.docs/reference/storage/cloudflare.md +88 -0
- package/.docs/reference/storage/composite.md +235 -0
- package/.docs/reference/storage/convex.md +161 -0
- package/.docs/reference/storage/dynamodb.md +282 -0
- package/.docs/reference/storage/lance.md +131 -0
- package/.docs/reference/storage/libsql.md +135 -0
- package/.docs/reference/storage/mongodb.md +262 -0
- package/.docs/reference/storage/mssql.md +157 -0
- package/.docs/reference/storage/overview.md +121 -0
- package/.docs/reference/storage/postgresql.md +526 -0
- package/.docs/reference/storage/upstash.md +160 -0
- package/.docs/reference/streaming/ChunkType.md +292 -0
- package/.docs/reference/streaming/agents/MastraModelOutput.md +182 -0
- package/.docs/reference/streaming/agents/stream.md +255 -0
- package/.docs/reference/streaming/agents/streamLegacy.md +142 -0
- package/.docs/reference/streaming/workflows/observeStream.md +42 -0
- package/.docs/reference/streaming/workflows/resumeStream.md +61 -0
- package/.docs/reference/streaming/workflows/stream.md +88 -0
- package/.docs/reference/streaming/workflows/timeTravelStream.md +142 -0
- package/.docs/reference/templates/overview.md +194 -0
- package/.docs/reference/tools/create-tool.md +285 -0
- package/.docs/reference/tools/document-chunker-tool.md +89 -0
- package/.docs/reference/tools/graph-rag-tool.md +182 -0
- package/.docs/reference/tools/mcp-client.md +965 -0
- package/.docs/reference/tools/mcp-server.md +1271 -0
- package/.docs/reference/tools/vector-query-tool.md +459 -0
- package/.docs/reference/vectors/astra.md +121 -0
- package/.docs/reference/vectors/chroma.md +264 -0
- package/.docs/reference/vectors/convex.md +300 -0
- package/.docs/reference/vectors/couchbase.md +226 -0
- package/.docs/reference/vectors/duckdb.md +318 -0
- package/.docs/reference/vectors/elasticsearch.md +189 -0
- package/.docs/reference/vectors/lance.md +220 -0
- package/.docs/reference/vectors/libsql.md +305 -0
- package/.docs/reference/vectors/mongodb.md +295 -0
- package/.docs/reference/vectors/opensearch.md +99 -0
- package/.docs/reference/vectors/pg.md +408 -0
- package/.docs/reference/vectors/pinecone.md +168 -0
- package/.docs/reference/vectors/qdrant.md +222 -0
- package/.docs/reference/vectors/s3vectors.md +277 -0
- package/.docs/reference/vectors/turbopuffer.md +157 -0
- package/.docs/reference/vectors/upstash.md +294 -0
- package/.docs/reference/vectors/vectorize.md +147 -0
- package/.docs/reference/voice/azure.md +148 -0
- package/.docs/reference/voice/cloudflare.md +83 -0
- package/.docs/reference/voice/composite-voice.md +121 -0
- package/.docs/reference/voice/deepgram.md +79 -0
- package/.docs/reference/voice/elevenlabs.md +98 -0
- package/.docs/reference/voice/google-gemini-live.md +378 -0
- package/.docs/reference/voice/google.md +228 -0
- package/.docs/reference/voice/mastra-voice.md +311 -0
- package/.docs/reference/voice/murf.md +122 -0
- package/.docs/reference/voice/openai-realtime.md +203 -0
- package/.docs/reference/voice/openai.md +88 -0
- package/.docs/reference/voice/playai.md +80 -0
- package/.docs/reference/voice/sarvam.md +126 -0
- package/.docs/reference/voice/speechify.md +75 -0
- package/.docs/reference/voice/voice.addInstructions.md +55 -0
- package/.docs/reference/voice/voice.addTools.md +67 -0
- package/.docs/reference/voice/voice.answer.md +54 -0
- package/.docs/reference/voice/voice.close.md +51 -0
- package/.docs/reference/voice/voice.connect.md +94 -0
- package/.docs/reference/voice/voice.events.md +37 -0
- package/.docs/reference/voice/voice.getSpeakers.md +129 -0
- package/.docs/reference/voice/voice.listen.md +164 -0
- package/.docs/reference/voice/voice.off.md +54 -0
- package/.docs/reference/voice/voice.on.md +111 -0
- package/.docs/reference/voice/voice.send.md +65 -0
- package/.docs/reference/voice/voice.speak.md +157 -0
- package/.docs/reference/voice/voice.updateConfig.md +60 -0
- package/.docs/reference/workflows/run-methods/cancel.md +86 -0
- package/.docs/reference/workflows/run-methods/restart.md +33 -0
- package/.docs/reference/workflows/run-methods/resume.md +59 -0
- package/.docs/reference/workflows/run-methods/start.md +58 -0
- package/.docs/reference/workflows/run-methods/startAsync.md +67 -0
- package/.docs/reference/workflows/run-methods/timeTravel.md +142 -0
- package/.docs/reference/workflows/run.md +59 -0
- package/.docs/reference/workflows/step.md +119 -0
- package/.docs/reference/workflows/workflow-methods/branch.md +25 -0
- package/.docs/reference/workflows/workflow-methods/commit.md +17 -0
- package/.docs/reference/workflows/workflow-methods/create-run.md +63 -0
- package/.docs/reference/workflows/workflow-methods/dountil.md +25 -0
- package/.docs/reference/workflows/workflow-methods/dowhile.md +25 -0
- package/.docs/reference/workflows/workflow-methods/foreach.md +118 -0
- package/.docs/reference/workflows/workflow-methods/map.md +93 -0
- package/.docs/reference/workflows/workflow-methods/parallel.md +21 -0
- package/.docs/reference/workflows/workflow-methods/sleep.md +35 -0
- package/.docs/reference/workflows/workflow-methods/sleepUntil.md +35 -0
- package/.docs/reference/workflows/workflow-methods/then.md +21 -0
- package/.docs/reference/workflows/workflow.md +157 -0
- package/.docs/reference/workspace/daytona-sandbox.md +580 -0
- package/.docs/reference/workspace/e2b-sandbox.md +289 -0
- package/.docs/reference/workspace/filesystem.md +255 -0
- package/.docs/reference/workspace/gcs-filesystem.md +174 -0
- package/.docs/reference/workspace/local-filesystem.md +343 -0
- package/.docs/reference/workspace/local-sandbox.md +301 -0
- package/.docs/reference/workspace/s3-filesystem.md +177 -0
- package/.docs/reference/workspace/sandbox.md +87 -0
- package/.docs/reference/workspace/workspace-class.md +244 -0
- package/CHANGELOG.md +659 -4
- package/LICENSE.md +15 -0
- package/README.md +63 -125
- 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/prompts/migration.d.ts +6 -0
- package/dist/prompts/migration.d.ts.map +1 -0
- package/dist/stdio.js +1253 -293
- package/dist/stdio.js.map +1 -0
- package/dist/tools/course.d.ts.map +1 -1
- package/dist/tools/docs.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/dist/tools/migration.d.ts +40 -0
- package/dist/tools/migration.d.ts.map +1 -0
- package/dist/utils.d.ts +0 -54
- package/dist/utils.d.ts.map +1 -1
- package/package.json +22 -21
- package/.docs/organized/changelogs/%40internal%2Fchangeset-cli.md +0 -9
- package/.docs/organized/changelogs/%40internal%2Fplayground.md +0 -3
- package/.docs/organized/changelogs/%40internal%2Fstorage-test-utils.md +0 -302
- package/.docs/organized/changelogs/%40internal%2Ftypes-builder.md +0 -49
- package/.docs/organized/changelogs/%40mastra%2Fagent-builder.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fai-sdk.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fastra.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fauth.md +0 -31
- package/.docs/organized/changelogs/%40mastra%2Fchroma.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fclickhouse.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fclient-js.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fcloud.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fcloudflare-d1.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fcloudflare.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fcore.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fcouchbase.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloud.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloudflare.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-netlify.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-vercel.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fdeployer.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fdynamodb.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fevals.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Ffastembed.md +0 -87
- package/.docs/organized/changelogs/%40mastra%2Flance.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Flibsql.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Floggers.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fmcp-docs-server.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fmcp-registry-registry.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fmcp.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fmemory.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fmongodb.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fmssql.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fopensearch.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fpg.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fpinecone.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fplayground-ui.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fqdrant.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Frag.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Freact.md +0 -247
- package/.docs/organized/changelogs/%40mastra%2Fs3vectors.md +0 -149
- package/.docs/organized/changelogs/%40mastra%2Fschema-compat.md +0 -195
- package/.docs/organized/changelogs/%40mastra%2Fserver.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fturbopuffer.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fupstash.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fvectorize.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fvoice-azure.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fvoice-cloudflare.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fvoice-deepgram.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fvoice-elevenlabs.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fvoice-gladia.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fvoice-google-gemini-live.md +0 -265
- package/.docs/organized/changelogs/%40mastra%2Fvoice-google.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fvoice-murf.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fvoice-openai-realtime.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fvoice-openai.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fvoice-playai.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fvoice-sarvam.md +0 -302
- package/.docs/organized/changelogs/%40mastra%2Fvoice-speechify.md +0 -302
- package/.docs/organized/changelogs/create-mastra.md +0 -302
- package/.docs/organized/changelogs/mastra.md +0 -302
- package/.docs/organized/code-examples/a2a.md +0 -208
- package/.docs/organized/code-examples/agent.md +0 -1333
- package/.docs/organized/code-examples/agui.md +0 -173
- package/.docs/organized/code-examples/ai-elements.md +0 -47
- package/.docs/organized/code-examples/ai-sdk-useChat.md +0 -369
- package/.docs/organized/code-examples/ai-sdk-v5.md +0 -203
- package/.docs/organized/code-examples/assistant-ui.md +0 -28
- package/.docs/organized/code-examples/bird-checker-with-express.md +0 -223
- package/.docs/organized/code-examples/bird-checker-with-nextjs-and-eval.md +0 -347
- package/.docs/organized/code-examples/bird-checker-with-nextjs.md +0 -241
- package/.docs/organized/code-examples/client-side-tools.md +0 -59
- package/.docs/organized/code-examples/crypto-chatbot.md +0 -87
- package/.docs/organized/code-examples/experimental-auth-weather-agent.md +0 -564
- package/.docs/organized/code-examples/fireworks-r1.md +0 -148
- package/.docs/organized/code-examples/heads-up-game.md +0 -252
- package/.docs/organized/code-examples/mcp-configuration.md +0 -556
- package/.docs/organized/code-examples/mcp-registry-registry.md +0 -50
- package/.docs/organized/code-examples/memory-per-resource-example.md +0 -222
- package/.docs/organized/code-examples/memory-todo-agent.md +0 -152
- package/.docs/organized/code-examples/memory-with-context.md +0 -155
- package/.docs/organized/code-examples/memory-with-libsql.md +0 -190
- package/.docs/organized/code-examples/memory-with-pg.md +0 -211
- package/.docs/organized/code-examples/memory-with-processors.md +0 -594
- package/.docs/organized/code-examples/memory-with-upstash.md +0 -254
- package/.docs/organized/code-examples/openapi-spec-writer.md +0 -567
- package/.docs/organized/code-examples/quick-start.md +0 -156
- package/.docs/organized/code-examples/stock-price-tool.md +0 -111
- package/.docs/organized/code-examples/weather-agent.md +0 -576
- package/.docs/organized/code-examples/workflow-ai-recruiter.md +0 -147
- package/.docs/organized/code-examples/workflow-with-inline-steps.md +0 -99
- package/.docs/organized/code-examples/workflow-with-memory.md +0 -381
- package/.docs/organized/code-examples/workflow-with-separate-steps.md +0 -160
- package/.docs/organized/code-examples/workflow-with-suspend-resume.md +0 -182
- package/.docs/raw/agents/adding-voice.mdx +0 -290
- package/.docs/raw/agents/agent-memory.mdx +0 -158
- package/.docs/raw/agents/guardrails.mdx +0 -342
- package/.docs/raw/agents/networks.mdx +0 -235
- package/.docs/raw/agents/overview.mdx +0 -425
- package/.docs/raw/agents/using-tools.mdx +0 -95
- package/.docs/raw/auth/auth0.mdx +0 -235
- package/.docs/raw/auth/clerk.mdx +0 -142
- package/.docs/raw/auth/firebase.mdx +0 -285
- package/.docs/raw/auth/index.mdx +0 -19
- package/.docs/raw/auth/jwt.mdx +0 -101
- package/.docs/raw/auth/supabase.mdx +0 -128
- package/.docs/raw/auth/workos.mdx +0 -198
- package/.docs/raw/community/contributing-templates.mdx +0 -193
- package/.docs/raw/community/discord.mdx +0 -12
- package/.docs/raw/community/licensing.mdx +0 -71
- package/.docs/raw/course/01-first-agent/04-project-structure.md +0 -17
- package/.docs/raw/course/01-first-agent/05-running-playground.md +0 -19
- package/.docs/raw/course/01-first-agent/07-creating-your-agent.md +0 -51
- package/.docs/raw/course/01-first-agent/08-exporting-your-agent.md +0 -33
- package/.docs/raw/course/01-first-agent/09-testing-your-agent.md +0 -12
- package/.docs/raw/course/01-first-agent/11-creating-transactions-tool.md +0 -41
- package/.docs/raw/course/01-first-agent/12-connecting-tool-to-agent.md +0 -29
- package/.docs/raw/course/01-first-agent/13-testing-your-tool.md +0 -15
- package/.docs/raw/course/01-first-agent/15-installing-memory.md +0 -13
- package/.docs/raw/course/01-first-agent/16-adding-memory-to-agent.md +0 -33
- package/.docs/raw/course/01-first-agent/17-testing-memory.md +0 -15
- package/.docs/raw/course/02-agent-tools-mcp/03-setting-up-mcp-configuration.md +0 -21
- package/.docs/raw/course/02-agent-tools-mcp/04-initializing-mcp-tools.md +0 -11
- package/.docs/raw/course/02-agent-tools-mcp/05-updating-your-agent.md +0 -20
- package/.docs/raw/course/02-agent-tools-mcp/07-what-is-zapier-mcp.md +0 -14
- package/.docs/raw/course/02-agent-tools-mcp/08-getting-zapier-mcp-url.md +0 -16
- package/.docs/raw/course/02-agent-tools-mcp/09-updating-mcp-config-zapier.md +0 -17
- package/.docs/raw/course/02-agent-tools-mcp/10-updating-agent-instructions-zapier.md +0 -29
- package/.docs/raw/course/02-agent-tools-mcp/12-troubleshooting-zapier.md +0 -17
- package/.docs/raw/course/02-agent-tools-mcp/13-what-is-github-mcp.md +0 -14
- package/.docs/raw/course/02-agent-tools-mcp/14-getting-github-mcp-url.md +0 -35
- package/.docs/raw/course/02-agent-tools-mcp/15-updating-mcp-config-github.md +0 -20
- package/.docs/raw/course/02-agent-tools-mcp/16-updating-agent-instructions-github.md +0 -33
- package/.docs/raw/course/02-agent-tools-mcp/18-troubleshooting-github.md +0 -17
- package/.docs/raw/course/02-agent-tools-mcp/20-updating-mcp-config-hackernews.md +0 -26
- package/.docs/raw/course/02-agent-tools-mcp/21-updating-agent-instructions-hackernews.md +0 -38
- package/.docs/raw/course/02-agent-tools-mcp/26-updating-mcp-config-filesystem.md +0 -33
- package/.docs/raw/course/02-agent-tools-mcp/27-updating-agent-instructions-filesystem.md +0 -45
- package/.docs/raw/course/02-agent-tools-mcp/31-enhancing-memory-configuration.md +0 -76
- package/.docs/raw/course/02-agent-tools-mcp/32-conclusion.md +0 -17
- package/.docs/raw/course/03-agent-memory/03-installing-memory.md +0 -13
- package/.docs/raw/course/03-agent-memory/04-creating-basic-memory-agent.md +0 -36
- package/.docs/raw/course/03-agent-memory/05-updating-mastra-export.md +0 -18
- package/.docs/raw/course/03-agent-memory/07-understanding-memory-threads.md +0 -14
- package/.docs/raw/course/03-agent-memory/08-configuring-conversation-history.md +0 -37
- package/.docs/raw/course/03-agent-memory/09-using-memory-in-application.md +0 -19
- package/.docs/raw/course/03-agent-memory/10-storage-configuration.md +0 -30
- package/.docs/raw/course/03-agent-memory/12-handling-memory-frontend.md +0 -62
- package/.docs/raw/course/03-agent-memory/13-vector-store-configuration.md +0 -27
- package/.docs/raw/course/03-agent-memory/16-configuring-semantic-recall.md +0 -41
- package/.docs/raw/course/03-agent-memory/18-advanced-configuration-semantic-recall.md +0 -28
- package/.docs/raw/course/03-agent-memory/21-configuring-working-memory.md +0 -63
- package/.docs/raw/course/03-agent-memory/22-custom-working-memory-templates.md +0 -89
- package/.docs/raw/course/03-agent-memory/25-combining-memory-features.md +0 -80
- package/.docs/raw/course/03-agent-memory/26-updating-mastra-export-comprehensive.md +0 -32
- package/.docs/raw/course/03-agent-memory/27-creating-learning-assistant.md +0 -103
- package/.docs/raw/course/04-workflows/01-introduction-to-workflows.md +0 -44
- package/.docs/raw/course/04-workflows/02-understanding-steps.md +0 -53
- package/.docs/raw/course/04-workflows/03-creating-your-first-step.md +0 -57
- package/.docs/raw/course/04-workflows/04-creating-a-second-step.md +0 -58
- package/.docs/raw/course/04-workflows/05-chaining-steps-together.md +0 -57
- package/.docs/raw/course/04-workflows/06-registering-with-mastra.md +0 -24
- package/.docs/raw/course/04-workflows/07-using-playground.md +0 -58
- package/.docs/raw/course/04-workflows/08-running-workflows-programmatically.md +0 -77
- package/.docs/raw/course/04-workflows/09-adding-a-third-step.md +0 -70
- package/.docs/raw/course/04-workflows/10-updating-the-workflow.md +0 -55
- package/.docs/raw/course/04-workflows/11-creating-an-ai-agent.md +0 -67
- package/.docs/raw/course/04-workflows/12-using-agent-in-workflow.md +0 -91
- package/.docs/raw/course/04-workflows/13-creating-ai-enhanced-workflow.md +0 -75
- package/.docs/raw/course/04-workflows/14-understanding-parallel-execution.md +0 -38
- package/.docs/raw/course/04-workflows/15-creating-parallel-steps.md +0 -115
- package/.docs/raw/course/04-workflows/16-building-parallel-workflow.md +0 -100
- package/.docs/raw/course/04-workflows/17-testing-parallel-performance.md +0 -40
- package/.docs/raw/course/04-workflows/18-understanding-conditional-branching.md +0 -61
- package/.docs/raw/course/04-workflows/19-creating-conditional-steps.md +0 -128
- package/.docs/raw/course/04-workflows/20-building-conditional-workflow.md +0 -60
- package/.docs/raw/course/04-workflows/21-testing-conditional-logic.md +0 -58
- package/.docs/raw/deployment/cloud-providers/amazon-ec2.mdx +0 -115
- package/.docs/raw/deployment/cloud-providers/aws-lambda.mdx +0 -273
- package/.docs/raw/deployment/cloud-providers/azure-app-services.mdx +0 -137
- package/.docs/raw/deployment/cloud-providers/digital-ocean.mdx +0 -206
- package/.docs/raw/deployment/cloud-providers/index.mdx +0 -52
- package/.docs/raw/deployment/monorepo.mdx +0 -107
- package/.docs/raw/deployment/overview.mdx +0 -82
- package/.docs/raw/deployment/server-deployment.mdx +0 -86
- package/.docs/raw/deployment/serverless-platforms/cloudflare-deployer.mdx +0 -87
- package/.docs/raw/deployment/serverless-platforms/index.mdx +0 -52
- package/.docs/raw/deployment/serverless-platforms/netlify-deployer.mdx +0 -94
- package/.docs/raw/deployment/serverless-platforms/vercel-deployer.mdx +0 -109
- package/.docs/raw/deployment/web-framework.mdx +0 -63
- package/.docs/raw/frameworks/agentic-uis/ai-sdk.mdx +0 -675
- package/.docs/raw/frameworks/agentic-uis/assistant-ui.mdx +0 -125
- package/.docs/raw/frameworks/agentic-uis/cedar-os.mdx +0 -108
- package/.docs/raw/frameworks/agentic-uis/copilotkit.mdx +0 -341
- package/.docs/raw/frameworks/agentic-uis/openrouter.mdx +0 -165
- package/.docs/raw/frameworks/servers/express.mdx +0 -208
- package/.docs/raw/frameworks/web-frameworks/astro.mdx +0 -519
- package/.docs/raw/frameworks/web-frameworks/next-js.mdx +0 -336
- package/.docs/raw/frameworks/web-frameworks/sveltekit.mdx +0 -461
- package/.docs/raw/frameworks/web-frameworks/vite-react.mdx +0 -242
- package/.docs/raw/getting-started/installation.mdx +0 -316
- package/.docs/raw/getting-started/mcp-docs-server.mdx +0 -183
- package/.docs/raw/getting-started/project-structure.mdx +0 -72
- package/.docs/raw/getting-started/templates.mdx +0 -70
- package/.docs/raw/index.mdx +0 -58
- package/.docs/raw/mastra-cloud/dashboard.mdx +0 -100
- package/.docs/raw/mastra-cloud/observability.mdx +0 -52
- package/.docs/raw/mastra-cloud/overview.mdx +0 -71
- package/.docs/raw/mastra-cloud/setting-up.mdx +0 -92
- package/.docs/raw/memory/conversation-history.mdx +0 -23
- package/.docs/raw/memory/memory-processors.mdx +0 -136
- package/.docs/raw/memory/overview.mdx +0 -119
- package/.docs/raw/memory/semantic-recall.mdx +0 -226
- package/.docs/raw/memory/threads-and-resources.mdx +0 -94
- package/.docs/raw/memory/working-memory.mdx +0 -378
- package/.docs/raw/observability/ai-tracing/exporters/braintrust.mdx +0 -81
- package/.docs/raw/observability/ai-tracing/exporters/cloud.mdx +0 -120
- package/.docs/raw/observability/ai-tracing/exporters/default.mdx +0 -168
- package/.docs/raw/observability/ai-tracing/exporters/langfuse.mdx +0 -121
- package/.docs/raw/observability/ai-tracing/exporters/langsmith.mdx +0 -88
- package/.docs/raw/observability/ai-tracing/exporters/otel.mdx +0 -253
- package/.docs/raw/observability/ai-tracing/overview.mdx +0 -565
- package/.docs/raw/observability/ai-tracing/processors/sensitive-data-filter.mdx +0 -274
- package/.docs/raw/observability/logging.mdx +0 -113
- package/.docs/raw/observability/nextjs-tracing.mdx +0 -109
- package/.docs/raw/observability/otel-tracing.mdx +0 -190
- package/.docs/raw/observability/overview.mdx +0 -66
- package/.docs/raw/rag/chunking-and-embedding.mdx +0 -208
- package/.docs/raw/rag/overview.mdx +0 -87
- package/.docs/raw/rag/retrieval.mdx +0 -543
- package/.docs/raw/rag/vector-databases.mdx +0 -529
- package/.docs/raw/reference/agents/agent.mdx +0 -230
- package/.docs/raw/reference/agents/generate.mdx +0 -577
- package/.docs/raw/reference/agents/generateLegacy.mdx +0 -528
- package/.docs/raw/reference/agents/getDefaultGenerateOptions.mdx +0 -67
- package/.docs/raw/reference/agents/getDefaultStreamOptions.mdx +0 -67
- package/.docs/raw/reference/agents/getDescription.mdx +0 -34
- package/.docs/raw/reference/agents/getInstructions.mdx +0 -67
- package/.docs/raw/reference/agents/getLLM.mdx +0 -74
- package/.docs/raw/reference/agents/getMemory.mdx +0 -67
- package/.docs/raw/reference/agents/getModel.mdx +0 -67
- package/.docs/raw/reference/agents/getScorers.mdx +0 -67
- package/.docs/raw/reference/agents/getTools.mdx +0 -67
- package/.docs/raw/reference/agents/getVoice.mdx +0 -67
- package/.docs/raw/reference/agents/getWorkflows.mdx +0 -67
- package/.docs/raw/reference/agents/listAgents.mdx +0 -68
- package/.docs/raw/reference/agents/network.mdx +0 -290
- package/.docs/raw/reference/auth/auth0.mdx +0 -117
- package/.docs/raw/reference/auth/clerk.mdx +0 -71
- package/.docs/raw/reference/auth/firebase.mdx +0 -128
- package/.docs/raw/reference/auth/jwt.mdx +0 -41
- package/.docs/raw/reference/auth/supabase.mdx +0 -62
- package/.docs/raw/reference/auth/workos.mdx +0 -128
- package/.docs/raw/reference/cli/create-mastra.mdx +0 -177
- package/.docs/raw/reference/cli/mastra.mdx +0 -258
- package/.docs/raw/reference/client-js/agents.mdx +0 -220
- package/.docs/raw/reference/client-js/error-handling.mdx +0 -23
- package/.docs/raw/reference/client-js/logs.mdx +0 -29
- package/.docs/raw/reference/client-js/mastra-client.mdx +0 -157
- package/.docs/raw/reference/client-js/memory.mdx +0 -130
- package/.docs/raw/reference/client-js/observability.mdx +0 -76
- package/.docs/raw/reference/client-js/telemetry.mdx +0 -25
- package/.docs/raw/reference/client-js/tools.mdx +0 -49
- package/.docs/raw/reference/client-js/vectors.mdx +0 -84
- package/.docs/raw/reference/client-js/workflows-legacy.mdx +0 -143
- package/.docs/raw/reference/client-js/workflows.mdx +0 -175
- package/.docs/raw/reference/core/getAgent.mdx +0 -43
- package/.docs/raw/reference/core/getAgentById.mdx +0 -43
- package/.docs/raw/reference/core/getAgents.mdx +0 -35
- package/.docs/raw/reference/core/getDeployer.mdx +0 -35
- package/.docs/raw/reference/core/getLogger.mdx +0 -35
- package/.docs/raw/reference/core/getLogs.mdx +0 -92
- package/.docs/raw/reference/core/getLogsByRunId.mdx +0 -84
- package/.docs/raw/reference/core/getMCPServer.mdx +0 -49
- package/.docs/raw/reference/core/getMCPServers.mdx +0 -35
- package/.docs/raw/reference/core/getMemory.mdx +0 -35
- package/.docs/raw/reference/core/getScorer.mdx +0 -75
- package/.docs/raw/reference/core/getScorerByName.mdx +0 -75
- package/.docs/raw/reference/core/getScorers.mdx +0 -42
- package/.docs/raw/reference/core/getServer.mdx +0 -35
- package/.docs/raw/reference/core/getStorage.mdx +0 -35
- package/.docs/raw/reference/core/getTelemetry.mdx +0 -35
- package/.docs/raw/reference/core/getVector.mdx +0 -43
- package/.docs/raw/reference/core/getVectors.mdx +0 -35
- package/.docs/raw/reference/core/getWorkflow.mdx +0 -48
- package/.docs/raw/reference/core/getWorkflows.mdx +0 -43
- package/.docs/raw/reference/core/mastra-class.mdx +0 -143
- package/.docs/raw/reference/core/setLogger.mdx +0 -47
- package/.docs/raw/reference/core/setStorage.mdx +0 -39
- package/.docs/raw/reference/core/setTelemetry.mdx +0 -35
- package/.docs/raw/reference/deployer/cloudflare.mdx +0 -91
- package/.docs/raw/reference/deployer/deployer.mdx +0 -165
- package/.docs/raw/reference/deployer/netlify.mdx +0 -20
- package/.docs/raw/reference/deployer/vercel.mdx +0 -46
- package/.docs/raw/reference/evals/answer-relevancy.mdx +0 -190
- package/.docs/raw/reference/evals/bias.mdx +0 -195
- package/.docs/raw/reference/evals/completeness.mdx +0 -184
- package/.docs/raw/reference/evals/content-similarity.mdx +0 -185
- package/.docs/raw/reference/evals/context-position.mdx +0 -198
- package/.docs/raw/reference/evals/context-precision.mdx +0 -196
- package/.docs/raw/reference/evals/context-relevancy.mdx +0 -197
- package/.docs/raw/reference/evals/contextual-recall.mdx +0 -197
- package/.docs/raw/reference/evals/faithfulness.mdx +0 -200
- package/.docs/raw/reference/evals/hallucination.mdx +0 -227
- package/.docs/raw/reference/evals/keyword-coverage.mdx +0 -186
- package/.docs/raw/reference/evals/prompt-alignment.mdx +0 -248
- package/.docs/raw/reference/evals/summarization.mdx +0 -214
- package/.docs/raw/reference/evals/textual-difference.mdx +0 -172
- package/.docs/raw/reference/evals/tone-consistency.mdx +0 -190
- package/.docs/raw/reference/evals/toxicity.mdx +0 -173
- package/.docs/raw/reference/index.mdx +0 -12
- package/.docs/raw/reference/legacyWorkflows/after.mdx +0 -89
- package/.docs/raw/reference/legacyWorkflows/afterEvent.mdx +0 -79
- package/.docs/raw/reference/legacyWorkflows/commit.mdx +0 -33
- package/.docs/raw/reference/legacyWorkflows/createRun.mdx +0 -76
- package/.docs/raw/reference/legacyWorkflows/else.mdx +0 -68
- package/.docs/raw/reference/legacyWorkflows/events.mdx +0 -305
- package/.docs/raw/reference/legacyWorkflows/execute.mdx +0 -110
- package/.docs/raw/reference/legacyWorkflows/if.mdx +0 -108
- package/.docs/raw/reference/legacyWorkflows/resume.mdx +0 -158
- package/.docs/raw/reference/legacyWorkflows/resumeWithEvent.mdx +0 -133
- package/.docs/raw/reference/legacyWorkflows/snapshots.mdx +0 -207
- package/.docs/raw/reference/legacyWorkflows/start.mdx +0 -87
- package/.docs/raw/reference/legacyWorkflows/step-class.mdx +0 -100
- package/.docs/raw/reference/legacyWorkflows/step-condition.mdx +0 -137
- package/.docs/raw/reference/legacyWorkflows/step-function.mdx +0 -93
- package/.docs/raw/reference/legacyWorkflows/step-options.mdx +0 -69
- package/.docs/raw/reference/legacyWorkflows/step-retries.mdx +0 -196
- package/.docs/raw/reference/legacyWorkflows/suspend.mdx +0 -70
- package/.docs/raw/reference/legacyWorkflows/then.mdx +0 -72
- package/.docs/raw/reference/legacyWorkflows/until.mdx +0 -168
- package/.docs/raw/reference/legacyWorkflows/watch.mdx +0 -124
- package/.docs/raw/reference/legacyWorkflows/while.mdx +0 -168
- package/.docs/raw/reference/legacyWorkflows/workflow.mdx +0 -234
- package/.docs/raw/reference/memory/Memory.mdx +0 -206
- package/.docs/raw/reference/memory/createThread.mdx +0 -119
- package/.docs/raw/reference/memory/deleteMessages.mdx +0 -60
- package/.docs/raw/reference/memory/getThreadById.mdx +0 -46
- package/.docs/raw/reference/memory/getThreadsByResourceId.mdx +0 -78
- package/.docs/raw/reference/memory/getThreadsByResourceIdPaginated.mdx +0 -109
- package/.docs/raw/reference/memory/query.mdx +0 -174
- package/.docs/raw/reference/observability/ai-tracing/ai-tracing.mdx +0 -182
- package/.docs/raw/reference/observability/ai-tracing/configuration.mdx +0 -234
- package/.docs/raw/reference/observability/ai-tracing/exporters/braintrust.mdx +0 -112
- package/.docs/raw/reference/observability/ai-tracing/exporters/cloud-exporter.mdx +0 -176
- package/.docs/raw/reference/observability/ai-tracing/exporters/console-exporter.mdx +0 -148
- package/.docs/raw/reference/observability/ai-tracing/exporters/default-exporter.mdx +0 -196
- package/.docs/raw/reference/observability/ai-tracing/exporters/langfuse.mdx +0 -116
- package/.docs/raw/reference/observability/ai-tracing/exporters/langsmith.mdx +0 -112
- package/.docs/raw/reference/observability/ai-tracing/exporters/otel.mdx +0 -361
- package/.docs/raw/reference/observability/ai-tracing/interfaces.mdx +0 -651
- package/.docs/raw/reference/observability/ai-tracing/processors/sensitive-data-filter.mdx +0 -178
- package/.docs/raw/reference/observability/ai-tracing/span.mdx +0 -371
- package/.docs/raw/reference/observability/logging/pino-logger.mdx +0 -148
- package/.docs/raw/reference/observability/otel-tracing/otel-config.mdx +0 -117
- package/.docs/raw/reference/observability/otel-tracing/providers/arize-ax.mdx +0 -81
- package/.docs/raw/reference/observability/otel-tracing/providers/arize-phoenix.mdx +0 -120
- package/.docs/raw/reference/observability/otel-tracing/providers/braintrust.mdx +0 -40
- package/.docs/raw/reference/observability/otel-tracing/providers/dash0.mdx +0 -40
- package/.docs/raw/reference/observability/otel-tracing/providers/index.mdx +0 -22
- package/.docs/raw/reference/observability/otel-tracing/providers/keywordsai.mdx +0 -73
- package/.docs/raw/reference/observability/otel-tracing/providers/laminar.mdx +0 -41
- package/.docs/raw/reference/observability/otel-tracing/providers/langfuse.mdx +0 -84
- package/.docs/raw/reference/observability/otel-tracing/providers/langsmith.mdx +0 -48
- package/.docs/raw/reference/observability/otel-tracing/providers/langwatch.mdx +0 -43
- package/.docs/raw/reference/observability/otel-tracing/providers/new-relic.mdx +0 -40
- package/.docs/raw/reference/observability/otel-tracing/providers/signoz.mdx +0 -40
- package/.docs/raw/reference/observability/otel-tracing/providers/traceloop.mdx +0 -40
- package/.docs/raw/reference/processors/batch-parts-processor.mdx +0 -111
- package/.docs/raw/reference/processors/language-detector.mdx +0 -154
- package/.docs/raw/reference/processors/moderation-processor.mdx +0 -145
- package/.docs/raw/reference/processors/pii-detector.mdx +0 -153
- package/.docs/raw/reference/processors/prompt-injection-detector.mdx +0 -130
- package/.docs/raw/reference/processors/system-prompt-scrubber.mdx +0 -145
- package/.docs/raw/reference/processors/token-limiter-processor.mdx +0 -136
- package/.docs/raw/reference/processors/unicode-normalizer.mdx +0 -114
- package/.docs/raw/reference/rag/chunk.mdx +0 -445
- package/.docs/raw/reference/rag/database-config.mdx +0 -334
- package/.docs/raw/reference/rag/document.mdx +0 -131
- package/.docs/raw/reference/rag/embeddings.mdx +0 -168
- package/.docs/raw/reference/rag/extract-params.mdx +0 -254
- package/.docs/raw/reference/rag/graph-rag.mdx +0 -186
- package/.docs/raw/reference/rag/metadata-filters.mdx +0 -347
- package/.docs/raw/reference/rag/rerank.mdx +0 -213
- package/.docs/raw/reference/rag/rerankWithScorer.mdx +0 -213
- package/.docs/raw/reference/scorers/answer-relevancy.mdx +0 -209
- package/.docs/raw/reference/scorers/answer-similarity.mdx +0 -423
- package/.docs/raw/reference/scorers/bias.mdx +0 -225
- package/.docs/raw/reference/scorers/completeness.mdx +0 -209
- package/.docs/raw/reference/scorers/content-similarity.mdx +0 -195
- package/.docs/raw/reference/scorers/context-precision.mdx +0 -343
- package/.docs/raw/reference/scorers/context-relevance.mdx +0 -599
- package/.docs/raw/reference/scorers/create-scorer.mdx +0 -495
- package/.docs/raw/reference/scorers/faithfulness.mdx +0 -233
- package/.docs/raw/reference/scorers/hallucination.mdx +0 -247
- package/.docs/raw/reference/scorers/keyword-coverage.mdx +0 -224
- package/.docs/raw/reference/scorers/mastra-scorer.mdx +0 -182
- package/.docs/raw/reference/scorers/noise-sensitivity.mdx +0 -766
- package/.docs/raw/reference/scorers/prompt-alignment.mdx +0 -614
- package/.docs/raw/reference/scorers/run-experiment.mdx +0 -216
- package/.docs/raw/reference/scorers/textual-difference.mdx +0 -204
- package/.docs/raw/reference/scorers/tone-consistency.mdx +0 -208
- package/.docs/raw/reference/scorers/tool-call-accuracy.mdx +0 -567
- package/.docs/raw/reference/scorers/toxicity.mdx +0 -224
- package/.docs/raw/reference/storage/cloudflare-d1.mdx +0 -104
- package/.docs/raw/reference/storage/cloudflare.mdx +0 -95
- package/.docs/raw/reference/storage/dynamodb.mdx +0 -196
- package/.docs/raw/reference/storage/lance.mdx +0 -101
- package/.docs/raw/reference/storage/libsql.mdx +0 -74
- package/.docs/raw/reference/storage/mssql.mdx +0 -112
- package/.docs/raw/reference/storage/postgresql.mdx +0 -305
- package/.docs/raw/reference/storage/upstash.mdx +0 -91
- package/.docs/raw/reference/streaming/ChunkType.mdx +0 -854
- package/.docs/raw/reference/streaming/agents/MastraModelOutput.mdx +0 -321
- package/.docs/raw/reference/streaming/agents/stream.mdx +0 -698
- package/.docs/raw/reference/streaming/agents/streamLegacy.mdx +0 -515
- package/.docs/raw/reference/streaming/workflows/observeStream.mdx +0 -49
- package/.docs/raw/reference/streaming/workflows/observeStreamVNext.mdx +0 -47
- package/.docs/raw/reference/streaming/workflows/resumeStreamVNext.mdx +0 -118
- package/.docs/raw/reference/streaming/workflows/stream.mdx +0 -125
- package/.docs/raw/reference/streaming/workflows/streamVNext.mdx +0 -144
- package/.docs/raw/reference/templates/overview.mdx +0 -228
- package/.docs/raw/reference/tools/client.mdx +0 -336
- package/.docs/raw/reference/tools/create-tool.mdx +0 -130
- package/.docs/raw/reference/tools/document-chunker-tool.mdx +0 -141
- package/.docs/raw/reference/tools/graph-rag-tool.mdx +0 -262
- package/.docs/raw/reference/tools/mcp-client.mdx +0 -830
- package/.docs/raw/reference/tools/mcp-server.mdx +0 -1079
- package/.docs/raw/reference/tools/vector-query-tool.mdx +0 -604
- package/.docs/raw/reference/vectors/astra.mdx +0 -258
- package/.docs/raw/reference/vectors/chroma.mdx +0 -422
- package/.docs/raw/reference/vectors/couchbase.mdx +0 -345
- package/.docs/raw/reference/vectors/lance.mdx +0 -451
- package/.docs/raw/reference/vectors/libsql.mdx +0 -355
- package/.docs/raw/reference/vectors/mongodb.mdx +0 -309
- package/.docs/raw/reference/vectors/opensearch.mdx +0 -200
- package/.docs/raw/reference/vectors/pg.mdx +0 -632
- package/.docs/raw/reference/vectors/pinecone.mdx +0 -286
- package/.docs/raw/reference/vectors/qdrant.mdx +0 -236
- package/.docs/raw/reference/vectors/s3vectors.mdx +0 -386
- package/.docs/raw/reference/vectors/turbopuffer.mdx +0 -249
- package/.docs/raw/reference/vectors/upstash.mdx +0 -354
- package/.docs/raw/reference/vectors/vectorize.mdx +0 -298
- package/.docs/raw/reference/voice/azure.mdx +0 -218
- package/.docs/raw/reference/voice/cloudflare.mdx +0 -154
- package/.docs/raw/reference/voice/composite-voice.mdx +0 -144
- package/.docs/raw/reference/voice/deepgram.mdx +0 -166
- package/.docs/raw/reference/voice/elevenlabs.mdx +0 -218
- package/.docs/raw/reference/voice/google-gemini-live.mdx +0 -629
- package/.docs/raw/reference/voice/google.mdx +0 -203
- package/.docs/raw/reference/voice/mastra-voice.mdx +0 -413
- package/.docs/raw/reference/voice/murf.mdx +0 -253
- package/.docs/raw/reference/voice/openai-realtime.mdx +0 -376
- package/.docs/raw/reference/voice/openai.mdx +0 -169
- package/.docs/raw/reference/voice/playai.mdx +0 -163
- package/.docs/raw/reference/voice/sarvam.mdx +0 -260
- package/.docs/raw/reference/voice/speechify.mdx +0 -147
- package/.docs/raw/reference/voice/voice.addInstructions.mdx +0 -72
- package/.docs/raw/reference/voice/voice.addTools.mdx +0 -83
- package/.docs/raw/reference/voice/voice.answer.mdx +0 -69
- package/.docs/raw/reference/voice/voice.close.mdx +0 -56
- package/.docs/raw/reference/voice/voice.connect.mdx +0 -123
- package/.docs/raw/reference/voice/voice.events.mdx +0 -85
- package/.docs/raw/reference/voice/voice.getSpeakers.mdx +0 -298
- package/.docs/raw/reference/voice/voice.listen.mdx +0 -201
- package/.docs/raw/reference/voice/voice.off.mdx +0 -74
- package/.docs/raw/reference/voice/voice.on.mdx +0 -132
- package/.docs/raw/reference/voice/voice.send.mdx +0 -81
- package/.docs/raw/reference/voice/voice.speak.mdx +0 -206
- package/.docs/raw/reference/voice/voice.updateConfig.mdx +0 -92
- package/.docs/raw/reference/workflows/run-methods/cancel.mdx +0 -58
- package/.docs/raw/reference/workflows/run-methods/resume.mdx +0 -137
- package/.docs/raw/reference/workflows/run-methods/start.mdx +0 -134
- package/.docs/raw/reference/workflows/run-methods/watch.mdx +0 -74
- package/.docs/raw/reference/workflows/run.mdx +0 -104
- package/.docs/raw/reference/workflows/step.mdx +0 -155
- package/.docs/raw/reference/workflows/workflow-methods/branch.mdx +0 -48
- package/.docs/raw/reference/workflows/workflow-methods/commit.mdx +0 -30
- package/.docs/raw/reference/workflows/workflow-methods/create-run.mdx +0 -65
- package/.docs/raw/reference/workflows/workflow-methods/dountil.mdx +0 -52
- package/.docs/raw/reference/workflows/workflow-methods/dowhile.mdx +0 -52
- package/.docs/raw/reference/workflows/workflow-methods/foreach.mdx +0 -60
- package/.docs/raw/reference/workflows/workflow-methods/map.mdx +0 -43
- package/.docs/raw/reference/workflows/workflow-methods/parallel.mdx +0 -43
- package/.docs/raw/reference/workflows/workflow-methods/sendEvent.mdx +0 -70
- package/.docs/raw/reference/workflows/workflow-methods/sleep.mdx +0 -61
- package/.docs/raw/reference/workflows/workflow-methods/sleepUntil.mdx +0 -61
- package/.docs/raw/reference/workflows/workflow-methods/then.mdx +0 -44
- package/.docs/raw/reference/workflows/workflow-methods/waitForEvent.mdx +0 -66
- package/.docs/raw/reference/workflows/workflow.mdx +0 -132
- package/.docs/raw/scorers/custom-scorers.mdx +0 -473
- package/.docs/raw/scorers/evals-old-api/custom-eval.mdx +0 -26
- package/.docs/raw/scorers/evals-old-api/overview.mdx +0 -106
- package/.docs/raw/scorers/evals-old-api/running-in-ci.mdx +0 -85
- package/.docs/raw/scorers/evals-old-api/textual-evals.mdx +0 -58
- package/.docs/raw/scorers/off-the-shelf-scorers.mdx +0 -48
- package/.docs/raw/scorers/overview.mdx +0 -138
- package/.docs/raw/server-db/custom-api-routes.mdx +0 -67
- package/.docs/raw/server-db/local-dev-playground.mdx +0 -233
- package/.docs/raw/server-db/mastra-client.mdx +0 -274
- package/.docs/raw/server-db/middleware.mdx +0 -173
- package/.docs/raw/server-db/production-server.mdx +0 -91
- package/.docs/raw/server-db/runtime-context.mdx +0 -190
- package/.docs/raw/server-db/storage.mdx +0 -514
- package/.docs/raw/streaming/events.mdx +0 -223
- package/.docs/raw/streaming/overview.mdx +0 -177
- package/.docs/raw/streaming/tool-streaming.mdx +0 -143
- package/.docs/raw/streaming/workflow-streaming.mdx +0 -124
- package/.docs/raw/tools-mcp/advanced-usage.mdx +0 -128
- package/.docs/raw/tools-mcp/mcp-overview.mdx +0 -370
- package/.docs/raw/tools-mcp/overview.mdx +0 -93
- package/.docs/raw/voice/overview.mdx +0 -944
- package/.docs/raw/voice/speech-to-speech.mdx +0 -105
- package/.docs/raw/voice/speech-to-text.mdx +0 -86
- package/.docs/raw/voice/text-to-speech.mdx +0 -90
- package/.docs/raw/workflows/control-flow.mdx +0 -265
- package/.docs/raw/workflows/error-handling.mdx +0 -213
- package/.docs/raw/workflows/inngest-workflow.mdx +0 -359
- package/.docs/raw/workflows/input-data-mapping.mdx +0 -107
- package/.docs/raw/workflows/overview.mdx +0 -277
- package/.docs/raw/workflows/snapshots.mdx +0 -250
- package/.docs/raw/workflows/suspend-and-resume.mdx +0 -298
- package/.docs/raw/workflows/using-with-agents-and-tools.mdx +0 -350
- package/.docs/raw/workflows-legacy/control-flow.mdx +0 -776
- package/.docs/raw/workflows-legacy/dynamic-workflows.mdx +0 -237
- package/.docs/raw/workflows-legacy/error-handling.mdx +0 -185
- package/.docs/raw/workflows-legacy/nested-workflows.mdx +0 -354
- package/.docs/raw/workflows-legacy/overview.mdx +0 -180
- package/.docs/raw/workflows-legacy/runtime-variables.mdx +0 -154
- package/.docs/raw/workflows-legacy/steps.mdx +0 -113
- package/.docs/raw/workflows-legacy/suspend-and-resume.mdx +0 -404
- package/.docs/raw/workflows-legacy/variables.mdx +0 -316
- package/dist/chunk-TUAHUTTB.js +0 -356
- package/dist/prepare-docs/code-examples.d.ts +0 -5
- package/dist/prepare-docs/code-examples.d.ts.map +0 -1
- package/dist/prepare-docs/copy-raw.d.ts +0 -2
- package/dist/prepare-docs/copy-raw.d.ts.map +0 -1
- package/dist/prepare-docs/package-changes.d.ts +0 -5
- package/dist/prepare-docs/package-changes.d.ts.map +0 -1
- package/dist/prepare-docs/prepare.d.ts +0 -2
- package/dist/prepare-docs/prepare.d.ts.map +0 -1
- package/dist/prepare-docs/prepare.js +0 -1
- package/dist/tools/__tests__/test-setup.d.ts +0 -5
- package/dist/tools/__tests__/test-setup.d.ts.map +0 -1
- package/dist/tools/blog.d.ts +0 -22
- package/dist/tools/blog.d.ts.map +0 -1
- package/dist/tools/changes.d.ts +0 -22
- package/dist/tools/changes.d.ts.map +0 -1
- package/dist/tools/examples.d.ts +0 -28
- package/dist/tools/examples.d.ts.map +0 -1
- /package/.docs/{raw/course → course}/01-first-agent/01-introduction-to-mastra.md +0 -0
- /package/.docs/{raw/course → course}/01-first-agent/02-what-is-mastra.md +0 -0
- /package/.docs/{raw/course → course}/01-first-agent/03-verifying-installation.md +0 -0
- /package/.docs/{raw/course → course}/01-first-agent/06-understanding-system-prompts.md +0 -0
- /package/.docs/{raw/course → course}/01-first-agent/10-understanding-tools.md +0 -0
- /package/.docs/{raw/course → course}/01-first-agent/14-understanding-memory.md +0 -0
- /package/.docs/{raw/course → course}/01-first-agent/18-conclusion.md +0 -0
- /package/.docs/{raw/course → course}/02-agent-tools-mcp/01-introduction-to-mcp.md +0 -0
- /package/.docs/{raw/course → course}/02-agent-tools-mcp/02-installing-mcp.md +0 -0
- /package/.docs/{raw/course → course}/02-agent-tools-mcp/06-testing-mcp-setup.md +0 -0
- /package/.docs/{raw/course → course}/02-agent-tools-mcp/11-testing-zapier-integration.md +0 -0
- /package/.docs/{raw/course → course}/02-agent-tools-mcp/17-testing-github-integration.md +0 -0
- /package/.docs/{raw/course → course}/02-agent-tools-mcp/19-what-is-hackernews-mcp.md +0 -0
- /package/.docs/{raw/course → course}/02-agent-tools-mcp/22-testing-hackernews-integration.md +0 -0
- /package/.docs/{raw/course → course}/02-agent-tools-mcp/23-troubleshooting-hackernews.md +0 -0
- /package/.docs/{raw/course → course}/02-agent-tools-mcp/24-what-is-filesystem-mcp.md +0 -0
- /package/.docs/{raw/course → course}/02-agent-tools-mcp/25-creating-notes-directory.md +0 -0
- /package/.docs/{raw/course → course}/02-agent-tools-mcp/28-testing-filesystem-integration.md +0 -0
- /package/.docs/{raw/course → course}/02-agent-tools-mcp/29-troubleshooting-filesystem.md +0 -0
- /package/.docs/{raw/course → course}/03-agent-memory/01-understanding-memory.md +0 -0
- /package/.docs/{raw/course → course}/03-agent-memory/02-why-memory-matters.md +0 -0
- /package/.docs/{raw/course → course}/03-agent-memory/06-testing-memory-agent.md +0 -0
- /package/.docs/{raw/course → course}/03-agent-memory/11-testing-conversation-history.md +0 -0
- /package/.docs/{raw/course → course}/03-agent-memory/14-what-is-semantic-recall.md +0 -0
- /package/.docs/{raw/course → course}/03-agent-memory/15-how-semantic-recall-works.md +0 -0
- /package/.docs/{raw/course → course}/03-agent-memory/17-testing-semantic-recall.md +0 -0
- /package/.docs/{raw/course → course}/03-agent-memory/19-what-is-working-memory.md +0 -0
- /package/.docs/{raw/course → course}/03-agent-memory/20-how-working-memory-works.md +0 -0
- /package/.docs/{raw/course → course}/03-agent-memory/23-testing-working-memory.md +0 -0
- /package/.docs/{raw/course → course}/03-agent-memory/24-working-memory-in-practice.md +0 -0
- /package/.docs/{raw/course → course}/03-agent-memory/28-testing-memory-enhanced-agents.md +0 -0
- /package/.docs/{raw/course → course}/03-agent-memory/29-memory-best-practices.md +0 -0
- /package/.docs/{raw/course → course}/03-agent-memory/30-conclusion.md +0 -0
- /package/.docs/{raw/course → course}/04-workflows/22-conclusion.md +0 -0
|
@@ -1,137 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: "Azure App Services"
|
|
3
|
-
description: "Deploy your Mastra applications to Azure App Services."
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
import { Callout, Steps } from "nextra/components";
|
|
7
|
-
|
|
8
|
-
# Azure App Services
|
|
9
|
-
|
|
10
|
-
Deploy your Mastra applications to Azure App Services.
|
|
11
|
-
|
|
12
|
-
<Callout>
|
|
13
|
-
This guide assumes your Mastra application has been created using the default
|
|
14
|
-
`npx create-mastra@latest` command.
|
|
15
|
-
For more information on how to create a new Mastra application,
|
|
16
|
-
refer to our [getting started guide](/docs/getting-started/installation)
|
|
17
|
-
</Callout>
|
|
18
|
-
|
|
19
|
-
## Prerequisites
|
|
20
|
-
|
|
21
|
-
- An [Azure account](https://azure.microsoft.com/) with an active subscription
|
|
22
|
-
- A [GitHub repository](https://github.com/) containing your Mastra application
|
|
23
|
-
- Your Mastra application should be created using `npx create-mastra@latest`
|
|
24
|
-
|
|
25
|
-
## Deployment Steps
|
|
26
|
-
|
|
27
|
-
<Steps>
|
|
28
|
-
|
|
29
|
-
### Create a new App Service
|
|
30
|
-
|
|
31
|
-
- Log in to the [Azure Portal](https://portal.azure.com)
|
|
32
|
-
- Navigate to **[App Services](https://docs.microsoft.com/en-us/azure/app-service/)** or search for it in the top search bar
|
|
33
|
-
- Click **Create** to create a new App Service
|
|
34
|
-
- In the drop-down, select **Web App**
|
|
35
|
-
|
|
36
|
-
### Configure App Service settings
|
|
37
|
-
|
|
38
|
-
- **Subscription**: Select your Azure subscription
|
|
39
|
-
- **Resource Group**: Create a new resource group or select an existing one
|
|
40
|
-
- **Instance name**: Enter a unique name for your app (this will be part of your URL)
|
|
41
|
-
- **Publish**: Select **Code**
|
|
42
|
-
- **Runtime stack**: Select **Node 22 LTS**
|
|
43
|
-
- **Operating System**: Select **Linux**
|
|
44
|
-
- **Region**: Choose a region close to your users
|
|
45
|
-
- **Linux Plan**: You may have the option of choosing a plan depending on the region you chose, pick an appropriate one for your needs.
|
|
46
|
-
- Click **Review + Create**
|
|
47
|
-
- Wait for validation to complete, then click **Create**
|
|
48
|
-
|
|
49
|
-
### Wait for deployment
|
|
50
|
-
|
|
51
|
-
- Wait for the deployment to complete
|
|
52
|
-
- Once finished, click **Go to resource** under the next steps section
|
|
53
|
-
|
|
54
|
-
### Configure environment variables
|
|
55
|
-
|
|
56
|
-
Before setting up deployment, configure your environment variables:
|
|
57
|
-
|
|
58
|
-
- Navigate to **Settings** > **Environment variables** in the left sidebar
|
|
59
|
-
- Add your required environment variables such as:
|
|
60
|
-
- Model provider API keys (e.g., `OPENAI_API_KEY`)
|
|
61
|
-
- Database connection strings
|
|
62
|
-
- Any other configuration values your Mastra application requires
|
|
63
|
-
- Click **Apply** to save the changes
|
|
64
|
-
|
|
65
|
-
### Set up GitHub deployment
|
|
66
|
-
|
|
67
|
-
- Navigate to **Deployment Center** in the left sidebar
|
|
68
|
-
- Select **GitHub** as your source
|
|
69
|
-
- Sign in to GitHub if you're not already authenticated with Azure
|
|
70
|
-
- In this example, we will keep [GitHub Actions](https://docs.github.com/en/actions) as our provider
|
|
71
|
-
- Select your organization, repository, and branch
|
|
72
|
-
- Azure will generate a GitHub workflow file and you can preview it before proceeding
|
|
73
|
-
- Click **Save** (the save button is located at the top of the page)
|
|
74
|
-
|
|
75
|
-
### Modify the GitHub workflow
|
|
76
|
-
|
|
77
|
-
<Callout type="warning">
|
|
78
|
-
The default workflow generated by Azure will fail for Mastra applications and needs to be modified.
|
|
79
|
-
</Callout>
|
|
80
|
-
|
|
81
|
-
After Azure creates the workflow, it will trigger a GitHub Actions run and merge the workflow file into your branch. **Cancel this initial run** as it will fail without the necessary modifications.
|
|
82
|
-
|
|
83
|
-
Pull the latest changes to your local repository and modify the generated workflow file (`.github/workflows/main_<your-app-name>.yml`):
|
|
84
|
-
|
|
85
|
-
1. **Update the build step**: Find the step named "npm install, build, and test" and:
|
|
86
|
-
- Change the step name to "npm install and build"
|
|
87
|
-
- If you haven't set up proper tests in your Mastra application, remove the `npm test` command from the run section as the default test script will fail and disrupt deployment. If you have working tests, you can keep the test command.
|
|
88
|
-
|
|
89
|
-
2. **Update the zip artifact step**: Find the "Zip artifact for deployment" step and replace the zip command with:
|
|
90
|
-
|
|
91
|
-
```yaml
|
|
92
|
-
run: (cd .mastra/output && zip ../../release.zip -r .)
|
|
93
|
-
```
|
|
94
|
-
|
|
95
|
-
This ensures only the build outputs from `.mastra/output` are included in the deployment package.
|
|
96
|
-
|
|
97
|
-
### Deploy your changes
|
|
98
|
-
|
|
99
|
-
- Commit and push your workflow modifications
|
|
100
|
-
- The build will be automatically triggered in the **Deployment Center** in your Azure dashboard
|
|
101
|
-
- Monitor the deployment progress until it completes successfully
|
|
102
|
-
|
|
103
|
-
### Access your application
|
|
104
|
-
|
|
105
|
-
- Once the build is successful, wait a few moments for the application to start
|
|
106
|
-
- Access your deployed application using the default URL provided in the **Overview** tab in the Azure portal
|
|
107
|
-
- Your application will be available at `https://<your-app-name>.azurewebsites.net`
|
|
108
|
-
|
|
109
|
-
</Steps>
|
|
110
|
-
|
|
111
|
-
## Connect to your Mastra server
|
|
112
|
-
|
|
113
|
-
You can now connect to your Mastra server from your client application using a `MastraClient` from the `@mastra/client-js` package.
|
|
114
|
-
|
|
115
|
-
Refer to the [`MastraClient` documentation](/docs/client-js/overview) for more information.
|
|
116
|
-
|
|
117
|
-
```typescript copy showLineNumbers
|
|
118
|
-
import { MastraClient } from "@mastra/client-js";
|
|
119
|
-
|
|
120
|
-
const mastraClient = new MastraClient({
|
|
121
|
-
baseUrl: "https://<your-app-name>.azurewebsites.net",
|
|
122
|
-
});
|
|
123
|
-
```
|
|
124
|
-
|
|
125
|
-
<Callout>
|
|
126
|
-
Azure App Services uses an ephemeral file system for some pricing tiers.
|
|
127
|
-
For production applications, avoid using Mastra storage providers that rely on the local file system,
|
|
128
|
-
such as `LibSQLStore` with a file URL. Consider using cloud-based storage solutions instead.
|
|
129
|
-
</Callout>
|
|
130
|
-
|
|
131
|
-
## Next steps
|
|
132
|
-
|
|
133
|
-
- [Mastra Client SDK](/docs/client-js/overview)
|
|
134
|
-
- [Configure custom domains](https://docs.microsoft.com/en-us/azure/app-service/app-service-web-tutorial-custom-domain)
|
|
135
|
-
- [Enable HTTPS](https://docs.microsoft.com/en-us/azure/app-service/configure-ssl-bindings)
|
|
136
|
-
- [Azure App Service documentation](https://docs.microsoft.com/en-us/azure/app-service/)
|
|
137
|
-
|
|
@@ -1,206 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: "Digital Ocean"
|
|
3
|
-
description: "Deploy your Mastra applications to Digital Ocean."
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
import { Callout, Steps, Tabs } from "nextra/components";
|
|
7
|
-
|
|
8
|
-
# Digital Ocean
|
|
9
|
-
|
|
10
|
-
Deploy your Mastra applications to Digital Ocean's App Platform and Droplets.
|
|
11
|
-
|
|
12
|
-
<Callout>
|
|
13
|
-
This guide assumes your Mastra application has been created using the default
|
|
14
|
-
`npx create-mastra@latest` command.
|
|
15
|
-
For more information on how to create a new Mastra application,
|
|
16
|
-
refer to our [getting started guide](./../../getting-started/installation.mdx)
|
|
17
|
-
</Callout>
|
|
18
|
-
|
|
19
|
-
<Tabs items={["App Platform", "Droplets"]}>
|
|
20
|
-
|
|
21
|
-
<Tabs.Tab>
|
|
22
|
-
|
|
23
|
-
## App Platform
|
|
24
|
-
|
|
25
|
-
### Prerequisites [#app-platform-prerequisites]
|
|
26
|
-
|
|
27
|
-
- 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.
|
|
28
|
-
- A [Digital Ocean account](https://www.digitalocean.com/)
|
|
29
|
-
|
|
30
|
-
### Deployment Steps
|
|
31
|
-
|
|
32
|
-
<Steps>
|
|
33
|
-
|
|
34
|
-
### Create a new App
|
|
35
|
-
|
|
36
|
-
- Log in to your [Digital Ocean dashboard](https://cloud.digitalocean.com/).
|
|
37
|
-
- Navigate to the [App Platform](https://docs.digitalocean.com/products/app-platform/) service.
|
|
38
|
-
- Select your source provider and create a new app.
|
|
39
|
-
|
|
40
|
-
### Configure Deployment Source
|
|
41
|
-
|
|
42
|
-
- Connect and select your repository. You may also choose a container image or a sample app.
|
|
43
|
-
- Select the branch you want to deploy from.
|
|
44
|
-
- Configure the source directory if necessary. If your Mastra application uses the default directory structure, no action is required here.
|
|
45
|
-
- Head to the next step.
|
|
46
|
-
|
|
47
|
-
### Configure Resource Settings and Environment Variables
|
|
48
|
-
|
|
49
|
-
- A Node.js build should be detected automatically.
|
|
50
|
-
- **Configure Build Command**: You need to add a custom build command for the app platform to build your Mastra project successfully. Set the build command based on your package manager:
|
|
51
|
-
|
|
52
|
-
<Tabs items={["npm", "pnpm", "yarn", "bun"]}>
|
|
53
|
-
<Tabs.Tab>
|
|
54
|
-
```
|
|
55
|
-
npm run build
|
|
56
|
-
```
|
|
57
|
-
</Tabs.Tab>
|
|
58
|
-
<Tabs.Tab>
|
|
59
|
-
```
|
|
60
|
-
pnpm build
|
|
61
|
-
```
|
|
62
|
-
</Tabs.Tab>
|
|
63
|
-
<Tabs.Tab>
|
|
64
|
-
```
|
|
65
|
-
yarn build
|
|
66
|
-
```
|
|
67
|
-
</Tabs.Tab>
|
|
68
|
-
<Tabs.Tab>
|
|
69
|
-
```
|
|
70
|
-
bun run build
|
|
71
|
-
```
|
|
72
|
-
</Tabs.Tab>
|
|
73
|
-
</Tabs>
|
|
74
|
-
|
|
75
|
-
- Add any required environment variables for your Mastra application. This includes API keys, database URLs, and other configuration values.
|
|
76
|
-
- You may choose to configure the size of your resource here.
|
|
77
|
-
- Other things you may optionally configure include, the region of your resource, the unique app name, and what project the resource belongs to.
|
|
78
|
-
- Once you're done, you may create the app after reviewing your configuration and pricing estimates.
|
|
79
|
-
|
|
80
|
-
### Deployment
|
|
81
|
-
|
|
82
|
-
- Your app will be built and deployed automatically.
|
|
83
|
-
- Digital Ocean will provide you with a URL to access your deployed application.
|
|
84
|
-
|
|
85
|
-
</Steps>
|
|
86
|
-
|
|
87
|
-
You can now access your deployed application at the URL provided by Digital Ocean.
|
|
88
|
-
|
|
89
|
-
<Callout>
|
|
90
|
-
The Digital Ocean App Platform uses an ephemeral file system,
|
|
91
|
-
meaning that any files written to the file system are short-lived and may be lost.
|
|
92
|
-
Avoid using a Mastra storage provider that uses the file system,
|
|
93
|
-
such as `LibSQLStore` with a file URL.
|
|
94
|
-
</Callout>
|
|
95
|
-
|
|
96
|
-
</Tabs.Tab>
|
|
97
|
-
|
|
98
|
-
<Tabs.Tab>
|
|
99
|
-
|
|
100
|
-
## Droplets
|
|
101
|
-
|
|
102
|
-
Deploy your Mastra application to Digital Ocean's Droplets.
|
|
103
|
-
|
|
104
|
-
### Prerequisites [#droplets-prerequisites]
|
|
105
|
-
|
|
106
|
-
- A [Digital Ocean account](https://www.digitalocean.com/)
|
|
107
|
-
- A [Droplet](https://docs.digitalocean.com/products/droplets/) running Ubuntu 24+
|
|
108
|
-
- A domain name with an A record pointing to your droplet
|
|
109
|
-
- A reverse proxy configured (e.g., using [nginx](https://nginx.org/))
|
|
110
|
-
- SSL certificate configured (e.g., using [Let's Encrypt](https://letsencrypt.org/))
|
|
111
|
-
- Node.js 18+ installed on your droplet
|
|
112
|
-
|
|
113
|
-
### Deployment Steps
|
|
114
|
-
|
|
115
|
-
<Steps>
|
|
116
|
-
|
|
117
|
-
### Clone your Mastra application
|
|
118
|
-
|
|
119
|
-
Connect to your Droplet and clone your repository:
|
|
120
|
-
|
|
121
|
-
<Tabs items={["Public Repository", "Private Repository"]}>
|
|
122
|
-
<Tabs.Tab>
|
|
123
|
-
|
|
124
|
-
```bash copy
|
|
125
|
-
git clone https://github.com/<your-username>/<your-repository>.git
|
|
126
|
-
```
|
|
127
|
-
|
|
128
|
-
</Tabs.Tab>
|
|
129
|
-
|
|
130
|
-
<Tabs.Tab>
|
|
131
|
-
|
|
132
|
-
```bash copy
|
|
133
|
-
git clone https://<your-username>:<your-personal-access-token>@github.com/<your-username>/<your-repository>.git
|
|
134
|
-
```
|
|
135
|
-
|
|
136
|
-
</Tabs.Tab>
|
|
137
|
-
</Tabs>
|
|
138
|
-
|
|
139
|
-
Navigate to the repository directory:
|
|
140
|
-
|
|
141
|
-
```bash copy
|
|
142
|
-
cd "<your-repository>"
|
|
143
|
-
```
|
|
144
|
-
|
|
145
|
-
### Install dependencies
|
|
146
|
-
|
|
147
|
-
```bash copy
|
|
148
|
-
npm install
|
|
149
|
-
```
|
|
150
|
-
|
|
151
|
-
### Set up environment variables
|
|
152
|
-
|
|
153
|
-
Create a `.env` file and add your environment variables:
|
|
154
|
-
|
|
155
|
-
```bash copy
|
|
156
|
-
touch .env
|
|
157
|
-
```
|
|
158
|
-
|
|
159
|
-
Edit the `.env` file and add your environment variables:
|
|
160
|
-
|
|
161
|
-
```bash copy
|
|
162
|
-
OPENAI_API_KEY=<your-openai-api-key>
|
|
163
|
-
# Add other required environment variables
|
|
164
|
-
```
|
|
165
|
-
|
|
166
|
-
### Build the application
|
|
167
|
-
|
|
168
|
-
```bash copy
|
|
169
|
-
npm run build
|
|
170
|
-
```
|
|
171
|
-
|
|
172
|
-
### Run the application
|
|
173
|
-
|
|
174
|
-
```bash copy
|
|
175
|
-
node --import=./.mastra/output/instrumentation.mjs --env-file=".env" .mastra/output/index.mjs
|
|
176
|
-
```
|
|
177
|
-
|
|
178
|
-
<Callout>
|
|
179
|
-
Your Mastra application will run on port 4111 by default. Ensure your reverse proxy is configured to forward requests to this port.
|
|
180
|
-
</Callout>
|
|
181
|
-
|
|
182
|
-
</Steps>
|
|
183
|
-
|
|
184
|
-
</Tabs.Tab>
|
|
185
|
-
|
|
186
|
-
</Tabs>
|
|
187
|
-
|
|
188
|
-
## Connect to your Mastra server
|
|
189
|
-
|
|
190
|
-
You can now connect to your Mastra server from your client application using a `MastraClient` from the `@mastra/client-js` package.
|
|
191
|
-
|
|
192
|
-
Refer to the [`MastraClient` documentation](/docs/server-db/mastra-client) for more information.
|
|
193
|
-
|
|
194
|
-
```typescript copy showLineNumbers
|
|
195
|
-
import { MastraClient } from "@mastra/client-js";
|
|
196
|
-
|
|
197
|
-
const mastraClient = new MastraClient({
|
|
198
|
-
baseUrl: "https://<your-domain-name>",
|
|
199
|
-
});
|
|
200
|
-
```
|
|
201
|
-
|
|
202
|
-
## Next steps
|
|
203
|
-
|
|
204
|
-
- [Mastra Client SDK](/docs/client-js/overview)
|
|
205
|
-
- [Digital Ocean App Platform documentation](https://docs.digitalocean.com/products/app-platform/)
|
|
206
|
-
- [Digital Ocean Droplets documentation](https://docs.digitalocean.com/products/droplets/)
|
|
@@ -1,52 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: "Cloud Providers"
|
|
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](/docs/deployment/cloud-providers/amazon-ec2)
|
|
11
|
-
- [AWS Lambda](/docs/deployment/cloud-providers/aws-lambda)
|
|
12
|
-
- [Digital Ocean](/docs/deployment/cloud-providers/digital-ocean)
|
|
13
|
-
- [Azure App Services](/docs/deployment/cloud-providers/azure-app-services)
|
|
14
|
-
|
|
15
|
-
For self-hosted Node.js server deployment, see the [Creating A Mastra Server](/docs/deployment/server) guide.
|
|
16
|
-
|
|
17
|
-
## Prerequisites
|
|
18
|
-
|
|
19
|
-
Before deploying to a cloud provider, ensure you have:
|
|
20
|
-
|
|
21
|
-
- A [Mastra application](/docs/getting-started/installation)
|
|
22
|
-
- Node.js `v20.0` or higher
|
|
23
|
-
- A GitHub repository for your application (required for most CI/CD setups)
|
|
24
|
-
- Domain name management access (for SSL and HTTPS)
|
|
25
|
-
- Basic familiarity with server setup (e.g. Nginx, environment variables)
|
|
26
|
-
|
|
27
|
-
## LibSQLStore
|
|
28
|
-
|
|
29
|
-
`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**, **Azure App Services**, or **Digital Ocean App Platform**, you **must remove** all usage of `LibSQLStore`.
|
|
30
|
-
|
|
31
|
-
Specifically, ensure you've removed it from both `src/mastra/index.ts` and `src/mastra/agents/weather-agent.ts`:
|
|
32
|
-
|
|
33
|
-
```typescript filename="src/mastra/index.ts" showLineNumbers
|
|
34
|
-
export const mastra = new Mastra({
|
|
35
|
-
// ...
|
|
36
|
-
storage: new LibSQLStore({ // [!code --]
|
|
37
|
-
// stores telemetry, evals, ... into memory storage, if it needs to persist, change to file:../mastra.db // [!code --]
|
|
38
|
-
url: ":memory:", // [!code --]
|
|
39
|
-
})//[!code --]
|
|
40
|
-
});
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
```typescript filename="src/mastra/agents/weather-agent.ts" showLineNumbers
|
|
44
|
-
export const weatherAgent = new Agent({
|
|
45
|
-
// ..
|
|
46
|
-
memory: new Memory({ // [!code --]
|
|
47
|
-
storage: new LibSQLStore({ // [!code --]
|
|
48
|
-
url: "file:../mastra.db" // path is relative to the .mastra/output directory // [!code --]
|
|
49
|
-
}) // [!code --]
|
|
50
|
-
})// [!code --]
|
|
51
|
-
});
|
|
52
|
-
```
|
|
@@ -1,107 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Monorepo Deployment
|
|
3
|
-
description: Learn how to deploy Mastra applications that are part of a monorepo setup
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
import { FileTree } from "nextra/components";
|
|
7
|
-
|
|
8
|
-
# Monorepo Deployment
|
|
9
|
-
|
|
10
|
-
Deploying Mastra in a monorepo follows the same approach as deploying a standalone application. While some [Cloud](./cloud-providers/) or [Serverless Platform](./serverless-platforms/) providers may introduce extra requirements, the core setup is the same.
|
|
11
|
-
|
|
12
|
-
## Example monorepo
|
|
13
|
-
|
|
14
|
-
In this example, the Mastra application is located at `apps/api`.
|
|
15
|
-
|
|
16
|
-
<FileTree>
|
|
17
|
-
<FileTree.Folder name="apps" defaultOpen>
|
|
18
|
-
<FileTree.Folder name="api" defaultOpen>
|
|
19
|
-
<FileTree.Folder name="src" defaultOpen>
|
|
20
|
-
<FileTree.Folder name="mastra" defaultOpen>
|
|
21
|
-
<FileTree.Folder name="agents" />
|
|
22
|
-
<FileTree.Folder name="tools" />
|
|
23
|
-
<FileTree.Folder name="workflows" />
|
|
24
|
-
<FileTree.File name="index.ts" />
|
|
25
|
-
</FileTree.Folder>
|
|
26
|
-
</FileTree.Folder>
|
|
27
|
-
<FileTree.File name="package.json" />
|
|
28
|
-
<FileTree.File name="tsconfig.json" />
|
|
29
|
-
</FileTree.Folder>
|
|
30
|
-
<FileTree.Folder name="web" />
|
|
31
|
-
</FileTree.Folder>
|
|
32
|
-
<FileTree.Folder name="packages" defaultOpen>
|
|
33
|
-
<FileTree.Folder name="ui" />
|
|
34
|
-
<FileTree.Folder name="utils" />
|
|
35
|
-
</FileTree.Folder>
|
|
36
|
-
<FileTree.File name="package.json" />
|
|
37
|
-
</FileTree>
|
|
38
|
-
|
|
39
|
-
## Environment variables
|
|
40
|
-
|
|
41
|
-
Environment variables like `OPENAI_API_KEY` should be stored in an `.env` file at the root of the Mastra application `(apps/api)`, for example:
|
|
42
|
-
|
|
43
|
-
<FileTree>
|
|
44
|
-
<FileTree.Folder name="api" defaultOpen>
|
|
45
|
-
<FileTree.Folder name="src" defaultOpen>
|
|
46
|
-
<FileTree.Folder name="mastra" />
|
|
47
|
-
</FileTree.Folder>
|
|
48
|
-
<FileTree.File name=".env" />
|
|
49
|
-
<FileTree.File name="package.json" />
|
|
50
|
-
<FileTree.File name="tsconfig.json" />
|
|
51
|
-
</FileTree.Folder>
|
|
52
|
-
</FileTree>
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
## Deployment configuration
|
|
56
|
-
|
|
57
|
-
The image below shows how to select `apps/api` as the project root when deploying to [Mastra Cloud](../mastra-cloud/overview.mdx). While the interface may differ between providers, the configuration remains the same.
|
|
58
|
-
|
|
59
|
-

|
|
60
|
-
|
|
61
|
-
## Dependency management
|
|
62
|
-
|
|
63
|
-
In a monorepo, keep dependencies consistent to avoid version conflicts and build errors.
|
|
64
|
-
|
|
65
|
-
- Use a **single lockfile** at the project root so all packages resolve the same versions.
|
|
66
|
-
- Align versions of **shared libraries** (like Mastra or frameworks) to prevent duplicates.
|
|
67
|
-
|
|
68
|
-
## Deployment pitfalls
|
|
69
|
-
|
|
70
|
-
Common issues to watch for when deploying Mastra in a monorepo:
|
|
71
|
-
|
|
72
|
-
- **Wrong project root**: make sure the correct package (e.g. `apps/api`) is selected as the deploy target.
|
|
73
|
-
|
|
74
|
-
## Bundler options
|
|
75
|
-
|
|
76
|
-
Use `transpilePackages` to compile TypeScript workspace packages or libraries. List package names exactly as they appear in each `package.json`. Use `externals` to exclude dependencies resolved at runtime, and `sourcemap` to emit readable stack traces.
|
|
77
|
-
|
|
78
|
-
```typescript filename="src/mastra/index.ts" showLineNumbers copy
|
|
79
|
-
import { Mastra } from "@mastra/core/mastra";
|
|
80
|
-
|
|
81
|
-
export const mastra = new Mastra({
|
|
82
|
-
// ...
|
|
83
|
-
bundler: {
|
|
84
|
-
transpilePackages: ["utils"],
|
|
85
|
-
externals: ["ui"],
|
|
86
|
-
sourcemap: true
|
|
87
|
-
}
|
|
88
|
-
});
|
|
89
|
-
```
|
|
90
|
-
|
|
91
|
-
> See [Mastra Class](../../reference/core/mastra-class.mdx) for more configuration options.
|
|
92
|
-
|
|
93
|
-
## Supported monorepos
|
|
94
|
-
|
|
95
|
-
Mastra works with:
|
|
96
|
-
|
|
97
|
-
- npm workspaces
|
|
98
|
-
- pnpm workspaces
|
|
99
|
-
- Yarn workspaces
|
|
100
|
-
- Turborepo
|
|
101
|
-
|
|
102
|
-
Known limitations:
|
|
103
|
-
|
|
104
|
-
- Bun workspaces — partial support; known issues
|
|
105
|
-
- Nx — You can use Nx's [supported dependency strategies](https://nx.dev/concepts/decisions/dependency-management) but you need to have `package.json` files inside your workspace packages
|
|
106
|
-
|
|
107
|
-
> If you are experiencing issues with monorepos see our: [Monorepos Support mega issue](https://github.com/mastra-ai/mastra/issues/6852).
|
|
@@ -1,82 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Deployment Overview
|
|
3
|
-
description: Learn about different deployment options for your Mastra applications
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Deployment Overview
|
|
7
|
-
|
|
8
|
-
Mastra offers multiple deployment options to suit your application's needs, from fully-managed solutions to self-hosted options, and web framework integrations. This guide will help you understand the available deployment paths and choose the right one for your project.
|
|
9
|
-
|
|
10
|
-
## Choosing a Deployment Option
|
|
11
|
-
|
|
12
|
-
| Option | Best For | Key Benefits |
|
|
13
|
-
| ------------------------ | ------------------------------------------------------------- | -------------------------------------------------------------- |
|
|
14
|
-
| **Mastra Cloud** | Teams wanting to ship quickly without infrastructure concerns | Fully-managed, automatic scaling, built-in observability |
|
|
15
|
-
| **Framework Deployment** | Teams already using Next.js, Astro etc | Simplify deployment with a unified codebase for frontend and backend |
|
|
16
|
-
| **Server Deployment** | Teams needing maximum control and customization | Full control, custom middleware, integrate with existing apps |
|
|
17
|
-
| **Serverless Platforms** | Teams already using Vercel, Netlify, or Cloudflare | Platform integration, simplified deployment, automatic scaling |
|
|
18
|
-
|
|
19
|
-
## Deployment Options
|
|
20
|
-
|
|
21
|
-
### Runtime support
|
|
22
|
-
|
|
23
|
-
- Node.js `v20.0` or higher
|
|
24
|
-
- Bun
|
|
25
|
-
- Deno
|
|
26
|
-
- [Cloudflare](../deployment/serverless-platforms/cloudflare-deployer.mdx)
|
|
27
|
-
|
|
28
|
-
### Mastra Cloud
|
|
29
|
-
|
|
30
|
-
Mastra Cloud is a deployment platform that connects to your GitHub repository, automatically deploys on code changes, and provides monitoring tools. It includes:
|
|
31
|
-
|
|
32
|
-
- GitHub repository integration
|
|
33
|
-
- Deployment on git push
|
|
34
|
-
- Agent testing interface
|
|
35
|
-
- Comprehensive logs and traces
|
|
36
|
-
- Custom domains for each project
|
|
37
|
-
|
|
38
|
-
[View Mastra Cloud documentation →](../mastra-cloud/overview.mdx)
|
|
39
|
-
|
|
40
|
-
### With a Web Framework
|
|
41
|
-
|
|
42
|
-
Mastra can be integrated with a variety of web frameworks. For example, see one of the following for a detailed guide.
|
|
43
|
-
|
|
44
|
-
- [With Next.js](../frameworks/web-frameworks/next-js.mdx)
|
|
45
|
-
- [With Astro](../frameworks/web-frameworks/astro.mdx)
|
|
46
|
-
|
|
47
|
-
When integrated with a framework, Mastra typically requires no additional configuration for deployment.
|
|
48
|
-
|
|
49
|
-
[View Web Framework Integration →](./web-framework.mdx)
|
|
50
|
-
|
|
51
|
-
### With a Server
|
|
52
|
-
|
|
53
|
-
You can deploy Mastra as a standard Node.js HTTP server, which gives you full control over your infrastructure and deployment environment.
|
|
54
|
-
|
|
55
|
-
- Custom API routes and middleware
|
|
56
|
-
- Configurable CORS and authentication
|
|
57
|
-
- Deploy to VMs, containers, or PaaS platforms
|
|
58
|
-
- Ideal for integrating with existing Node.js applications
|
|
59
|
-
|
|
60
|
-
[Server deployment guide →](./server-deployment.mdx)
|
|
61
|
-
|
|
62
|
-
### Serverless Platforms
|
|
63
|
-
|
|
64
|
-
Mastra provides platform-specific deployers for popular serverless platforms, enabling you to deploy your application with minimal configuration.
|
|
65
|
-
|
|
66
|
-
- Deploy to Cloudflare Workers, Vercel, or Netlify
|
|
67
|
-
- Platform-specific optimizations
|
|
68
|
-
- Simplified deployment process
|
|
69
|
-
- Automatic scaling through the platform
|
|
70
|
-
|
|
71
|
-
[Serverless deployment guide →](./server-deployment.mdx)
|
|
72
|
-
|
|
73
|
-
## Client Configuration
|
|
74
|
-
|
|
75
|
-
Once your Mastra application is deployed, you'll need to configure your client to communicate with it. The Mastra Client SDK provides a simple and type-safe interface for interacting with your Mastra server.
|
|
76
|
-
|
|
77
|
-
- Type-safe API interactions
|
|
78
|
-
- Authentication and request handling
|
|
79
|
-
- Retries and error handling
|
|
80
|
-
- Support for streaming responses
|
|
81
|
-
|
|
82
|
-
[Client configuration guide →](../server-db/mastra-client.mdx)
|
|
@@ -1,86 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: "Deploy a Mastra Server"
|
|
3
|
-
description: "Learn how to deploy a Mastra server with build settings and deployment options."
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
import { FileTree } from "nextra/components";
|
|
7
|
-
|
|
8
|
-
# Deploy a Mastra Server
|
|
9
|
-
|
|
10
|
-
Mastra runs as a standard Node.js server and can be deployed across a wide range of environments.
|
|
11
|
-
|
|
12
|
-
## Default project structure
|
|
13
|
-
|
|
14
|
-
The [getting started guide](/docs/getting-started/installation) scaffolds a project with sensible defaults to help you begin quickly. By default, the CLI organizes application files under the `src/mastra/` directory, resulting in a structure similar to the following:
|
|
15
|
-
|
|
16
|
-
<FileTree>
|
|
17
|
-
<FileTree.Folder name="src" defaultOpen>
|
|
18
|
-
<FileTree.Folder name="mastra" defaultOpen>
|
|
19
|
-
<FileTree.Folder name="agents" />
|
|
20
|
-
<FileTree.Folder name="tools" />
|
|
21
|
-
<FileTree.Folder name="workflows" />
|
|
22
|
-
<FileTree.File name="index.ts" />
|
|
23
|
-
</FileTree.Folder>
|
|
24
|
-
</FileTree.Folder>
|
|
25
|
-
<FileTree.File name="package.json" />
|
|
26
|
-
<FileTree.File name="tsconfig.json" />
|
|
27
|
-
</FileTree>
|
|
28
|
-
|
|
29
|
-
## Building
|
|
30
|
-
|
|
31
|
-
The `mastra build` command starts the build process:
|
|
32
|
-
|
|
33
|
-
```bash copy
|
|
34
|
-
mastra build
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
### Customizing the input directory
|
|
38
|
-
|
|
39
|
-
If your Mastra files are located elsewhere, use the `--dir` flag to specify the custom location. The `--dir` flag tells Mastra where to find your entry point file (`index.ts` or `index.js`) and related directories.
|
|
40
|
-
|
|
41
|
-
```bash copy
|
|
42
|
-
mastra build --dir ./my-project/mastra
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
## Build process
|
|
46
|
-
|
|
47
|
-
The build process follows these steps:
|
|
48
|
-
|
|
49
|
-
1. **Locates entry file**: Finds `index.ts` or `index.js` in your specified directory (default: `src/mastra/`).
|
|
50
|
-
2. **Creates build directory**: Generates a `.mastra/` directory containing:
|
|
51
|
-
- **`.build`**: Contains dependency analysis, bundled dependencies, and build configuration files.
|
|
52
|
-
- **`output`**: Contains the production-ready application bundle with `index.mjs`, `instrumentation.mjs`, and project-specific files.
|
|
53
|
-
3. **Copies static assets**: Copies the `public/` folder contents to the `output` directory for serving static files.
|
|
54
|
-
4. **Bundles code**: Uses Rollup with tree shaking and source maps for optimization.
|
|
55
|
-
5. **Generates server**: Creates a [Hono](https://hono.dev) HTTP server ready for deployment.
|
|
56
|
-
|
|
57
|
-
### Build output structure
|
|
58
|
-
|
|
59
|
-
After building, Mastra creates a `.mastra/` directory with the following structure:
|
|
60
|
-
|
|
61
|
-
<FileTree>
|
|
62
|
-
<FileTree.Folder name=".mastra" defaultOpen>
|
|
63
|
-
<FileTree.Folder name=".build" />
|
|
64
|
-
<FileTree.Folder name="output" />
|
|
65
|
-
</FileTree.Folder>
|
|
66
|
-
</FileTree>
|
|
67
|
-
|
|
68
|
-
### `public` folder
|
|
69
|
-
|
|
70
|
-
If a `public` folder exists in `src/mastra`, its contents are copied into the `.build/output` directory during the build process.
|
|
71
|
-
|
|
72
|
-
## Running the Server
|
|
73
|
-
|
|
74
|
-
Start the HTTP server:
|
|
75
|
-
|
|
76
|
-
```bash copy
|
|
77
|
-
node .mastra/output/index.mjs
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
## Enable Telemetry
|
|
81
|
-
|
|
82
|
-
To enable telemetry and observability, load the instrumentation file:
|
|
83
|
-
|
|
84
|
-
```bash copy
|
|
85
|
-
node --import=./.mastra/output/instrumentation.mjs .mastra/output/index.mjs
|
|
86
|
-
```
|