@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
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# dataset.getItemHistory()
|
|
2
|
+
|
|
3
|
+
**Added in:** `@mastra/core@1.4.0`
|
|
4
|
+
|
|
5
|
+
Retrieves the full SCD-2 (Slowly Changing Dimension Type 2) history of a specific item across all dataset versions.
|
|
6
|
+
|
|
7
|
+
## Usage example
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
import { Mastra } from '@mastra/core'
|
|
11
|
+
|
|
12
|
+
const mastra = new Mastra({
|
|
13
|
+
/* storage config */
|
|
14
|
+
})
|
|
15
|
+
|
|
16
|
+
const dataset = await mastra.datasets.get({ id: 'dataset-id' })
|
|
17
|
+
|
|
18
|
+
const history = await dataset.getItemHistory({ itemId: 'item-id' })
|
|
19
|
+
|
|
20
|
+
for (const row of history) {
|
|
21
|
+
console.log(`Version ${row.datasetVersion}: ${row.isDeleted ? 'deleted' : 'active'}`)
|
|
22
|
+
}
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Parameters
|
|
26
|
+
|
|
27
|
+
**itemId:** (`string`): ID of the item to retrieve history for.
|
|
28
|
+
|
|
29
|
+
## Returns
|
|
30
|
+
|
|
31
|
+
**result:** (`Promise<DatasetItemRow[]>`): DatasetItemRowid:stringUnique row identifier.datasetId:stringID of the parent dataset.datasetVersion:numberDataset version for this row\.validTo:number | nullVersion at which this row was superseded, or \`null\` if still current.isDeleted:booleanWhether this row represents a deletion.input:unknownInput data at this version.groundTruth?:unknownGround truth at this version.metadata?:Record\<string, unknown>Metadata at this version.createdAt:DateWhen this row was created.updatedAt:DateWhen this row was last updated.
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# DatasetsManager.list()
|
|
2
|
+
|
|
3
|
+
**Added in:** `@mastra/core@1.4.0`
|
|
4
|
+
|
|
5
|
+
Lists all datasets with pagination.
|
|
6
|
+
|
|
7
|
+
## Usage example
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
import { Mastra } from '@mastra/core'
|
|
11
|
+
|
|
12
|
+
const mastra = new Mastra({
|
|
13
|
+
/* storage config */
|
|
14
|
+
})
|
|
15
|
+
|
|
16
|
+
const { datasets, pagination } = await mastra.datasets.list({ page: 0, perPage: 10 })
|
|
17
|
+
|
|
18
|
+
for (const ds of datasets) {
|
|
19
|
+
console.log(`${ds.id}: ${ds.name} (v${ds.version})`)
|
|
20
|
+
}
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Parameters
|
|
24
|
+
|
|
25
|
+
**page?:** (`number`): Page number. Defaults to \`0\`.
|
|
26
|
+
|
|
27
|
+
**perPage?:** (`number`): Number of datasets per page. Defaults to \`20\`.
|
|
28
|
+
|
|
29
|
+
## Returns
|
|
30
|
+
|
|
31
|
+
**result:** (`Promise<object>`): objectdatasets:DatasetRecord\[]Array of dataset records. See dataset.getDetails() for the record shape.pagination:PaginationInfoPagination metadata with \`total\`, \`page\`, \`perPage\`, and \`hasMore\`.
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# dataset.listExperimentResults()
|
|
2
|
+
|
|
3
|
+
**Added in:** `@mastra/core@1.4.0`
|
|
4
|
+
|
|
5
|
+
Lists individual item results for a specific experiment with pagination.
|
|
6
|
+
|
|
7
|
+
## Usage example
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
import { Mastra } from '@mastra/core'
|
|
11
|
+
|
|
12
|
+
const mastra = new Mastra({
|
|
13
|
+
/* storage config */
|
|
14
|
+
})
|
|
15
|
+
|
|
16
|
+
const dataset = await mastra.datasets.get({ id: 'dataset-id' })
|
|
17
|
+
|
|
18
|
+
const { results, pagination } = await dataset.listExperimentResults({
|
|
19
|
+
experimentId: 'exp-id',
|
|
20
|
+
page: 0,
|
|
21
|
+
perPage: 50,
|
|
22
|
+
})
|
|
23
|
+
|
|
24
|
+
for (const result of results) {
|
|
25
|
+
console.log(`Item ${result.itemId}: ${result.error ? 'FAILED' : 'OK'}`)
|
|
26
|
+
}
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Parameters
|
|
30
|
+
|
|
31
|
+
**experimentId:** (`string`): ID of the experiment to list results for.
|
|
32
|
+
|
|
33
|
+
**page?:** (`number`): Page number. Defaults to \`0\`.
|
|
34
|
+
|
|
35
|
+
**perPage?:** (`number`): Number of results per page. Defaults to \`20\`.
|
|
36
|
+
|
|
37
|
+
## Returns
|
|
38
|
+
|
|
39
|
+
**result:** (`Promise<object>`): objectresults:ExperimentResult\[]Array of item-level results.ExperimentResultid:stringUnique result ID.experimentId:stringID of the parent experiment.itemId:stringID of the dataset item.itemDatasetVersion:number | nullDataset version of the item when executed.input:unknownInput data passed to the target.output:unknown | nullOutput from the target.groundTruth:unknown | nullExpected output.error:{ message: string; stack?: string; code?: string } | nullStructured error if execution failed.startedAt:DateWhen execution started.completedAt:DateWhen execution completed.retryCount:numberNumber of retry attempts.traceId:string | nullTrace ID for observability.createdAt:DateWhen the result record was created.pagination:PaginationInfoPagination metadata with \`total\`, \`page\`, \`perPage\`, and \`hasMore\`.
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# dataset.listExperiments()
|
|
2
|
+
|
|
3
|
+
**Added in:** `@mastra/core@1.4.0`
|
|
4
|
+
|
|
5
|
+
Lists all experiments (runs) for this dataset with pagination.
|
|
6
|
+
|
|
7
|
+
## Usage example
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
import { Mastra } from '@mastra/core'
|
|
11
|
+
|
|
12
|
+
const mastra = new Mastra({
|
|
13
|
+
/* storage config */
|
|
14
|
+
})
|
|
15
|
+
|
|
16
|
+
const dataset = await mastra.datasets.get({ id: 'dataset-id' })
|
|
17
|
+
|
|
18
|
+
const { experiments, pagination } = await dataset.listExperiments({ page: 0, perPage: 10 })
|
|
19
|
+
|
|
20
|
+
for (const exp of experiments) {
|
|
21
|
+
console.log(`${exp.id}: ${exp.status} (${exp.succeededCount}/${exp.totalItems})`)
|
|
22
|
+
}
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Parameters
|
|
26
|
+
|
|
27
|
+
**page?:** (`number`): Page number. Defaults to \`0\`.
|
|
28
|
+
|
|
29
|
+
**perPage?:** (`number`): Number of experiments per page. Defaults to \`20\`.
|
|
30
|
+
|
|
31
|
+
## Returns
|
|
32
|
+
|
|
33
|
+
**result:** (`Promise<object>`): objectexperiments:Experiment\[]Array of experiment records.Experimentid:stringUnique experiment ID.name?:stringDisplay name.description?:stringDescription.metadata?:Record\<string, unknown>Arbitrary metadata.datasetId:stringID of the parent dataset.datasetVersion:number | nullDataset version used for the experiment.targetType:'agent' | 'workflow' | 'scorer' | 'processor'Type of target used.targetId:stringID of the target used.status:'pending' | 'running' | 'completed' | 'failed'Current status of the experiment.totalItems:numberTotal number of items.succeededCount:numberNumber of successful items.failedCount:numberNumber of failed items.skippedCount:numberNumber of skipped items.startedAt:Date | nullWhen the experiment started.completedAt:Date | nullWhen the experiment completed.createdAt:DateWhen the experiment record was created.updatedAt:DateWhen the experiment record was last updated.pagination:PaginationInfoPagination metadata with \`total\`, \`page\`, \`perPage\`, and \`hasMore\`.
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# dataset.listItems()
|
|
2
|
+
|
|
3
|
+
**Added in:** `@mastra/core@1.4.0`
|
|
4
|
+
|
|
5
|
+
Lists items in the dataset. When a `version` is specified, returns all items at that version. Otherwise, returns paginated items from the latest version.
|
|
6
|
+
|
|
7
|
+
## Usage example
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
import { Mastra } from '@mastra/core'
|
|
11
|
+
|
|
12
|
+
const mastra = new Mastra({
|
|
13
|
+
/* storage config */
|
|
14
|
+
})
|
|
15
|
+
|
|
16
|
+
const dataset = await mastra.datasets.get({ id: 'dataset-id' })
|
|
17
|
+
|
|
18
|
+
// Paginated list (default: page 0, 20 per page)
|
|
19
|
+
const result = await dataset.listItems()
|
|
20
|
+
|
|
21
|
+
// List with search
|
|
22
|
+
const filtered = await dataset.listItems({ search: 'TypeScript', page: 0, perPage: 10 })
|
|
23
|
+
|
|
24
|
+
// List all items at a specific version
|
|
25
|
+
const versionedItems = await dataset.listItems({ version: 2 })
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## Parameters
|
|
29
|
+
|
|
30
|
+
**version?:** (`number`): Dataset version to list items at. When set, returns all items at that version (no pagination).
|
|
31
|
+
|
|
32
|
+
**page?:** (`number`): Page number for pagination. Defaults to \`0\`.
|
|
33
|
+
|
|
34
|
+
**perPage?:** (`number`): Number of items per page. Defaults to \`20\`.
|
|
35
|
+
|
|
36
|
+
**search?:** (`string`): Search string to filter items.
|
|
37
|
+
|
|
38
|
+
## Returns
|
|
39
|
+
|
|
40
|
+
When `version` is specified:
|
|
41
|
+
|
|
42
|
+
**result:** (`Promise<DatasetItem[]>`): Array of all items at the specified dataset version.
|
|
43
|
+
|
|
44
|
+
When `version` is not specified:
|
|
45
|
+
|
|
46
|
+
**result:** (`Promise<object>`): objectitems:DatasetItem\[]Array of items for the current page.pagination:objectPagination metadata.objecttotal:numberTotal number of items.page:numberCurrent page number.perPage:number | falseItems per page, or \`false\` if unpaginated.hasMore:booleanWhether more pages are available.
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# dataset.listVersions()
|
|
2
|
+
|
|
3
|
+
**Added in:** `@mastra/core@1.4.0`
|
|
4
|
+
|
|
5
|
+
Lists all versions of the dataset with pagination.
|
|
6
|
+
|
|
7
|
+
## Usage example
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
import { Mastra } from '@mastra/core'
|
|
11
|
+
|
|
12
|
+
const mastra = new Mastra({
|
|
13
|
+
/* storage config */
|
|
14
|
+
})
|
|
15
|
+
|
|
16
|
+
const dataset = await mastra.datasets.get({ id: 'dataset-id' })
|
|
17
|
+
|
|
18
|
+
const { versions, pagination } = await dataset.listVersions({ page: 0, perPage: 10 })
|
|
19
|
+
|
|
20
|
+
for (const version of versions) {
|
|
21
|
+
console.log(`Version ${version.version} created at ${version.createdAt}`)
|
|
22
|
+
}
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Parameters
|
|
26
|
+
|
|
27
|
+
**page?:** (`number`): Page number. Defaults to \`0\`.
|
|
28
|
+
|
|
29
|
+
**perPage?:** (`number`): Number of versions per page. Defaults to \`20\`.
|
|
30
|
+
|
|
31
|
+
## Returns
|
|
32
|
+
|
|
33
|
+
**result:** (`Promise<object>`): objectversions:DatasetVersion\[]Array of version records.DatasetVersionid:stringUnique identifier of the version record.datasetId:stringID of the parent dataset.version:numberVersion number.createdAt:DateWhen this version was created.pagination:objectPagination metadata.objecttotal:numberTotal number of versions.page:numberCurrent page number.perPage:number | falseVersions per page, or \`false\` if unpaginated.hasMore:booleanWhether more pages are available.
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# dataset.startExperiment()
|
|
2
|
+
|
|
3
|
+
**Added in:** `@mastra/core@1.4.0`
|
|
4
|
+
|
|
5
|
+
Runs an experiment on the dataset and waits for completion. Executes all items against a target (agent, workflow, or scorer) with optional scoring.
|
|
6
|
+
|
|
7
|
+
## Usage example
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
import { Mastra } from '@mastra/core'
|
|
11
|
+
|
|
12
|
+
const mastra = new Mastra({
|
|
13
|
+
/* storage config */
|
|
14
|
+
})
|
|
15
|
+
|
|
16
|
+
const dataset = await mastra.datasets.get({ id: 'dataset-id' })
|
|
17
|
+
|
|
18
|
+
// Run against a registered agent with scorers
|
|
19
|
+
const summary = await dataset.startExperiment({
|
|
20
|
+
targetType: 'agent',
|
|
21
|
+
targetId: 'my-agent',
|
|
22
|
+
scorers: ['accuracy', 'relevancy'],
|
|
23
|
+
maxConcurrency: 10,
|
|
24
|
+
})
|
|
25
|
+
|
|
26
|
+
console.log(`${summary.succeededCount}/${summary.totalItems} succeeded`)
|
|
27
|
+
console.log(`Status: ${summary.status}`)
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## Parameters
|
|
31
|
+
|
|
32
|
+
**targetType?:** (`'agent' | 'workflow' | 'scorer'`): Type of registered target to run items against. Use with \`targetId\`.
|
|
33
|
+
|
|
34
|
+
**targetId?:** (`string`): ID of the registered target. Use with \`targetType\`.
|
|
35
|
+
|
|
36
|
+
**scorers?:** (`(MastraScorer | string)[]`): Scorers to evaluate each result. Pass \`MastraScorer\` instances or registered scorer IDs.
|
|
37
|
+
|
|
38
|
+
**name?:** (`string`): Display name for the experiment.
|
|
39
|
+
|
|
40
|
+
**description?:** (`string`): Description of the experiment.
|
|
41
|
+
|
|
42
|
+
**metadata?:** (`Record<string, unknown>`): Arbitrary metadata for the experiment.
|
|
43
|
+
|
|
44
|
+
**version?:** (`number`): Pin to a specific dataset version. Defaults to the latest version.
|
|
45
|
+
|
|
46
|
+
**maxConcurrency?:** (`number`): Maximum concurrent item executions. Defaults to \`5\`.
|
|
47
|
+
|
|
48
|
+
**signal?:** (`AbortSignal`): AbortSignal for cancelling the experiment.
|
|
49
|
+
|
|
50
|
+
**itemTimeout?:** (`number`): Per-item execution timeout in milliseconds.
|
|
51
|
+
|
|
52
|
+
**maxRetries?:** (`number`): Maximum retries per item on failure. Defaults to \`0\` (no retries). Abort errors are never retried.
|
|
53
|
+
|
|
54
|
+
## Returns
|
|
55
|
+
|
|
56
|
+
**result:** (`Promise<ExperimentSummary>`): ExperimentSummaryexperimentId:stringUnique ID of the experiment.status:'pending' | 'running' | 'completed' | 'failed'Final status of the experiment.totalItems:numberTotal number of items in the dataset.succeededCount:numberNumber of items that succeeded.failedCount:numberNumber of items that failed.skippedCount:numberNumber of items skipped (e.g., due to abort).completedWithErrors:boolean\`true\` if the run completed but some items failed.startedAt:DateWhen the experiment started.completedAt:DateWhen the experiment completed.results:ItemWithScores\[]All item results with their scores.ItemWithScoresitemId:stringID of the dataset item.itemVersion:numberDataset version of the item when executed.input:unknownInput data passed to the target.output:unknown | nullOutput from the target, or \`null\` if failed.groundTruth:unknown | nullExpected output from the dataset item.error:{ message: string; stack?: string; code?: string } | nullStructured error if execution failed.startedAt:DateWhen item execution started.completedAt:DateWhen item execution completed.retryCount:numberNumber of retry attempts.scores:ScorerResult\[]Results from all scorers for this item.ScorerResultscorerId:stringID of the scorer.scorerName:stringDisplay name of the scorer.score:number | nullComputed score, or \`null\` if the scorer failed.reason:string | nullReason/explanation for the score.error:string | nullError message if the scorer failed.
|
|
57
|
+
|
|
58
|
+
## Related
|
|
59
|
+
|
|
60
|
+
- [dataset.startExperimentAsync()](https://mastra.ai/reference/datasets/startExperimentAsync)
|
|
61
|
+
- [dataset.listExperiments()](https://mastra.ai/reference/datasets/listExperiments)
|
|
62
|
+
- [DatasetsManager.compareExperiments()](https://mastra.ai/reference/datasets/compareExperiments)
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# dataset.startExperimentAsync()
|
|
2
|
+
|
|
3
|
+
**Added in:** `@mastra/core@1.4.0`
|
|
4
|
+
|
|
5
|
+
Starts an experiment asynchronously (fire-and-forget). Returns immediately with the experiment ID and a `'pending'` status. The experiment runs in the background.
|
|
6
|
+
|
|
7
|
+
## Usage example
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
import { Mastra } from '@mastra/core'
|
|
11
|
+
|
|
12
|
+
const mastra = new Mastra({
|
|
13
|
+
/* storage config */
|
|
14
|
+
})
|
|
15
|
+
|
|
16
|
+
const dataset = await mastra.datasets.get({ id: 'dataset-id' })
|
|
17
|
+
|
|
18
|
+
// Start experiment without waiting
|
|
19
|
+
const { experimentId, status } = await dataset.startExperimentAsync({
|
|
20
|
+
targetType: 'agent',
|
|
21
|
+
targetId: 'my-agent',
|
|
22
|
+
scorers: ['accuracy'],
|
|
23
|
+
})
|
|
24
|
+
|
|
25
|
+
console.log(`Experiment ${experimentId} started with status: ${status}`)
|
|
26
|
+
|
|
27
|
+
// Check progress later
|
|
28
|
+
const experiment = await dataset.getExperiment({ experimentId })
|
|
29
|
+
console.log(`Current status: ${experiment.status}`)
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Parameters
|
|
33
|
+
|
|
34
|
+
Takes the same `StartExperimentConfig` as [`dataset.startExperiment()`](https://mastra.ai/reference/datasets/startExperiment).
|
|
35
|
+
|
|
36
|
+
## Returns
|
|
37
|
+
|
|
38
|
+
**result:** (`Promise<object>`): objectexperimentId:stringUnique ID of the created experiment.status:'pending'Always \`'pending'\` since the experiment hasn't started executing yet.
|
|
39
|
+
|
|
40
|
+
## Related
|
|
41
|
+
|
|
42
|
+
- [dataset.startExperiment()](https://mastra.ai/reference/datasets/startExperiment)
|
|
43
|
+
- [dataset.getExperiment()](https://mastra.ai/reference/datasets/getExperiment)
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# dataset.update()
|
|
2
|
+
|
|
3
|
+
**Added in:** `@mastra/core@1.4.0`
|
|
4
|
+
|
|
5
|
+
Updates dataset metadata, name, description, and/or schemas. Zod schemas are automatically converted to JSON Schema.
|
|
6
|
+
|
|
7
|
+
## Usage example
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
import { Mastra } from '@mastra/core'
|
|
11
|
+
import { z } from 'zod'
|
|
12
|
+
|
|
13
|
+
const mastra = new Mastra({
|
|
14
|
+
/* storage config */
|
|
15
|
+
})
|
|
16
|
+
|
|
17
|
+
const dataset = await mastra.datasets.get({ id: 'dataset-id' })
|
|
18
|
+
|
|
19
|
+
// Update with plain metadata
|
|
20
|
+
const updated = await dataset.update({
|
|
21
|
+
name: 'Updated QA pairs',
|
|
22
|
+
description: 'Revised evaluation set',
|
|
23
|
+
})
|
|
24
|
+
|
|
25
|
+
// Update with Zod schema (auto-converted to JSON Schema)
|
|
26
|
+
const updated2 = await dataset.update({
|
|
27
|
+
inputSchema: z.object({
|
|
28
|
+
question: z.string(),
|
|
29
|
+
context: z.string().optional(),
|
|
30
|
+
}),
|
|
31
|
+
})
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Parameters
|
|
35
|
+
|
|
36
|
+
**name?:** (`string`): New display name.
|
|
37
|
+
|
|
38
|
+
**description?:** (`string`): New description.
|
|
39
|
+
|
|
40
|
+
**metadata?:** (`Record<string, unknown>`): Updated metadata.
|
|
41
|
+
|
|
42
|
+
**inputSchema?:** (`unknown`): JSON Schema or Zod schema for item inputs.
|
|
43
|
+
|
|
44
|
+
**groundTruthSchema?:** (`unknown`): JSON Schema or Zod schema for item ground truths.
|
|
45
|
+
|
|
46
|
+
## Returns
|
|
47
|
+
|
|
48
|
+
**result:** (`Promise<DatasetRecord>`): The updated dataset record. See dataset.getDetails() for the full shape.
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# dataset.updateItem()
|
|
2
|
+
|
|
3
|
+
**Added in:** `@mastra/core@1.4.0`
|
|
4
|
+
|
|
5
|
+
Updates an existing item in the dataset. Only the provided fields are updated. Updating an item creates a new version.
|
|
6
|
+
|
|
7
|
+
## Usage example
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
import { Mastra } from '@mastra/core'
|
|
11
|
+
|
|
12
|
+
const mastra = new Mastra({
|
|
13
|
+
/* storage config */
|
|
14
|
+
})
|
|
15
|
+
|
|
16
|
+
const dataset = await mastra.datasets.get({ id: 'dataset-id' })
|
|
17
|
+
|
|
18
|
+
const updated = await dataset.updateItem({
|
|
19
|
+
itemId: 'item-id',
|
|
20
|
+
input: { question: 'What is TypeScript?' },
|
|
21
|
+
groundTruth: { answer: 'A typed superset of JavaScript' },
|
|
22
|
+
metadata: { reviewed: true },
|
|
23
|
+
})
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Parameters
|
|
27
|
+
|
|
28
|
+
**itemId:** (`string`): ID of the item to update.
|
|
29
|
+
|
|
30
|
+
**input?:** (`unknown`): Updated input data.
|
|
31
|
+
|
|
32
|
+
**groundTruth?:** (`unknown`): Updated ground truth.
|
|
33
|
+
|
|
34
|
+
**metadata?:** (`Record<string, unknown>`): Updated metadata.
|
|
35
|
+
|
|
36
|
+
## Returns
|
|
37
|
+
|
|
38
|
+
**result:** (`Promise<DatasetItem>`): The updated dataset item. See dataset.addItem() for the item shape.
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
# CloudflareDeployer
|
|
2
|
+
|
|
3
|
+
The `CloudflareDeployer` bundles your Mastra server and generates a `wrangler.jsonc` file conforming to Cloudflare's [wrangler configuration](https://developers.cloudflare.com/workers/wrangler/configuration/). Cloudflare deploys this as a Cloudflare Worker.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
To use `CloudflareDeployer`, install the `@mastra/deployer-cloudflare` package:
|
|
8
|
+
|
|
9
|
+
**npm**:
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install @mastra/deployer-cloudflare@latest
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
**pnpm**:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
pnpm add @mastra/deployer-cloudflare@latest
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
**Yarn**:
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
yarn add @mastra/deployer-cloudflare@latest
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
**Bun**:
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
bun add @mastra/deployer-cloudflare@latest
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Usage example
|
|
34
|
+
|
|
35
|
+
Import `CloudflareDeployer` and set it as the deployer in your Mastra configuration:
|
|
36
|
+
|
|
37
|
+
```typescript
|
|
38
|
+
import { Mastra } from '@mastra/core'
|
|
39
|
+
import { CloudflareDeployer } from '@mastra/deployer-cloudflare'
|
|
40
|
+
|
|
41
|
+
export const mastra = new Mastra({
|
|
42
|
+
deployer: new CloudflareDeployer({
|
|
43
|
+
name: 'your-project-name',
|
|
44
|
+
routes: [
|
|
45
|
+
{
|
|
46
|
+
pattern: 'example.com/*',
|
|
47
|
+
zone_name: 'example.com',
|
|
48
|
+
custom_domain: true,
|
|
49
|
+
},
|
|
50
|
+
],
|
|
51
|
+
vars: {
|
|
52
|
+
NODE_ENV: 'production',
|
|
53
|
+
API_KEY: '<api-key>',
|
|
54
|
+
},
|
|
55
|
+
d1_databases: [
|
|
56
|
+
{
|
|
57
|
+
binding: 'DB',
|
|
58
|
+
database_name: 'my-database',
|
|
59
|
+
database_id: 'd1-database-id',
|
|
60
|
+
preview_database_id: 'your-preview-database-id',
|
|
61
|
+
},
|
|
62
|
+
],
|
|
63
|
+
kv_namespaces: [
|
|
64
|
+
{
|
|
65
|
+
binding: 'CACHE',
|
|
66
|
+
id: 'kv-namespace-id',
|
|
67
|
+
},
|
|
68
|
+
],
|
|
69
|
+
}),
|
|
70
|
+
})
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
## Constructor options
|
|
74
|
+
|
|
75
|
+
The `CloudflareDeployer` constructor accepts the same configuration options as `wrangler.jsonc`. See the [Wrangler configuration documentation](https://developers.cloudflare.com/workers/wrangler/configuration/) for all available options.
|
|
76
|
+
|
|
77
|
+
## Build output
|
|
78
|
+
|
|
79
|
+
After running `mastra build`, the deployer generates a `wrangler.jsonc` file conforming to Cloudflare's [wrangler configuration](https://developers.cloudflare.com/workers/wrangler/configuration/). It points to files inside `.mastra/output` so you need to run `mastra build` before deploying with Wrangler.
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
# NetlifyDeployer
|
|
2
|
+
|
|
3
|
+
The `NetlifyDeployer` class handles packaging, configuration, and deployment by adapting Mastra's output to create an optimized version of your server. It extends the base [`Deployer`](https://mastra.ai/reference/deployer) class with Netlify specific functionality. It enables you to run Mastra within Netlify functions.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
In order to use `NetlifyDeployer`, you need to install the `@mastra/deployer-netlify` package:
|
|
8
|
+
|
|
9
|
+
**npm**:
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install @mastra/deployer-netlify@latest
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
**pnpm**:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
pnpm add @mastra/deployer-netlify@latest
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
**Yarn**:
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
yarn add @mastra/deployer-netlify@latest
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
**Bun**:
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
bun add @mastra/deployer-netlify@latest
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Usage example
|
|
34
|
+
|
|
35
|
+
Import `NetlifyDeployer` and set it as the deployer in your Mastra configuration:
|
|
36
|
+
|
|
37
|
+
```typescript
|
|
38
|
+
import { Mastra } from '@mastra/core'
|
|
39
|
+
import { NetlifyDeployer } from '@mastra/deployer-netlify'
|
|
40
|
+
|
|
41
|
+
export const mastra = new Mastra({
|
|
42
|
+
deployer: new NetlifyDeployer(),
|
|
43
|
+
})
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Output
|
|
47
|
+
|
|
48
|
+
After running `mastra build`, the deployer generates a `.netlify` folder. The build output includes all agents, tools, and workflows of your project, alongside a special `config.json` file. The `config.json` file configures the behavior of Netlify functions.
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
your-project/
|
|
52
|
+
└── .netlify/
|
|
53
|
+
└── v1/
|
|
54
|
+
├── config.json
|
|
55
|
+
└── functions/
|
|
56
|
+
└── api/
|
|
57
|
+
├── index.mjs
|
|
58
|
+
├── package.json
|
|
59
|
+
└── node_modules/
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
The `config.json` file contains:
|
|
63
|
+
|
|
64
|
+
```json
|
|
65
|
+
{
|
|
66
|
+
"functions": {
|
|
67
|
+
"directory": ".netlify/v1/functions",
|
|
68
|
+
"node_bundler": "none",
|
|
69
|
+
"included_files": [".netlify/v1/functions/**"]
|
|
70
|
+
},
|
|
71
|
+
"redirects": [
|
|
72
|
+
{
|
|
73
|
+
"force": true,
|
|
74
|
+
"from": "/*",
|
|
75
|
+
"to": "/.netlify/functions/api/:splat",
|
|
76
|
+
"status": 200
|
|
77
|
+
}
|
|
78
|
+
]
|
|
79
|
+
}
|
|
80
|
+
```
|
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
# VercelDeployer
|
|
2
|
+
|
|
3
|
+
The `VercelDeployer` bundles your Mastra server and generates output conforming to Vercel's [Build Output API](https://vercel.com/docs/build-output-api/v3). Vercel deploys this output directly as serverless functions.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
To use `VercelDeployer`, install the `@mastra/deployer-vercel` package:
|
|
8
|
+
|
|
9
|
+
**npm**:
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install @mastra/deployer-vercel@latest
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
**pnpm**:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
pnpm add @mastra/deployer-vercel@latest
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
**Yarn**:
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
yarn add @mastra/deployer-vercel@latest
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
**Bun**:
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
bun add @mastra/deployer-vercel@latest
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Usage example
|
|
34
|
+
|
|
35
|
+
Import `VercelDeployer` and set it as the deployer in your Mastra configuration:
|
|
36
|
+
|
|
37
|
+
```typescript
|
|
38
|
+
import { Mastra } from '@mastra/core'
|
|
39
|
+
import { VercelDeployer } from '@mastra/deployer-vercel'
|
|
40
|
+
|
|
41
|
+
export const mastra = new Mastra({
|
|
42
|
+
deployer: new VercelDeployer(),
|
|
43
|
+
})
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Constructor options
|
|
47
|
+
|
|
48
|
+
The deployer accepts the following options:
|
|
49
|
+
|
|
50
|
+
- `studio?: boolean` — Deploy [Studio](https://mastra.ai/docs/getting-started/studio) alongside your API as static assets served from Vercel's Edge CDN. Defaults to `false`.
|
|
51
|
+
- `maxDuration?: number` — Function execution timeout (in seconds)
|
|
52
|
+
- `memory?: number` — Function memory (in MB)
|
|
53
|
+
- `regions?: string[]` — Regions to deploy the function (e.g. `['sfo1','iad1']`)
|
|
54
|
+
|
|
55
|
+
The `maxDuration`, `memory`, and `regions` options are merged into `.vercel/output/functions/index.func/.vc-config.json` while preserving default fields (`handler`, `launcherType`, `runtime`, `shouldAddHelpers`).
|
|
56
|
+
|
|
57
|
+
### Example with overrides
|
|
58
|
+
|
|
59
|
+
```typescript
|
|
60
|
+
import { Mastra } from '@mastra/core'
|
|
61
|
+
import { VercelDeployer } from '@mastra/deployer-vercel'
|
|
62
|
+
|
|
63
|
+
export const mastra = new Mastra({
|
|
64
|
+
deployer: new VercelDeployer({
|
|
65
|
+
studio: true,
|
|
66
|
+
maxDuration: 600,
|
|
67
|
+
memory: 1536,
|
|
68
|
+
regions: ['sfo1', 'iad1'],
|
|
69
|
+
}),
|
|
70
|
+
})
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
## Build output
|
|
74
|
+
|
|
75
|
+
After running `mastra build`, the deployer generates a `.vercel/output` directory conforming to Vercel's [Build Output API (v3)](https://vercel.com/docs/build-output-api/v3). This directory contains routing configuration and serverless function bundles that Vercel deploys directly, bypassing framework detection.
|
|
76
|
+
|
|
77
|
+
The output contains:
|
|
78
|
+
|
|
79
|
+
- **config.json** — Routing configuration that directs requests to the appropriate handler
|
|
80
|
+
- **functions/** — Your Mastra server bundled as a serverless function
|
|
81
|
+
- **static/** — Studio SPA assets (only when `studio: true`)
|
|
82
|
+
|
|
83
|
+
Without studio:
|
|
84
|
+
|
|
85
|
+
```bash
|
|
86
|
+
.vercel/
|
|
87
|
+
└── output/
|
|
88
|
+
├── config.json
|
|
89
|
+
└── functions/
|
|
90
|
+
└── index.func/
|
|
91
|
+
├── .vc-config.json
|
|
92
|
+
├── index.mjs
|
|
93
|
+
└── node_modules/
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
With `studio: true`:
|
|
97
|
+
|
|
98
|
+
```bash
|
|
99
|
+
.vercel/
|
|
100
|
+
└── output/
|
|
101
|
+
├── config.json
|
|
102
|
+
├── static/
|
|
103
|
+
│ ├── index.html
|
|
104
|
+
│ └── assets/
|
|
105
|
+
│ ├── *.js
|
|
106
|
+
│ └── *.css
|
|
107
|
+
└── functions/
|
|
108
|
+
└── index.func/
|
|
109
|
+
├── .vc-config.json
|
|
110
|
+
├── index.mjs
|
|
111
|
+
└── node_modules/
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
When studio is enabled, the routing is configured so that `/api/*` requests are handled by the serverless function, static assets (JS, CSS) are served from Vercel's Edge CDN with no function invocations, and all other paths fall back to `index.html` for client-side routing.
|
|
115
|
+
|
|
116
|
+
This folder is generated during build and should not be committed to version control.
|