@mastra/mcp-docs-server 0.13.39-alpha.0 → 1.0.0-beta.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.docs/organized/changelogs/%40internal%2Fai-sdk-v4.md +1 -0
- package/.docs/organized/changelogs/%40internal%2Fchangeset-cli.md +0 -8
- package/.docs/organized/changelogs/%40internal%2Fexternal-types.md +0 -8
- package/.docs/organized/changelogs/%40internal%2Fstorage-test-utils.md +29 -29
- package/.docs/organized/changelogs/%40internal%2Ftypes-builder.md +0 -8
- package/.docs/organized/changelogs/%40mastra%2Fagent-builder.md +70 -70
- package/.docs/organized/changelogs/%40mastra%2Fai-sdk.md +25 -25
- package/.docs/organized/changelogs/%40mastra%2Fastra.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fauth.md +4 -8
- package/.docs/organized/changelogs/%40mastra%2Fchroma.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fclickhouse.md +199 -199
- package/.docs/organized/changelogs/%40mastra%2Fclient-js.md +223 -223
- package/.docs/organized/changelogs/%40mastra%2Fcloudflare-d1.md +189 -189
- package/.docs/organized/changelogs/%40mastra%2Fcloudflare.md +198 -198
- package/.docs/organized/changelogs/%40mastra%2Fcodemod.md +7 -0
- package/.docs/organized/changelogs/%40mastra%2Fcore.md +214 -214
- package/.docs/organized/changelogs/%40mastra%2Fcouchbase.md +16 -16
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloud.md +63 -63
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloudflare.md +57 -57
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-netlify.md +60 -60
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-vercel.md +57 -57
- package/.docs/organized/changelogs/%40mastra%2Fdeployer.md +209 -209
- package/.docs/organized/changelogs/%40mastra%2Fdynamodb.md +191 -191
- package/.docs/organized/changelogs/%40mastra%2Fevals.md +38 -38
- package/.docs/organized/changelogs/%40mastra%2Ffastembed.md +5 -7
- package/.docs/organized/changelogs/%40mastra%2Flance.md +186 -186
- package/.docs/organized/changelogs/%40mastra%2Flibsql.md +199 -199
- package/.docs/organized/changelogs/%40mastra%2Floggers.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fmcp-docs-server.md +53 -53
- package/.docs/organized/changelogs/%40mastra%2Fmcp-registry-registry.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fmcp.md +69 -69
- package/.docs/organized/changelogs/%40mastra%2Fmemory.md +221 -221
- package/.docs/organized/changelogs/%40mastra%2Fmongodb.md +199 -199
- package/.docs/organized/changelogs/%40mastra%2Fmssql.md +206 -206
- package/.docs/organized/changelogs/%40mastra%2Fopensearch.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fpg.md +197 -197
- package/.docs/organized/changelogs/%40mastra%2Fpinecone.md +16 -16
- package/.docs/organized/changelogs/%40mastra%2Fplayground-ui.md +218 -218
- package/.docs/organized/changelogs/%40mastra%2Fqdrant.md +16 -16
- package/.docs/organized/changelogs/%40mastra%2Frag.md +65 -65
- package/.docs/organized/changelogs/%40mastra%2Freact.md +61 -61
- package/.docs/organized/changelogs/%40mastra%2Fs3vectors.md +10 -9
- package/.docs/organized/changelogs/%40mastra%2Fschema-compat.md +6 -24
- package/.docs/organized/changelogs/%40mastra%2Fserver.md +206 -206
- package/.docs/organized/changelogs/%40mastra%2Fturbopuffer.md +16 -16
- package/.docs/organized/changelogs/%40mastra%2Fupstash.md +191 -191
- package/.docs/organized/changelogs/%40mastra%2Fvectorize.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fvoice-azure.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fvoice-cloudflare.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fvoice-deepgram.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fvoice-elevenlabs.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fvoice-gladia.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fvoice-google-gemini-live.md +58 -58
- package/.docs/organized/changelogs/%40mastra%2Fvoice-google.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fvoice-murf.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fvoice-openai-realtime.md +56 -56
- package/.docs/organized/changelogs/%40mastra%2Fvoice-openai.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fvoice-playai.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fvoice-sarvam.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fvoice-speechify.md +11 -11
- package/.docs/organized/changelogs/create-mastra.md +27 -27
- package/.docs/organized/changelogs/mastra.md +87 -87
- package/.docs/organized/code-examples/a2a.md +4 -2
- package/.docs/organized/code-examples/agui.md +12 -9
- package/.docs/organized/code-examples/ai-sdk-useChat.md +12 -18
- package/.docs/organized/code-examples/ai-sdk-v5.md +4 -2
- package/.docs/organized/code-examples/bird-checker-with-express.md +5 -4
- package/.docs/organized/code-examples/bird-checker-with-nextjs-and-eval.md +4 -3
- package/.docs/organized/code-examples/bird-checker-with-nextjs.md +4 -3
- package/.docs/organized/code-examples/client-side-tools.md +1 -0
- package/.docs/organized/code-examples/crypto-chatbot.md +1 -1
- package/.docs/organized/code-examples/experimental-auth-weather-agent.md +8 -177
- package/.docs/organized/code-examples/fireworks-r1.md +2 -2
- package/.docs/organized/code-examples/heads-up-game.md +10 -7
- package/.docs/organized/code-examples/mcp-configuration.md +5 -3
- package/.docs/organized/code-examples/mcp-registry-registry.md +3 -2
- package/.docs/organized/code-examples/memory-per-resource-example.md +4 -2
- package/.docs/organized/code-examples/memory-todo-agent.md +1 -0
- package/.docs/organized/code-examples/memory-with-context.md +2 -1
- package/.docs/organized/code-examples/memory-with-libsql.md +4 -2
- package/.docs/organized/code-examples/memory-with-mongodb.md +4 -2
- package/.docs/organized/code-examples/memory-with-pg.md +4 -2
- package/.docs/organized/code-examples/memory-with-processors.md +13 -8
- package/.docs/organized/code-examples/memory-with-upstash.md +5 -3
- package/.docs/organized/code-examples/openapi-spec-writer.md +32 -41
- package/.docs/organized/code-examples/quick-start.md +5 -32
- package/.docs/organized/code-examples/stock-price-tool.md +6 -5
- package/.docs/organized/code-examples/weather-agent.md +21 -16
- package/.docs/organized/code-examples/workflow-ai-recruiter.md +3 -2
- package/.docs/organized/code-examples/workflow-with-inline-steps.md +9 -12
- package/.docs/organized/code-examples/workflow-with-memory.md +16 -15
- package/.docs/organized/code-examples/workflow-with-separate-steps.md +2 -2
- package/.docs/organized/code-examples/workflow-with-suspend-resume.md +3 -2
- package/.docs/raw/agents/adding-voice.mdx +27 -22
- package/.docs/raw/agents/agent-memory.mdx +23 -15
- package/.docs/raw/agents/guardrails.mdx +33 -12
- package/.docs/raw/agents/networks.mdx +8 -4
- package/.docs/raw/agents/overview.mdx +21 -15
- package/.docs/raw/agents/using-tools.mdx +11 -8
- package/.docs/raw/auth/auth0.mdx +8 -8
- package/.docs/raw/auth/clerk.mdx +6 -6
- package/.docs/raw/auth/firebase.mdx +8 -8
- package/.docs/raw/auth/index.mdx +6 -6
- package/.docs/raw/auth/jwt.mdx +6 -6
- package/.docs/raw/auth/supabase.mdx +7 -7
- package/.docs/raw/auth/workos.mdx +8 -8
- package/.docs/raw/community/contributing-templates.mdx +3 -3
- package/.docs/raw/community/discord.mdx +1 -1
- package/.docs/raw/course/01-first-agent/08-exporting-your-agent.md +2 -1
- package/.docs/raw/course/01-first-agent/16-adding-memory-to-agent.md +2 -1
- package/.docs/raw/course/02-agent-tools-mcp/31-enhancing-memory-configuration.md +2 -0
- package/.docs/raw/course/03-agent-memory/04-creating-basic-memory-agent.md +1 -0
- package/.docs/raw/course/03-agent-memory/10-storage-configuration.md +2 -3
- package/.docs/raw/course/03-agent-memory/13-vector-store-configuration.md +2 -0
- package/.docs/raw/course/03-agent-memory/16-configuring-semantic-recall.md +2 -0
- package/.docs/raw/course/03-agent-memory/18-advanced-configuration-semantic-recall.md +1 -0
- package/.docs/raw/course/03-agent-memory/21-configuring-working-memory.md +2 -0
- package/.docs/raw/course/03-agent-memory/22-custom-working-memory-templates.md +1 -0
- package/.docs/raw/course/03-agent-memory/25-combining-memory-features.md +1 -0
- package/.docs/raw/course/03-agent-memory/27-creating-learning-assistant.md +1 -0
- package/.docs/raw/course/04-workflows/08-running-workflows-programmatically.md +2 -2
- package/.docs/raw/deployment/cloud-providers/amazon-ec2.mdx +5 -5
- package/.docs/raw/deployment/cloud-providers/aws-lambda.mdx +7 -5
- package/.docs/raw/deployment/cloud-providers/azure-app-services.mdx +3 -3
- package/.docs/raw/deployment/cloud-providers/digital-ocean.mdx +4 -4
- package/.docs/raw/deployment/cloud-providers/index.mdx +11 -8
- package/.docs/raw/deployment/monorepo.mdx +2 -2
- package/.docs/raw/deployment/overview.mdx +2 -2
- package/.docs/raw/deployment/server-deployment.mdx +2 -10
- package/.docs/raw/deployment/serverless-platforms/cloudflare-deployer.mdx +4 -4
- package/.docs/raw/deployment/serverless-platforms/index.mdx +10 -7
- package/.docs/raw/deployment/serverless-platforms/netlify-deployer.mdx +4 -4
- package/.docs/raw/deployment/serverless-platforms/vercel-deployer.mdx +4 -4
- package/.docs/raw/deployment/web-framework.mdx +8 -8
- package/.docs/raw/{scorers → evals}/custom-scorers.mdx +6 -6
- package/.docs/raw/evals/off-the-shelf-scorers.mdx +50 -0
- package/.docs/raw/{scorers → evals}/overview.mdx +8 -8
- package/.docs/raw/evals/running-in-ci.mdx +113 -0
- package/.docs/raw/frameworks/agentic-uis/ai-sdk.mdx +22 -21
- package/.docs/raw/frameworks/agentic-uis/copilotkit.mdx +8 -8
- package/.docs/raw/frameworks/agentic-uis/openrouter.mdx +3 -0
- package/.docs/raw/frameworks/servers/express.mdx +10 -9
- package/.docs/raw/frameworks/web-frameworks/astro.mdx +6 -6
- package/.docs/raw/frameworks/web-frameworks/next-js.mdx +3 -3
- package/.docs/raw/frameworks/web-frameworks/sveltekit.mdx +4 -4
- package/.docs/raw/frameworks/web-frameworks/vite-react.mdx +2 -2
- package/.docs/raw/getting-started/installation.mdx +13 -12
- package/.docs/raw/getting-started/mcp-docs-server.mdx +1 -1
- package/.docs/raw/getting-started/project-structure.mdx +4 -4
- package/.docs/raw/getting-started/studio.mdx +8 -8
- package/.docs/raw/getting-started/templates.mdx +1 -1
- package/.docs/raw/guides/guide/ai-recruiter.mdx +264 -0
- package/.docs/raw/guides/guide/chef-michel.mdx +271 -0
- package/.docs/raw/guides/guide/notes-mcp-server.mdx +450 -0
- package/.docs/raw/guides/guide/research-assistant.mdx +389 -0
- package/.docs/raw/guides/guide/stock-agent.mdx +185 -0
- package/.docs/raw/guides/guide/web-search.mdx +291 -0
- package/.docs/raw/guides/index.mdx +43 -0
- package/.docs/raw/guides/migrations/agentnetwork.mdx +114 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/_template.mdx +50 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/agent.mdx +265 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/cli.mdx +48 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/client.mdx +153 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/evals.mdx +230 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/mastra.mdx +171 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/mcp.mdx +114 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/memory.mdx +241 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/overview.mdx +83 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/processors.mdx +62 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/storage.mdx +270 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/tools.mdx +115 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/tracing.mdx +280 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/vectors.mdx +23 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/voice.mdx +39 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/workflows.mdx +178 -0
- package/.docs/raw/guides/migrations/vnext-to-standard-apis.mdx +367 -0
- package/.docs/raw/index.mdx +9 -9
- package/.docs/raw/{observability/logging.mdx → logging.mdx} +4 -4
- package/.docs/raw/mastra-cloud/dashboard.mdx +2 -2
- package/.docs/raw/mastra-cloud/observability.mdx +6 -6
- package/.docs/raw/mastra-cloud/overview.mdx +2 -2
- package/.docs/raw/mastra-cloud/setting-up.mdx +4 -4
- package/.docs/raw/memory/conversation-history.mdx +1 -0
- package/.docs/raw/memory/memory-processors.mdx +4 -3
- package/.docs/raw/memory/overview.mdx +9 -5
- package/.docs/raw/memory/semantic-recall.mdx +12 -7
- package/.docs/raw/memory/storage/memory-with-libsql.mdx +10 -5
- package/.docs/raw/memory/storage/memory-with-pg.mdx +9 -4
- package/.docs/raw/memory/storage/memory-with-upstash.mdx +9 -4
- package/.docs/raw/memory/threads-and-resources.mdx +11 -13
- package/.docs/raw/memory/working-memory.mdx +30 -14
- package/.docs/raw/observability/overview.mdx +13 -30
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/arize.mdx +10 -18
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/braintrust.mdx +7 -16
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/cloud.mdx +11 -17
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/default.mdx +16 -20
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/langfuse.mdx +7 -16
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/langsmith.mdx +7 -16
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/otel.mdx +9 -18
- package/.docs/raw/observability/{ai-tracing → tracing}/overview.mdx +107 -142
- package/.docs/raw/observability/{ai-tracing → tracing}/processors/sensitive-data-filter.mdx +14 -13
- package/.docs/raw/rag/chunking-and-embedding.mdx +5 -5
- package/.docs/raw/rag/overview.mdx +3 -13
- package/.docs/raw/rag/retrieval.mdx +24 -12
- package/.docs/raw/rag/vector-databases.mdx +7 -1
- package/.docs/raw/reference/agents/agent.mdx +33 -28
- package/.docs/raw/reference/agents/generate.mdx +10 -10
- package/.docs/raw/reference/agents/generateLegacy.mdx +8 -8
- package/.docs/raw/reference/agents/getDefaultGenerateOptions.mdx +21 -15
- package/.docs/raw/reference/agents/getDefaultOptions.mdx +69 -0
- package/.docs/raw/reference/agents/getDefaultStreamOptions.mdx +22 -16
- package/.docs/raw/reference/agents/getDescription.mdx +1 -1
- package/.docs/raw/reference/agents/getInstructions.mdx +8 -8
- package/.docs/raw/reference/agents/getLLM.mdx +9 -9
- package/.docs/raw/reference/agents/getMemory.mdx +9 -9
- package/.docs/raw/reference/agents/getModel.mdx +10 -10
- package/.docs/raw/reference/agents/getVoice.mdx +8 -8
- package/.docs/raw/reference/agents/listAgents.mdx +9 -9
- package/.docs/raw/reference/agents/listScorers.mdx +7 -7
- package/.docs/raw/reference/agents/listTools.mdx +7 -7
- package/.docs/raw/reference/agents/listWorkflows.mdx +7 -7
- package/.docs/raw/reference/agents/network.mdx +11 -10
- package/.docs/raw/reference/auth/auth0.mdx +4 -4
- package/.docs/raw/reference/auth/clerk.mdx +4 -4
- package/.docs/raw/reference/auth/firebase.mdx +6 -6
- package/.docs/raw/reference/auth/jwt.mdx +4 -4
- package/.docs/raw/reference/auth/supabase.mdx +4 -4
- package/.docs/raw/reference/auth/workos.mdx +4 -4
- package/.docs/raw/reference/cli/mastra.mdx +7 -7
- package/.docs/raw/reference/client-js/agents.mdx +6 -2
- package/.docs/raw/reference/client-js/mastra-client.mdx +7 -7
- package/.docs/raw/reference/client-js/memory.mdx +24 -16
- package/.docs/raw/reference/client-js/observability.mdx +11 -11
- package/.docs/raw/reference/client-js/workflows.mdx +6 -34
- package/.docs/raw/reference/core/getAgent.mdx +1 -1
- package/.docs/raw/reference/core/getAgentById.mdx +1 -1
- package/.docs/raw/reference/core/getDeployer.mdx +2 -2
- package/.docs/raw/reference/core/getLogger.mdx +2 -2
- package/.docs/raw/reference/core/getMCPServer.mdx +31 -15
- package/.docs/raw/reference/core/getMCPServerById.mdx +81 -0
- package/.docs/raw/reference/core/getScorer.mdx +3 -3
- package/.docs/raw/reference/core/getScorerById.mdx +79 -0
- package/.docs/raw/reference/core/getServer.mdx +2 -2
- package/.docs/raw/reference/core/getStorage.mdx +2 -2
- package/.docs/raw/reference/core/getTelemetry.mdx +2 -2
- package/.docs/raw/reference/core/getVector.mdx +2 -2
- package/.docs/raw/reference/core/getWorkflow.mdx +1 -1
- package/.docs/raw/reference/core/listAgents.mdx +1 -1
- package/.docs/raw/reference/core/listLogs.mdx +2 -2
- package/.docs/raw/reference/core/listLogsByRunId.mdx +2 -2
- package/.docs/raw/reference/core/listMCPServers.mdx +65 -0
- package/.docs/raw/reference/core/listScorers.mdx +3 -3
- package/.docs/raw/reference/core/listVectors.mdx +36 -0
- package/.docs/raw/reference/core/listWorkflows.mdx +6 -6
- package/.docs/raw/reference/core/mastra-class.mdx +3 -2
- package/.docs/raw/reference/core/setLogger.mdx +2 -2
- package/.docs/raw/reference/core/setStorage.mdx +3 -2
- package/.docs/raw/reference/core/setTelemetry.mdx +2 -2
- package/.docs/raw/reference/deployer/cloudflare.mdx +2 -2
- package/.docs/raw/reference/deployer/deployer.mdx +0 -6
- package/.docs/raw/reference/deployer/netlify.mdx +2 -2
- package/.docs/raw/reference/deployer/vercel.mdx +3 -3
- package/.docs/raw/reference/evals/answer-relevancy.mdx +164 -126
- package/.docs/raw/reference/{scorers → evals}/answer-similarity.mdx +27 -27
- package/.docs/raw/reference/evals/bias.mdx +149 -115
- package/.docs/raw/reference/evals/completeness.mdx +148 -117
- package/.docs/raw/reference/evals/content-similarity.mdx +126 -113
- package/.docs/raw/reference/evals/context-precision.mdx +290 -133
- package/.docs/raw/reference/{scorers → evals}/context-relevance.mdx +6 -6
- package/.docs/raw/reference/{scorers → evals}/create-scorer.mdx +11 -11
- package/.docs/raw/reference/evals/faithfulness.mdx +163 -121
- package/.docs/raw/reference/evals/hallucination.mdx +159 -132
- package/.docs/raw/reference/evals/keyword-coverage.mdx +169 -125
- package/.docs/raw/reference/{scorers → evals}/mastra-scorer.mdx +5 -5
- package/.docs/raw/reference/{scorers → evals}/noise-sensitivity.mdx +9 -9
- package/.docs/raw/reference/evals/prompt-alignment.mdx +604 -182
- package/.docs/raw/reference/{scorers/run-experiment.mdx → evals/run-evals.mdx} +17 -18
- package/.docs/raw/reference/evals/textual-difference.mdx +149 -117
- package/.docs/raw/reference/evals/tone-consistency.mdx +149 -125
- package/.docs/raw/reference/{scorers → evals}/tool-call-accuracy.mdx +8 -6
- package/.docs/raw/reference/evals/toxicity.mdx +152 -96
- package/.docs/raw/reference/{observability/logging → logging}/pino-logger.mdx +2 -2
- package/.docs/raw/reference/memory/createThread.mdx +5 -5
- package/.docs/raw/reference/memory/deleteMessages.mdx +7 -7
- package/.docs/raw/reference/memory/getThreadById.mdx +4 -4
- package/.docs/raw/reference/memory/listThreadsByResourceId.mdx +110 -0
- package/.docs/raw/reference/memory/memory-class.mdx +13 -9
- package/.docs/raw/reference/memory/query.mdx +58 -57
- package/.docs/raw/reference/memory/recall.mdx +185 -0
- package/.docs/raw/reference/observability/tracing/configuration.mdx +245 -0
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/arize.mdx +13 -13
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/braintrust.mdx +11 -8
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/cloud-exporter.mdx +21 -19
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/console-exporter.mdx +49 -17
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/default-exporter.mdx +42 -41
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/langfuse.mdx +10 -7
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/langsmith.mdx +10 -7
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/otel.mdx +5 -5
- package/.docs/raw/reference/observability/tracing/instances.mdx +168 -0
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/interfaces.mdx +115 -89
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/processors/sensitive-data-filter.mdx +3 -3
- package/.docs/raw/reference/observability/{ai-tracing/span.mdx → tracing/spans.mdx} +59 -41
- package/.docs/raw/reference/processors/batch-parts-processor.mdx +1 -1
- package/.docs/raw/reference/processors/language-detector.mdx +1 -1
- package/.docs/raw/reference/processors/moderation-processor.mdx +1 -1
- package/.docs/raw/reference/processors/pii-detector.mdx +1 -1
- package/.docs/raw/reference/processors/prompt-injection-detector.mdx +1 -1
- package/.docs/raw/reference/processors/system-prompt-scrubber.mdx +1 -1
- package/.docs/raw/reference/processors/token-limiter-processor.mdx +1 -1
- package/.docs/raw/reference/processors/unicode-normalizer.mdx +1 -1
- package/.docs/raw/reference/rag/chunk.mdx +1 -8
- package/.docs/raw/reference/rag/database-config.mdx +7 -7
- package/.docs/raw/reference/rag/metadata-filters.mdx +14 -11
- package/.docs/raw/reference/storage/libsql.mdx +2 -0
- package/.docs/raw/reference/storage/mssql.mdx +5 -0
- package/.docs/raw/reference/storage/postgresql.mdx +6 -0
- package/.docs/raw/reference/storage/upstash.mdx +1 -0
- package/.docs/raw/reference/streaming/agents/stream.mdx +12 -12
- package/.docs/raw/reference/streaming/agents/streamLegacy.mdx +8 -8
- package/.docs/raw/reference/streaming/workflows/observeStream.mdx +3 -3
- package/.docs/raw/reference/streaming/workflows/observeStreamVNext.mdx +3 -3
- package/.docs/raw/reference/streaming/workflows/resumeStreamVNext.mdx +6 -6
- package/.docs/raw/reference/streaming/workflows/stream.mdx +10 -10
- package/.docs/raw/reference/streaming/workflows/streamVNext.mdx +11 -11
- package/.docs/raw/reference/templates/overview.mdx +2 -2
- package/.docs/raw/reference/tools/create-tool.mdx +52 -35
- package/.docs/raw/reference/tools/graph-rag-tool.mdx +15 -15
- package/.docs/raw/reference/tools/mcp-client.mdx +1 -1
- package/.docs/raw/reference/tools/mcp-server.mdx +119 -35
- package/.docs/raw/reference/tools/vector-query-tool.mdx +27 -26
- package/.docs/raw/reference/vectors/libsql.mdx +1 -0
- package/.docs/raw/reference/vectors/pg.mdx +3 -0
- package/.docs/raw/reference/vectors/upstash.mdx +1 -0
- package/.docs/raw/reference/voice/google-gemini-live.mdx +1 -1
- package/.docs/raw/reference/voice/voice.addTools.mdx +3 -3
- package/.docs/raw/reference/workflows/run-methods/cancel.mdx +4 -4
- package/.docs/raw/reference/workflows/run-methods/resume.mdx +14 -14
- package/.docs/raw/reference/workflows/run-methods/start.mdx +17 -17
- package/.docs/raw/reference/workflows/run.mdx +1 -8
- package/.docs/raw/reference/workflows/step.mdx +5 -5
- package/.docs/raw/reference/workflows/workflow-methods/branch.mdx +2 -2
- package/.docs/raw/reference/workflows/workflow-methods/commit.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/create-run.mdx +7 -13
- package/.docs/raw/reference/workflows/workflow-methods/dountil.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/dowhile.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/foreach.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/map.mdx +5 -0
- package/.docs/raw/reference/workflows/workflow-methods/parallel.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/sendEvent.mdx +2 -2
- package/.docs/raw/reference/workflows/workflow-methods/sleep.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/sleepUntil.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/then.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/waitForEvent.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow.mdx +1 -1
- package/.docs/raw/server-db/custom-api-routes.mdx +2 -2
- package/.docs/raw/server-db/mastra-client.mdx +19 -18
- package/.docs/raw/server-db/middleware.mdx +7 -7
- package/.docs/raw/server-db/production-server.mdx +4 -4
- package/.docs/raw/server-db/{runtime-context.mdx → request-context.mdx} +46 -45
- package/.docs/raw/server-db/storage.mdx +29 -21
- package/.docs/raw/streaming/events.mdx +3 -3
- package/.docs/raw/streaming/overview.mdx +5 -5
- package/.docs/raw/streaming/tool-streaming.mdx +18 -17
- package/.docs/raw/streaming/workflow-streaming.mdx +1 -1
- package/.docs/raw/tools-mcp/advanced-usage.mdx +5 -4
- package/.docs/raw/tools-mcp/mcp-overview.mdx +32 -19
- package/.docs/raw/tools-mcp/overview.mdx +11 -11
- package/.docs/raw/voice/overview.mdx +63 -43
- package/.docs/raw/voice/speech-to-speech.mdx +5 -3
- package/.docs/raw/voice/speech-to-text.mdx +9 -8
- package/.docs/raw/voice/text-to-speech.mdx +12 -11
- package/.docs/raw/workflows/agents-and-tools.mdx +9 -5
- package/.docs/raw/workflows/control-flow.mdx +3 -3
- package/.docs/raw/workflows/error-handling.mdx +2 -21
- package/.docs/raw/workflows/human-in-the-loop.mdx +7 -4
- package/.docs/raw/workflows/inngest-workflow.mdx +2 -2
- package/.docs/raw/workflows/input-data-mapping.mdx +107 -0
- package/.docs/raw/workflows/overview.mdx +17 -16
- package/.docs/raw/workflows/snapshots.mdx +13 -11
- package/.docs/raw/workflows/suspend-and-resume.mdx +23 -15
- package/CHANGELOG.md +52 -47
- package/README.md +11 -2
- package/dist/{chunk-TUAHUTTB.js → chunk-5NJC7NRO.js} +3 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/prepare-docs/copy-raw.d.ts.map +1 -1
- package/dist/prepare-docs/prepare.js +1 -1
- package/dist/prompts/migration.d.ts +6 -0
- package/dist/prompts/migration.d.ts.map +1 -0
- package/dist/stdio.js +402 -30
- package/dist/tools/migration.d.ts +40 -0
- package/dist/tools/migration.d.ts.map +1 -0
- package/package.json +8 -12
- package/.docs/organized/changelogs/%40mastra%2Fcloud.md +0 -302
- package/.docs/raw/observability/nextjs-tracing.mdx +0 -109
- package/.docs/raw/observability/otel-tracing.mdx +0 -189
- package/.docs/raw/reference/agents/getScorers.mdx +0 -69
- package/.docs/raw/reference/agents/getTools.mdx +0 -69
- package/.docs/raw/reference/agents/getWorkflows.mdx +0 -69
- package/.docs/raw/reference/client-js/workflows-legacy.mdx +0 -143
- package/.docs/raw/reference/core/getAgents.mdx +0 -35
- package/.docs/raw/reference/core/getLogs.mdx +0 -96
- package/.docs/raw/reference/core/getLogsByRunId.mdx +0 -87
- package/.docs/raw/reference/core/getMCPServers.mdx +0 -36
- package/.docs/raw/reference/core/getMemory.mdx +0 -36
- package/.docs/raw/reference/core/getScorerByName.mdx +0 -78
- package/.docs/raw/reference/core/getScorers.mdx +0 -43
- package/.docs/raw/reference/core/getVectors.mdx +0 -36
- package/.docs/raw/reference/core/getWorkflows.mdx +0 -45
- package/.docs/raw/reference/evals/context-position.mdx +0 -197
- package/.docs/raw/reference/evals/context-relevancy.mdx +0 -196
- package/.docs/raw/reference/evals/contextual-recall.mdx +0 -196
- package/.docs/raw/reference/evals/summarization.mdx +0 -212
- package/.docs/raw/reference/legacyWorkflows/after.mdx +0 -89
- package/.docs/raw/reference/legacyWorkflows/afterEvent.mdx +0 -79
- package/.docs/raw/reference/legacyWorkflows/commit.mdx +0 -33
- package/.docs/raw/reference/legacyWorkflows/createRun.mdx +0 -76
- package/.docs/raw/reference/legacyWorkflows/else.mdx +0 -68
- package/.docs/raw/reference/legacyWorkflows/events.mdx +0 -305
- package/.docs/raw/reference/legacyWorkflows/execute.mdx +0 -110
- package/.docs/raw/reference/legacyWorkflows/if.mdx +0 -108
- package/.docs/raw/reference/legacyWorkflows/resume.mdx +0 -158
- package/.docs/raw/reference/legacyWorkflows/resumeWithEvent.mdx +0 -133
- package/.docs/raw/reference/legacyWorkflows/snapshots.mdx +0 -207
- package/.docs/raw/reference/legacyWorkflows/start.mdx +0 -87
- package/.docs/raw/reference/legacyWorkflows/step-class.mdx +0 -100
- package/.docs/raw/reference/legacyWorkflows/step-condition.mdx +0 -137
- package/.docs/raw/reference/legacyWorkflows/step-function.mdx +0 -93
- package/.docs/raw/reference/legacyWorkflows/step-options.mdx +0 -69
- package/.docs/raw/reference/legacyWorkflows/step-retries.mdx +0 -196
- package/.docs/raw/reference/legacyWorkflows/suspend.mdx +0 -70
- package/.docs/raw/reference/legacyWorkflows/then.mdx +0 -72
- package/.docs/raw/reference/legacyWorkflows/until.mdx +0 -168
- package/.docs/raw/reference/legacyWorkflows/watch.mdx +0 -124
- package/.docs/raw/reference/legacyWorkflows/while.mdx +0 -168
- package/.docs/raw/reference/legacyWorkflows/workflow.mdx +0 -234
- package/.docs/raw/reference/memory/getThreadsByResourceId.mdx +0 -79
- package/.docs/raw/reference/memory/getThreadsByResourceIdPaginated.mdx +0 -110
- package/.docs/raw/reference/observability/ai-tracing/ai-tracing.mdx +0 -185
- package/.docs/raw/reference/observability/ai-tracing/configuration.mdx +0 -238
- package/.docs/raw/reference/observability/otel-tracing/otel-config.mdx +0 -117
- package/.docs/raw/reference/observability/otel-tracing/providers/arize-ax.mdx +0 -81
- package/.docs/raw/reference/observability/otel-tracing/providers/arize-phoenix.mdx +0 -121
- package/.docs/raw/reference/observability/otel-tracing/providers/braintrust.mdx +0 -40
- package/.docs/raw/reference/observability/otel-tracing/providers/dash0.mdx +0 -40
- package/.docs/raw/reference/observability/otel-tracing/providers/index.mdx +0 -20
- package/.docs/raw/reference/observability/otel-tracing/providers/keywordsai.mdx +0 -73
- package/.docs/raw/reference/observability/otel-tracing/providers/laminar.mdx +0 -41
- package/.docs/raw/reference/observability/otel-tracing/providers/langfuse.mdx +0 -84
- package/.docs/raw/reference/observability/otel-tracing/providers/langsmith.mdx +0 -48
- package/.docs/raw/reference/observability/otel-tracing/providers/langwatch.mdx +0 -43
- package/.docs/raw/reference/observability/otel-tracing/providers/new-relic.mdx +0 -40
- package/.docs/raw/reference/observability/otel-tracing/providers/signoz.mdx +0 -40
- package/.docs/raw/reference/observability/otel-tracing/providers/traceloop.mdx +0 -40
- package/.docs/raw/reference/scorers/answer-relevancy.mdx +0 -227
- package/.docs/raw/reference/scorers/bias.mdx +0 -228
- package/.docs/raw/reference/scorers/completeness.mdx +0 -214
- package/.docs/raw/reference/scorers/content-similarity.mdx +0 -197
- package/.docs/raw/reference/scorers/context-precision.mdx +0 -352
- package/.docs/raw/reference/scorers/faithfulness.mdx +0 -241
- package/.docs/raw/reference/scorers/hallucination.mdx +0 -252
- package/.docs/raw/reference/scorers/keyword-coverage.mdx +0 -229
- package/.docs/raw/reference/scorers/prompt-alignment.mdx +0 -668
- package/.docs/raw/reference/scorers/textual-difference.mdx +0 -203
- package/.docs/raw/reference/scorers/tone-consistency.mdx +0 -211
- package/.docs/raw/reference/scorers/toxicity.mdx +0 -228
- package/.docs/raw/reference/workflows/run-methods/watch.mdx +0 -73
- package/.docs/raw/scorers/evals-old-api/custom-eval.mdx +0 -24
- package/.docs/raw/scorers/evals-old-api/overview.mdx +0 -106
- package/.docs/raw/scorers/evals-old-api/running-in-ci.mdx +0 -85
- package/.docs/raw/scorers/evals-old-api/textual-evals.mdx +0 -58
- package/.docs/raw/scorers/off-the-shelf-scorers.mdx +0 -50
- package/.docs/raw/workflows-legacy/control-flow.mdx +0 -774
- package/.docs/raw/workflows-legacy/dynamic-workflows.mdx +0 -239
- package/.docs/raw/workflows-legacy/error-handling.mdx +0 -187
- package/.docs/raw/workflows-legacy/nested-workflows.mdx +0 -360
- package/.docs/raw/workflows-legacy/overview.mdx +0 -182
- package/.docs/raw/workflows-legacy/runtime-variables.mdx +0 -156
- package/.docs/raw/workflows-legacy/steps.mdx +0 -115
- package/.docs/raw/workflows-legacy/suspend-and-resume.mdx +0 -406
- package/.docs/raw/workflows-legacy/variables.mdx +0 -318
|
@@ -15,7 +15,7 @@ This approach allows you to run your Mastra server as a containerized Lambda fun
|
|
|
15
15
|
This guide assumes your Mastra application has been created using the default
|
|
16
16
|
`npx create-mastra@latest` command.
|
|
17
17
|
For more information on how to create a new Mastra application,
|
|
18
|
-
refer to our [getting started guide](/docs/getting-started/installation)
|
|
18
|
+
refer to our [getting started guide](/docs/v1/getting-started/installation)
|
|
19
19
|
:::
|
|
20
20
|
|
|
21
21
|
## Prerequisites
|
|
@@ -44,6 +44,7 @@ Lambda functions have limitations with file system storage. Configure your Mastr
|
|
|
44
44
|
import { LibSQLStore } from "@mastra/libsql";
|
|
45
45
|
|
|
46
46
|
const storage = new LibSQLStore({
|
|
47
|
+
id: 'mastra-storage',
|
|
47
48
|
url: ":memory:", // in-memory storage
|
|
48
49
|
});
|
|
49
50
|
```
|
|
@@ -56,12 +57,13 @@ For persistent memory across Lambda invocations, use external storage providers
|
|
|
56
57
|
import { LibSQLStore } from "@mastra/libsql";
|
|
57
58
|
|
|
58
59
|
const storage = new LibSQLStore({
|
|
60
|
+
id: 'mastra-storage',
|
|
59
61
|
url: "libsql://your-database.turso.io", // External Turso database
|
|
60
62
|
authToken: process.env.TURSO_AUTH_TOKEN,
|
|
61
63
|
});
|
|
62
64
|
```
|
|
63
65
|
|
|
64
|
-
For more memory configuration options, see the [Memory documentation](/docs/memory/overview).
|
|
66
|
+
For more memory configuration options, see the [Memory documentation](/docs/v1/memory/overview).
|
|
65
67
|
|
|
66
68
|
## Creating a Dockerfile
|
|
67
69
|
|
|
@@ -90,7 +92,7 @@ ENV READINESS_CHECK_PATH="/api"
|
|
|
90
92
|
|
|
91
93
|
EXPOSE 8080
|
|
92
94
|
|
|
93
|
-
CMD ["node", "
|
|
95
|
+
CMD ["node", ".mastra/output/index.mjs"]
|
|
94
96
|
```
|
|
95
97
|
|
|
96
98
|
## Building and Deploying
|
|
@@ -214,7 +216,7 @@ Once deployed, test your Lambda function:
|
|
|
214
216
|
2. Visit the URL in your browser to see your Mastra's server home screen
|
|
215
217
|
3. Test your agents and workflows using the generated API endpoints
|
|
216
218
|
|
|
217
|
-
For more information about available API endpoints, see the [Server documentation](/docs/deployment/server-deployment).
|
|
219
|
+
For more information about available API endpoints, see the [Server documentation](/docs/v1/deployment/server-deployment).
|
|
218
220
|
|
|
219
221
|
## Connecting your client
|
|
220
222
|
|
|
@@ -287,6 +289,6 @@ For production deployments:
|
|
|
287
289
|
|
|
288
290
|
## Next steps
|
|
289
291
|
|
|
290
|
-
- [Mastra Client SDK](/reference/client-js/mastra-client)
|
|
292
|
+
- [Mastra Client SDK](/reference/v1/client-js/mastra-client)
|
|
291
293
|
- [AWS Lambda documentation](https://docs.aws.amazon.com/lambda/)
|
|
292
294
|
- [AWS Lambda Web Adapter](https://github.com/awslabs/aws-lambda-web-adapter)
|
|
@@ -14,7 +14,7 @@ Deploy your Mastra applications to Azure App Services.
|
|
|
14
14
|
This guide assumes your Mastra application has been created using the default
|
|
15
15
|
`npx create-mastra@latest` command.
|
|
16
16
|
For more information on how to create a new Mastra application,
|
|
17
|
-
refer to our [getting started guide](/docs/getting-started/installation)
|
|
17
|
+
refer to our [getting started guide](/docs/v1/getting-started/installation)
|
|
18
18
|
:::
|
|
19
19
|
|
|
20
20
|
## Prerequisites
|
|
@@ -141,7 +141,7 @@ Access your deployed application:
|
|
|
141
141
|
|
|
142
142
|
You can now connect to your Mastra server from your client application using a `MastraClient` from the `@mastra/client-js` package.
|
|
143
143
|
|
|
144
|
-
Refer to the [`MastraClient` documentation](/reference/client-js/mastra-client) for more information.
|
|
144
|
+
Refer to the [`MastraClient` documentation](/reference/v1/client-js/mastra-client) for more information.
|
|
145
145
|
|
|
146
146
|
```typescript copy showLineNumbers
|
|
147
147
|
import { MastraClient } from "@mastra/client-js";
|
|
@@ -159,7 +159,7 @@ such as `LibSQLStore` with a file URL. Consider using cloud-based storage soluti
|
|
|
159
159
|
|
|
160
160
|
## Next steps
|
|
161
161
|
|
|
162
|
-
- [Mastra Client SDK](/reference/client-js/mastra-client)
|
|
162
|
+
- [Mastra Client SDK](/reference/v1/client-js/mastra-client)
|
|
163
163
|
- [Configure custom domains](https://docs.microsoft.com/en-us/azure/app-service/app-service-web-tutorial-custom-domain)
|
|
164
164
|
- [Enable HTTPS](https://docs.microsoft.com/en-us/azure/app-service/configure-ssl-bindings)
|
|
165
165
|
- [Azure App Service documentation](https://docs.microsoft.com/en-us/azure/app-service/)
|
|
@@ -119,7 +119,7 @@ Deploy your Mastra application to Digital Ocean's Droplets.
|
|
|
119
119
|
- A domain name with an A record pointing to your droplet
|
|
120
120
|
- A reverse proxy configured (e.g., using [nginx](https://nginx.org/))
|
|
121
121
|
- SSL certificate configured (e.g., using [Let's Encrypt](https://letsencrypt.org/))
|
|
122
|
-
- Node.js
|
|
122
|
+
- Node.js 22.13.0 or later installed on your droplet
|
|
123
123
|
|
|
124
124
|
### Deployment Steps
|
|
125
125
|
|
|
@@ -201,7 +201,7 @@ npm run build
|
|
|
201
201
|
Run the application
|
|
202
202
|
|
|
203
203
|
```bash copy
|
|
204
|
-
node --
|
|
204
|
+
node --env-file=".env" .mastra/output/index.mjs
|
|
205
205
|
```
|
|
206
206
|
|
|
207
207
|
:::note
|
|
@@ -220,7 +220,7 @@ Your Mastra application will run on port 4111 by default. Ensure your reverse pr
|
|
|
220
220
|
|
|
221
221
|
You can now connect to your Mastra server from your client application using a `MastraClient` from the `@mastra/client-js` package.
|
|
222
222
|
|
|
223
|
-
Refer to the [`MastraClient` documentation](/docs/server-db/mastra-client) for more information.
|
|
223
|
+
Refer to the [`MastraClient` documentation](/docs/v1/server-db/mastra-client) for more information.
|
|
224
224
|
|
|
225
225
|
```typescript copy showLineNumbers
|
|
226
226
|
import { MastraClient } from "@mastra/client-js";
|
|
@@ -232,6 +232,6 @@ const mastraClient = new MastraClient({
|
|
|
232
232
|
|
|
233
233
|
## Next steps
|
|
234
234
|
|
|
235
|
-
- [Mastra Client SDK](/reference/client-js/mastra-client)
|
|
235
|
+
- [Mastra Client SDK](/reference/v1/client-js/mastra-client)
|
|
236
236
|
- [Digital Ocean App Platform documentation](https://docs.digitalocean.com/products/app-platform/)
|
|
237
237
|
- [Digital Ocean Droplets documentation](https://docs.digitalocean.com/products/droplets/)
|
|
@@ -7,19 +7,19 @@ description: "Deploy your Mastra applications to popular cloud providers."
|
|
|
7
7
|
|
|
8
8
|
Standalone Mastra applications can be deployed to popular cloud providers, see one of the following guides for more information:
|
|
9
9
|
|
|
10
|
-
- [Amazon EC2](/docs/deployment/cloud-providers/amazon-ec2)
|
|
11
|
-
- [AWS Lambda](/docs/deployment/cloud-providers/aws-lambda)
|
|
12
|
-
- [Digital Ocean](/docs/deployment/cloud-providers/digital-ocean)
|
|
13
|
-
- [Azure App Services](/docs/deployment/cloud-providers/azure-app-services)
|
|
10
|
+
- [Amazon EC2](/docs/v1/deployment/cloud-providers/amazon-ec2)
|
|
11
|
+
- [AWS Lambda](/docs/v1/deployment/cloud-providers/aws-lambda)
|
|
12
|
+
- [Digital Ocean](/docs/v1/deployment/cloud-providers/digital-ocean)
|
|
13
|
+
- [Azure App Services](/docs/v1/deployment/cloud-providers/azure-app-services)
|
|
14
14
|
|
|
15
|
-
For self-hosted Node.js server deployment, see the [Creating A Mastra Server](/docs/deployment/server-deployment) guide.
|
|
15
|
+
For self-hosted Node.js server deployment, see the [Creating A Mastra Server](/docs/v1/deployment/server-deployment) guide.
|
|
16
16
|
|
|
17
17
|
## Prerequisites
|
|
18
18
|
|
|
19
19
|
Before deploying to a cloud provider, ensure you have:
|
|
20
20
|
|
|
21
|
-
- A [Mastra application](/docs/getting-started/installation)
|
|
22
|
-
- Node.js `
|
|
21
|
+
- A [Mastra application](/docs/v1/getting-started/installation)
|
|
22
|
+
- Node.js `v22.13.0` or later
|
|
23
23
|
- A GitHub repository for your application (required for most CI/CD setups)
|
|
24
24
|
- Domain name management access (for SSL and HTTPS)
|
|
25
25
|
- Basic familiarity with server setup (e.g. Nginx, environment variables)
|
|
@@ -34,8 +34,9 @@ Specifically, ensure you've removed it from both `src/mastra/index.ts` and `src/
|
|
|
34
34
|
export const mastra = new Mastra({
|
|
35
35
|
// ...
|
|
36
36
|
storage: new LibSQLStore({
|
|
37
|
+
id: 'mastra-storage',
|
|
37
38
|
// [!code --]
|
|
38
|
-
// stores telemetry,
|
|
39
|
+
// stores telemetry, scorer results, ... into memory storage, if it needs to persist, change to file:../mastra.db // [!code --]
|
|
39
40
|
url: ":memory:", // [!code --]
|
|
40
41
|
}), //[!code --]
|
|
41
42
|
});
|
|
@@ -43,10 +44,12 @@ export const mastra = new Mastra({
|
|
|
43
44
|
|
|
44
45
|
```typescript title="src/mastra/agents/weather-agent.ts" showLineNumbers
|
|
45
46
|
export const weatherAgent = new Agent({
|
|
47
|
+
id: "weather-agent",
|
|
46
48
|
// ..
|
|
47
49
|
memory: new Memory({
|
|
48
50
|
// [!code --]
|
|
49
51
|
storage: new LibSQLStore({
|
|
52
|
+
id: 'mastra-storage',
|
|
50
53
|
// [!code --]
|
|
51
54
|
url: "file:../mastra.db", // path is relative to the .mastra/output directory // [!code --]
|
|
52
55
|
}), // [!code --]
|
|
@@ -66,7 +66,7 @@ Common issues to watch for when deploying Mastra in a monorepo:
|
|
|
66
66
|
Use `transpilePackages` to compile TypeScript workspace packages or libraries. List package names exactly as they appear in each `package.json`. Use `externals` to exclude dependencies resolved at runtime, and `sourcemap` to emit readable stack traces.
|
|
67
67
|
|
|
68
68
|
```typescript title="src/mastra/index.ts" showLineNumbers copy
|
|
69
|
-
import { Mastra } from "@mastra/core
|
|
69
|
+
import { Mastra } from "@mastra/core";
|
|
70
70
|
|
|
71
71
|
export const mastra = new Mastra({
|
|
72
72
|
// ...
|
|
@@ -78,7 +78,7 @@ export const mastra = new Mastra({
|
|
|
78
78
|
});
|
|
79
79
|
```
|
|
80
80
|
|
|
81
|
-
> See [Mastra Class](/reference/core/mastra-class) for more configuration options.
|
|
81
|
+
> See [Mastra Class](/reference/v1/core/mastra-class) for more configuration options.
|
|
82
82
|
|
|
83
83
|
## Supported monorepos
|
|
84
84
|
|
|
@@ -20,7 +20,7 @@ Mastra offers multiple deployment options to suit your application's needs, from
|
|
|
20
20
|
|
|
21
21
|
### Runtime support
|
|
22
22
|
|
|
23
|
-
- Node.js `
|
|
23
|
+
- Node.js `v22.13.0` or later
|
|
24
24
|
- Bun
|
|
25
25
|
- Deno
|
|
26
26
|
- [Cloudflare](../deployment/serverless-platforms/cloudflare-deployer)
|
|
@@ -79,4 +79,4 @@ Once your Mastra application is deployed, you'll need to configure your client t
|
|
|
79
79
|
- Retries and error handling
|
|
80
80
|
- Support for streaming responses
|
|
81
81
|
|
|
82
|
-
[Client configuration guide →](/docs/server-db/mastra-client)
|
|
82
|
+
[Client configuration guide →](/docs/v1/server-db/mastra-client)
|
|
@@ -9,7 +9,7 @@ Mastra runs as a standard Node.js server and can be deployed across a wide range
|
|
|
9
9
|
|
|
10
10
|
## Default project structure
|
|
11
11
|
|
|
12
|
-
The [getting started guide](/docs/getting-started/installation) scaffolds a project with sensible defaults to help you begin quickly. By default, the CLI organizes application files under the `src/mastra/` directory, resulting in a structure similar to the following:
|
|
12
|
+
The [getting started guide](/docs/v1/getting-started/installation) scaffolds a project with sensible defaults to help you begin quickly. By default, the CLI organizes application files under the `src/mastra/` directory, resulting in a structure similar to the following:
|
|
13
13
|
|
|
14
14
|
```
|
|
15
15
|
src/
|
|
@@ -45,7 +45,7 @@ The build process follows these steps:
|
|
|
45
45
|
1. **Locates entry file**: Finds `index.ts` or `index.js` in your specified directory (default: `src/mastra/`).
|
|
46
46
|
2. **Creates build directory**: Generates a `.mastra/` directory containing:
|
|
47
47
|
- **`.build`**: Contains dependency analysis, bundled dependencies, and build configuration files.
|
|
48
|
-
- **`output`**: Contains the production-ready application bundle with `index.mjs
|
|
48
|
+
- **`output`**: Contains the production-ready application bundle with `index.mjs` and project-specific files.
|
|
49
49
|
3. **Copies static assets**: Copies the `public/` folder contents to the `output` directory for serving static files.
|
|
50
50
|
4. **Bundles code**: Uses Rollup with tree shaking and source maps for optimization.
|
|
51
51
|
5. **Generates server**: Creates a [Hono](https://hono.dev) HTTP server ready for deployment.
|
|
@@ -71,11 +71,3 @@ Start the HTTP server:
|
|
|
71
71
|
```bash copy
|
|
72
72
|
node .mastra/output/index.mjs
|
|
73
73
|
```
|
|
74
|
-
|
|
75
|
-
## Enable Telemetry
|
|
76
|
-
|
|
77
|
-
To enable telemetry and observability, load the instrumentation file:
|
|
78
|
-
|
|
79
|
-
```bash copy
|
|
80
|
-
node --import=./.mastra/output/instrumentation.mjs .mastra/output/index.mjs
|
|
81
|
-
```
|
|
@@ -5,7 +5,7 @@ description: "Learn how to deploy a Mastra application to Cloudflare using the M
|
|
|
5
5
|
|
|
6
6
|
# CloudflareDeployer
|
|
7
7
|
|
|
8
|
-
The `CloudflareDeployer` class handles deployment of standalone Mastra applications to Cloudflare Workers. It manages configuration, deployment, and extends the base [Deployer](/reference/deployer/) class with Cloudflare specific functionality.
|
|
8
|
+
The `CloudflareDeployer` class handles deployment of standalone Mastra applications to Cloudflare Workers. It manages configuration, deployment, and extends the base [Deployer](/reference/v1/deployer/) class with Cloudflare specific functionality.
|
|
9
9
|
|
|
10
10
|
## Installation
|
|
11
11
|
|
|
@@ -16,7 +16,7 @@ npm install @mastra/deployer-cloudflare@latest
|
|
|
16
16
|
## Usage example
|
|
17
17
|
|
|
18
18
|
```typescript title="src/mastra/index.ts" showLineNumbers copy
|
|
19
|
-
import { Mastra } from "@mastra/core
|
|
19
|
+
import { Mastra } from "@mastra/core";
|
|
20
20
|
import { CloudflareDeployer } from "@mastra/deployer-cloudflare";
|
|
21
21
|
|
|
22
22
|
export const mastra = new Mastra({
|
|
@@ -30,7 +30,7 @@ export const mastra = new Mastra({
|
|
|
30
30
|
});
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
> See the [CloudflareDeployer](/reference/deployer/cloudflare) API reference for all available configuration options.
|
|
33
|
+
> See the [CloudflareDeployer](/reference/v1/deployer/cloudflare) API reference for all available configuration options.
|
|
34
34
|
|
|
35
35
|
## Manual deployment
|
|
36
36
|
|
|
@@ -83,4 +83,4 @@ The `CloudflareDeployer` automatically generates a `wrangler.json` configuration
|
|
|
83
83
|
|
|
84
84
|
## Next steps
|
|
85
85
|
|
|
86
|
-
- [Mastra Client SDK](/reference/client-js/mastra-client)
|
|
86
|
+
- [Mastra Client SDK](/reference/v1/client-js/mastra-client)
|
|
@@ -7,19 +7,19 @@ description: "Build and deploy Mastra applications using platform-specific deplo
|
|
|
7
7
|
|
|
8
8
|
Standalone Mastra applications can be deployed to popular serverless platforms using one of our deployer packages:
|
|
9
9
|
|
|
10
|
-
- [Cloudflare](/docs/deployment/serverless-platforms/cloudflare-deployer)
|
|
11
|
-
- [Netlify](/docs/deployment/serverless-platforms/netlify-deployer)
|
|
12
|
-
- [Vercel](/docs/deployment/serverless-platforms/vercel-deployer)
|
|
10
|
+
- [Cloudflare](/docs/v1/deployment/serverless-platforms/cloudflare-deployer)
|
|
11
|
+
- [Netlify](/docs/v1/deployment/serverless-platforms/netlify-deployer)
|
|
12
|
+
- [Vercel](/docs/v1/deployment/serverless-platforms/vercel-deployer)
|
|
13
13
|
|
|
14
|
-
Deployers **aren't** required when integrating Mastra with a framework. See [Web Framework Integration](/docs/deployment/web-framework) for more information.
|
|
14
|
+
Deployers **aren't** required when integrating Mastra with a framework. See [Web Framework Integration](/docs/v1/deployment/web-framework) for more information.
|
|
15
15
|
|
|
16
|
-
For self-hosted Node.js server deployment, see the [Creating A Mastra Server](/docs/deployment/server-deployment) guide.
|
|
16
|
+
For self-hosted Node.js server deployment, see the [Creating A Mastra Server](/docs/v1/deployment/server-deployment) guide.
|
|
17
17
|
|
|
18
18
|
## Prerequisites
|
|
19
19
|
|
|
20
20
|
Before you begin, ensure you have:
|
|
21
21
|
|
|
22
|
-
- Node.js `
|
|
22
|
+
- Node.js `v22.13.0` or later
|
|
23
23
|
- If using a platform-specific deployer:
|
|
24
24
|
- An account with your chosen platform
|
|
25
25
|
- Required API keys or credentials
|
|
@@ -34,8 +34,9 @@ Specifically, ensure you've removed it from both `src/mastra/index.ts` and `src/
|
|
|
34
34
|
export const mastra = new Mastra({
|
|
35
35
|
// ...
|
|
36
36
|
storage: new LibSQLStore({
|
|
37
|
+
id: 'mastra-storage',
|
|
37
38
|
// [!code --]
|
|
38
|
-
// stores telemetry,
|
|
39
|
+
// stores telemetry, scorer results, ... into memory storage, if it needs to persist, change to file:../mastra.db // [!code --]
|
|
39
40
|
url: ":memory:", // [!code --]
|
|
40
41
|
}), //[!code --]
|
|
41
42
|
});
|
|
@@ -43,10 +44,12 @@ export const mastra = new Mastra({
|
|
|
43
44
|
|
|
44
45
|
```typescript title="src/mastra/agents/weather-agent.ts" showLineNumbers
|
|
45
46
|
export const weatherAgent = new Agent({
|
|
47
|
+
id: "weather-agent",
|
|
46
48
|
// ..
|
|
47
49
|
memory: new Memory({
|
|
48
50
|
// [!code --]
|
|
49
51
|
storage: new LibSQLStore({
|
|
52
|
+
id: 'mastra-storage',
|
|
50
53
|
// [!code --]
|
|
51
54
|
url: "file:../mastra.db", // path is relative to the .mastra/output directory // [!code --]
|
|
52
55
|
}), // [!code --]
|
|
@@ -5,7 +5,7 @@ description: "Learn how to deploy a Mastra application to Netlify using the Mast
|
|
|
5
5
|
|
|
6
6
|
# NetlifyDeployer
|
|
7
7
|
|
|
8
|
-
The `NetlifyDeployer` class handles deployment of standalone Mastra applications to Netlify. It manages configuration, deployment, and extends the base [Deployer](/reference/deployer/) class with Netlify specific functionality.
|
|
8
|
+
The `NetlifyDeployer` class handles deployment of standalone Mastra applications to Netlify. It manages configuration, deployment, and extends the base [Deployer](/reference/v1/deployer/) class with Netlify specific functionality.
|
|
9
9
|
|
|
10
10
|
## Installation
|
|
11
11
|
|
|
@@ -16,7 +16,7 @@ npm install @mastra/deployer-netlify@latest
|
|
|
16
16
|
## Usage example
|
|
17
17
|
|
|
18
18
|
```typescript title="src/mastra/index.ts" showLineNumbers copy
|
|
19
|
-
import { Mastra } from "@mastra/core
|
|
19
|
+
import { Mastra } from "@mastra/core";
|
|
20
20
|
import { NetlifyDeployer } from "@mastra/deployer-netlify";
|
|
21
21
|
|
|
22
22
|
export const mastra = new Mastra({
|
|
@@ -25,7 +25,7 @@ export const mastra = new Mastra({
|
|
|
25
25
|
});
|
|
26
26
|
```
|
|
27
27
|
|
|
28
|
-
> See the [NetlifyDeployer](/reference/deployer/netlify) API reference for all available configuration options.
|
|
28
|
+
> See the [NetlifyDeployer](/reference/v1/deployer/netlify) API reference for all available configuration options.
|
|
29
29
|
|
|
30
30
|
## Continuous integration
|
|
31
31
|
|
|
@@ -82,4 +82,4 @@ The `NetlifyDeployer` automatically generates a `config.json` configuration file
|
|
|
82
82
|
|
|
83
83
|
## Next steps
|
|
84
84
|
|
|
85
|
-
- [Mastra Client SDK](/reference/client-js/mastra-client)
|
|
85
|
+
- [Mastra Client SDK](/reference/v1/client-js/mastra-client)
|
|
@@ -5,7 +5,7 @@ description: "Learn how to deploy a Mastra application to Vercel using the Mastr
|
|
|
5
5
|
|
|
6
6
|
# VercelDeployer
|
|
7
7
|
|
|
8
|
-
The `VercelDeployer` class handles deployment of standalone Mastra applications to Vercel. It manages configuration, deployment, and extends the base [Deployer](/reference/deployer/) class with Vercel specific functionality.
|
|
8
|
+
The `VercelDeployer` class handles deployment of standalone Mastra applications to Vercel. It manages configuration, deployment, and extends the base [Deployer](/reference/v1/deployer/) class with Vercel specific functionality.
|
|
9
9
|
|
|
10
10
|
## Installation
|
|
11
11
|
|
|
@@ -16,7 +16,7 @@ npm install @mastra/deployer-vercel@latest
|
|
|
16
16
|
## Usage example
|
|
17
17
|
|
|
18
18
|
```typescript title="src/mastra/index.ts" showLineNumbers copy
|
|
19
|
-
import { Mastra } from "@mastra/core
|
|
19
|
+
import { Mastra } from "@mastra/core";
|
|
20
20
|
import { VercelDeployer } from "@mastra/deployer-vercel";
|
|
21
21
|
|
|
22
22
|
export const mastra = new Mastra({
|
|
@@ -25,7 +25,7 @@ export const mastra = new Mastra({
|
|
|
25
25
|
});
|
|
26
26
|
```
|
|
27
27
|
|
|
28
|
-
> See the [VercelDeployer](/reference/deployer/vercel) API reference for all available configuration options.
|
|
28
|
+
> See the [VercelDeployer](/reference/v1/deployer/vercel) API reference for all available configuration options.
|
|
29
29
|
|
|
30
30
|
### Optional overrides
|
|
31
31
|
|
|
@@ -99,4 +99,4 @@ The `VercelDeployer` automatically generates a `config.json` configuration file
|
|
|
99
99
|
|
|
100
100
|
## Next steps
|
|
101
101
|
|
|
102
|
-
- [Mastra Client SDK](/reference/client-js/mastra-client)
|
|
102
|
+
- [Mastra Client SDK](/reference/v1/client-js/mastra-client)
|
|
@@ -7,16 +7,16 @@ description: "Learn how Mastra can be deployed when integrated with a Web Framew
|
|
|
7
7
|
|
|
8
8
|
This guide covers deploying integrated Mastra applications. Mastra can be integrated with a variety of web frameworks, see one of the following for a detailed guide.
|
|
9
9
|
|
|
10
|
-
- [With Next.js](/docs/frameworks/web-frameworks/next-js)
|
|
11
|
-
- [With Astro](/docs/frameworks/web-frameworks/astro)
|
|
10
|
+
- [With Next.js](/docs/v1/frameworks/web-frameworks/next-js)
|
|
11
|
+
- [With Astro](/docs/v1/frameworks/web-frameworks/astro)
|
|
12
12
|
|
|
13
13
|
When integrated with a framework, Mastra typically requires no additional configuration for deployment.
|
|
14
14
|
|
|
15
15
|
## With Next.js on Vercel
|
|
16
16
|
|
|
17
|
-
If you've integrated Mastra with Next.js [by following our guide](/docs/frameworks/web-frameworks/next-js) and plan to deploy to Vercel, no additional setup is required.
|
|
17
|
+
If you've integrated Mastra with Next.js [by following our guide](/docs/v1/frameworks/web-frameworks/next-js) and plan to deploy to Vercel, no additional setup is required.
|
|
18
18
|
|
|
19
|
-
The only thing to verify is that you've added the following to your `next.config.ts` and removed any usage of [LibSQLStore](/docs/deployment/overview), which is not supported in serverless environments:
|
|
19
|
+
The only thing to verify is that you've added the following to your `next.config.ts` and removed any usage of [LibSQLStore](/docs/v1/deployment/overview), which is not supported in serverless environments:
|
|
20
20
|
|
|
21
21
|
```typescript {4} title="next.config.ts" showLineNumbers copy
|
|
22
22
|
import type { NextConfig } from "next";
|
|
@@ -30,9 +30,9 @@ export default nextConfig;
|
|
|
30
30
|
|
|
31
31
|
## With Astro on Vercel
|
|
32
32
|
|
|
33
|
-
If you've integrated Mastra with Astro [by following our guide](/docs/frameworks/web-frameworks/astro) and plan to deploy to Vercel, no additional setup is required.
|
|
33
|
+
If you've integrated Mastra with Astro [by following our guide](/docs/v1/frameworks/web-frameworks/astro) and plan to deploy to Vercel, no additional setup is required.
|
|
34
34
|
|
|
35
|
-
The only thing to verify is that you've added the following to your `astro.config.mjs` and removed any usage of [LibSQLStore](/docs/deployment/overview), which is not supported in serverless environments:
|
|
35
|
+
The only thing to verify is that you've added the following to your `astro.config.mjs` and removed any usage of [LibSQLStore](/docs/v1/deployment/overview), which is not supported in serverless environments:
|
|
36
36
|
|
|
37
37
|
```javascript {2,6,7} title="astro.config.mjs" showLineNumbers copy
|
|
38
38
|
import { defineConfig } from "astro/config";
|
|
@@ -47,9 +47,9 @@ export default defineConfig({
|
|
|
47
47
|
|
|
48
48
|
## With Astro on Netlify
|
|
49
49
|
|
|
50
|
-
If you've integrated Mastra with Astro [by following our guide](/docs/frameworks/web-frameworks/astro) and plan to deploy to Netlify, no additional setup is required.
|
|
50
|
+
If you've integrated Mastra with Astro [by following our guide](/docs/v1/frameworks/web-frameworks/astro) and plan to deploy to Netlify, no additional setup is required.
|
|
51
51
|
|
|
52
|
-
The only thing to verify is that you've added the following to your `astro.config.mjs` and removed any usage of [LibSQLStore](/docs/deployment/overview), which is not supported in serverless environments:
|
|
52
|
+
The only thing to verify is that you've added the following to your `astro.config.mjs` and removed any usage of [LibSQLStore](/docs/v1/deployment/overview), which is not supported in serverless environments:
|
|
53
53
|
|
|
54
54
|
```javascript {2,6,7} title="astro.config.mjs" showLineNumbers copy
|
|
55
55
|
import { defineConfig } from "astro/config";
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Custom Scorers |
|
|
2
|
+
title: "Custom Scorers | Evals | Mastra Docs"
|
|
3
3
|
---
|
|
4
4
|
|
|
5
5
|
# Custom scorers
|
|
@@ -40,7 +40,7 @@ You can mix and match approaches within a single scorer - for example, use a fun
|
|
|
40
40
|
Every scorer starts with the `createScorer` factory function, which requires a name and description, and optionally accepts a type specification and judge configuration.
|
|
41
41
|
|
|
42
42
|
```typescript
|
|
43
|
-
import { createScorer } from '@mastra/core/
|
|
43
|
+
import { createScorer } from '@mastra/core/evals';
|
|
44
44
|
import { openai } from '@ai-sdk/openai';
|
|
45
45
|
|
|
46
46
|
const glutenCheckerScorer = createScorer({
|
|
@@ -187,7 +187,7 @@ const glutenCheckerScorer = createScorer({...})
|
|
|
187
187
|
})
|
|
188
188
|
```
|
|
189
189
|
|
|
190
|
-
**Prompt Objects:** See the [`createScorer`](/reference/
|
|
190
|
+
**Prompt Objects:** See the [`createScorer`](/reference/v1/evals/create-scorer) API reference for details on using prompt objects with generateScore, including required `calculateScore` function.
|
|
191
191
|
|
|
192
192
|
**Data Flow:** The score is available to generateReason as the `score` parameter
|
|
193
193
|
|
|
@@ -242,11 +242,11 @@ A custom scorer in Mastra uses `createScorer` with four core components:
|
|
|
242
242
|
|
|
243
243
|
Together, these components allow you to define custom evaluation logic using LLMs as judges.
|
|
244
244
|
|
|
245
|
-
> See [createScorer](/reference/
|
|
245
|
+
> See [createScorer](/reference/v1/evals/create-scorer) for the full API and configuration options.
|
|
246
246
|
|
|
247
247
|
```typescript title="src/mastra/scorers/gluten-checker.ts" showLineNumbers copy
|
|
248
248
|
import { openai } from "@ai-sdk/openai";
|
|
249
|
-
import { createScorer } from "@mastra/core/
|
|
249
|
+
import { createScorer } from "@mastra/core/evals";
|
|
250
250
|
import { z } from "zod";
|
|
251
251
|
|
|
252
252
|
export const GLUTEN_INSTRUCTIONS = `You are a Chef that identifies if recipes contain gluten.`;
|
|
@@ -479,5 +479,5 @@ console.log("Reason:", result.reason);
|
|
|
479
479
|
|
|
480
480
|
**Examples and Resources:**
|
|
481
481
|
|
|
482
|
-
- [createScorer API Reference](/reference/
|
|
482
|
+
- [createScorer API Reference](/reference/v1/evals/create-scorer) - Complete technical documentation
|
|
483
483
|
- [Built-in Scorers Source Code](https://github.com/mastra-ai/mastra/tree/main/packages/evals/src/scorers) - Real implementations for reference
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Built-in Scorers | Evals | Mastra Docs"
|
|
3
|
+
description: "Overview of Mastra's ready-to-use scorers for evaluating AI outputs across quality, safety, and performance dimensions."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Built-in Scorers
|
|
7
|
+
|
|
8
|
+
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.
|
|
9
|
+
|
|
10
|
+
## Available Scorers
|
|
11
|
+
|
|
12
|
+
### Accuracy and Reliability
|
|
13
|
+
|
|
14
|
+
These scorers evaluate how correct, truthful, and complete your agent's answers are:
|
|
15
|
+
|
|
16
|
+
- [`answer-relevancy`](/reference/v1/evals/answer-relevancy): Evaluates how well responses address the input query (`0-1`, higher is better)
|
|
17
|
+
- [`answer-similarity`](/reference/v1/evals/answer-similarity): Compares agent outputs against ground truth answers for CI/CD testing using semantic analysis (`0-1`, higher is better)
|
|
18
|
+
- [`faithfulness`](/reference/v1/evals/faithfulness): Measures how accurately responses represent provided context (`0-1`, higher is better)
|
|
19
|
+
- [`hallucination`](/reference/v1/evals/hallucination): Detects factual contradictions and unsupported claims (`0-1`, lower is better)
|
|
20
|
+
- [`completeness`](/reference/v1/evals/completeness): Checks if responses include all necessary information (`0-1`, higher is better)
|
|
21
|
+
- [`content-similarity`](/reference/v1/evals/content-similarity): Measures textual similarity using character-level matching (`0-1`, higher is better)
|
|
22
|
+
- [`textual-difference`](/reference/v1/evals/textual-difference): Measures textual differences between strings (`0-1`, higher means more similar)
|
|
23
|
+
- [`tool-call-accuracy`](/reference/v1/evals/tool-call-accuracy): Evaluates whether the LLM selects the correct tool from available options (`0-1`, higher is better)
|
|
24
|
+
- [`prompt-alignment`](/reference/v1/evals/prompt-alignment): Measures how well agent responses align with user prompt intent, requirements, completeness, and format (`0-1`, higher is better)
|
|
25
|
+
|
|
26
|
+
### Context Quality
|
|
27
|
+
|
|
28
|
+
These scorers evaluate the quality and relevance of context used in generating responses:
|
|
29
|
+
|
|
30
|
+
- [`context-precision`](/reference/v1/evals/context-precision): Evaluates context relevance and ranking using Mean Average Precision, rewarding early placement of relevant context (`0-1`, higher is better)
|
|
31
|
+
- [`context-relevance`](/reference/v1/evals/context-relevance): Measures context utility with nuanced relevance levels, usage tracking, and missing context detection (`0-1`, higher is better)
|
|
32
|
+
|
|
33
|
+
> tip Context Scorer Selection
|
|
34
|
+
|
|
35
|
+
- Use **Context Precision** when context ordering matters and you need standard IR metrics (ideal for RAG ranking evaluation)
|
|
36
|
+
- Use **Context Relevance** when you need detailed relevance assessment and want to track context usage and identify gaps
|
|
37
|
+
|
|
38
|
+
Both context scorers support:
|
|
39
|
+
|
|
40
|
+
- **Static context**: Pre-defined context arrays
|
|
41
|
+
- **Dynamic context extraction**: Extract context from runs using custom functions (ideal for RAG systems, vector databases, etc.)
|
|
42
|
+
|
|
43
|
+
### Output Quality
|
|
44
|
+
|
|
45
|
+
These scorers evaluate adherence to format, style, and safety requirements:
|
|
46
|
+
|
|
47
|
+
- [`tone-consistency`](/reference/v1/evals/tone-consistency): Measures consistency in formality, complexity, and style (`0-1`, higher is better)
|
|
48
|
+
- [`toxicity`](/reference/v1/evals/toxicity): Detects harmful or inappropriate content (`0-1`, lower is better)
|
|
49
|
+
- [`bias`](/reference/v1/evals/bias): Detects potential biases in the output (`0-1`, lower is better)
|
|
50
|
+
- [`keyword-coverage`](/reference/v1/evals/keyword-coverage): Assesses technical terminology usage (`0-1`, higher is better)
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Scorers overview |
|
|
2
|
+
title: "Scorers overview | Evals | Mastra Docs"
|
|
3
3
|
description: Overview of scorers in Mastra, detailing their capabilities for evaluating AI outputs and measuring performance.
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -33,7 +33,7 @@ npm install @mastra/evals@latest
|
|
|
33
33
|
|
|
34
34
|
### Adding scorers to agents
|
|
35
35
|
|
|
36
|
-
You can add built-in scorers to your agents to automatically evaluate their outputs. See the [full list of built-in scorers](/docs/
|
|
36
|
+
You can add built-in scorers to your agents to automatically evaluate their outputs. See the [full list of built-in scorers](/docs/v1/evals/off-the-shelf-scorers) for all available options.
|
|
37
37
|
|
|
38
38
|
```typescript title="src/mastra/agents/evaluated-agent.ts" showLineNumbers copy
|
|
39
39
|
import { Agent } from "@mastra/core/agent";
|
|
@@ -41,7 +41,7 @@ import { openai } from "@ai-sdk/openai";
|
|
|
41
41
|
import {
|
|
42
42
|
createAnswerRelevancyScorer,
|
|
43
43
|
createToxicityScorer,
|
|
44
|
-
} from "@mastra/evals/scorers/
|
|
44
|
+
} from "@mastra/evals/scorers/prebuilt";
|
|
45
45
|
|
|
46
46
|
export const evaluatedAgent = new Agent({
|
|
47
47
|
// ...
|
|
@@ -106,7 +106,7 @@ In addition to live evaluations, you can use scorers to evaluate historical trac
|
|
|
106
106
|
|
|
107
107
|
**Observability Required**
|
|
108
108
|
|
|
109
|
-
To score traces, you must first configure observability in your Mastra instance to collect trace data. See [
|
|
109
|
+
To score traces, you must first configure observability in your Mastra instance to collect trace data. See [Tracing documentation](../observability/tracing/overview) for setup instructions.
|
|
110
110
|
|
|
111
111
|
:::
|
|
112
112
|
|
|
@@ -130,10 +130,10 @@ Once registered, you can score traces interactively within Studio under the Obse
|
|
|
130
130
|
|
|
131
131
|
Mastra provides a CLI command `mastra dev` to test your scorers. Studio includes a scorers section where you can run individual scorers against test inputs and view detailed results.
|
|
132
132
|
|
|
133
|
-
For more details, see [Studio](/docs/getting-started/studio) docs.
|
|
133
|
+
For more details, see [Studio](/docs/v1/getting-started/studio) docs.
|
|
134
134
|
|
|
135
135
|
## Next steps
|
|
136
136
|
|
|
137
|
-
- Learn how to create your own scorers in the [Creating Custom Scorers](/docs/
|
|
138
|
-
- Explore built-in scorers in the [Off-the-shelf Scorers](/docs/
|
|
139
|
-
- Test scorers with [Studio](/docs/getting-started/studio)
|
|
137
|
+
- Learn how to create your own scorers in the [Creating Custom Scorers](/docs/v1/evals/custom-scorers) guide
|
|
138
|
+
- Explore built-in scorers in the [Off-the-shelf Scorers](/docs/v1/evals/off-the-shelf-scorers) section
|
|
139
|
+
- Test scorers with [Studio](/docs/v1/getting-started/studio)
|