@mastra/mcp-docs-server 1.1.8 → 1.1.9-alpha.1
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/docs/agents/adding-voice.md +4 -4
- package/.docs/docs/agents/agent-approval.md +3 -3
- package/.docs/docs/agents/agent-memory.md +3 -3
- package/.docs/docs/agents/guardrails.md +3 -3
- package/.docs/docs/agents/network-approval.md +5 -2
- package/.docs/docs/agents/networks.md +2 -2
- package/.docs/docs/agents/overview.md +2 -2
- package/.docs/docs/agents/processors.md +42 -24
- package/.docs/docs/agents/structured-output.md +2 -2
- package/.docs/docs/agents/supervisor-agents.md +3 -3
- package/.docs/docs/agents/using-tools.md +3 -3
- package/.docs/docs/build-with-ai/mcp-docs-server.md +5 -5
- package/.docs/docs/build-with-ai/skills.md +2 -2
- package/.docs/docs/community/contributing-templates.md +1 -1
- package/.docs/docs/community/discord.md +3 -3
- package/.docs/docs/community/licensing.md +2 -2
- package/.docs/docs/deployment/cloud-providers.md +2 -2
- package/.docs/docs/deployment/mastra-server.md +2 -2
- package/.docs/docs/deployment/monorepo.md +1 -1
- package/.docs/docs/deployment/overview.md +3 -3
- package/.docs/docs/deployment/studio.md +3 -3
- package/.docs/docs/deployment/web-framework.md +2 -2
- package/.docs/docs/deployment/workflow-runners.md +1 -1
- package/.docs/docs/evals/built-in-scorers.md +1 -1
- package/.docs/docs/evals/custom-scorers.md +6 -6
- package/.docs/docs/evals/overview.md +2 -2
- package/.docs/docs/evals/running-in-ci.md +6 -6
- package/.docs/docs/getting-started/build-with-ai.md +3 -3
- package/.docs/docs/getting-started/manual-install.md +1 -1
- package/.docs/docs/getting-started/project-structure.md +2 -2
- package/.docs/docs/index.md +63 -17
- package/.docs/docs/mastra-cloud/deployment.md +1 -1
- package/.docs/docs/mastra-cloud/studio.md +1 -1
- package/.docs/docs/mcp/overview.md +1 -1
- package/.docs/docs/mcp/publishing-mcp-server.md +4 -4
- package/.docs/docs/memory/memory-processors.md +9 -9
- package/.docs/docs/memory/message-history.md +4 -4
- package/.docs/docs/memory/observational-memory.md +11 -7
- package/.docs/docs/memory/semantic-recall.md +9 -9
- package/.docs/docs/memory/storage.md +1 -1
- package/.docs/docs/memory/working-memory.md +20 -20
- package/.docs/docs/observability/datasets/overview.md +1 -1
- package/.docs/docs/observability/datasets/running-experiments.md +1 -1
- package/.docs/docs/observability/logging.md +1 -1
- package/.docs/docs/observability/overview.md +5 -5
- package/.docs/docs/observability/tracing/bridges/otel.md +9 -9
- package/.docs/docs/observability/tracing/exporters/arize.md +3 -3
- package/.docs/docs/observability/tracing/exporters/braintrust.md +1 -1
- package/.docs/docs/observability/tracing/exporters/cloud.md +2 -2
- package/.docs/docs/observability/tracing/exporters/datadog.md +3 -3
- package/.docs/docs/observability/tracing/exporters/default.md +8 -8
- package/.docs/docs/observability/tracing/exporters/laminar.md +1 -1
- package/.docs/docs/observability/tracing/exporters/langfuse.md +3 -3
- package/.docs/docs/observability/tracing/exporters/langsmith.md +4 -4
- package/.docs/docs/observability/tracing/exporters/otel.md +8 -8
- package/.docs/docs/observability/tracing/exporters/posthog.md +2 -2
- package/.docs/docs/observability/tracing/exporters/sentry.md +4 -4
- package/.docs/docs/observability/tracing/overview.md +24 -24
- package/.docs/docs/observability/tracing/processors/sensitive-data-filter.md +13 -13
- package/.docs/docs/rag/chunking-and-embedding.md +5 -5
- package/.docs/docs/rag/overview.md +2 -2
- package/.docs/docs/rag/retrieval.md +4 -4
- package/.docs/docs/rag/vector-databases.md +13 -13
- package/.docs/docs/server/auth/auth0.md +2 -2
- package/.docs/docs/server/auth/clerk.md +1 -1
- package/.docs/docs/server/auth/composite-auth.md +9 -9
- package/.docs/docs/server/auth/custom-auth-provider.md +12 -12
- package/.docs/docs/server/auth/firebase.md +3 -3
- package/.docs/docs/server/auth/jwt.md +1 -1
- package/.docs/docs/server/auth/simple-auth.md +9 -9
- package/.docs/docs/server/auth/supabase.md +1 -1
- package/.docs/docs/server/auth/workos.md +1 -1
- package/.docs/docs/server/auth.md +2 -2
- package/.docs/docs/server/custom-adapters.md +7 -7
- package/.docs/docs/server/custom-api-routes.md +2 -2
- package/.docs/docs/server/mastra-client.md +2 -2
- package/.docs/docs/server/mastra-server.md +2 -2
- package/.docs/docs/server/request-context.md +2 -2
- package/.docs/docs/server/server-adapters.md +3 -3
- package/.docs/docs/streaming/events.md +2 -2
- package/.docs/docs/streaming/overview.md +2 -2
- package/.docs/docs/streaming/tool-streaming.md +46 -32
- package/.docs/docs/streaming/workflow-streaming.md +1 -1
- package/.docs/docs/voice/overview.md +3 -3
- package/.docs/docs/voice/speech-to-speech.md +1 -1
- package/.docs/docs/voice/speech-to-text.md +2 -2
- package/.docs/docs/voice/text-to-speech.md +2 -2
- package/.docs/docs/workflows/agents-and-tools.md +1 -1
- package/.docs/docs/workflows/control-flow.md +45 -3
- package/.docs/docs/workflows/error-handling.md +4 -4
- package/.docs/docs/workflows/overview.md +3 -3
- package/.docs/docs/workflows/snapshots.md +1 -1
- package/.docs/docs/workflows/suspend-and-resume.md +1 -1
- package/.docs/docs/workflows/time-travel.md +3 -3
- package/.docs/docs/workflows/workflow-state.md +1 -1
- package/.docs/docs/workspace/filesystem.md +3 -3
- package/.docs/docs/workspace/overview.md +53 -8
- package/.docs/docs/workspace/sandbox.md +72 -13
- package/.docs/docs/workspace/search.md +1 -1
- package/.docs/docs/workspace/skills.md +4 -4
- package/.docs/guides/build-your-ui/ai-sdk-ui.md +2 -2
- package/.docs/guides/build-your-ui/assistant-ui.md +1 -1
- package/.docs/guides/build-your-ui/copilotkit.md +2 -2
- package/.docs/guides/deployment/digital-ocean.md +1 -1
- package/.docs/guides/deployment/inngest.md +4 -4
- package/.docs/guides/getting-started/astro.md +1 -1
- package/.docs/guides/getting-started/electron.md +1 -1
- package/.docs/guides/getting-started/next-js.md +1 -1
- package/.docs/guides/getting-started/vite-react.md +1 -1
- package/.docs/guides/guide/ai-recruiter.md +4 -4
- package/.docs/guides/guide/chef-michel.md +4 -4
- package/.docs/guides/guide/code-review-bot.md +3 -3
- package/.docs/guides/guide/dev-assistant.md +5 -5
- package/.docs/guides/guide/docs-manager.md +3 -3
- package/.docs/guides/guide/github-actions-pr-description.md +4 -4
- package/.docs/guides/guide/notes-mcp-server.md +4 -4
- package/.docs/guides/guide/research-assistant.md +4 -4
- package/.docs/guides/guide/research-coordinator.md +1 -1
- package/.docs/guides/guide/stock-agent.md +6 -6
- package/.docs/guides/guide/web-search.md +2 -2
- package/.docs/guides/guide/whatsapp-chat-bot.md +1 -1
- package/.docs/guides/migrations/agentnetwork.md +1 -1
- package/.docs/guides/migrations/ai-sdk-v4-to-v5.md +3 -3
- package/.docs/guides/migrations/network-to-supervisor.md +1 -1
- package/.docs/guides/migrations/upgrade-to-v1/agent.md +1 -1
- package/.docs/guides/migrations/upgrade-to-v1/client.md +2 -2
- package/.docs/guides/migrations/upgrade-to-v1/deployment.md +2 -2
- package/.docs/guides/migrations/upgrade-to-v1/evals.md +1 -1
- package/.docs/guides/migrations/upgrade-to-v1/mastra.md +1 -1
- package/.docs/guides/migrations/upgrade-to-v1/memory.md +2 -2
- package/.docs/guides/migrations/upgrade-to-v1/overview.md +3 -3
- package/.docs/guides/migrations/upgrade-to-v1/storage.md +4 -4
- package/.docs/guides/migrations/upgrade-to-v1/tools.md +2 -2
- package/.docs/guides/migrations/upgrade-to-v1/tracing.md +2 -2
- package/.docs/guides/migrations/upgrade-to-v1/vectors.md +3 -3
- package/.docs/guides/migrations/upgrade-to-v1/voice.md +1 -1
- package/.docs/guides/migrations/upgrade-to-v1/workflows.md +6 -6
- package/.docs/guides/migrations/vnext-to-standard-apis.md +3 -3
- package/.docs/models/embeddings.md +4 -4
- package/.docs/models/gateways/custom-gateways.md +4 -4
- package/.docs/models/gateways/netlify.md +2 -3
- package/.docs/models/gateways/openrouter.md +9 -2
- package/.docs/models/gateways/vercel.md +11 -2
- package/.docs/models/gateways.md +2 -2
- package/.docs/models/index.md +1 -1
- package/.docs/models/providers/302ai.md +3 -3
- package/.docs/models/providers/abacus.md +24 -14
- package/.docs/models/providers/aihubmix.md +10 -5
- package/.docs/models/providers/alibaba-cn.md +83 -74
- package/.docs/models/providers/alibaba-coding-plan-cn.md +78 -0
- package/.docs/models/providers/alibaba-coding-plan.md +78 -0
- package/.docs/models/providers/alibaba.md +3 -3
- package/.docs/models/providers/anthropic.md +4 -4
- package/.docs/models/providers/bailing.md +3 -3
- package/.docs/models/providers/baseten.md +3 -3
- package/.docs/models/providers/berget.md +3 -3
- package/.docs/models/providers/cerebras.md +4 -4
- package/.docs/models/providers/chutes.md +7 -6
- package/.docs/models/providers/clarifai.md +81 -0
- package/.docs/models/providers/cloudferro-sherlock.md +8 -7
- package/.docs/models/providers/cloudflare-workers-ai.md +6 -5
- package/.docs/models/providers/cortecs.md +10 -8
- package/.docs/models/providers/deepinfra.md +11 -6
- package/.docs/models/providers/deepseek.md +4 -4
- package/.docs/models/providers/drun.md +73 -0
- package/.docs/models/providers/evroc.md +3 -3
- package/.docs/models/providers/fastrouter.md +3 -3
- package/.docs/models/providers/fireworks-ai.md +3 -3
- package/.docs/models/providers/firmware.md +31 -23
- package/.docs/models/providers/friendli.md +3 -3
- package/.docs/models/providers/github-models.md +3 -3
- package/.docs/models/providers/google.md +7 -5
- package/.docs/models/providers/groq.md +4 -4
- package/.docs/models/providers/helicone.md +3 -3
- package/.docs/models/providers/huggingface.md +3 -3
- package/.docs/models/providers/iflowcn.md +3 -3
- package/.docs/models/providers/inception.md +7 -5
- package/.docs/models/providers/inference.md +3 -3
- package/.docs/models/providers/io-net.md +3 -3
- package/.docs/models/providers/jiekou.md +3 -3
- package/.docs/models/providers/kilo.md +6 -4
- package/.docs/models/providers/kimi-for-coding.md +4 -4
- package/.docs/models/providers/kuae-cloud-coding-plan.md +3 -3
- package/.docs/models/providers/llama.md +3 -3
- package/.docs/models/providers/lmstudio.md +3 -3
- package/.docs/models/providers/lucidquery.md +3 -3
- package/.docs/models/providers/meganova.md +3 -3
- package/.docs/models/providers/minimax-cn-coding-plan.md +4 -4
- package/.docs/models/providers/minimax-cn.md +4 -4
- package/.docs/models/providers/minimax-coding-plan.md +4 -4
- package/.docs/models/providers/minimax.md +4 -4
- package/.docs/models/providers/mistral.md +4 -4
- package/.docs/models/providers/moark.md +3 -3
- package/.docs/models/providers/modelscope.md +3 -3
- package/.docs/models/providers/moonshotai-cn.md +3 -3
- package/.docs/models/providers/moonshotai.md +3 -3
- package/.docs/models/providers/morph.md +3 -3
- package/.docs/models/providers/nano-gpt.md +523 -42
- package/.docs/models/providers/nebius.md +37 -37
- package/.docs/models/providers/nova.md +3 -3
- package/.docs/models/providers/novita-ai.md +3 -3
- package/.docs/models/providers/nvidia.md +7 -5
- package/.docs/models/providers/ollama-cloud.md +4 -5
- package/.docs/models/providers/openai.md +7 -5
- package/.docs/models/providers/opencode-go.md +3 -3
- package/.docs/models/providers/opencode.md +39 -36
- package/.docs/models/providers/ovhcloud.md +3 -3
- package/.docs/models/providers/perplexity-agent.md +4 -4
- package/.docs/models/providers/perplexity.md +4 -4
- package/.docs/models/providers/poe.md +11 -5
- package/.docs/models/providers/privatemode-ai.md +3 -3
- package/.docs/models/providers/qihang-ai.md +3 -3
- package/.docs/models/providers/qiniu-ai.md +23 -8
- package/.docs/models/providers/requesty.md +20 -4
- package/.docs/models/providers/scaleway.md +3 -3
- package/.docs/models/providers/siliconflow-cn.md +10 -4
- package/.docs/models/providers/siliconflow.md +3 -3
- package/.docs/models/providers/stackit.md +3 -3
- package/.docs/models/providers/stepfun.md +3 -3
- package/.docs/models/providers/submodel.md +3 -3
- package/.docs/models/providers/synthetic.md +3 -3
- package/.docs/models/providers/togetherai.md +5 -7
- package/.docs/models/providers/upstage.md +3 -3
- package/.docs/models/providers/vivgrid.md +4 -4
- package/.docs/models/providers/vultr.md +3 -3
- package/.docs/models/providers/wandb.md +3 -3
- package/.docs/models/providers/xai.md +34 -31
- package/.docs/models/providers/xiaomi.md +4 -4
- package/.docs/models/providers/zai-coding-plan.md +3 -3
- package/.docs/models/providers/zai.md +3 -3
- package/.docs/models/providers/zenmux.md +7 -5
- package/.docs/models/providers/zhipuai-coding-plan.md +3 -3
- package/.docs/models/providers/zhipuai.md +3 -3
- package/.docs/models/providers.md +4 -0
- package/.docs/reference/agents/agent.md +3 -3
- package/.docs/reference/agents/generateLegacy.md +1 -1
- package/.docs/reference/agents/getDefaultGenerateOptions.md +1 -1
- package/.docs/reference/agents/getDefaultOptions.md +1 -1
- package/.docs/reference/agents/getDefaultStreamOptions.md +1 -1
- package/.docs/reference/agents/getDescription.md +1 -1
- package/.docs/reference/agents/network.md +5 -3
- package/.docs/reference/ai-sdk/handle-chat-stream.md +2 -0
- package/.docs/reference/ai-sdk/handle-network-stream.md +2 -0
- package/.docs/reference/ai-sdk/network-route.md +2 -0
- package/.docs/reference/ai-sdk/to-ai-sdk-stream.md +1 -1
- package/.docs/reference/ai-sdk/to-ai-sdk-v4-messages.md +1 -1
- package/.docs/reference/ai-sdk/to-ai-sdk-v5-messages.md +1 -1
- package/.docs/reference/auth/auth0.md +7 -7
- package/.docs/reference/auth/better-auth.md +2 -2
- package/.docs/reference/auth/clerk.md +1 -1
- package/.docs/reference/auth/firebase.md +5 -5
- package/.docs/reference/auth/jwt.md +1 -1
- package/.docs/reference/auth/supabase.md +1 -1
- package/.docs/reference/auth/workos.md +6 -6
- package/.docs/reference/cli/mastra.md +5 -5
- package/.docs/reference/client-js/agents.md +22 -22
- package/.docs/reference/client-js/error-handling.md +2 -2
- package/.docs/reference/client-js/logs.md +2 -2
- package/.docs/reference/client-js/mastra-client.md +2 -2
- package/.docs/reference/client-js/memory.md +6 -6
- package/.docs/reference/client-js/observability.md +4 -4
- package/.docs/reference/client-js/telemetry.md +1 -1
- package/.docs/reference/client-js/tools.md +3 -3
- package/.docs/reference/client-js/vectors.md +2 -2
- package/.docs/reference/client-js/workflows.md +12 -12
- package/.docs/reference/configuration.md +62 -6
- package/.docs/reference/core/getDeployer.md +1 -1
- package/.docs/reference/core/getGatewayById.md +1 -1
- package/.docs/reference/core/getLogger.md +1 -1
- package/.docs/reference/core/getMCPServer.md +2 -2
- package/.docs/reference/core/getMCPServerById.md +2 -2
- package/.docs/reference/core/getMemory.md +1 -1
- package/.docs/reference/core/getScorer.md +4 -4
- package/.docs/reference/core/getScorerById.md +2 -2
- package/.docs/reference/core/getServer.md +1 -1
- package/.docs/reference/core/getStorage.md +1 -1
- package/.docs/reference/core/getStoredAgentById.md +3 -3
- package/.docs/reference/core/getTelemetry.md +1 -1
- package/.docs/reference/core/getWorkflow.md +1 -1
- package/.docs/reference/core/listAgents.md +1 -1
- package/.docs/reference/core/listMCPServers.md +3 -3
- package/.docs/reference/core/listMemory.md +1 -1
- package/.docs/reference/core/listScorers.md +1 -1
- package/.docs/reference/core/listStoredAgents.md +3 -3
- package/.docs/reference/core/listVectors.md +1 -1
- package/.docs/reference/core/mastra-class.md +2 -2
- package/.docs/reference/core/mastra-model-gateway.md +11 -11
- package/.docs/reference/core/setLogger.md +1 -1
- package/.docs/reference/core/setStorage.md +1 -1
- package/.docs/reference/datasets/dataset.md +2 -2
- package/.docs/reference/datasets/datasets-manager.md +1 -1
- package/.docs/reference/datasets/get.md +2 -2
- package/.docs/reference/datasets/getDetails.md +1 -1
- package/.docs/reference/datasets/listItems.md +1 -1
- package/.docs/reference/deployer/vercel.md +1 -1
- package/.docs/reference/deployer.md +4 -4
- package/.docs/reference/evals/answer-relevancy.md +4 -4
- package/.docs/reference/evals/answer-similarity.md +3 -3
- package/.docs/reference/evals/bias.md +4 -4
- package/.docs/reference/evals/completeness.md +6 -6
- package/.docs/reference/evals/content-similarity.md +3 -3
- package/.docs/reference/evals/context-precision.md +9 -9
- package/.docs/reference/evals/context-relevance.md +7 -7
- package/.docs/reference/evals/create-scorer.md +7 -7
- package/.docs/reference/evals/faithfulness.md +3 -3
- package/.docs/reference/evals/hallucination.md +8 -14
- package/.docs/reference/evals/keyword-coverage.md +4 -4
- package/.docs/reference/evals/mastra-scorer.md +7 -7
- package/.docs/reference/evals/noise-sensitivity.md +11 -11
- package/.docs/reference/evals/prompt-alignment.md +5 -5
- package/.docs/reference/evals/run-evals.md +5 -5
- package/.docs/reference/evals/scorer-utils.md +17 -17
- package/.docs/reference/evals/textual-difference.md +4 -4
- package/.docs/reference/evals/tone-consistency.md +5 -5
- package/.docs/reference/evals/tool-call-accuracy.md +10 -10
- package/.docs/reference/evals/toxicity.md +3 -3
- package/.docs/reference/harness/harness-class.md +5 -3
- package/.docs/reference/index.md +2 -0
- package/.docs/reference/memory/clone-utilities.md +7 -7
- package/.docs/reference/memory/cloneThread.md +5 -5
- package/.docs/reference/memory/createThread.md +1 -1
- package/.docs/reference/memory/deleteMessages.md +1 -1
- package/.docs/reference/memory/getThreadById.md +1 -1
- package/.docs/reference/memory/listThreads.md +3 -3
- package/.docs/reference/memory/memory-class.md +1 -1
- package/.docs/reference/memory/observational-memory.md +8 -6
- package/.docs/reference/memory/recall.md +1 -1
- package/.docs/reference/observability/tracing/bridges/otel.md +6 -6
- package/.docs/reference/observability/tracing/configuration.md +17 -17
- package/.docs/reference/observability/tracing/exporters/arize.md +4 -4
- package/.docs/reference/observability/tracing/exporters/braintrust.md +3 -3
- package/.docs/reference/observability/tracing/exporters/cloud-exporter.md +6 -6
- package/.docs/reference/observability/tracing/exporters/console-exporter.md +4 -4
- package/.docs/reference/observability/tracing/exporters/datadog.md +4 -4
- package/.docs/reference/observability/tracing/exporters/default-exporter.md +6 -6
- package/.docs/reference/observability/tracing/exporters/laminar.md +2 -2
- package/.docs/reference/observability/tracing/exporters/langfuse.md +4 -4
- package/.docs/reference/observability/tracing/exporters/langsmith.md +6 -6
- package/.docs/reference/observability/tracing/exporters/otel.md +12 -12
- package/.docs/reference/observability/tracing/exporters/posthog.md +3 -3
- package/.docs/reference/observability/tracing/exporters/sentry.md +5 -5
- package/.docs/reference/observability/tracing/instances.md +9 -9
- package/.docs/reference/observability/tracing/interfaces.md +39 -39
- package/.docs/reference/observability/tracing/processors/sensitive-data-filter.md +6 -6
- package/.docs/reference/observability/tracing/spans.md +15 -13
- package/.docs/reference/processors/message-history-processor.md +1 -1
- package/.docs/reference/processors/processor-interface.md +21 -17
- package/.docs/reference/processors/token-limiter-processor.md +2 -2
- package/.docs/reference/rag/chunk.md +2 -2
- package/.docs/reference/rag/database-config.md +8 -8
- package/.docs/reference/rag/document.md +11 -11
- package/.docs/reference/rag/embeddings.md +5 -5
- package/.docs/reference/rag/extract-params.md +8 -8
- package/.docs/reference/rag/graph-rag.md +4 -4
- package/.docs/reference/rag/metadata-filters.md +15 -15
- package/.docs/reference/rag/rerank.md +2 -2
- package/.docs/reference/rag/rerankWithScorer.md +2 -2
- package/.docs/reference/server/create-route.md +2 -0
- package/.docs/reference/server/express-adapter.md +1 -1
- package/.docs/reference/server/fastify-adapter.md +1 -1
- package/.docs/reference/server/hono-adapter.md +1 -1
- package/.docs/reference/server/koa-adapter.md +2 -2
- package/.docs/reference/server/mastra-server.md +16 -16
- package/.docs/reference/server/register-api-route.md +7 -7
- package/.docs/reference/server/routes.md +1 -1
- package/.docs/reference/storage/cloudflare-d1.md +5 -5
- package/.docs/reference/storage/cloudflare.md +3 -3
- package/.docs/reference/storage/composite.md +1 -1
- package/.docs/reference/storage/convex.md +6 -6
- package/.docs/reference/storage/dynamodb.md +7 -7
- package/.docs/reference/storage/lance.md +5 -5
- package/.docs/reference/storage/libsql.md +1 -1
- package/.docs/reference/storage/mongodb.md +6 -6
- package/.docs/reference/storage/mssql.md +4 -4
- package/.docs/reference/storage/overview.md +2 -2
- package/.docs/reference/storage/postgresql.md +7 -7
- package/.docs/reference/storage/upstash.md +4 -4
- package/.docs/reference/streaming/ChunkType.md +13 -13
- package/.docs/reference/streaming/agents/MastraModelOutput.md +6 -6
- package/.docs/reference/streaming/agents/stream.md +2 -2
- package/.docs/reference/streaming/agents/streamLegacy.md +1 -1
- package/.docs/reference/streaming/workflows/observeStream.md +2 -2
- package/.docs/reference/streaming/workflows/resumeStream.md +1 -1
- package/.docs/reference/streaming/workflows/stream.md +1 -1
- package/.docs/reference/templates/overview.md +4 -4
- package/.docs/reference/tools/create-tool.md +10 -10
- package/.docs/reference/tools/document-chunker-tool.md +4 -4
- package/.docs/reference/tools/graph-rag-tool.md +7 -7
- package/.docs/reference/tools/mcp-client.md +13 -13
- package/.docs/reference/tools/mcp-server.md +27 -27
- package/.docs/reference/tools/vector-query-tool.md +12 -12
- package/.docs/reference/vectors/astra.md +13 -13
- package/.docs/reference/vectors/chroma.md +18 -18
- package/.docs/reference/vectors/convex.md +15 -15
- package/.docs/reference/vectors/couchbase.md +21 -21
- package/.docs/reference/vectors/duckdb.md +17 -17
- package/.docs/reference/vectors/elasticsearch.md +14 -14
- package/.docs/reference/vectors/lance.md +22 -22
- package/.docs/reference/vectors/libsql.md +15 -15
- package/.docs/reference/vectors/mongodb.md +18 -18
- package/.docs/reference/vectors/opensearch.md +11 -11
- package/.docs/reference/vectors/pg.md +23 -21
- package/.docs/reference/vectors/pinecone.md +15 -15
- package/.docs/reference/vectors/qdrant.md +15 -15
- package/.docs/reference/vectors/s3vectors.md +22 -22
- package/.docs/reference/vectors/turbopuffer.md +14 -14
- package/.docs/reference/vectors/upstash.md +15 -15
- package/.docs/reference/vectors/vectorize.md +16 -16
- package/.docs/reference/voice/azure.md +12 -10
- package/.docs/reference/voice/cloudflare.md +9 -7
- package/.docs/reference/voice/composite-voice.md +5 -5
- package/.docs/reference/voice/deepgram.md +5 -5
- package/.docs/reference/voice/elevenlabs.md +7 -7
- package/.docs/reference/voice/google-gemini-live.md +22 -22
- package/.docs/reference/voice/google.md +12 -12
- package/.docs/reference/voice/mastra-voice.md +18 -18
- package/.docs/reference/voice/murf.md +8 -8
- package/.docs/reference/voice/openai-realtime.md +19 -17
- package/.docs/reference/voice/openai.md +12 -8
- package/.docs/reference/voice/playai.md +9 -7
- package/.docs/reference/voice/sarvam.md +8 -6
- package/.docs/reference/voice/speechify.md +11 -9
- package/.docs/reference/voice/voice.addInstructions.md +4 -4
- package/.docs/reference/voice/voice.addTools.md +3 -3
- package/.docs/reference/voice/voice.answer.md +2 -2
- package/.docs/reference/voice/voice.close.md +4 -4
- package/.docs/reference/voice/voice.connect.md +9 -7
- package/.docs/reference/voice/voice.events.md +4 -4
- package/.docs/reference/voice/voice.getSpeakers.md +4 -4
- package/.docs/reference/voice/voice.listen.md +17 -11
- package/.docs/reference/voice/voice.off.md +4 -4
- package/.docs/reference/voice/voice.on.md +5 -5
- package/.docs/reference/voice/voice.send.md +2 -2
- package/.docs/reference/voice/voice.speak.md +19 -9
- package/.docs/reference/voice/voice.updateConfig.md +4 -4
- package/.docs/reference/workflows/run-methods/startAsync.md +1 -1
- package/.docs/reference/workflows/run-methods/timeTravel.md +1 -1
- package/.docs/reference/workflows/run.md +3 -3
- package/.docs/reference/workflows/step.md +2 -2
- package/.docs/reference/workflows/workflow-methods/create-run.md +1 -1
- package/.docs/reference/workflows/workflow.md +1 -1
- package/.docs/reference/workspace/blaxel-sandbox.md +164 -0
- package/.docs/reference/workspace/daytona-sandbox.md +50 -141
- package/.docs/reference/workspace/e2b-sandbox.md +41 -77
- package/.docs/reference/workspace/filesystem.md +25 -11
- package/.docs/reference/workspace/gcs-filesystem.md +21 -1
- package/.docs/reference/workspace/local-filesystem.md +24 -10
- package/.docs/reference/workspace/local-sandbox.md +27 -102
- package/.docs/reference/workspace/process-manager.md +296 -0
- package/.docs/reference/workspace/s3-filesystem.md +21 -1
- package/.docs/reference/workspace/sandbox.md +9 -1
- package/.docs/reference/workspace/workspace-class.md +95 -27
- package/CHANGELOG.md +15 -0
- package/dist/tools/course.d.ts +7 -27
- package/dist/tools/course.d.ts.map +1 -1
- package/dist/tools/docs.d.ts +6 -18
- package/dist/tools/docs.d.ts.map +1 -1
- package/dist/tools/embedded-docs.d.ts +12 -112
- package/dist/tools/embedded-docs.d.ts.map +1 -1
- package/dist/tools/migration.d.ts +6 -26
- package/dist/tools/migration.d.ts.map +1 -1
- package/package.json +6 -6
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Building a
|
|
1
|
+
# Building a research paper assistant with RAG
|
|
2
2
|
|
|
3
3
|
In this guide, you'll create an AI research assistant that can analyze academic papers and answer specific questions about their content using Retrieval Augmented Generation (RAG).
|
|
4
4
|
|
|
@@ -39,7 +39,7 @@ Your implementation will:
|
|
|
39
39
|
3. Use similarity search to find relevant sections
|
|
40
40
|
4. Generate accurate responses using retrieved context
|
|
41
41
|
|
|
42
|
-
## Creating the
|
|
42
|
+
## Creating the agent
|
|
43
43
|
|
|
44
44
|
Let's define the agent's behavior, connect it to your Mastra project, and create the vector store.
|
|
45
45
|
|
|
@@ -256,7 +256,7 @@ In the following steps you'll fetch the research paper, split it into smaller ch
|
|
|
256
256
|
|
|
257
257
|
If the operation was successful you should see no output/errors in your terminal.
|
|
258
258
|
|
|
259
|
-
## Test the
|
|
259
|
+
## Test the assistant
|
|
260
260
|
|
|
261
261
|
Now that the vector database has all embeddings, you can test the research assistant with different types of queries.
|
|
262
262
|
|
|
@@ -338,7 +338,7 @@ curl -X POST http://localhost:4111/api/agents/researchAgent/generate \
|
|
|
338
338
|
}'
|
|
339
339
|
```
|
|
340
340
|
|
|
341
|
-
## Advanced RAG
|
|
341
|
+
## Advanced RAG examples
|
|
342
342
|
|
|
343
343
|
Explore these examples for more advanced RAG techniques:
|
|
344
344
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Building a
|
|
1
|
+
# Building a research coordinator with supervisor pattern
|
|
2
2
|
|
|
3
3
|
In this guide, you'll build a research coordinator that orchestrates multiple specialized agents using the supervisor pattern. The coordinator will delegate research tasks to a research agent and writing tasks to a writing agent, then synthesize the results into a comprehensive report.
|
|
4
4
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
# Building an AI
|
|
1
|
+
# Building an AI stock agent
|
|
2
2
|
|
|
3
|
-
In this guide, you're going to create
|
|
3
|
+
In this guide, you're going to create an agent that fetches the last day's closing stock price for a given symbol. You'll learn how to create a tool, add it to an agent, and use the agent to fetch stock prices.
|
|
4
4
|
|
|
5
5
|
[YouTube video player](https://www.youtube-nocookie.com/embed/rIaZ4l7y9wo)
|
|
6
6
|
|
|
@@ -10,7 +10,7 @@ In this guide, you're going to create a simple agent that fetches the last day's
|
|
|
10
10
|
- An API key from a supported [Model Provider](https://mastra.ai/models)
|
|
11
11
|
- An existing Mastra project (Follow the [installation guide](https://mastra.ai/guides/getting-started/quickstart) to set up a new project)
|
|
12
12
|
|
|
13
|
-
## Creating the
|
|
13
|
+
## Creating the agent
|
|
14
14
|
|
|
15
15
|
To create an agent in Mastra use the `Agent` class to define it and then register it with Mastra.
|
|
16
16
|
|
|
@@ -39,9 +39,9 @@ To create an agent in Mastra use the `Agent` class to define it and then registe
|
|
|
39
39
|
})
|
|
40
40
|
```
|
|
41
41
|
|
|
42
|
-
## Creating the
|
|
42
|
+
## Creating the stock price tool
|
|
43
43
|
|
|
44
|
-
|
|
44
|
+
The Stock Agent doesn't yet know anything about current stock prices. To change this, create a tool and add it to the agent.
|
|
45
45
|
|
|
46
46
|
1. Create a new file `src/mastra/tools/stockPrices.ts`. Inside, add a `stockPrices` tool that will fetch the last day's closing stock price for a given symbol:
|
|
47
47
|
|
|
@@ -90,7 +90,7 @@ So far the Stock Agent doesn't know anything about the current stock prices. To
|
|
|
90
90
|
})
|
|
91
91
|
```
|
|
92
92
|
|
|
93
|
-
## Running the
|
|
93
|
+
## Running the agent server
|
|
94
94
|
|
|
95
95
|
Learn how to interact with your agent through Mastra's API.
|
|
96
96
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Building an
|
|
1
|
+
# Building an agent that can search the web
|
|
2
2
|
|
|
3
3
|
When building a web search agent, you have two main strategies to consider:
|
|
4
4
|
|
|
@@ -202,7 +202,7 @@ Some LLM providers include built-in web search capabilities that can be used dir
|
|
|
202
202
|
|
|
203
203
|
Inside Studio navigate to the **"Search Agent"** and ask it: "What happened last week in AI news?"
|
|
204
204
|
|
|
205
|
-
## Using
|
|
205
|
+
## Using search APIs
|
|
206
206
|
|
|
207
207
|
For more control over search behavior, you can integrate external search APIs as custom tools. [Exa](https://exa.ai/) is a search engine built specifically for AI applications, offering semantic search, configurable filters (category, domain, date range), and the ability to retrieve full page contents. The search API is wrapped in a Mastra tool that defines the input schema, output format, and execution logic.
|
|
208
208
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# WhatsApp
|
|
1
|
+
# WhatsApp chat bot
|
|
2
2
|
|
|
3
3
|
This guide demonstrates how to create a WhatsApp chat bot using Mastra agents and workflows. The bot receives incoming WhatsApp messages via webhook, processes them through an AI agent, breaks responses into natural text messages, and sends them back via the WhatsApp Business API.
|
|
4
4
|
|
|
@@ -6,7 +6,7 @@ As of `v0.20.0` for `@mastra/core`, the following changes apply.
|
|
|
6
6
|
|
|
7
7
|
- Bump all your model provider packages by a major version.
|
|
8
8
|
|
|
9
|
-
> **Note:** This will ensure that they
|
|
9
|
+
> **Note:** This will ensure that they're all v5 models now.
|
|
10
10
|
|
|
11
11
|
## Memory is required
|
|
12
12
|
|
|
@@ -9,11 +9,11 @@ This guide covers only the Mastra-specific aspects of the migration.
|
|
|
9
9
|
- **Data compatibility**: New data stored in v5 format will no longer work if you downgrade from v5 to v4
|
|
10
10
|
- **Backup recommendation**: Keep DB backups from before you upgrade to v5
|
|
11
11
|
|
|
12
|
-
## Memory and
|
|
12
|
+
## Memory and storage
|
|
13
13
|
|
|
14
14
|
Mastra automatically handles AI SDK v4 data using its internal `MessageList` class, which manages format conversion—including v4 to v5. No database migrations are required; your existing messages are translated on the fly and continue working after you upgrade.
|
|
15
15
|
|
|
16
|
-
## Message
|
|
16
|
+
## Message format conversion
|
|
17
17
|
|
|
18
18
|
For cases where you need to manually convert messages between AI SDK and Mastra formats, use the `convertMessages()` utility:
|
|
19
19
|
|
|
@@ -32,7 +32,7 @@ const aiv5Messages = convertMessages(mastraMessages).to('AIV5.Core')
|
|
|
32
32
|
|
|
33
33
|
This utility is helpful when you want to fetch messages directly from your storage DB and convert them for use in AI SDK.
|
|
34
34
|
|
|
35
|
-
## Type
|
|
35
|
+
## Type inference for tools
|
|
36
36
|
|
|
37
37
|
When using tools with TypeScript in AI SDK v5, Mastra provides type inference helpers to ensure type safety for your tool inputs and outputs.
|
|
38
38
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Migrate from `.network()` to
|
|
1
|
+
# Migrate from `.network()` to supervisor pattern
|
|
2
2
|
|
|
3
3
|
The supervisor pattern using `Agent.stream()` and `Agent.generate()` is the recommended approach for coordinating multiple agents, replacing the older `.network()` API. This guide walks you through each step of the migration.
|
|
4
4
|
|
|
@@ -271,9 +271,9 @@ To migrate, use workflow streaming APIs instead of watch.
|
|
|
271
271
|
+ }
|
|
272
272
|
```
|
|
273
273
|
|
|
274
|
-
### Run-related methods
|
|
274
|
+
### Run-related methods can't be called directly on workflow instance
|
|
275
275
|
|
|
276
|
-
Run-related methods
|
|
276
|
+
Run-related methods can't be called directly on workflow instance. You need to create a run instance first using `createRun()` method.
|
|
277
277
|
|
|
278
278
|
```diff
|
|
279
279
|
- const result = await workflow.start({ runId: '123', inputData: { ... } });
|
|
@@ -4,7 +4,7 @@ The `CloudflareDeployer` configuration has been updated to use standard `wrangle
|
|
|
4
4
|
|
|
5
5
|
## Changed
|
|
6
6
|
|
|
7
|
-
### CloudflareDeployer uses standard wrangler.json property names
|
|
7
|
+
### `CloudflareDeployer` uses standard `wrangler.json` property names
|
|
8
8
|
|
|
9
9
|
The `CloudflareDeployer` constructor now accepts standard `wrangler.json` property names instead of custom camelCase variants. This change aligns the deployer with Cloudflare's official configuration format and provides access to all wrangler configuration options.
|
|
10
10
|
|
|
@@ -32,6 +32,6 @@ const deployer = new CloudflareDeployer({
|
|
|
32
32
|
});
|
|
33
33
|
```
|
|
34
34
|
|
|
35
|
-
The `workerNamespace` field has been removed as it
|
|
35
|
+
The `workerNamespace` field has been removed as it's no longer used.
|
|
36
36
|
|
|
37
37
|
For all available configuration options, see the [Wrangler configuration documentation](https://developers.cloudflare.com/workers/wrangler/configuration/).
|
|
@@ -29,7 +29,7 @@ const memory = new Memory({
|
|
|
29
29
|
|
|
30
30
|
### Default memory scope from `thread` to `resource`
|
|
31
31
|
|
|
32
|
-
The default scope for both working memory and semantic recall has changed from `'thread'` to `'resource'`. This change aligns with common use cases where applications want to remember user information across conversations. When semantic recall is enabled, it now defaults to searching across all user conversations rather than
|
|
32
|
+
The default scope for both working memory and semantic recall has changed from `'thread'` to `'resource'`. This change aligns with common use cases where applications want to remember user information across conversations. When semantic recall is enabled, it now defaults to searching across all user conversations rather than the current thread.
|
|
33
33
|
|
|
34
34
|
To migrate, if you want to maintain the old behavior where memory is isolated per conversation thread, explicitly set `scope: 'thread'`.
|
|
35
35
|
|
|
@@ -119,7 +119,7 @@ agent.stream('Hello', {
|
|
|
119
119
|
|
|
120
120
|
### `Memory.query()` renamed to `Memory.recall()`
|
|
121
121
|
|
|
122
|
-
The `Memory.query()` method has been renamed to `Memory.recall()`. The new method returns a simpler format with
|
|
122
|
+
The `Memory.query()` method has been renamed to `Memory.recall()`. The new method returns a simpler format with `{ messages: MastraDBMessage[] }` instead of multiple format variations. This change better describes the action of retrieving messages from memory and simplifies the API.
|
|
123
123
|
|
|
124
124
|
To migrate, rename `query()` to `recall()` and update code that expects the old return format.
|
|
125
125
|
|
|
@@ -8,7 +8,7 @@ This guide provides a comprehensive overview of breaking changes when upgrading
|
|
|
8
8
|
|
|
9
9
|
> **Need help?:** Need help with the migration? Join our [Discord community](https://discord.gg/BTYqqHKUrf) to ask questions.
|
|
10
10
|
|
|
11
|
-
## Migration
|
|
11
|
+
## Migration strategy
|
|
12
12
|
|
|
13
13
|
### Update all Mastra packages to `latest` tag
|
|
14
14
|
|
|
@@ -58,7 +58,7 @@ Work through the [migration checklist](#migration-checklist) below to update you
|
|
|
58
58
|
|
|
59
59
|
> **Database Migration Required:** If you're using PostgreSQL or LibSQL storage, you'll need to run a database migration. See the [Storage migration guide](https://mastra.ai/guides/migrations/upgrade-to-v1/storage) for details.
|
|
60
60
|
|
|
61
|
-
## Breaking
|
|
61
|
+
## Breaking changes by area
|
|
62
62
|
|
|
63
63
|
- **[Mastra Class](https://mastra.ai/guides/migrations/upgrade-to-v1/mastra)** - Import restructuring and property access changes.
|
|
64
64
|
- **[Agent Class](https://mastra.ai/guides/migrations/upgrade-to-v1/agent)** - Voice methods moved to namespace and streaming API updates.
|
|
@@ -76,7 +76,7 @@ Work through the [migration checklist](#migration-checklist) below to update you
|
|
|
76
76
|
- **[Client SDKs](https://mastra.ai/guides/migrations/upgrade-to-v1/client)** - Types and utilities renamed for consistency.
|
|
77
77
|
- **[Voice Packages](https://mastra.ai/guides/migrations/upgrade-to-v1/voice)** - Packages renamed from speech to voice.
|
|
78
78
|
|
|
79
|
-
## Migration
|
|
79
|
+
## Migration checklist
|
|
80
80
|
|
|
81
81
|
Work through this checklist in order, starting with high-impact changes that affect most applications.
|
|
82
82
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Storage APIs have been standardized with consistent pagination and naming patterns across all methods.
|
|
4
4
|
|
|
5
|
-
## Database
|
|
5
|
+
## Database migration
|
|
6
6
|
|
|
7
7
|
Run these SQL migrations through your normal migration process (e.g., Prisma Migrate, Drizzle Kit, or your DBA review process).
|
|
8
8
|
|
|
@@ -23,7 +23,7 @@ ALTER TABLE mastra_scorers DROP COLUMN "runtimeContext";
|
|
|
23
23
|
|
|
24
24
|
### Duplicate spans migration
|
|
25
25
|
|
|
26
|
-
If you're upgrading from an older version of Mastra, you may have duplicate `(traceId, spanId)` entries in your `mastra_spans` table. V1 adds a unique constraint on these columns to ensure data integrity, but this constraint
|
|
26
|
+
If you're upgrading from an older version of Mastra, you may have duplicate `(traceId, spanId)` entries in your `mastra_spans` table. V1 adds a unique constraint on these columns to ensure data integrity, but this constraint can't be added if duplicates exist.
|
|
27
27
|
|
|
28
28
|
> **Who needs this migration:** Only if you have existing spans data from Mastra versions prior to v1 and encounter errors about duplicate key violations or constraint creation failures.
|
|
29
29
|
|
|
@@ -89,7 +89,7 @@ USING snapshot::jsonb;
|
|
|
89
89
|
|
|
90
90
|
## Added
|
|
91
91
|
|
|
92
|
-
### Storage composition in MastraCompositeStore
|
|
92
|
+
### Storage composition in `MastraCompositeStore`
|
|
93
93
|
|
|
94
94
|
`MastraCompositeStore` can now compose storage domains from different adapters. Use it when you need different databases for different purposes - for example, PostgreSQL for memory and workflows, but a specialized database for observability.
|
|
95
95
|
|
|
@@ -460,7 +460,7 @@ To migrate, rename the method and use named arguments.
|
|
|
460
460
|
+ });
|
|
461
461
|
```
|
|
462
462
|
|
|
463
|
-
### PostgresStore `schema` to `schemaName`
|
|
463
|
+
### `PostgresStore`: `schema` to `schemaName`
|
|
464
464
|
|
|
465
465
|
The `schema` parameter has been renamed to `schemaName` in the PostgresStore constructor. This change provides clearer naming to avoid confusion with database schema concepts.
|
|
466
466
|
|
|
@@ -8,7 +8,7 @@ Tool execution signatures have been updated to use separate input and context pa
|
|
|
8
8
|
|
|
9
9
|
All `createTool` execute functions now use a new signature with separate `inputData` and `context` parameters instead of a single destructured object. This change provides clearer separation between tool inputs and execution context.
|
|
10
10
|
|
|
11
|
-
**Note:** This change only applies to `createTool`. If you're using `createStep` for workflows, the signature remains `async (inputData, context)` and
|
|
11
|
+
**Note:** This change only applies to `createTool`. If you're using `createStep` for workflows, the signature remains `async (inputData, context)` and doesn't need to be changed.
|
|
12
12
|
|
|
13
13
|
To migrate, update `createTool` signatures to use `inputData` as the first parameter (typed from `inputSchema`) and `context` as the second parameter.
|
|
14
14
|
|
|
@@ -80,7 +80,7 @@ createTool({
|
|
|
80
80
|
|
|
81
81
|
The `suspendPayload` gets validated against the `suspendSchema` when the tool is executed. If the suspendPayload doesn't match the `suspendSchema`, a warning is logged and the error is returned as tool output, but suspension continues. Also, when the tool is resumed, the `resumeData` gets validated against the `resumeSchema`. If the resumeData doesn't match the `resumeSchema`, the tool will return a `ValidationError`, preventing the tool resumption.
|
|
82
82
|
|
|
83
|
-
To skip the `suspendSchema` or `resumeSchema` validation,
|
|
83
|
+
To skip the `suspendSchema` or `resumeSchema` validation, don't define `suspendSchema` or `resumeSchema` in the tool creation.
|
|
84
84
|
|
|
85
85
|
> **Note:** For MCP-specific tool context changes, see the [MCP migration guide](https://mastra.ai/guides/migrations/upgrade-to-v1/mcp).
|
|
86
86
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
The observability system has been restructured in v1 with a dedicated `@mastra/observability` package. This guide covers two migration paths depending on which version you're upgrading from.
|
|
4
4
|
|
|
5
|
-
## Migration
|
|
5
|
+
## Migration paths
|
|
6
6
|
|
|
7
7
|
### From OTEL-based Telemetry (0.x)
|
|
8
8
|
|
|
@@ -342,7 +342,7 @@ node --env-file=".env" .mastra/output/index.mjs
|
|
|
342
342
|
|
|
343
343
|
No separate instrumentation files or special startup flags required.
|
|
344
344
|
|
|
345
|
-
## Provider
|
|
345
|
+
## Provider migration reference
|
|
346
346
|
|
|
347
347
|
If you were using OTEL-based telemetry with specific providers in 0.x, here's how to configure them in v1:
|
|
348
348
|
|
|
@@ -40,7 +40,7 @@ const vectorStore = new VectorStore({ ... });
|
|
|
40
40
|
+ const vectors = await vectorStore.listVectors({ ... });
|
|
41
41
|
```
|
|
42
42
|
|
|
43
|
-
### LibSQLVector
|
|
43
|
+
### `LibSQLVector`: `connectionUrl` to `url`
|
|
44
44
|
|
|
45
45
|
The `connectionUrl` parameter has been renamed to `url` to align with the `@libsql/client` API and match LibSQLStorage.
|
|
46
46
|
|
|
@@ -52,7 +52,7 @@ const vectorStore = new LibSQLVector({
|
|
|
52
52
|
});
|
|
53
53
|
```
|
|
54
54
|
|
|
55
|
-
### OpenSearchVector
|
|
55
|
+
### `OpenSearchVector`: `url` to `node`
|
|
56
56
|
|
|
57
57
|
The `url` parameter has been renamed to `node` to match the OpenSearch `ClientOptions` API. The constructor now accepts all OpenSearch client options including authentication, SSL, and compression.
|
|
58
58
|
|
|
@@ -64,7 +64,7 @@ const vectorStore = new OpenSearchVector({
|
|
|
64
64
|
});
|
|
65
65
|
```
|
|
66
66
|
|
|
67
|
-
### PineconeVector
|
|
67
|
+
### `PineconeVector`: `environment` removed
|
|
68
68
|
|
|
69
69
|
The `environment` parameter has been removed. Use `controllerHostUrl` instead if you need to specify a custom controller host. The constructor now accepts all Pinecone configuration options.
|
|
70
70
|
|
|
@@ -84,7 +84,7 @@ createStep({
|
|
|
84
84
|
|
|
85
85
|
### `getInitData` returns unknown
|
|
86
86
|
|
|
87
|
-
The `getInitData` function in the execute function now returns unknown instead of any. You'll need to type it yourself. To
|
|
87
|
+
The `getInitData` function in the execute function now returns unknown instead of any. You'll need to type it yourself. To migrate, change `getInitData()` into `getInitData<any>()`
|
|
88
88
|
|
|
89
89
|
```diff
|
|
90
90
|
createStep({
|
|
@@ -198,7 +198,7 @@ const run = await workflow.createRun();
|
|
|
198
198
|
+ });
|
|
199
199
|
```
|
|
200
200
|
|
|
201
|
-
> **Note:** The `writer` parameter passed to step `execute` functions
|
|
201
|
+
> **Note:** The `writer` parameter passed to step `execute` functions isn't affected by this change. It remains a `ToolStream` that extends `WritableStream<unknown>` and provides `.write()` and `.custom()` methods:
|
|
202
202
|
>
|
|
203
203
|
> ```ts
|
|
204
204
|
> createStep({
|
|
@@ -240,9 +240,9 @@ See [`Run.stream()`](https://mastra.ai/reference/streaming/workflows/stream), [`
|
|
|
240
240
|
> npx @mastra/codemod@latest v1/workflow-stream-vnext .
|
|
241
241
|
> ```
|
|
242
242
|
|
|
243
|
-
### `suspend` and `setState`
|
|
243
|
+
### `suspend` and `setState` aren't available in step condition functions parameters
|
|
244
244
|
|
|
245
|
-
The `suspend` and `setState` functions
|
|
245
|
+
The `suspend` and `setState` functions aren't available in step condition functions parameters.
|
|
246
246
|
|
|
247
247
|
To migrate, use the `suspend` function in the step execute function instead.
|
|
248
248
|
|
|
@@ -260,7 +260,7 @@ This is the same for `dountil` and `branch` condition functions parameters.
|
|
|
260
260
|
|
|
261
261
|
The `./workflows/legacy` export path has been removed from `@mastra/core`. Legacy workflows are no longer supported.
|
|
262
262
|
|
|
263
|
-
To migrate, use the new workflow API.
|
|
263
|
+
To migrate, use the new workflow API. No direct migration path exists from legacy workflows.
|
|
264
264
|
|
|
265
265
|
```diff
|
|
266
266
|
- import { LegacyWorkflow } from '@mastra/core/workflows/legacy';
|
|
@@ -268,7 +268,7 @@ To migrate, use the new workflow API. There is no direct migration path from leg
|
|
|
268
268
|
+ // Migrate to the new workflow API
|
|
269
269
|
```
|
|
270
270
|
|
|
271
|
-
### `pipeThrough` and `pipeTo` methods from WorkflowRunOutput
|
|
271
|
+
### `pipeThrough` and `pipeTo` methods from `WorkflowRunOutput`
|
|
272
272
|
|
|
273
273
|
The `pipeThrough()` and `pipeTo()` methods on `WorkflowRunOutput` are deprecated. These methods still work but show console warnings.
|
|
274
274
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Migrate from VNext to
|
|
1
|
+
# Migrate from VNext to standard APIs
|
|
2
2
|
|
|
3
3
|
As of `v0.20.0` for `@mastra/core`, the following changes apply.
|
|
4
4
|
|
|
@@ -40,7 +40,7 @@ Choose the migration path that fits your needs:
|
|
|
40
40
|
|
|
41
41
|
- Bump all your model provider packages by a major version.
|
|
42
42
|
|
|
43
|
-
> This will ensure that they
|
|
43
|
+
> This will ensure that they're all v5 models now. Follow the guide below to understand the key differences and update your code accordingly.
|
|
44
44
|
|
|
45
45
|
## Key differences
|
|
46
46
|
|
|
@@ -306,7 +306,7 @@ The following options are available in the standard `.stream()` and `generate()`
|
|
|
306
306
|
|
|
307
307
|
- `output`
|
|
308
308
|
|
|
309
|
-
The `output` property is deprecated in favor of `structuredOutput`, to achieve the same results, omit the model and only pass `structuredOutput.schema`, optionally add `jsonPromptInjection: true` if your model
|
|
309
|
+
The `output` property is deprecated in favor of `structuredOutput`, to achieve the same results, omit the model and only pass `structuredOutput.schema`, optionally add `jsonPromptInjection: true` if your model doesn't natively support `response_format`.
|
|
310
310
|
|
|
311
311
|
```typescript
|
|
312
312
|
const result = await agent.generate(messages, {
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
# Embedding
|
|
1
|
+
# Embedding models
|
|
2
2
|
|
|
3
3
|
Mastra's model router supports embedding models using the same `provider/model` string format as language models. This provides a unified interface for both chat and embedding models with TypeScript autocomplete support.
|
|
4
4
|
|
|
5
|
-
## Quick
|
|
5
|
+
## Quick start
|
|
6
6
|
|
|
7
7
|
```typescript
|
|
8
8
|
import { ModelRouterEmbeddingModel } from "@mastra/core/llm";
|
|
@@ -15,7 +15,7 @@ const { embeddings } = await embedMany({
|
|
|
15
15
|
});
|
|
16
16
|
```
|
|
17
17
|
|
|
18
|
-
## Supported
|
|
18
|
+
## Supported models
|
|
19
19
|
|
|
20
20
|
### OpenAI
|
|
21
21
|
|
|
@@ -127,7 +127,7 @@ const modelId: EmbeddingModelId = "openai/text-embedding-3-small";
|
|
|
127
127
|
const embedder = new ModelRouterEmbeddingModel(modelId);
|
|
128
128
|
```
|
|
129
129
|
|
|
130
|
-
## Error
|
|
130
|
+
## Error handling
|
|
131
131
|
|
|
132
132
|
The model router validates provider and model IDs at construction time:
|
|
133
133
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Custom
|
|
1
|
+
# Custom model gateways
|
|
2
2
|
|
|
3
3
|
Custom model gateways allow you to implement private or specialized LLM provider integrations by extending the `MastraModelGateway` base class.
|
|
4
4
|
|
|
@@ -357,7 +357,7 @@ Examples:
|
|
|
357
357
|
|
|
358
358
|
- `private/my-provider/model-1`
|
|
359
359
|
|
|
360
|
-
## Advanced
|
|
360
|
+
## Advanced example
|
|
361
361
|
|
|
362
362
|
Token-based gateway with caching:
|
|
363
363
|
|
|
@@ -432,7 +432,7 @@ class TokenGateway extends MastraModelGateway {
|
|
|
432
432
|
}
|
|
433
433
|
```
|
|
434
434
|
|
|
435
|
-
## Error
|
|
435
|
+
## Error handling
|
|
436
436
|
|
|
437
437
|
Provide descriptive errors for common failure scenarios:
|
|
438
438
|
|
|
@@ -513,7 +513,7 @@ describe('MyPrivateGateway', () => {
|
|
|
513
513
|
});
|
|
514
514
|
```
|
|
515
515
|
|
|
516
|
-
## Best
|
|
516
|
+
## Best practices
|
|
517
517
|
|
|
518
518
|
1. **Use descriptive IDs for versioning**: Set explicit `id` values when you need to version your gateways
|
|
519
519
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Netlify
|
|
2
2
|
|
|
3
|
-
Netlify AI Gateway provides unified access to multiple providers with built-in caching and observability. Access
|
|
3
|
+
Netlify AI Gateway provides unified access to multiple providers with built-in caching and observability. Access 59 models through Mastra's model router.
|
|
4
4
|
|
|
5
5
|
Learn more in the [Netlify documentation](https://docs.netlify.com/build/ai-gateway/overview/).
|
|
6
6
|
|
|
@@ -31,7 +31,7 @@ OPENAI_API_KEY=sk-...
|
|
|
31
31
|
ANTHROPIC_API_KEY=ant-...
|
|
32
32
|
```
|
|
33
33
|
|
|
34
|
-
## Available
|
|
34
|
+
## Available models
|
|
35
35
|
|
|
36
36
|
| Model |
|
|
37
37
|
| ---------------------------------------------- |
|
|
@@ -57,7 +57,6 @@ ANTHROPIC_API_KEY=ant-...
|
|
|
57
57
|
| `gemini/gemini-2.5-pro` |
|
|
58
58
|
| `gemini/gemini-3-flash-preview` |
|
|
59
59
|
| `gemini/gemini-3-pro-image-preview` |
|
|
60
|
-
| `gemini/gemini-3-pro-preview` |
|
|
61
60
|
| `gemini/gemini-3.1-flash-image-preview` |
|
|
62
61
|
| `gemini/gemini-3.1-flash-lite-preview` |
|
|
63
62
|
| `gemini/gemini-3.1-pro-preview` |
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# OpenRouter
|
|
2
2
|
|
|
3
|
-
OpenRouter aggregates models from multiple providers with enhanced features like rate limiting and failover. Access
|
|
3
|
+
OpenRouter aggregates models from multiple providers with enhanced features like rate limiting and failover. Access 193 models through Mastra's model router.
|
|
4
4
|
|
|
5
5
|
Learn more in the [OpenRouter documentation](https://openrouter.ai/models).
|
|
6
6
|
|
|
@@ -30,7 +30,7 @@ OPENAI_API_KEY=sk-...
|
|
|
30
30
|
ANTHROPIC_API_KEY=ant-...
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
## Available
|
|
33
|
+
## Available models
|
|
34
34
|
|
|
35
35
|
| Model |
|
|
36
36
|
| --------------------------------------------------------------- |
|
|
@@ -91,6 +91,9 @@ ANTHROPIC_API_KEY=ant-...
|
|
|
91
91
|
| `google/gemma-3n-e2b-it:free` |
|
|
92
92
|
| `google/gemma-3n-e4b-it` |
|
|
93
93
|
| `google/gemma-3n-e4b-it:free` |
|
|
94
|
+
| `inception/mercury` |
|
|
95
|
+
| `inception/mercury-2` |
|
|
96
|
+
| `inception/mercury-coder` |
|
|
94
97
|
| `kwaipilot/kat-coder-pro:free` |
|
|
95
98
|
| `liquid/lfm-2.5-1.2b-instruct:free` |
|
|
96
99
|
| `liquid/lfm-2.5-1.2b-thinking:free` |
|
|
@@ -153,6 +156,9 @@ ANTHROPIC_API_KEY=ant-...
|
|
|
153
156
|
| `openai/gpt-5.2-chat` |
|
|
154
157
|
| `openai/gpt-5.2-codex` |
|
|
155
158
|
| `openai/gpt-5.2-pro` |
|
|
159
|
+
| `openai/gpt-5.3-codex` |
|
|
160
|
+
| `openai/gpt-5.4` |
|
|
161
|
+
| `openai/gpt-5.4-pro` |
|
|
156
162
|
| `openai/gpt-oss-120b` |
|
|
157
163
|
| `openai/gpt-oss-120b:exacto` |
|
|
158
164
|
| `openai/gpt-oss-120b:free` |
|
|
@@ -161,6 +167,7 @@ ANTHROPIC_API_KEY=ant-...
|
|
|
161
167
|
| `openai/gpt-oss-safeguard-20b` |
|
|
162
168
|
| `openai/o4-mini` |
|
|
163
169
|
| `openrouter/aurora-alpha` |
|
|
170
|
+
| `openrouter/free` |
|
|
164
171
|
| `openrouter/sherlock-dash-alpha` |
|
|
165
172
|
| `openrouter/sherlock-think-alpha` |
|
|
166
173
|
| `prime-intellect/intellect-3` |
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Vercel
|
|
2
2
|
|
|
3
|
-
Vercel aggregates models from multiple providers with enhanced features like rate limiting and failover. Access
|
|
3
|
+
Vercel aggregates models from multiple providers with enhanced features like rate limiting and failover. Access 208 models through Mastra's model router.
|
|
4
4
|
|
|
5
5
|
Learn more in the [Vercel documentation](https://ai-sdk.dev/providers/ai-sdk-providers).
|
|
6
6
|
|
|
@@ -30,7 +30,7 @@ OPENAI_API_KEY=sk-...
|
|
|
30
30
|
ANTHROPIC_API_KEY=ant-...
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
## Available
|
|
33
|
+
## Available models
|
|
34
34
|
|
|
35
35
|
| Model |
|
|
36
36
|
| ---------------------------------------------- |
|
|
@@ -104,6 +104,8 @@ ANTHROPIC_API_KEY=ant-...
|
|
|
104
104
|
| `google/gemini-3-flash` |
|
|
105
105
|
| `google/gemini-3-pro-image` |
|
|
106
106
|
| `google/gemini-3-pro-preview` |
|
|
107
|
+
| `google/gemini-3.1-flash-image-preview` |
|
|
108
|
+
| `google/gemini-3.1-flash-lite-preview` |
|
|
107
109
|
| `google/gemini-3.1-pro-preview` |
|
|
108
110
|
| `google/gemini-embedding-001` |
|
|
109
111
|
| `google/imagen-4.0-fast-generate-001` |
|
|
@@ -111,6 +113,7 @@ ANTHROPIC_API_KEY=ant-...
|
|
|
111
113
|
| `google/imagen-4.0-ultra-generate-001` |
|
|
112
114
|
| `google/text-embedding-005` |
|
|
113
115
|
| `google/text-multilingual-embedding-002` |
|
|
116
|
+
| `inception/mercury-2` |
|
|
114
117
|
| `inception/mercury-coder-small` |
|
|
115
118
|
| `kwaipilot/kat-coder-pro-v1` |
|
|
116
119
|
| `meituan/longcat-flash-chat` |
|
|
@@ -181,7 +184,10 @@ ANTHROPIC_API_KEY=ant-...
|
|
|
181
184
|
| `openai/gpt-5.2-chat` |
|
|
182
185
|
| `openai/gpt-5.2-codex` |
|
|
183
186
|
| `openai/gpt-5.2-pro` |
|
|
187
|
+
| `openai/gpt-5.3-chat` |
|
|
184
188
|
| `openai/gpt-5.3-codex` |
|
|
189
|
+
| `openai/gpt-5.4` |
|
|
190
|
+
| `openai/gpt-5.4-pro` |
|
|
185
191
|
| `openai/gpt-oss-120b` |
|
|
186
192
|
| `openai/gpt-oss-20b` |
|
|
187
193
|
| `openai/gpt-oss-safeguard-20b` |
|
|
@@ -206,6 +212,9 @@ ANTHROPIC_API_KEY=ant-...
|
|
|
206
212
|
| `voyage/voyage-3-large` |
|
|
207
213
|
| `voyage/voyage-3.5` |
|
|
208
214
|
| `voyage/voyage-3.5-lite` |
|
|
215
|
+
| `voyage/voyage-4` |
|
|
216
|
+
| `voyage/voyage-4-large` |
|
|
217
|
+
| `voyage/voyage-4-lite` |
|
|
209
218
|
| `voyage/voyage-code-2` |
|
|
210
219
|
| `voyage/voyage-code-3` |
|
|
211
220
|
| `voyage/voyage-finance-2` |
|
package/.docs/models/gateways.md
CHANGED
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
Gateway providers aggregate multiple model providers and add features like caching, rate limiting, analytics, and automatic failover. Use gateways when you need observability, cost management, or simplified multi-provider access.
|
|
4
4
|
|
|
5
|
-
## Custom
|
|
5
|
+
## Custom gateways
|
|
6
6
|
|
|
7
7
|
Create custom gateways for private LLM deployments or specialized provider integrations. See [Custom Gateways](https://mastra.ai/models/gateways/custom-gateways) for implementation details.
|
|
8
8
|
|
|
9
|
-
## Built-in
|
|
9
|
+
## Built-in gateways
|
|
10
10
|
|
|
11
11
|
- [Azure OpenAI](https://mastra.ai/models/gateways/azure-openai)
|
|
12
12
|
- [Netlify](https://mastra.ai/models/gateways/netlify)
|
package/.docs/models/index.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Model Providers
|
|
2
2
|
|
|
3
|
-
Mastra provides a unified interface for working with LLMs across multiple providers, giving you access to
|
|
3
|
+
Mastra provides a unified interface for working with LLMs across multiple providers, giving you access to 3239 models from 92 providers through a single API.
|
|
4
4
|
|
|
5
5
|
## Features
|
|
6
6
|
|