@mastra/mcp-docs-server 1.1.5 → 1.1.6
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 +349 -0
- package/.docs/docs/agents/agent-approval.md +558 -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 +214 -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 +239 -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/mastra-code/configuration.md +299 -0
- package/.docs/docs/mastra-code/customization.md +228 -0
- package/.docs/docs/mastra-code/modes.md +104 -0
- package/.docs/docs/mastra-code/overview.md +135 -0
- package/.docs/docs/mastra-code/tools.md +229 -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 +248 -0
- package/.docs/docs/memory/overview.md +45 -0
- package/.docs/docs/memory/semantic-recall.md +272 -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 +203 -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 +63 -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 +101 -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 +3 -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 +88 -0
- package/.docs/models/gateways/openrouter.md +219 -0
- package/.docs/models/gateways/vercel.md +225 -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 +107 -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 +153 -0
- package/.docs/models/providers/azure.md +33 -0
- package/.docs/models/providers/bailing.md +72 -0
- package/.docs/models/providers/baseten.md +77 -0
- package/.docs/models/providers/berget.md +78 -0
- package/.docs/models/providers/cerebras.md +101 -0
- package/.docs/models/providers/chutes.md +136 -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/fastrouter.md +84 -0
- package/.docs/models/providers/fireworks-ai.md +89 -0
- package/.docs/models/providers/firmware.md +85 -0
- package/.docs/models/providers/friendli.md +78 -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 +159 -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/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.md +100 -0
- package/.docs/models/providers/ovhcloud.md +83 -0
- package/.docs/models/providers/perplexity.md +100 -0
- package/.docs/models/providers/poe.md +183 -0
- package/.docs/models/providers/privatemode-ai.md +75 -0
- package/.docs/models/providers/requesty.md +90 -0
- package/.docs/models/providers/scaleway.md +84 -0
- package/.docs/models/providers/siliconflow-cn.md +138 -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 +115 -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 +161 -0
- package/.docs/models/providers/zhipuai-coding-plan.md +79 -0
- package/.docs/models/providers/zhipuai.md +79 -0
- package/.docs/models/providers.md +81 -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 +133 -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 +59 -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 +91 -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 +708 -0
- package/.docs/reference/index.md +277 -0
- package/.docs/reference/logging/pino-logger.md +117 -0
- package/.docs/reference/mastra-code/createMastraCode.md +108 -0
- package/.docs/reference/memory/clone-utilities.md +199 -0
- package/.docs/reference/memory/cloneThread.md +130 -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 +565 -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 +221 -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 +237 -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 +954 -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/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 +175 -0
- package/.docs/reference/workspace/sandbox.md +87 -0
- package/.docs/reference/workspace/workspace-class.md +244 -0
- package/CHANGELOG.md +16 -0
- package/package.json +6 -6
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
# Deploy a Mastra Server
|
|
2
|
+
|
|
3
|
+
Mastra compiles your application into a standalone Node.js server that can run on any platform supporting Node.js, Bun, or Deno.
|
|
4
|
+
|
|
5
|
+
> **Tip:** This guide covers deploying the standalone server generated by `mastra build`. If you need to integrate Mastra into an existing Express or Hono application, see [Server Adapters](https://mastra.ai/docs/server/server-adapters) instead.
|
|
6
|
+
|
|
7
|
+
## Building your application
|
|
8
|
+
|
|
9
|
+
Run the build command from your project root:
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
mastra build
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
This creates a `.mastra` directory containing your production-ready server.
|
|
16
|
+
|
|
17
|
+
> **Info:** Read the [`mastra build`](https://mastra.ai/reference/cli/mastra) reference for all available flags.
|
|
18
|
+
|
|
19
|
+
## Build output
|
|
20
|
+
|
|
21
|
+
After building, Mastra creates the following structure:
|
|
22
|
+
|
|
23
|
+
```text
|
|
24
|
+
.mastra/
|
|
25
|
+
├── .build/ # Intermediate build artifacts (module maps, analysis)
|
|
26
|
+
└── output/
|
|
27
|
+
├── index.mjs # Server entry point
|
|
28
|
+
├── mastra.mjs # Your bundled Mastra configuration
|
|
29
|
+
├── tools.mjs # Aggregated tool exports
|
|
30
|
+
├── tools/ # Individual tool bundles
|
|
31
|
+
├── package.json # Production dependencies
|
|
32
|
+
├── node_modules/ # Installed dependencies
|
|
33
|
+
├── .npmrc # Copied from your project (if present)
|
|
34
|
+
├── public/ # Static assets (if src/mastra/public exists)
|
|
35
|
+
└── playground/ # Studio UI (if --studio flag used)
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
The `output` directory is self-contained. You can copy it to any server and run it directly.
|
|
39
|
+
|
|
40
|
+
## Running the server
|
|
41
|
+
|
|
42
|
+
Start the server using the Mastra CLI:
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
mastra start
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
Or run directly with Node.js:
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
node .mastra/output/index.mjs
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
The `mastra start` command provides additional features:
|
|
55
|
+
|
|
56
|
+
- Loads environment variables from `.env.production` and `.env`
|
|
57
|
+
- Provides helpful error messages for missing modules
|
|
58
|
+
- Handles process signals for graceful shutdown
|
|
59
|
+
|
|
60
|
+
> **Info:** Read the [`mastra start`](https://mastra.ai/reference/cli/mastra) reference for all available flags.
|
|
61
|
+
|
|
62
|
+
## Build configuration
|
|
63
|
+
|
|
64
|
+
### Public folder
|
|
65
|
+
|
|
66
|
+
If a `public` folder exists in your Mastra directory (`src/mastra/public`), its contents are copied to the output directory during build. These files are served as static assets by the server.
|
|
67
|
+
|
|
68
|
+
### Mastra configuration
|
|
69
|
+
|
|
70
|
+
The build process respects configuration in your Mastra instance. For server behavior like CORS, timeouts, and middleware, see [server overview](https://mastra.ai/docs/server/mastra-server). For all available options, see the [configuration reference](https://mastra.ai/reference/configuration).
|
|
71
|
+
|
|
72
|
+
## Build process
|
|
73
|
+
|
|
74
|
+
The build follows these steps:
|
|
75
|
+
|
|
76
|
+
1. **Locates entry file**: Finds `index.ts` or `index.js` in your Mastra directory.
|
|
77
|
+
2. **Discovers tools**: Scans for tool files matching `{mastraDir}/tools/**/*.{js,ts}`, excluding test files.
|
|
78
|
+
3. **Analyzes dependencies**: Determines which packages to bundle vs. install externally.
|
|
79
|
+
4. **Bundles code**: Uses Rollup with tree-shaking and optional source maps.
|
|
80
|
+
5. **Generates server**: Creates a Hono-based HTTP server as `index.mjs`.
|
|
81
|
+
6. **Installs dependencies**: Runs `npm install` in the output directory.
|
|
82
|
+
7. **Copies assets**: Copies `public` folder and `.npmrc` if present.
|
|
83
|
+
|
|
84
|
+
## Environment variables
|
|
85
|
+
|
|
86
|
+
| Variable | Description |
|
|
87
|
+
| -------------------- | --------------------------------------------------------------------------- |
|
|
88
|
+
| `PORT` | Server port (default: `4111`) |
|
|
89
|
+
| `MASTRA_STUDIO_PATH` | Path to Studio build directory (default: `./playground`) |
|
|
90
|
+
| `MASTRA_SKIP_DOTENV` | Skip loading `.env` files when set |
|
|
91
|
+
| `NODE_OPTIONS` | Node.js options (e.g., `--max-old-space-size=4096` for build memory issues) |
|
|
92
|
+
|
|
93
|
+
## Server endpoints
|
|
94
|
+
|
|
95
|
+
The built server exposes endpoints for health checks, agents, workflows, and more:
|
|
96
|
+
|
|
97
|
+
| Endpoint | Description |
|
|
98
|
+
| ------------------- | ---------------------------------------------------------------------- |
|
|
99
|
+
| `GET /health` | Health check endpoint, returns `200 OK` |
|
|
100
|
+
| `GET /openapi.json` | OpenAPI specification (if `server.build.openAPIDocs` is enabled) |
|
|
101
|
+
| `GET /swagger-ui` | Interactive API documentation (if `server.build.swaggerUI` is enabled) |
|
|
102
|
+
|
|
103
|
+
This list is not exhaustive. To view all endpoints, run `mastra dev` and visit `http://localhost:4111/swagger-ui`.
|
|
104
|
+
|
|
105
|
+
To add your own endpoints, see [Custom API Routes](https://mastra.ai/docs/server/custom-api-routes).
|
|
106
|
+
|
|
107
|
+
## Troubleshooting
|
|
108
|
+
|
|
109
|
+
### Memory errors during build
|
|
110
|
+
|
|
111
|
+
If you encounter `JavaScript heap out of memory` errors:
|
|
112
|
+
|
|
113
|
+
```bash
|
|
114
|
+
NODE_OPTIONS="--max-old-space-size=4096" mastra build
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
## Related
|
|
118
|
+
|
|
119
|
+
- [Server Overview](https://mastra.ai/docs/server/mastra-server) - Configure server behavior, middleware, and authentication
|
|
120
|
+
- [Server Adapters](https://mastra.ai/docs/server/server-adapters) - Use Express or Hono instead of `mastra build`
|
|
121
|
+
- [Custom API Routes](https://mastra.ai/docs/server/custom-api-routes) - Add custom HTTP endpoints
|
|
122
|
+
- [Configuration Reference](https://mastra.ai/reference/configuration) - Full configuration options
|
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
# Deploy in a Monorepo
|
|
2
|
+
|
|
3
|
+
Deploying Mastra in a monorepo follows the same process as a standalone application. This guide covers monorepo-specific considerations. For the core build and deployment steps, see [Deploy a Mastra Server](https://mastra.ai/docs/deployment/mastra-server).
|
|
4
|
+
|
|
5
|
+
## Supported monorepos
|
|
6
|
+
|
|
7
|
+
Mastra works with:
|
|
8
|
+
|
|
9
|
+
- npm workspaces
|
|
10
|
+
- pnpm workspaces
|
|
11
|
+
- Yarn workspaces
|
|
12
|
+
- Turborepo
|
|
13
|
+
|
|
14
|
+
Known limitations:
|
|
15
|
+
|
|
16
|
+
- Bun workspaces - partial support; known issues
|
|
17
|
+
- Nx - You can use Nx's [supported dependency strategies](https://nx.dev/concepts/decisions/dependency-management) but you need to have `package.json` files inside your workspace packages
|
|
18
|
+
|
|
19
|
+
## Example structure
|
|
20
|
+
|
|
21
|
+
In this example, the Mastra application is located at `apps/api`:
|
|
22
|
+
|
|
23
|
+
```text
|
|
24
|
+
apps/
|
|
25
|
+
├── api/
|
|
26
|
+
│ ├── src/
|
|
27
|
+
│ │ └── mastra/
|
|
28
|
+
│ │ ├── agents/
|
|
29
|
+
│ │ ├── tools/
|
|
30
|
+
│ │ ├── workflows/
|
|
31
|
+
│ │ └── index.ts
|
|
32
|
+
│ ├── package.json
|
|
33
|
+
│ └── tsconfig.json
|
|
34
|
+
└── web/
|
|
35
|
+
packages/
|
|
36
|
+
├── ui/
|
|
37
|
+
└── utils/
|
|
38
|
+
package.json
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Building from a monorepo
|
|
42
|
+
|
|
43
|
+
Use your monorepo tool to run the build command from the correct package. There's no need for special flags.
|
|
44
|
+
|
|
45
|
+
Examples:
|
|
46
|
+
|
|
47
|
+
**npm**:
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
npm run build --workspace=apps/api
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
**pnpm**:
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
pnpm --filter api run build
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
**yarn**:
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
yarn workspace api build
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
**Turborepo**:
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
turbo run build --filter=api
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
Your package's `build` script should run `mastra build`:
|
|
72
|
+
|
|
73
|
+
```json
|
|
74
|
+
{
|
|
75
|
+
"scripts": {
|
|
76
|
+
"build": "mastra build"
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
## Workspace packages
|
|
82
|
+
|
|
83
|
+
When your Mastra application imports from other workspace packages, Mastra handles this automatically:
|
|
84
|
+
|
|
85
|
+
- If the package is pre-compiled (e.g., built with `tsc` or `tsdown`), Mastra imports the compiled JavaScript
|
|
86
|
+
- If the package contains uncompiled TypeScript, Mastra transpiles it during the build
|
|
87
|
+
|
|
88
|
+
For most setups, this works without configuration. If you encounter issues with workspace package imports, add the package to [`transpilePackages`](https://mastra.ai/reference/configuration):
|
|
89
|
+
|
|
90
|
+
```typescript
|
|
91
|
+
export const mastra = new Mastra({
|
|
92
|
+
bundler: {
|
|
93
|
+
transpilePackages: ['@my-org/utils'],
|
|
94
|
+
},
|
|
95
|
+
})
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
## Environment variables
|
|
99
|
+
|
|
100
|
+
Store `.env` files in the Mastra application directory (e.g., `apps/api/.env`), not the monorepo root.
|
|
101
|
+
|
|
102
|
+
## Deployment configuration
|
|
103
|
+
|
|
104
|
+
When deploying to cloud providers, ensure the correct package is selected as the deploy target. Selecting the monorepo root instead of the application directory (e.g., `apps/api`) is a common mistake.
|
|
105
|
+
|
|
106
|
+
Most providers let you specify the root directory in their dashboard or configuration file.
|
|
107
|
+
|
|
108
|
+
### Mastra Cloud
|
|
109
|
+
|
|
110
|
+
The image below shows how to select `apps/api` as the project root when deploying to [Mastra Cloud](https://mastra.ai/docs/mastra-cloud/overview). While the interface may differ between providers, the configuration remains the same.
|
|
111
|
+
|
|
112
|
+

|
|
113
|
+
|
|
114
|
+
## Dependency management
|
|
115
|
+
|
|
116
|
+
Keep dependencies consistent to avoid version conflicts and build errors:
|
|
117
|
+
|
|
118
|
+
- Use a **single lockfile** at the monorepo root so all packages resolve the same versions
|
|
119
|
+
- Align versions of **shared libraries** (like Mastra or frameworks) to prevent duplicates
|
|
120
|
+
|
|
121
|
+
## Troubleshooting
|
|
122
|
+
|
|
123
|
+
### Workspace package not found
|
|
124
|
+
|
|
125
|
+
If Mastra can't resolve a workspace package, ensure:
|
|
126
|
+
|
|
127
|
+
- The package is listed in your `package.json` dependencies
|
|
128
|
+
- Your lockfile is up to date (`pnpm install`, `npm install`, etc.)
|
|
129
|
+
- The package has a valid `main` or `exports` field in its `package.json`
|
|
130
|
+
|
|
131
|
+
### TypeScript errors from workspace packages
|
|
132
|
+
|
|
133
|
+
If you see type errors from uncompiled workspace packages, either:
|
|
134
|
+
|
|
135
|
+
- Build the package first (recommended for faster Mastra builds)
|
|
136
|
+
- Add the package to [`transpilePackages`](https://mastra.ai/reference/configuration) in your Mastra config
|
|
137
|
+
|
|
138
|
+
## Related
|
|
139
|
+
|
|
140
|
+
- [Deploy a Mastra Server](https://mastra.ai/docs/deployment/mastra-server) - Core build and deployment guide
|
|
141
|
+
- [Configuration Reference](https://mastra.ai/reference/configuration) - `bundler.transpilePackages` and other options
|
|
142
|
+
- [CLI Reference](https://mastra.ai/reference/cli/mastra) - Build command flags
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# Deployment Overview
|
|
2
|
+
|
|
3
|
+
Mastra applications can be deployed to any Node.js-compatible environment. You can deploy a Mastra server, integrate with an existing web framework, deploy to cloud providers, or use Mastra Cloud for managed hosting.
|
|
4
|
+
|
|
5
|
+
## Runtime support
|
|
6
|
+
|
|
7
|
+
Mastra can run against any of these runtime environments:
|
|
8
|
+
|
|
9
|
+
- Node.js `v22.13.0` or later
|
|
10
|
+
- Bun
|
|
11
|
+
- Deno
|
|
12
|
+
- Cloudflare
|
|
13
|
+
|
|
14
|
+
## Deployment Options
|
|
15
|
+
|
|
16
|
+
### Mastra Server
|
|
17
|
+
|
|
18
|
+
Mastra provides a [server](https://mastra.ai/docs/server/mastra-server) powered by Hono that can be deployed independently. Use the `mastra build` command to build your application and deploy the output to your preferred VM, container, or PaaS platform.
|
|
19
|
+
|
|
20
|
+
Use this option when you need full control over your infrastructure, long-running processes, or WebSocket connections. The [Mastra server deployment guide](https://mastra.ai/docs/deployment/mastra-server) provides more details.
|
|
21
|
+
|
|
22
|
+
### Monorepo
|
|
23
|
+
|
|
24
|
+
Deploy a Mastra server as part of a monorepo setup, following the same approach as standalone deployment.
|
|
25
|
+
|
|
26
|
+
Read about [monorepo deployment](https://mastra.ai/docs/deployment/monorepo).
|
|
27
|
+
|
|
28
|
+
### Cloud Providers
|
|
29
|
+
|
|
30
|
+
Mastra applications can be deployed to cloud providers and serverless platforms. Mastra includes optional built-in deployers for Vercel, Netlify, and Cloudflare to automate the build and deployment process.
|
|
31
|
+
|
|
32
|
+
Use this option for auto-scaling, minimal infrastructure management, or when you're already using one of these platforms.
|
|
33
|
+
|
|
34
|
+
- [Amazon EC2](https://mastra.ai/guides/deployment/amazon-ec2)
|
|
35
|
+
- [AWS Lambda](https://mastra.ai/guides/deployment/aws-lambda)
|
|
36
|
+
- [Azure App Services](https://mastra.ai/guides/deployment/azure-app-services)
|
|
37
|
+
- [Cloudflare](https://mastra.ai/guides/deployment/cloudflare)
|
|
38
|
+
- [Digital Ocean](https://mastra.ai/guides/deployment/digital-ocean)
|
|
39
|
+
- [Netlify](https://mastra.ai/guides/deployment/netlify)
|
|
40
|
+
- [Vercel](https://mastra.ai/guides/deployment/vercel)
|
|
41
|
+
|
|
42
|
+
### Web Framework
|
|
43
|
+
|
|
44
|
+
When Mastra is integrated with a web framework, it deploys alongside your application using the framework's standard deployment process. The guides below cover framework-specific configuration requirements for deployment.
|
|
45
|
+
|
|
46
|
+
Use these guides when adding Mastra to an existing Next.js or Astro application.
|
|
47
|
+
|
|
48
|
+
- [With Next.js on Vercel](https://mastra.ai/docs/deployment/web-framework)
|
|
49
|
+
- [With Astro on Vercel](https://mastra.ai/docs/deployment/web-framework)
|
|
50
|
+
- [With Astro on Netlify](https://mastra.ai/docs/deployment/web-framework)
|
|
51
|
+
|
|
52
|
+
### Mastra Cloud
|
|
53
|
+
|
|
54
|
+
We're building Mastra Cloud to be the easiest place to deploy and observe your Mastra agents. It's currently in beta.
|
|
55
|
+
|
|
56
|
+
Learn more in the [Mastra Cloud docs](https://mastra.ai/docs/mastra-cloud/overview).
|
|
57
|
+
|
|
58
|
+
## Workflow Runners
|
|
59
|
+
|
|
60
|
+
Mastra workflows run using the built-in execution engine by default. For production workloads requiring managed infrastructure, workflows can also be deployed to specialized platforms like [Inngest](https://www.inngest.com) that provide step memoization, automatic retries, and real-time monitoring.
|
|
61
|
+
|
|
62
|
+
Visit the [Workflow Runners guide](https://mastra.ai/docs/deployment/workflow-runners) for execution options and the [Inngest deployment guide](https://mastra.ai/guides/deployment/inngest) for setup instructions.
|
|
@@ -0,0 +1,239 @@
|
|
|
1
|
+
# Deploying Studio
|
|
2
|
+
|
|
3
|
+
[Studio](https://mastra.ai/docs/getting-started/studio) provides an interactive UI for building and testing your agents. It's a React-based Single Page Application (SPA) that runs in the browser and connects to a running [Mastra server](https://mastra.ai/docs/deployment/mastra-server).
|
|
4
|
+
|
|
5
|
+
There are two primary ways of deploying Studio:
|
|
6
|
+
|
|
7
|
+
- [Mastra Cloud](https://mastra.ai/docs/mastra-cloud/overview) hosts Studio for you and allows you to share access with your team via link
|
|
8
|
+
- You can self-host Studio on your own infrastructure, either alongside your Mastra server or separately as a standalone SPA
|
|
9
|
+
|
|
10
|
+
On this page you'll learn how to deploy Studio on your own infrastructure. As the finer details of deployment can vary widely based on your needs and setup, we'll cover the general principles and options available to you.
|
|
11
|
+
|
|
12
|
+
## Fundamentals
|
|
13
|
+
|
|
14
|
+
The easiest way to run Studio is the [`mastra studio`](https://mastra.ai/reference/cli/mastra) command.
|
|
15
|
+
|
|
16
|
+
Whereas `mastra dev` runs both Studio and an API for development purposes, the purpose of `mastra studio` is to serve a standalone, static UI that connects to an already-running Mastra server. This allows you to deploy Studio on its own, separate from the Mastra server, if desired.
|
|
17
|
+
|
|
18
|
+
Open a terminal and install the `mastra` CLI globally:
|
|
19
|
+
|
|
20
|
+
**npm**:
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
npm install -g mastra
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
**pnpm**:
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
pnpm add -g mastra
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
**Yarn**:
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
yarn global add mastra
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
**Bun**:
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
bun add --global mastra
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Run the `mastra studio` command:
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
mastra studio
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Open [localhost:3000](http://localhost:3000) in your browser to see the Studio UI. By default, it will attempt to connect to a Mastra server running at `http://localhost:4111`. If it doesn't find one there, you'll see a form where you can enter your Mastra instance URL and API prefix.
|
|
51
|
+
|
|
52
|
+
The command uses Node's built-in `http` module and [`serve-handler`](https://www.npmjs.com/package/serve-handler) to serve the static files.
|
|
53
|
+
|
|
54
|
+
## Running a server
|
|
55
|
+
|
|
56
|
+
Running `mastra studio` as a long-running process is no different from running any other Node.js service. All the best practices, tools, and options for deployment apply here as well. You can use process managers like PM2, use Docker, or cloud services that support Node.js applications. You'll need to ensure CORS is configured correctly and errors are monitored, just like with any web service.
|
|
57
|
+
|
|
58
|
+
> **Warning:** Once Studio is connected to your Mastra server, it has full access to your agents, workflows, and tools. Be sure to secure it properly in production (e.g. behind authentication, VPN, etc.) to prevent unauthorized access.
|
|
59
|
+
|
|
60
|
+
### Alongside your API
|
|
61
|
+
|
|
62
|
+
Alternatively, you can serve Studio alongside your [Mastra server](https://mastra.ai/docs/deployment/mastra-server). This way you only have one service to deploy and manage.
|
|
63
|
+
|
|
64
|
+
To do this, run `mastra build` with the `--studio` flag:
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
mastra build --studio
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
It'll create a `.mastra/output/studio` folder with the built Studio assets. By defining the `MASTRA_STUDIO_PATH` environment variable, the Mastra server can serve the Studio UI, too.
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
MASTRA_STUDIO_PATH=.mastra/output/studio node .mastra/output/index.mjs
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
## Using a CDN
|
|
77
|
+
|
|
78
|
+
Currently, you can't directly deploy the built Studio assets to a CDN, as the UI relies on some dynamic configuration. With a bit of extra setup, you can create a standalone SPA out of the built assets and deploy it to any static hosting service like Netlify, Vercel, etc.
|
|
79
|
+
|
|
80
|
+
Follow the example below to create a SPA using Vite.
|
|
81
|
+
|
|
82
|
+
1. Create a new folder and initialize a new Node.js project:
|
|
83
|
+
|
|
84
|
+
**npm**:
|
|
85
|
+
|
|
86
|
+
```bash
|
|
87
|
+
mkdir studio-spa
|
|
88
|
+
cd studio-spa
|
|
89
|
+
npm init
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
**pnpm**:
|
|
93
|
+
|
|
94
|
+
```bash
|
|
95
|
+
mkdir studio-spa
|
|
96
|
+
cd studio-spa
|
|
97
|
+
pnpm init
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
**Yarn**:
|
|
101
|
+
|
|
102
|
+
```bash
|
|
103
|
+
mkdir studio-spa
|
|
104
|
+
cd studio-spa
|
|
105
|
+
yarn init
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
**Bun**:
|
|
109
|
+
|
|
110
|
+
```bash
|
|
111
|
+
mkdir studio-spa
|
|
112
|
+
cd studio-spa
|
|
113
|
+
bun init
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
2. Install `vite` and `mastra` as dependencies:
|
|
117
|
+
|
|
118
|
+
**npm**:
|
|
119
|
+
|
|
120
|
+
```bash
|
|
121
|
+
npm install vite mastra
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
**pnpm**:
|
|
125
|
+
|
|
126
|
+
```bash
|
|
127
|
+
pnpm add vite mastra
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
**Yarn**:
|
|
131
|
+
|
|
132
|
+
```bash
|
|
133
|
+
yarn add vite mastra
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
**Bun**:
|
|
137
|
+
|
|
138
|
+
```bash
|
|
139
|
+
bun add vite mastra
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
3. Add a build script to your `package.json`:
|
|
143
|
+
|
|
144
|
+
```json
|
|
145
|
+
{
|
|
146
|
+
"scripts": {
|
|
147
|
+
"build": "vite build"
|
|
148
|
+
}
|
|
149
|
+
}
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
4. Create a placeholder `index.html` file:
|
|
153
|
+
|
|
154
|
+
```html
|
|
155
|
+
<!doctype html>
|
|
156
|
+
<html>
|
|
157
|
+
<head></head>
|
|
158
|
+
<body></body>
|
|
159
|
+
</html>
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
5. Create a `vite.config.js` file. It copies the built Studio assets to the `dist` folder and replaces any `%%PLACEHOLDER%%` values in the HTML with environment variable values.
|
|
163
|
+
|
|
164
|
+
```js
|
|
165
|
+
import { defineConfig, loadEnv } from 'vite'
|
|
166
|
+
import { readFileSync, cpSync, writeFileSync } from 'node:fs'
|
|
167
|
+
import { resolve, join } from 'node:path'
|
|
168
|
+
|
|
169
|
+
const studioDir = resolve(import.meta.dirname, 'node_modules/mastra/dist/studio')
|
|
170
|
+
|
|
171
|
+
export default defineConfig(({ mode }) => {
|
|
172
|
+
const env = loadEnv(mode, process.cwd(), 'MASTRA_')
|
|
173
|
+
|
|
174
|
+
return {
|
|
175
|
+
plugins: [
|
|
176
|
+
{
|
|
177
|
+
name: 'mastra-studio',
|
|
178
|
+
closeBundle() {
|
|
179
|
+
const outDir = resolve(import.meta.dirname, 'dist')
|
|
180
|
+
cpSync(studioDir, outDir, { recursive: true })
|
|
181
|
+
|
|
182
|
+
const indexPath = join(outDir, 'index.html')
|
|
183
|
+
const html = readFileSync(indexPath, 'utf-8')
|
|
184
|
+
writeFileSync(
|
|
185
|
+
indexPath,
|
|
186
|
+
html.replaceAll(/%%(\w+)%%/g, (_, key) => env[key] ?? ''),
|
|
187
|
+
)
|
|
188
|
+
},
|
|
189
|
+
},
|
|
190
|
+
],
|
|
191
|
+
build: {
|
|
192
|
+
emptyOutDir: true,
|
|
193
|
+
},
|
|
194
|
+
}
|
|
195
|
+
})
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
6. Create a `.env` file with the necessary environment variables.
|
|
199
|
+
|
|
200
|
+
```env
|
|
201
|
+
MASTRA_SERVER_HOST=localhost
|
|
202
|
+
MASTRA_SERVER_PORT=4111
|
|
203
|
+
MASTRA_SERVER_PROTOCOL=http
|
|
204
|
+
MASTRA_API_PREFIX=/api
|
|
205
|
+
MASTRA_STUDIO_BASE_PATH=
|
|
206
|
+
MASTRA_TELEMETRY_DISABLED=true
|
|
207
|
+
MASTRA_HIDE_CLOUD_CTA=false
|
|
208
|
+
MASTRA_CLOUD_API_ENDPOINT=
|
|
209
|
+
MASTRA_EXPERIMENTAL_FEATURES=false
|
|
210
|
+
MASTRA_REQUEST_CONTEXT_PRESETS=
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
7. Run the build script to generate the static files in the `dist` folder:
|
|
214
|
+
|
|
215
|
+
**npm**:
|
|
216
|
+
|
|
217
|
+
```bash
|
|
218
|
+
npm run build
|
|
219
|
+
```
|
|
220
|
+
|
|
221
|
+
**pnpm**:
|
|
222
|
+
|
|
223
|
+
```bash
|
|
224
|
+
pnpm run build
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
**Yarn**:
|
|
228
|
+
|
|
229
|
+
```bash
|
|
230
|
+
yarn build
|
|
231
|
+
```
|
|
232
|
+
|
|
233
|
+
**Bun**:
|
|
234
|
+
|
|
235
|
+
```bash
|
|
236
|
+
bun run build
|
|
237
|
+
```
|
|
238
|
+
|
|
239
|
+
8. Point your hosting provider to the `dist` folder and deploy!
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# Deploy with a Web Framework
|
|
2
|
+
|
|
3
|
+
When Mastra is integrated with a web framework, it deploys alongside your application using the framework's standard deployment process. Follow the instructions below to ensure your Mastra integration deploys correctly.
|
|
4
|
+
|
|
5
|
+
> **Warning:** If you're deploying to a cloud provider, remove any usage of [LibSQLStore](https://mastra.ai/reference/storage/libsql) from your Mastra configuration. LibSQLStore requires filesystem access and is not compatible with serverless platforms.
|
|
6
|
+
|
|
7
|
+
Integration guides:
|
|
8
|
+
|
|
9
|
+
- [With Next.js](https://mastra.ai/guides/getting-started/next-js)
|
|
10
|
+
- [With Astro](https://mastra.ai/guides/getting-started/astro)
|
|
11
|
+
|
|
12
|
+
## With Next.js on Vercel
|
|
13
|
+
|
|
14
|
+
If you've integrated Mastra with Next.js [by following our guide](https://mastra.ai/guides/getting-started/next-js) and plan to deploy to Vercel, add `serverExternalPackages: ["@mastra/*"]` to your `next.config.ts`:
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import type { NextConfig } from 'next'
|
|
18
|
+
|
|
19
|
+
const nextConfig: NextConfig = {
|
|
20
|
+
serverExternalPackages: ['@mastra/*'],
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
export default nextConfig
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## With Astro on Vercel
|
|
27
|
+
|
|
28
|
+
If you've integrated Mastra with Astro [by following our guide](https://mastra.ai/guides/getting-started/astro) and plan to deploy to Vercel, add the Vercel adapter and server output to your `astro.config.mjs`:
|
|
29
|
+
|
|
30
|
+
```javascript
|
|
31
|
+
import { defineConfig } from 'astro/config'
|
|
32
|
+
import vercel from '@astrojs/vercel'
|
|
33
|
+
|
|
34
|
+
export default defineConfig({
|
|
35
|
+
adapter: vercel(),
|
|
36
|
+
output: 'server',
|
|
37
|
+
})
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## With Astro on Netlify
|
|
41
|
+
|
|
42
|
+
If you've integrated Mastra with Astro [by following our guide](https://mastra.ai/guides/getting-started/astro) and plan to deploy to Netlify, add the Netlify adapter and server output to your `astro.config.mjs`:
|
|
43
|
+
|
|
44
|
+
```javascript
|
|
45
|
+
import { defineConfig } from 'astro/config'
|
|
46
|
+
import netlify from '@astrojs/netlify'
|
|
47
|
+
|
|
48
|
+
export default defineConfig({
|
|
49
|
+
adapter: netlify(),
|
|
50
|
+
output: 'server',
|
|
51
|
+
})
|
|
52
|
+
```
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# Workflow Runners
|
|
2
|
+
|
|
3
|
+
Mastra [workflows](https://mastra.ai/docs/workflows/overview) can be executed using the built-in workflow runner or deployed to specialized workflow execution platforms that handle orchestration, monitoring, and reliability.
|
|
4
|
+
|
|
5
|
+
## Inngest
|
|
6
|
+
|
|
7
|
+
Inngest is a developer platform for running background workflows without managing infrastructure. Mastra workflows can be deployed to Inngest, which provides step memoization, automatic retries, real-time monitoring, and suspend/resume capabilities.
|
|
8
|
+
|
|
9
|
+
Visit the [Inngest deployment guide](https://mastra.ai/guides/deployment/inngest) for setup instructions and the [Inngest workflow example](https://github.com/mastra-ai/mastra/tree/main/examples/inngest) for a complete implementation.
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# Built-in Scorers
|
|
2
|
+
|
|
3
|
+
Mastra provides a comprehensive set of built-in scorers for evaluating AI outputs. These scorers are optimized for common evaluation scenarios and are ready to use in your agents and workflows.
|
|
4
|
+
|
|
5
|
+
To create your own scorers, see the [Custom Scorers](https://mastra.ai/docs/evals/custom-scorers) guide.
|
|
6
|
+
|
|
7
|
+
## Available scorers
|
|
8
|
+
|
|
9
|
+
### Accuracy and reliability
|
|
10
|
+
|
|
11
|
+
These scorers evaluate how correct, truthful, and complete your agent's answers are:
|
|
12
|
+
|
|
13
|
+
- [`answer-relevancy`](https://mastra.ai/reference/evals/answer-relevancy): Evaluates how well responses address the input query (`0-1`, higher is better)
|
|
14
|
+
- [`answer-similarity`](https://mastra.ai/reference/evals/answer-similarity): Compares agent outputs against ground-truth answers for CI/CD testing using semantic analysis (`0-1`, higher is better)
|
|
15
|
+
- [`faithfulness`](https://mastra.ai/reference/evals/faithfulness): Measures how accurately responses represent provided context (`0-1`, higher is better)
|
|
16
|
+
- [`hallucination`](https://mastra.ai/reference/evals/hallucination): Detects factual contradictions and unsupported claims (`0-1`, lower is better)
|
|
17
|
+
- [`completeness`](https://mastra.ai/reference/evals/completeness): Checks if responses include all necessary information (`0-1`, higher is better)
|
|
18
|
+
- [`content-similarity`](https://mastra.ai/reference/evals/content-similarity): Measures textual similarity using character-level matching (`0-1`, higher is better)
|
|
19
|
+
- [`textual-difference`](https://mastra.ai/reference/evals/textual-difference): Measures textual differences between strings (`0-1`, higher means more similar)
|
|
20
|
+
- [`tool-call-accuracy`](https://mastra.ai/reference/evals/tool-call-accuracy): Evaluates whether the LLM selects the correct tool from available options (`0-1`, higher is better)
|
|
21
|
+
- [`prompt-alignment`](https://mastra.ai/reference/evals/prompt-alignment): Measures how well agent responses align with user prompt intent, requirements, completeness, and format (`0-1`, higher is better)
|
|
22
|
+
|
|
23
|
+
### Context quality
|
|
24
|
+
|
|
25
|
+
These scorers evaluate the quality and relevance of context used in generating responses:
|
|
26
|
+
|
|
27
|
+
- [`context-precision`](https://mastra.ai/reference/evals/context-precision): Evaluates context relevance and ranking using Mean Average Precision, rewarding early placement of relevant context (`0-1`, higher is better)
|
|
28
|
+
- [`context-relevance`](https://mastra.ai/reference/evals/context-relevance): Measures context utility with nuanced relevance levels, usage tracking, and missing context detection (`0-1`, higher is better)
|
|
29
|
+
|
|
30
|
+
> tip Context Scorer Selection
|
|
31
|
+
>
|
|
32
|
+
> - Use **Context Precision** when context ordering matters and you need standard IR metrics (ideal for RAG ranking evaluation)
|
|
33
|
+
> - Use **Context Relevance** when you need detailed relevance assessment and want to track context usage and identify gaps
|
|
34
|
+
>
|
|
35
|
+
> Both context scorers support:
|
|
36
|
+
>
|
|
37
|
+
> - **Static context**: Pre-defined context arrays
|
|
38
|
+
> - **Dynamic context extraction**: Extract context from runs using custom functions (ideal for RAG systems, vector databases, etc.)
|
|
39
|
+
|
|
40
|
+
### Output quality
|
|
41
|
+
|
|
42
|
+
These scorers evaluate adherence to format, style, and safety requirements:
|
|
43
|
+
|
|
44
|
+
- [`tone-consistency`](https://mastra.ai/reference/evals/tone-consistency): Measures consistency in formality, complexity, and style (`0-1`, higher is better)
|
|
45
|
+
- [`toxicity`](https://mastra.ai/reference/evals/toxicity): Detects harmful or inappropriate content (`0-1`, lower is better)
|
|
46
|
+
- [`bias`](https://mastra.ai/reference/evals/bias): Detects potential biases in the output (`0-1`, lower is better)
|
|
47
|
+
- [`keyword-coverage`](https://mastra.ai/reference/evals/keyword-coverage): Assesses technical terminology usage (`0-1`, higher is better)
|