@mastra/mcp-docs-server 1.0.0-beta.9 → 1.0.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%2Fchangeset-cli.md +3 -1
- package/.docs/organized/changelogs/%40internal%2Fexternal-types.md +3 -1
- package/.docs/organized/changelogs/%40internal%2Fplayground.md +40 -0
- package/.docs/organized/changelogs/%40internal%2Fstorage-test-utils.md +8 -8
- package/.docs/organized/changelogs/%40internal%2Ftypes-builder.md +3 -1
- package/.docs/organized/changelogs/%40mastra%2Fagent-builder.md +287 -287
- package/.docs/organized/changelogs/%40mastra%2Fai-sdk.md +299 -299
- package/.docs/organized/changelogs/%40mastra%2Fastra.md +53 -53
- package/.docs/organized/changelogs/%40mastra%2Fauth.md +38 -0
- package/.docs/organized/changelogs/%40mastra%2Fchroma.md +66 -66
- package/.docs/organized/changelogs/%40mastra%2Fclickhouse.md +522 -212
- package/.docs/organized/changelogs/%40mastra%2Fclient-js.md +662 -200
- package/.docs/organized/changelogs/%40mastra%2Fcloudflare-d1.md +439 -234
- package/.docs/organized/changelogs/%40mastra%2Fcloudflare.md +450 -211
- package/.docs/organized/changelogs/%40mastra%2Fcodemod.md +202 -0
- package/.docs/organized/changelogs/%40mastra%2Fconvex.md +448 -22
- package/.docs/organized/changelogs/%40mastra%2Fcore.md +3359 -289
- package/.docs/organized/changelogs/%40mastra%2Fcouchbase.md +60 -60
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloud.md +289 -289
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloudflare.md +90 -90
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-netlify.md +74 -74
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-vercel.md +70 -70
- package/.docs/organized/changelogs/%40mastra%2Fdeployer.md +248 -221
- package/.docs/organized/changelogs/%40mastra%2Fduckdb.md +70 -0
- package/.docs/organized/changelogs/%40mastra%2Fdynamodb.md +403 -225
- package/.docs/organized/changelogs/%40mastra%2Felasticsearch.md +72 -0
- package/.docs/organized/changelogs/%40mastra%2Fevals.md +145 -145
- package/.docs/organized/changelogs/%40mastra%2Ffastembed.md +54 -0
- package/.docs/organized/changelogs/%40mastra%2Flance.md +456 -226
- package/.docs/organized/changelogs/%40mastra%2Flibsql.md +625 -229
- package/.docs/organized/changelogs/%40mastra%2Floggers.md +71 -71
- package/.docs/organized/changelogs/%40mastra%2Fmcp-docs-server.md +247 -247
- package/.docs/organized/changelogs/%40mastra%2Fmcp-registry-registry.md +28 -28
- package/.docs/organized/changelogs/%40mastra%2Fmcp.md +281 -281
- package/.docs/organized/changelogs/%40mastra%2Fmemory.md +354 -156
- package/.docs/organized/changelogs/%40mastra%2Fmongodb.md +545 -212
- package/.docs/organized/changelogs/%40mastra%2Fmssql.md +481 -202
- package/.docs/organized/changelogs/%40mastra%2Fopensearch.md +194 -194
- package/.docs/organized/changelogs/%40mastra%2Fpg.md +781 -235
- package/.docs/organized/changelogs/%40mastra%2Fpinecone.md +198 -198
- package/.docs/organized/changelogs/%40mastra%2Fplayground-ui.md +655 -248
- package/.docs/organized/changelogs/%40mastra%2Fqdrant.md +163 -163
- package/.docs/organized/changelogs/%40mastra%2Frag.md +310 -310
- package/.docs/organized/changelogs/%40mastra%2Freact.md +328 -237
- package/.docs/organized/changelogs/%40mastra%2Fs3vectors.md +64 -0
- package/.docs/organized/changelogs/%40mastra%2Fschema-compat.md +160 -0
- package/.docs/organized/changelogs/%40mastra%2Fserver.md +850 -239
- package/.docs/organized/changelogs/%40mastra%2Fturbopuffer.md +57 -57
- package/.docs/organized/changelogs/%40mastra%2Fupstash.md +479 -232
- package/.docs/organized/changelogs/%40mastra%2Fvectorize.md +53 -53
- package/.docs/organized/changelogs/%40mastra%2Fvoice-azure.md +45 -45
- package/.docs/organized/changelogs/%40mastra%2Fvoice-cloudflare.md +45 -45
- package/.docs/organized/changelogs/%40mastra%2Fvoice-deepgram.md +47 -47
- package/.docs/organized/changelogs/%40mastra%2Fvoice-elevenlabs.md +110 -110
- package/.docs/organized/changelogs/%40mastra%2Fvoice-gladia.md +15 -0
- package/.docs/organized/changelogs/%40mastra%2Fvoice-google-gemini-live.md +98 -0
- package/.docs/organized/changelogs/%40mastra%2Fvoice-google.md +54 -54
- package/.docs/organized/changelogs/%40mastra%2Fvoice-murf.md +46 -46
- package/.docs/organized/changelogs/%40mastra%2Fvoice-openai-realtime.md +93 -93
- package/.docs/organized/changelogs/%40mastra%2Fvoice-openai.md +47 -47
- package/.docs/organized/changelogs/%40mastra%2Fvoice-playai.md +45 -45
- package/.docs/organized/changelogs/%40mastra%2Fvoice-sarvam.md +45 -45
- package/.docs/organized/changelogs/%40mastra%2Fvoice-speechify.md +45 -45
- package/.docs/organized/changelogs/create-mastra.md +215 -215
- package/.docs/organized/changelogs/mastra.md +278 -278
- package/.docs/organized/code-examples/a2a.md +2 -2
- package/.docs/organized/code-examples/agent-v6.md +221 -0
- package/.docs/organized/code-examples/agui.md +4 -4
- package/.docs/organized/code-examples/ai-elements.md +3 -3
- package/.docs/organized/code-examples/ai-sdk-useChat.md +2 -2
- package/.docs/organized/code-examples/ai-sdk-v5.md +3 -3
- package/.docs/organized/code-examples/assistant-ui.md +5 -5
- package/.docs/organized/code-examples/bird-checker-with-express.md +1 -1
- package/.docs/organized/code-examples/bird-checker-with-nextjs-and-eval.md +2 -2
- package/.docs/organized/code-examples/bird-checker-with-nextjs.md +3 -3
- package/.docs/organized/code-examples/client-side-tools.md +4 -4
- package/.docs/organized/code-examples/crypto-chatbot.md +5 -5
- package/.docs/organized/code-examples/experimental-auth-weather-agent.md +1 -1
- package/.docs/organized/code-examples/fireworks-r1.md +2 -2
- package/.docs/organized/code-examples/heads-up-game.md +7 -7
- package/.docs/organized/code-examples/inngest.md +1075 -0
- package/.docs/organized/code-examples/mcp-configuration.md +1 -1
- package/.docs/organized/code-examples/mcp-server-adapters.md +2 -2
- package/.docs/organized/code-examples/memory-per-resource-example.md +3 -3
- package/.docs/organized/code-examples/memory-todo-agent.md +1 -1
- package/.docs/organized/code-examples/memory-with-context.md +1 -1
- package/.docs/organized/code-examples/memory-with-processors.md +1 -1
- package/.docs/organized/code-examples/openapi-spec-writer.md +3 -3
- package/.docs/organized/code-examples/quick-start.md +1 -5
- package/.docs/organized/code-examples/server-app-access.md +2 -2
- package/.docs/organized/code-examples/server-express-adapter.md +1 -1
- package/.docs/organized/code-examples/server-fastify-adapter.md +83 -0
- package/.docs/organized/code-examples/server-hono-adapter.md +2 -2
- package/.docs/organized/code-examples/server-koa-adapter.md +94 -0
- package/.docs/organized/code-examples/stock-price-tool.md +21 -2
- package/.docs/organized/code-examples/workflow-ai-recruiter.md +1 -1
- package/.docs/organized/code-examples/workflow-with-inline-steps.md +1 -1
- package/.docs/organized/code-examples/workflow-with-memory.md +1 -1
- package/.docs/organized/code-examples/workflow-with-separate-steps.md +1 -1
- package/.docs/organized/code-examples/workflow-with-suspend-resume.md +1 -1
- package/.docs/raw/agents/adding-voice.mdx +24 -6
- package/.docs/raw/agents/agent-approval.mdx +209 -12
- package/.docs/raw/agents/agent-memory.mdx +36 -32
- package/.docs/raw/agents/guardrails.mdx +105 -56
- package/.docs/raw/agents/network-approval.mdx +281 -0
- package/.docs/raw/agents/networks.mdx +69 -13
- package/.docs/raw/agents/overview.mdx +43 -25
- package/.docs/raw/agents/processors.mdx +234 -17
- package/.docs/raw/agents/structured-output.mdx +78 -8
- package/.docs/raw/agents/using-tools.mdx +67 -6
- package/.docs/raw/course/01-first-agent/07-creating-your-agent.md +1 -2
- package/.docs/raw/course/01-first-agent/12-connecting-tool-to-agent.md +1 -1
- package/.docs/raw/course/01-first-agent/16-adding-memory-to-agent.md +1 -2
- package/.docs/raw/course/02-agent-tools-mcp/05-updating-your-agent.md +1 -1
- package/.docs/raw/course/02-agent-tools-mcp/10-updating-agent-instructions-zapier.md +1 -1
- package/.docs/raw/course/02-agent-tools-mcp/16-updating-agent-instructions-github.md +1 -1
- package/.docs/raw/course/02-agent-tools-mcp/21-updating-agent-instructions-hackernews.md +1 -1
- package/.docs/raw/course/02-agent-tools-mcp/27-updating-agent-instructions-filesystem.md +1 -1
- package/.docs/raw/course/02-agent-tools-mcp/31-enhancing-memory-configuration.md +3 -3
- package/.docs/raw/course/03-agent-memory/04-creating-basic-memory-agent.md +1 -2
- package/.docs/raw/course/03-agent-memory/07-understanding-memory-threads.md +35 -0
- package/.docs/raw/course/03-agent-memory/08-configuring-conversation-history.md +1 -2
- package/.docs/raw/course/03-agent-memory/13-vector-store-configuration.md +1 -1
- package/.docs/raw/course/03-agent-memory/16-configuring-semantic-recall.md +4 -5
- package/.docs/raw/course/03-agent-memory/18-advanced-configuration-semantic-recall.md +1 -1
- package/.docs/raw/course/03-agent-memory/21-configuring-working-memory.md +3 -4
- package/.docs/raw/course/03-agent-memory/22-custom-working-memory-templates.md +3 -4
- package/.docs/raw/course/03-agent-memory/25-combining-memory-features.md +3 -4
- package/.docs/raw/course/03-agent-memory/27-creating-learning-assistant.md +3 -4
- package/.docs/raw/course/04-workflows/11-creating-an-ai-agent.md +2 -3
- package/.docs/raw/deployment/cloud-providers.mdx +22 -0
- package/.docs/raw/deployment/mastra-server.mdx +140 -0
- package/.docs/raw/deployment/monorepo.mdx +106 -42
- package/.docs/raw/deployment/overview.mdx +35 -48
- package/.docs/raw/deployment/web-framework.mdx +17 -19
- package/.docs/raw/deployment/workflow-runners.mdx +16 -0
- package/.docs/raw/evals/built-in-scorers.mdx +2 -0
- package/.docs/raw/evals/custom-scorers.mdx +60 -12
- package/.docs/raw/evals/overview.mdx +6 -6
- package/.docs/raw/evals/running-in-ci.mdx +4 -2
- package/.docs/raw/getting-started/manual-install.mdx +20 -20
- package/.docs/raw/getting-started/mcp-docs-server.mdx +59 -2
- package/.docs/raw/getting-started/project-structure.mdx +2 -2
- package/.docs/raw/getting-started/start.mdx +17 -1
- package/.docs/raw/getting-started/studio.mdx +6 -35
- package/.docs/raw/guides/agent-frameworks/ai-sdk.mdx +23 -33
- package/.docs/raw/guides/build-your-ui/ai-sdk-ui.mdx +1034 -80
- package/.docs/raw/guides/build-your-ui/assistant-ui.mdx +8 -8
- package/.docs/raw/guides/build-your-ui/copilotkit.mdx +32 -11
- package/.docs/raw/{deployment/cloud-providers → guides/deployment}/amazon-ec2.mdx +9 -9
- package/.docs/raw/{deployment/cloud-providers → guides/deployment}/aws-lambda.mdx +13 -16
- package/.docs/raw/{deployment/cloud-providers → guides/deployment}/azure-app-services.mdx +5 -7
- package/.docs/raw/{deployment/cloud-providers → guides/deployment}/cloudflare-deployer.mdx +8 -5
- package/.docs/raw/{deployment/cloud-providers → guides/deployment}/digital-ocean.mdx +18 -23
- package/.docs/raw/guides/deployment/index.mdx +32 -0
- package/.docs/raw/guides/deployment/inngest.mdx +673 -0
- package/.docs/raw/{deployment/cloud-providers → guides/deployment}/netlify-deployer.mdx +7 -3
- package/.docs/raw/{deployment/cloud-providers → guides/deployment}/vercel-deployer.mdx +8 -5
- package/.docs/raw/guides/getting-started/astro.mdx +292 -451
- package/.docs/raw/guides/getting-started/express.mdx +72 -153
- package/.docs/raw/guides/getting-started/hono.mdx +227 -0
- package/.docs/raw/guides/getting-started/next-js.mdx +173 -61
- package/.docs/raw/guides/getting-started/nuxt.mdx +505 -0
- package/.docs/raw/guides/getting-started/quickstart.mdx +5 -5
- package/.docs/raw/guides/getting-started/sveltekit.mdx +238 -409
- package/.docs/raw/guides/getting-started/vite-react.mdx +317 -147
- package/.docs/raw/guides/guide/ai-recruiter.mdx +10 -10
- package/.docs/raw/guides/guide/chef-michel.mdx +9 -11
- package/.docs/raw/guides/guide/notes-mcp-server.mdx +15 -15
- package/.docs/raw/guides/guide/research-assistant.mdx +20 -20
- package/.docs/raw/guides/guide/stock-agent.mdx +5 -5
- package/.docs/raw/guides/guide/web-search.mdx +38 -38
- package/.docs/raw/guides/guide/whatsapp-chat-bot.mdx +7 -7
- package/.docs/raw/guides/index.mdx +0 -1
- package/.docs/raw/guides/migrations/ai-sdk-v4-to-v5.mdx +2 -2
- package/.docs/raw/guides/migrations/upgrade-to-v1/agent.mdx +105 -4
- package/.docs/raw/guides/migrations/upgrade-to-v1/cli.mdx +15 -1
- package/.docs/raw/guides/migrations/upgrade-to-v1/client.mdx +170 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/deployment.mdx +42 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/mastra.mdx +0 -35
- package/.docs/raw/guides/migrations/upgrade-to-v1/memory.mdx +40 -3
- package/.docs/raw/guides/migrations/upgrade-to-v1/overview.mdx +17 -2
- package/.docs/raw/guides/migrations/upgrade-to-v1/processors.mdx +11 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/rag.mdx +47 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/storage.mdx +271 -25
- package/.docs/raw/guides/migrations/upgrade-to-v1/tracing.mdx +72 -17
- package/.docs/raw/guides/migrations/upgrade-to-v1/vectors.mdx +46 -1
- package/.docs/raw/guides/migrations/upgrade-to-v1/workflows.mdx +50 -7
- package/.docs/raw/guides/migrations/vnext-to-standard-apis.mdx +21 -23
- package/.docs/raw/index.mdx +2 -2
- package/.docs/raw/mastra-cloud/deployment.mdx +86 -0
- package/.docs/raw/mastra-cloud/observability.mdx +43 -0
- package/.docs/raw/mastra-cloud/overview.mdx +31 -0
- package/.docs/raw/mastra-cloud/setup.mdx +64 -0
- package/.docs/raw/mastra-cloud/studio.mdx +35 -0
- package/.docs/raw/mcp/overview.mdx +60 -25
- package/.docs/raw/mcp/publishing-mcp-server.mdx +7 -4
- package/.docs/raw/memory/memory-processors.mdx +17 -12
- package/.docs/raw/memory/message-history.mdx +72 -0
- package/.docs/raw/memory/overview.mdx +38 -76
- package/.docs/raw/memory/semantic-recall.mdx +65 -52
- package/.docs/raw/memory/storage.mdx +248 -0
- package/.docs/raw/memory/working-memory.mdx +24 -13
- package/.docs/raw/observability/logging.mdx +16 -15
- package/.docs/raw/observability/overview.mdx +27 -7
- package/.docs/raw/observability/tracing/bridges/otel.mdx +7 -4
- package/.docs/raw/observability/tracing/exporters/arize.mdx +61 -24
- package/.docs/raw/observability/tracing/exporters/braintrust.mdx +32 -22
- package/.docs/raw/observability/tracing/exporters/cloud.mdx +24 -5
- package/.docs/raw/observability/tracing/exporters/datadog.mdx +175 -0
- package/.docs/raw/observability/tracing/exporters/default.mdx +28 -7
- package/.docs/raw/observability/tracing/exporters/laminar.mdx +89 -0
- package/.docs/raw/observability/tracing/exporters/langfuse.mdx +31 -22
- package/.docs/raw/observability/tracing/exporters/langsmith.mdx +33 -3
- package/.docs/raw/observability/tracing/exporters/otel.mdx +194 -22
- package/.docs/raw/observability/tracing/exporters/posthog.mdx +32 -22
- package/.docs/raw/observability/tracing/exporters/sentry.mdx +198 -0
- package/.docs/raw/observability/tracing/overview.mdx +388 -108
- package/.docs/raw/observability/tracing/processors/sensitive-data-filter.mdx +27 -7
- package/.docs/raw/rag/chunking-and-embedding.mdx +22 -33
- package/.docs/raw/rag/graph-rag.mdx +223 -0
- package/.docs/raw/rag/overview.mdx +6 -3
- package/.docs/raw/rag/retrieval.mdx +53 -57
- package/.docs/raw/rag/vector-databases.mdx +55 -31
- package/.docs/raw/reference/agents/agent.mdx +17 -14
- package/.docs/raw/reference/agents/generate.mdx +172 -44
- package/.docs/raw/reference/agents/generateLegacy.mdx +5 -3
- package/.docs/raw/reference/agents/getDefaultGenerateOptions.mdx +5 -3
- package/.docs/raw/reference/agents/getDefaultOptions.mdx +5 -3
- package/.docs/raw/reference/agents/getDefaultStreamOptions.mdx +5 -3
- package/.docs/raw/reference/agents/getDescription.mdx +3 -1
- package/.docs/raw/reference/agents/getInstructions.mdx +5 -3
- package/.docs/raw/reference/agents/getLLM.mdx +5 -3
- package/.docs/raw/reference/agents/getMemory.mdx +5 -3
- package/.docs/raw/reference/agents/getModel.mdx +5 -3
- package/.docs/raw/reference/agents/getTools.mdx +4 -2
- package/.docs/raw/reference/agents/getVoice.mdx +4 -2
- package/.docs/raw/reference/agents/listAgents.mdx +4 -2
- package/.docs/raw/reference/agents/listScorers.mdx +5 -3
- package/.docs/raw/reference/agents/listTools.mdx +4 -2
- package/.docs/raw/reference/agents/listWorkflows.mdx +4 -2
- package/.docs/raw/reference/agents/network.mdx +113 -1
- package/.docs/raw/reference/ai-sdk/chat-route.mdx +6 -3
- package/.docs/raw/reference/ai-sdk/handle-chat-stream.mdx +4 -2
- package/.docs/raw/reference/ai-sdk/handle-network-stream.mdx +4 -2
- package/.docs/raw/reference/ai-sdk/handle-workflow-stream.mdx +5 -3
- package/.docs/raw/reference/ai-sdk/network-route.mdx +6 -3
- package/.docs/raw/reference/ai-sdk/to-ai-sdk-stream.mdx +10 -6
- package/.docs/raw/reference/ai-sdk/to-ai-sdk-v4-messages.mdx +130 -0
- package/.docs/raw/reference/ai-sdk/to-ai-sdk-v5-messages.mdx +110 -0
- package/.docs/raw/reference/ai-sdk/with-mastra.mdx +122 -0
- package/.docs/raw/reference/ai-sdk/workflow-route.mdx +7 -4
- package/.docs/raw/reference/auth/auth0.mdx +5 -3
- package/.docs/raw/reference/auth/clerk.mdx +5 -3
- package/.docs/raw/reference/auth/firebase.mdx +6 -5
- package/.docs/raw/reference/auth/jwt.mdx +5 -3
- package/.docs/raw/reference/auth/supabase.mdx +5 -3
- package/.docs/raw/reference/auth/workos.mdx +5 -3
- package/.docs/raw/reference/cli/create-mastra.mdx +12 -10
- package/.docs/raw/reference/cli/mastra.mdx +63 -15
- package/.docs/raw/reference/client-js/agents.mdx +77 -35
- package/.docs/raw/reference/client-js/error-handling.mdx +3 -3
- package/.docs/raw/reference/client-js/logs.mdx +2 -0
- package/.docs/raw/reference/client-js/mastra-client.mdx +4 -2
- package/.docs/raw/reference/client-js/memory.mdx +43 -1
- package/.docs/raw/reference/client-js/observability.mdx +2 -0
- package/.docs/raw/reference/client-js/telemetry.mdx +2 -0
- package/.docs/raw/reference/client-js/tools.mdx +2 -0
- package/.docs/raw/reference/client-js/vectors.mdx +2 -0
- package/.docs/raw/reference/client-js/workflows.mdx +47 -3
- package/.docs/raw/reference/configuration.mdx +761 -0
- package/.docs/raw/reference/core/addGateway.mdx +2 -0
- package/.docs/raw/reference/core/getAgent.mdx +3 -1
- package/.docs/raw/reference/core/getAgentById.mdx +3 -1
- package/.docs/raw/reference/core/getDeployer.mdx +3 -1
- package/.docs/raw/reference/core/getGateway.mdx +2 -0
- package/.docs/raw/reference/core/getGatewayById.mdx +2 -0
- package/.docs/raw/reference/core/getLogger.mdx +3 -1
- package/.docs/raw/reference/core/getMCPServer.mdx +3 -1
- package/.docs/raw/reference/core/getMCPServerById.mdx +3 -1
- package/.docs/raw/reference/core/getMemory.mdx +7 -3
- package/.docs/raw/reference/core/getScorer.mdx +2 -0
- package/.docs/raw/reference/core/getScorerById.mdx +2 -0
- package/.docs/raw/reference/core/getServer.mdx +6 -4
- package/.docs/raw/reference/core/getStorage.mdx +5 -3
- package/.docs/raw/reference/core/getStoredAgentById.mdx +6 -4
- package/.docs/raw/reference/core/getTelemetry.mdx +3 -1
- package/.docs/raw/reference/core/getVector.mdx +3 -1
- package/.docs/raw/reference/core/getWorkflow.mdx +3 -1
- package/.docs/raw/reference/core/listAgents.mdx +3 -1
- package/.docs/raw/reference/core/listGateways.mdx +2 -0
- package/.docs/raw/reference/core/listLogs.mdx +3 -1
- package/.docs/raw/reference/core/listLogsByRunId.mdx +3 -1
- package/.docs/raw/reference/core/listMCPServers.mdx +3 -1
- package/.docs/raw/reference/core/listMemory.mdx +8 -4
- package/.docs/raw/reference/core/listScorers.mdx +2 -0
- package/.docs/raw/reference/core/listStoredAgents.mdx +7 -5
- package/.docs/raw/reference/core/listVectors.mdx +3 -1
- package/.docs/raw/reference/core/listWorkflows.mdx +3 -1
- package/.docs/raw/reference/core/mastra-class.mdx +27 -20
- package/.docs/raw/reference/core/mastra-model-gateway.mdx +2 -0
- package/.docs/raw/reference/core/setLogger.mdx +3 -1
- package/.docs/raw/reference/core/setStorage.mdx +6 -4
- package/.docs/raw/reference/deployer/cloudflare.mdx +22 -53
- package/.docs/raw/reference/deployer/deployer.mdx +2 -1
- package/.docs/raw/reference/deployer/netlify.mdx +4 -1
- package/.docs/raw/reference/deployer/vercel.mdx +5 -4
- package/.docs/raw/reference/evals/answer-relevancy.mdx +4 -1
- package/.docs/raw/reference/evals/answer-similarity.mdx +4 -1
- package/.docs/raw/reference/evals/bias.mdx +4 -1
- package/.docs/raw/reference/evals/completeness.mdx +4 -1
- package/.docs/raw/reference/evals/content-similarity.mdx +4 -1
- package/.docs/raw/reference/evals/context-precision.mdx +4 -1
- package/.docs/raw/reference/evals/context-relevance.mdx +2 -0
- package/.docs/raw/reference/evals/create-scorer.mdx +11 -3
- package/.docs/raw/reference/evals/faithfulness.mdx +4 -1
- package/.docs/raw/reference/evals/hallucination.mdx +4 -1
- package/.docs/raw/reference/evals/keyword-coverage.mdx +4 -1
- package/.docs/raw/reference/evals/mastra-scorer.mdx +2 -0
- package/.docs/raw/reference/evals/noise-sensitivity.mdx +2 -0
- package/.docs/raw/reference/evals/prompt-alignment.mdx +9 -7
- package/.docs/raw/reference/evals/run-evals.mdx +3 -1
- package/.docs/raw/reference/evals/scorer-utils.mdx +3 -0
- package/.docs/raw/reference/evals/textual-difference.mdx +4 -1
- package/.docs/raw/reference/evals/tone-consistency.mdx +4 -1
- package/.docs/raw/reference/evals/tool-call-accuracy.mdx +25 -23
- package/.docs/raw/reference/evals/toxicity.mdx +4 -1
- package/.docs/raw/reference/index.mdx +2 -1
- package/.docs/raw/reference/logging/pino-logger.mdx +10 -8
- package/.docs/raw/reference/memory/clone-utilities.mdx +345 -0
- package/.docs/raw/reference/memory/cloneThread.mdx +237 -0
- package/.docs/raw/reference/memory/createThread.mdx +6 -4
- package/.docs/raw/reference/memory/deleteMessages.mdx +4 -2
- package/.docs/raw/reference/memory/getThreadById.mdx +3 -1
- package/.docs/raw/reference/memory/listThreads.mdx +187 -0
- package/.docs/raw/reference/memory/memory-class.mdx +27 -20
- package/.docs/raw/reference/memory/recall.mdx +6 -4
- package/.docs/raw/reference/observability/tracing/bridges/otel.mdx +6 -2
- package/.docs/raw/reference/observability/tracing/configuration.mdx +51 -0
- package/.docs/raw/reference/observability/tracing/exporters/arize.mdx +25 -6
- package/.docs/raw/reference/observability/tracing/exporters/braintrust.mdx +23 -2
- package/.docs/raw/reference/observability/tracing/exporters/cloud-exporter.mdx +10 -0
- package/.docs/raw/reference/observability/tracing/exporters/console-exporter.mdx +3 -0
- package/.docs/raw/reference/observability/tracing/exporters/datadog.mdx +172 -0
- package/.docs/raw/reference/observability/tracing/exporters/default-exporter.mdx +10 -0
- package/.docs/raw/reference/observability/tracing/exporters/laminar.mdx +139 -0
- package/.docs/raw/reference/observability/tracing/exporters/langfuse.mdx +26 -4
- package/.docs/raw/reference/observability/tracing/exporters/langsmith.mdx +10 -0
- package/.docs/raw/reference/observability/tracing/exporters/otel.mdx +51 -34
- package/.docs/raw/reference/observability/tracing/exporters/posthog.mdx +25 -4
- package/.docs/raw/reference/observability/tracing/exporters/sentry.mdx +224 -0
- package/.docs/raw/reference/observability/tracing/instances.mdx +2 -0
- package/.docs/raw/reference/observability/tracing/interfaces.mdx +20 -0
- package/.docs/raw/reference/observability/tracing/processors/sensitive-data-filter.mdx +2 -0
- package/.docs/raw/reference/observability/tracing/spans.mdx +2 -0
- package/.docs/raw/reference/processors/batch-parts-processor.mdx +4 -2
- package/.docs/raw/reference/processors/language-detector.mdx +6 -3
- package/.docs/raw/reference/processors/message-history-processor.mdx +5 -2
- package/.docs/raw/reference/processors/moderation-processor.mdx +6 -4
- package/.docs/raw/reference/processors/pii-detector.mdx +6 -4
- package/.docs/raw/reference/processors/processor-interface.mdx +326 -23
- package/.docs/raw/reference/processors/prompt-injection-detector.mdx +5 -3
- package/.docs/raw/reference/processors/semantic-recall-processor.mdx +7 -2
- package/.docs/raw/reference/processors/system-prompt-scrubber.mdx +5 -3
- package/.docs/raw/reference/processors/token-limiter-processor.mdx +62 -19
- package/.docs/raw/reference/processors/tool-call-filter.mdx +5 -3
- package/.docs/raw/reference/processors/unicode-normalizer.mdx +6 -3
- package/.docs/raw/reference/processors/working-memory-processor.mdx +6 -3
- package/.docs/raw/reference/rag/chunk.mdx +7 -6
- package/.docs/raw/reference/rag/database-config.mdx +8 -6
- package/.docs/raw/reference/rag/document.mdx +2 -0
- package/.docs/raw/reference/rag/embeddings.mdx +2 -0
- package/.docs/raw/reference/rag/extract-params.mdx +57 -3
- package/.docs/raw/reference/rag/graph-rag.mdx +2 -0
- package/.docs/raw/reference/rag/metadata-filters.mdx +27 -7
- package/.docs/raw/reference/rag/rerank.mdx +2 -0
- package/.docs/raw/reference/rag/rerankWithScorer.mdx +2 -0
- package/.docs/raw/reference/server/create-route.mdx +34 -18
- package/.docs/raw/reference/server/express-adapter.mdx +27 -51
- package/.docs/raw/reference/server/fastify-adapter.mdx +130 -0
- package/.docs/raw/reference/server/hono-adapter.mdx +27 -51
- package/.docs/raw/reference/server/koa-adapter.mdx +129 -0
- package/.docs/raw/reference/server/mastra-server.mdx +52 -34
- package/.docs/raw/reference/server/routes.mdx +73 -10
- package/.docs/raw/reference/storage/cloudflare-d1.mdx +10 -5
- package/.docs/raw/reference/storage/cloudflare.mdx +12 -2
- package/.docs/raw/reference/storage/composite.mdx +245 -0
- package/.docs/raw/reference/storage/convex.mdx +8 -6
- package/.docs/raw/reference/storage/dynamodb.mdx +134 -8
- package/.docs/raw/reference/storage/lance.mdx +9 -5
- package/.docs/raw/reference/storage/libsql.mdx +76 -54
- package/.docs/raw/reference/storage/mongodb.mdx +115 -16
- package/.docs/raw/reference/storage/mssql.mdx +11 -6
- package/.docs/raw/{server-db/storage.mdx → reference/storage/overview.mdx} +15 -111
- package/.docs/raw/reference/storage/postgresql.mdx +228 -83
- package/.docs/raw/reference/storage/upstash.mdx +78 -2
- package/.docs/raw/reference/streaming/ChunkType.mdx +31 -3
- package/.docs/raw/reference/streaming/agents/MastraModelOutput.mdx +67 -6
- package/.docs/raw/reference/streaming/agents/stream.mdx +48 -51
- package/.docs/raw/reference/streaming/agents/streamLegacy.mdx +5 -3
- package/.docs/raw/reference/streaming/workflows/observeStream.mdx +3 -1
- package/.docs/raw/reference/streaming/workflows/resumeStream.mdx +3 -1
- package/.docs/raw/reference/streaming/workflows/stream.mdx +37 -22
- package/.docs/raw/reference/streaming/workflows/timeTravelStream.mdx +6 -4
- package/.docs/raw/reference/templates/overview.mdx +3 -2
- package/.docs/raw/reference/tools/client.mdx +3 -0
- package/.docs/raw/reference/tools/create-tool.mdx +127 -5
- package/.docs/raw/reference/tools/document-chunker-tool.mdx +2 -0
- package/.docs/raw/reference/tools/graph-rag-tool.mdx +40 -3
- package/.docs/raw/reference/tools/mcp-client.mdx +110 -1
- package/.docs/raw/reference/tools/mcp-server.mdx +278 -24
- package/.docs/raw/reference/tools/vector-query-tool.mdx +68 -4
- package/.docs/raw/reference/vectors/astra.mdx +5 -3
- package/.docs/raw/reference/vectors/chroma.mdx +5 -3
- package/.docs/raw/reference/vectors/convex.mdx +14 -12
- package/.docs/raw/reference/vectors/couchbase.mdx +7 -5
- package/.docs/raw/reference/vectors/duckdb.mdx +12 -10
- package/.docs/raw/reference/vectors/elasticsearch.mdx +12 -4
- package/.docs/raw/reference/vectors/lance.mdx +6 -4
- package/.docs/raw/reference/vectors/libsql.mdx +66 -13
- package/.docs/raw/reference/vectors/mongodb.mdx +90 -10
- package/.docs/raw/reference/vectors/opensearch.mdx +30 -3
- package/.docs/raw/reference/vectors/pg.mdx +58 -6
- package/.docs/raw/reference/vectors/pinecone.mdx +23 -8
- package/.docs/raw/reference/vectors/qdrant.mdx +148 -4
- package/.docs/raw/reference/vectors/s3vectors.mdx +8 -6
- package/.docs/raw/reference/vectors/turbopuffer.mdx +6 -4
- package/.docs/raw/reference/vectors/upstash.mdx +60 -6
- package/.docs/raw/reference/vectors/vectorize.mdx +5 -3
- package/.docs/raw/reference/voice/azure.mdx +2 -0
- package/.docs/raw/reference/voice/cloudflare.mdx +2 -0
- package/.docs/raw/reference/voice/composite-voice.mdx +4 -0
- package/.docs/raw/reference/voice/deepgram.mdx +2 -0
- package/.docs/raw/reference/voice/elevenlabs.mdx +2 -0
- package/.docs/raw/reference/voice/google-gemini-live.mdx +3 -0
- package/.docs/raw/reference/voice/google.mdx +2 -0
- package/.docs/raw/reference/voice/mastra-voice.mdx +2 -0
- package/.docs/raw/reference/voice/murf.mdx +2 -0
- package/.docs/raw/reference/voice/openai-realtime.mdx +3 -0
- package/.docs/raw/reference/voice/openai.mdx +2 -0
- package/.docs/raw/reference/voice/playai.mdx +2 -0
- package/.docs/raw/reference/voice/sarvam.mdx +2 -0
- package/.docs/raw/reference/voice/speechify.mdx +2 -0
- package/.docs/raw/reference/voice/voice.addInstructions.mdx +3 -0
- package/.docs/raw/reference/voice/voice.addTools.mdx +3 -0
- package/.docs/raw/reference/voice/voice.answer.mdx +4 -0
- package/.docs/raw/reference/voice/voice.close.mdx +3 -0
- package/.docs/raw/reference/voice/voice.connect.mdx +5 -1
- package/.docs/raw/reference/voice/voice.events.mdx +2 -0
- package/.docs/raw/reference/voice/voice.getSpeakers.mdx +3 -0
- package/.docs/raw/reference/voice/voice.listen.mdx +6 -0
- package/.docs/raw/reference/voice/voice.off.mdx +2 -0
- package/.docs/raw/reference/voice/voice.on.mdx +5 -1
- package/.docs/raw/reference/voice/voice.send.mdx +4 -0
- package/.docs/raw/reference/voice/voice.speak.mdx +6 -0
- package/.docs/raw/reference/voice/voice.updateConfig.mdx +2 -0
- package/.docs/raw/reference/workflows/run-methods/cancel.mdx +55 -5
- package/.docs/raw/reference/workflows/run-methods/restart.mdx +3 -3
- package/.docs/raw/reference/workflows/run-methods/resume.mdx +6 -4
- package/.docs/raw/reference/workflows/run-methods/start.mdx +7 -5
- package/.docs/raw/reference/workflows/run-methods/startAsync.mdx +145 -0
- package/.docs/raw/reference/workflows/run-methods/timeTravel.mdx +10 -8
- package/.docs/raw/reference/workflows/run.mdx +11 -3
- package/.docs/raw/reference/workflows/step.mdx +56 -3
- package/.docs/raw/reference/workflows/workflow-methods/branch.mdx +3 -1
- package/.docs/raw/reference/workflows/workflow-methods/commit.mdx +3 -1
- package/.docs/raw/reference/workflows/workflow-methods/create-run.mdx +39 -2
- package/.docs/raw/reference/workflows/workflow-methods/dountil.mdx +3 -1
- package/.docs/raw/reference/workflows/workflow-methods/dowhile.mdx +3 -1
- package/.docs/raw/reference/workflows/workflow-methods/foreach.mdx +71 -4
- package/.docs/raw/reference/workflows/workflow-methods/map.mdx +9 -7
- package/.docs/raw/reference/workflows/workflow-methods/parallel.mdx +3 -1
- package/.docs/raw/reference/workflows/workflow-methods/sleep.mdx +4 -6
- package/.docs/raw/reference/workflows/workflow-methods/sleepUntil.mdx +4 -6
- package/.docs/raw/reference/workflows/workflow-methods/then.mdx +3 -1
- package/.docs/raw/reference/workflows/workflow.mdx +193 -2
- package/.docs/raw/{auth → server/auth}/auth0.mdx +40 -21
- package/.docs/raw/{auth → server/auth}/clerk.mdx +37 -16
- package/.docs/raw/{auth → server/auth}/firebase.mdx +47 -25
- package/.docs/raw/{auth → server/auth}/index.mdx +8 -6
- package/.docs/raw/{auth → server/auth}/jwt.mdx +22 -10
- package/.docs/raw/{auth → server/auth}/supabase.mdx +45 -25
- package/.docs/raw/{auth → server/auth}/workos.mdx +39 -20
- package/.docs/raw/{server-db → server}/custom-adapters.mdx +40 -24
- package/.docs/raw/{server-db → server}/custom-api-routes.mdx +6 -6
- package/.docs/raw/{server-db → server}/mastra-client.mdx +35 -38
- package/.docs/raw/server/mastra-server.mdx +86 -0
- package/.docs/raw/{server-db → server}/middleware.mdx +11 -9
- package/.docs/raw/{server-db → server}/request-context.mdx +85 -43
- package/.docs/raw/{server-db → server}/server-adapters.mdx +154 -33
- package/.docs/raw/streaming/events.mdx +16 -7
- package/.docs/raw/streaming/overview.mdx +30 -17
- package/.docs/raw/streaming/tool-streaming.mdx +8 -6
- package/.docs/raw/streaming/workflow-streaming.mdx +8 -8
- package/.docs/raw/tools-mcp/advanced-usage.mdx +4 -2
- package/.docs/raw/tools-mcp/mcp-overview.mdx +46 -12
- package/.docs/raw/tools-mcp/overview.mdx +14 -13
- package/.docs/raw/voice/overview.mdx +17 -2
- package/.docs/raw/voice/speech-to-speech.mdx +5 -0
- package/.docs/raw/voice/speech-to-text.mdx +4 -0
- package/.docs/raw/voice/text-to-speech.mdx +3 -0
- package/.docs/raw/workflows/agents-and-tools.mdx +70 -21
- package/.docs/raw/workflows/control-flow.mdx +369 -34
- package/.docs/raw/workflows/error-handling.mdx +192 -18
- package/.docs/raw/workflows/human-in-the-loop.mdx +8 -7
- package/.docs/raw/workflows/input-data-mapping.mdx +9 -7
- package/.docs/raw/workflows/overview.mdx +80 -34
- package/.docs/raw/workflows/snapshots.mdx +19 -45
- package/.docs/raw/workflows/suspend-and-resume.mdx +14 -14
- package/.docs/raw/workflows/time-travel.mdx +25 -21
- package/.docs/raw/workflows/workflow-state.mdx +7 -8
- package/CHANGELOG.md +246 -0
- package/README.md +36 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/logger.d.ts +3 -0
- package/dist/logger.d.ts.map +1 -1
- package/dist/stdio.js +746 -49
- package/dist/tools/course.d.ts.map +1 -1
- package/dist/tools/embedded-docs.d.ts +276 -0
- package/dist/tools/embedded-docs.d.ts.map +1 -0
- package/package.json +9 -8
- package/.docs/organized/changelogs/%40internal%2Fai-sdk-v4.md +0 -1
- package/.docs/raw/deployment/building-mastra.mdx +0 -73
- package/.docs/raw/deployment/cloud-providers/index.mdx +0 -55
- package/.docs/raw/deployment/mastra-cloud/dashboard.mdx +0 -100
- package/.docs/raw/deployment/mastra-cloud/observability.mdx +0 -53
- package/.docs/raw/deployment/mastra-cloud/overview.mdx +0 -65
- package/.docs/raw/deployment/mastra-cloud/setting-up.mdx +0 -105
- package/.docs/raw/memory/conversation-history.mdx +0 -24
- package/.docs/raw/memory/storage/memory-with-libsql.mdx +0 -140
- package/.docs/raw/memory/storage/memory-with-mongodb.mdx +0 -150
- package/.docs/raw/memory/storage/memory-with-pg.mdx +0 -138
- package/.docs/raw/memory/storage/memory-with-upstash.mdx +0 -146
- package/.docs/raw/memory/threads-and-resources.mdx +0 -95
- package/.docs/raw/reference/core/setTelemetry.mdx +0 -36
- package/.docs/raw/reference/memory/listThreadsByResourceId.mdx +0 -110
- package/.docs/raw/reference/memory/query.mdx +0 -189
- package/.docs/raw/reference/workflows/workflow-methods/sendEvent.mdx +0 -70
- package/.docs/raw/reference/workflows/workflow-methods/waitForEvent.mdx +0 -66
- package/.docs/raw/server-db/mastra-server.mdx +0 -97
- package/.docs/raw/workflows/inngest-workflow.mdx +0 -363
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Reference: Prompt Alignment Scorer | Evals"
|
|
3
3
|
description: Documentation for the Prompt Alignment Scorer in Mastra. Evaluates how well agent responses align with user prompt intent, requirements, completeness, and appropriateness using multi-dimensional analysis.
|
|
4
|
+
packages:
|
|
5
|
+
- "@mastra/evals"
|
|
4
6
|
---
|
|
5
7
|
|
|
6
8
|
import PropertiesTable from "@site/src/components/PropertiesTable";
|
|
@@ -107,7 +109,7 @@ The `createPromptAlignmentScorerLLM()` function creates a scorer that evaluates
|
|
|
107
109
|
|
|
108
110
|
You can customize the Prompt Alignment Scorer by adjusting the scale parameter and evaluation mode to fit your scoring needs.
|
|
109
111
|
|
|
110
|
-
```typescript
|
|
112
|
+
```typescript
|
|
111
113
|
const scorer = createPromptAlignmentScorerLLM({
|
|
112
114
|
model: "openai/gpt-5.1",
|
|
113
115
|
options: {
|
|
@@ -417,7 +419,7 @@ const result = await scorer.run({
|
|
|
417
419
|
|
|
418
420
|
In this example, the response fully addresses the user's prompt with all requirements met.
|
|
419
421
|
|
|
420
|
-
```typescript title="src/example-excellent-prompt-alignment.ts"
|
|
422
|
+
```typescript title="src/example-excellent-prompt-alignment.ts"
|
|
421
423
|
import { createPromptAlignmentScorerLLM } from "@mastra/evals/scorers/prebuilt";
|
|
422
424
|
|
|
423
425
|
const scorer = createPromptAlignmentScorerLLM({
|
|
@@ -465,7 +467,7 @@ The output receives a high score because it perfectly addresses the intent, fulf
|
|
|
465
467
|
|
|
466
468
|
In this example, the response addresses the core intent but misses some requirements or has format issues.
|
|
467
469
|
|
|
468
|
-
```typescript title="src/example-partial-prompt-alignment.ts"
|
|
470
|
+
```typescript title="src/example-partial-prompt-alignment.ts"
|
|
469
471
|
import { createPromptAlignmentScorerLLM } from "@mastra/evals/scorers/prebuilt";
|
|
470
472
|
|
|
471
473
|
const scorer = createPromptAlignmentScorerLLM({
|
|
@@ -506,7 +508,7 @@ The output receives a lower score because while the content is accurate, it does
|
|
|
506
508
|
|
|
507
509
|
In this example, the response fails to address the user's specific requirements.
|
|
508
510
|
|
|
509
|
-
```typescript title="src/example-poor-prompt-alignment.ts"
|
|
511
|
+
```typescript title="src/example-poor-prompt-alignment.ts"
|
|
510
512
|
import { createPromptAlignmentScorerLLM } from "@mastra/evals/scorers/prebuilt";
|
|
511
513
|
|
|
512
514
|
const scorer = createPromptAlignmentScorerLLM({
|
|
@@ -552,7 +554,7 @@ The output receives a low score because it only partially fulfills the requireme
|
|
|
552
554
|
|
|
553
555
|
Evaluates how well the response addresses the user's request, ignoring system instructions:
|
|
554
556
|
|
|
555
|
-
```typescript title="src/example-user-mode.ts"
|
|
557
|
+
```typescript title="src/example-user-mode.ts"
|
|
556
558
|
const scorer = createPromptAlignmentScorerLLM({
|
|
557
559
|
model: "openai/gpt-5.1",
|
|
558
560
|
options: { evaluationMode: "user" },
|
|
@@ -584,7 +586,7 @@ const result = await scorer.run({
|
|
|
584
586
|
|
|
585
587
|
Evaluates compliance with system behavioral guidelines and constraints:
|
|
586
588
|
|
|
587
|
-
```typescript title="src/example-system-mode.ts"
|
|
589
|
+
```typescript title="src/example-system-mode.ts"
|
|
588
590
|
const scorer = createPromptAlignmentScorerLLM({
|
|
589
591
|
model: "openai/gpt-5.1",
|
|
590
592
|
options: { evaluationMode: "system" },
|
|
@@ -617,7 +619,7 @@ const result = await scorer.run({
|
|
|
617
619
|
|
|
618
620
|
Evaluates both user intent fulfillment and system compliance with weighted scoring (70% user, 30% system):
|
|
619
621
|
|
|
620
|
-
```typescript title="src/example-both-mode.ts"
|
|
622
|
+
```typescript title="src/example-both-mode.ts"
|
|
621
623
|
const scorer = createPromptAlignmentScorerLLM({
|
|
622
624
|
model: "openai/gpt-5.1",
|
|
623
625
|
options: { evaluationMode: "both" }, // This is the default
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Reference: runEvals | Evals"
|
|
3
3
|
description: "Documentation for the runEvals function in Mastra, which enables batch evaluation of agents and workflows using multiple scorers."
|
|
4
|
+
packages:
|
|
5
|
+
- "@mastra/core"
|
|
4
6
|
---
|
|
5
7
|
|
|
6
8
|
# runEvals
|
|
@@ -160,7 +162,7 @@ For workflows, you can specify scorers at different levels using `WorkflowScorer
|
|
|
160
162
|
import { createScorer, runEvals } from "@mastra/core/evals";
|
|
161
163
|
|
|
162
164
|
const myScorer = createScorer({
|
|
163
|
-
|
|
165
|
+
id: "my-scorer",
|
|
164
166
|
description: "Check if Agent's response contains ground truth",
|
|
165
167
|
type: "agent",
|
|
166
168
|
}).generateScore(({ run }) => {
|
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Reference: Scorer Utils | Evals"
|
|
3
3
|
description: Utility functions for extracting data from scorer run inputs and outputs, including text content, reasoning, system messages, and tool calls.
|
|
4
|
+
packages:
|
|
5
|
+
- "@mastra/core"
|
|
6
|
+
- "@mastra/evals"
|
|
4
7
|
---
|
|
5
8
|
|
|
6
9
|
# Scorer Utils
|
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Reference: Textual Difference Scorer | Evals"
|
|
3
3
|
description: Documentation for the Textual Difference Scorer in Mastra, which measures textual differences between strings using sequence matching.
|
|
4
|
+
packages:
|
|
5
|
+
- "@mastra/core"
|
|
6
|
+
- "@mastra/evals"
|
|
4
7
|
---
|
|
5
8
|
|
|
6
9
|
# Textual Difference Scorer
|
|
@@ -87,7 +90,7 @@ A textual difference score between 0 and 1:
|
|
|
87
90
|
|
|
88
91
|
Measure textual differences between expected and actual agent outputs:
|
|
89
92
|
|
|
90
|
-
```typescript title="src/example-textual-difference.ts"
|
|
93
|
+
```typescript title="src/example-textual-difference.ts"
|
|
91
94
|
import { runEvals } from "@mastra/core/evals";
|
|
92
95
|
import { createTextualDifferenceScorer } from "@mastra/evals/scorers/prebuilt";
|
|
93
96
|
import { myAgent } from "./agent";
|
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Reference: Tone Consistency Scorer | Evals"
|
|
3
3
|
description: Documentation for the Tone Consistency Scorer in Mastra, which evaluates emotional tone and sentiment consistency in text.
|
|
4
|
+
packages:
|
|
5
|
+
- "@mastra/core"
|
|
6
|
+
- "@mastra/evals"
|
|
4
7
|
---
|
|
5
8
|
|
|
6
9
|
# Tone Consistency Scorer
|
|
@@ -98,7 +101,7 @@ Object with tone metrics:
|
|
|
98
101
|
|
|
99
102
|
Evaluate tone consistency between related agent responses:
|
|
100
103
|
|
|
101
|
-
```typescript title="src/example-tone-consistency.ts"
|
|
104
|
+
```typescript title="src/example-tone-consistency.ts"
|
|
102
105
|
import { runEvals } from "@mastra/core/evals";
|
|
103
106
|
import { createToneScorer } from "@mastra/evals/scorers/prebuilt";
|
|
104
107
|
import { myAgent } from "./agent";
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Reference: Tool Call Accuracy Scorers | Evals"
|
|
3
3
|
description: Documentation for the Tool Call Accuracy Scorers in Mastra, which evaluate whether LLM outputs call the correct tools from available options.
|
|
4
|
+
packages:
|
|
5
|
+
- "@mastra/evals"
|
|
4
6
|
---
|
|
5
7
|
|
|
6
8
|
# Tool Call Accuracy Scorers
|
|
@@ -89,7 +91,7 @@ When `expectedToolOrder` is provided, the scorer validates tool calling sequence
|
|
|
89
91
|
|
|
90
92
|
### Code-Based Scorer Options
|
|
91
93
|
|
|
92
|
-
```typescript
|
|
94
|
+
```typescript
|
|
93
95
|
// Standard mode - passes if expected tool is called
|
|
94
96
|
const lenientScorer = createCodeScorer({
|
|
95
97
|
expectedTool: "search-tool",
|
|
@@ -135,14 +137,14 @@ The code-based scorer provides deterministic, binary scoring (0 or 1) based on e
|
|
|
135
137
|
|
|
136
138
|
### Correct tool selection
|
|
137
139
|
|
|
138
|
-
```typescript title="src/example-correct-tool.ts"
|
|
140
|
+
```typescript title="src/example-correct-tool.ts"
|
|
139
141
|
const scorer = createToolCallAccuracyScorerCode({
|
|
140
142
|
expectedTool: "weather-tool",
|
|
141
143
|
});
|
|
142
144
|
|
|
143
145
|
// Simulate LLM input and output with tool call
|
|
144
146
|
const inputMessages = [
|
|
145
|
-
|
|
147
|
+
createTestMessage({
|
|
146
148
|
content: "What is the weather like in New York today?",
|
|
147
149
|
role: "user",
|
|
148
150
|
id: "input-1",
|
|
@@ -150,7 +152,7 @@ const inputMessages = [
|
|
|
150
152
|
];
|
|
151
153
|
|
|
152
154
|
const output = [
|
|
153
|
-
|
|
155
|
+
createTestMessage({
|
|
154
156
|
content: "Let me check the weather for you.",
|
|
155
157
|
role: "assistant",
|
|
156
158
|
id: "output-1",
|
|
@@ -177,7 +179,7 @@ console.log(result.preprocessStepResult?.correctToolCalled); // true
|
|
|
177
179
|
|
|
178
180
|
Only passes if exactly one tool is called:
|
|
179
181
|
|
|
180
|
-
```typescript title="src/example-strict-mode.ts"
|
|
182
|
+
```typescript title="src/example-strict-mode.ts"
|
|
181
183
|
const strictScorer = createToolCallAccuracyScorerCode({
|
|
182
184
|
expectedTool: "weather-tool",
|
|
183
185
|
strictMode: true,
|
|
@@ -185,7 +187,7 @@ const strictScorer = createToolCallAccuracyScorerCode({
|
|
|
185
187
|
|
|
186
188
|
// Multiple tools called - fails in strict mode
|
|
187
189
|
const output = [
|
|
188
|
-
|
|
190
|
+
createTestMessage({
|
|
189
191
|
content: "Let me help you with that.",
|
|
190
192
|
role: "assistant",
|
|
191
193
|
id: "output-1",
|
|
@@ -216,7 +218,7 @@ console.log(result.score); // 0 - fails because multiple tools were called
|
|
|
216
218
|
|
|
217
219
|
Validates that tools are called in a specific sequence:
|
|
218
220
|
|
|
219
|
-
```typescript title="src/example-order-validation.ts"
|
|
221
|
+
```typescript title="src/example-order-validation.ts"
|
|
220
222
|
const orderScorer = createToolCallAccuracyScorerCode({
|
|
221
223
|
expectedTool: "auth-tool", // ignored when order is specified
|
|
222
224
|
expectedToolOrder: ["auth-tool", "fetch-tool"],
|
|
@@ -224,7 +226,7 @@ const orderScorer = createToolCallAccuracyScorerCode({
|
|
|
224
226
|
});
|
|
225
227
|
|
|
226
228
|
const output = [
|
|
227
|
-
|
|
229
|
+
createTestMessage({
|
|
228
230
|
content: "I will authenticate and fetch the data.",
|
|
229
231
|
role: "assistant",
|
|
230
232
|
id: "output-1",
|
|
@@ -255,7 +257,7 @@ console.log(result.score); // 1 - correct order
|
|
|
255
257
|
|
|
256
258
|
Allows extra tools as long as expected tools maintain relative order:
|
|
257
259
|
|
|
258
|
-
```typescript title="src/example-flexible-order.ts"
|
|
260
|
+
```typescript title="src/example-flexible-order.ts"
|
|
259
261
|
const flexibleOrderScorer = createToolCallAccuracyScorerCode({
|
|
260
262
|
expectedTool: "auth-tool",
|
|
261
263
|
expectedToolOrder: ["auth-tool", "fetch-tool"],
|
|
@@ -263,7 +265,7 @@ const flexibleOrderScorer = createToolCallAccuracyScorerCode({
|
|
|
263
265
|
});
|
|
264
266
|
|
|
265
267
|
const output = [
|
|
266
|
-
|
|
268
|
+
createTestMessage({
|
|
267
269
|
content: "Performing comprehensive operation.",
|
|
268
270
|
role: "assistant",
|
|
269
271
|
id: "output-1",
|
|
@@ -346,7 +348,7 @@ The LLM-based scorer provides:
|
|
|
346
348
|
|
|
347
349
|
### LLM-Based Scorer Options
|
|
348
350
|
|
|
349
|
-
```typescript
|
|
351
|
+
```typescript
|
|
350
352
|
// Basic configuration
|
|
351
353
|
const basicLLMScorer = createLLMScorer({
|
|
352
354
|
model: 'openai/gpt-5.1',
|
|
@@ -387,7 +389,7 @@ The LLM-based scorer uses AI to evaluate whether tool selections are appropriate
|
|
|
387
389
|
|
|
388
390
|
### Basic LLM evaluation
|
|
389
391
|
|
|
390
|
-
```typescript title="src/example-llm-basic.ts"
|
|
392
|
+
```typescript title="src/example-llm-basic.ts"
|
|
391
393
|
const llmScorer = createToolCallAccuracyScorerLLM({
|
|
392
394
|
model: "openai/gpt-5.1",
|
|
393
395
|
availableTools: [
|
|
@@ -407,7 +409,7 @@ const llmScorer = createToolCallAccuracyScorerLLM({
|
|
|
407
409
|
});
|
|
408
410
|
|
|
409
411
|
const inputMessages = [
|
|
410
|
-
|
|
412
|
+
createTestMessage({
|
|
411
413
|
content: "What is the weather like in San Francisco today?",
|
|
412
414
|
role: "user",
|
|
413
415
|
id: "input-1",
|
|
@@ -415,7 +417,7 @@ const inputMessages = [
|
|
|
415
417
|
];
|
|
416
418
|
|
|
417
419
|
const output = [
|
|
418
|
-
|
|
420
|
+
createTestMessage({
|
|
419
421
|
content: "Let me check the current weather for you.",
|
|
420
422
|
role: "assistant",
|
|
421
423
|
id: "output-1",
|
|
@@ -440,9 +442,9 @@ console.log(result.reason); // "The agent correctly used the weather-tool to add
|
|
|
440
442
|
|
|
441
443
|
### Handling inappropriate tool usage
|
|
442
444
|
|
|
443
|
-
```typescript title="src/example-llm-inappropriate.ts"
|
|
445
|
+
```typescript title="src/example-llm-inappropriate.ts"
|
|
444
446
|
const inputMessages = [
|
|
445
|
-
|
|
447
|
+
createTestMessage({
|
|
446
448
|
content: "What is the weather in Tokyo?",
|
|
447
449
|
role: "user",
|
|
448
450
|
id: "input-1",
|
|
@@ -450,7 +452,7 @@ const inputMessages = [
|
|
|
450
452
|
];
|
|
451
453
|
|
|
452
454
|
const inappropriateOutput = [
|
|
453
|
-
|
|
455
|
+
createTestMessage({
|
|
454
456
|
content: "Let me search for that information.",
|
|
455
457
|
role: "assistant",
|
|
456
458
|
id: "output-1",
|
|
@@ -477,9 +479,9 @@ console.log(result.reason); // "The agent used search-tool when weather-tool wou
|
|
|
477
479
|
|
|
478
480
|
The LLM scorer recognizes when agents appropriately ask for clarification:
|
|
479
481
|
|
|
480
|
-
```typescript title="src/example-llm-clarification.ts"
|
|
482
|
+
```typescript title="src/example-llm-clarification.ts"
|
|
481
483
|
const vagueInput = [
|
|
482
|
-
|
|
484
|
+
createTestMessage({
|
|
483
485
|
content: 'I need help with something',
|
|
484
486
|
role: 'user',
|
|
485
487
|
id: 'input-1'
|
|
@@ -487,7 +489,7 @@ const vagueInput = [
|
|
|
487
489
|
];
|
|
488
490
|
|
|
489
491
|
const clarificationOutput = [
|
|
490
|
-
|
|
492
|
+
createTestMessage({
|
|
491
493
|
content: 'I'd be happy to help! Could you please provide more details about what you need assistance with?',
|
|
492
494
|
role: 'assistant',
|
|
493
495
|
id: 'output-1',
|
|
@@ -509,7 +511,7 @@ console.log(result.reason); // "The agent appropriately asked for clarification
|
|
|
509
511
|
|
|
510
512
|
Here's an example using both scorers on the same data:
|
|
511
513
|
|
|
512
|
-
```typescript title="src/example-comparison.ts"
|
|
514
|
+
```typescript title="src/example-comparison.ts"
|
|
513
515
|
import {
|
|
514
516
|
createToolCallAccuracyScorerCode as createCodeScorer,
|
|
515
517
|
createToolCallAccuracyScorerLLM as createLLMScorer
|
|
@@ -532,14 +534,14 @@ const llmScorer = createLLMScorer({
|
|
|
532
534
|
// Test data
|
|
533
535
|
const run = createAgentTestRun({
|
|
534
536
|
inputMessages: [
|
|
535
|
-
|
|
537
|
+
createTestMessage({
|
|
536
538
|
content: "What is the weather?",
|
|
537
539
|
role: "user",
|
|
538
540
|
id: "input-1",
|
|
539
541
|
}),
|
|
540
542
|
],
|
|
541
543
|
output: [
|
|
542
|
-
|
|
544
|
+
createTestMessage({
|
|
543
545
|
content: "Let me find that information.",
|
|
544
546
|
role: "assistant",
|
|
545
547
|
id: "output-1",
|
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Reference: Toxicity Scorer | Evals"
|
|
3
3
|
description: Documentation for the Toxicity Scorer in Mastra, which evaluates LLM outputs for racist, biased, or toxic elements.
|
|
4
|
+
packages:
|
|
5
|
+
- "@mastra/core"
|
|
6
|
+
- "@mastra/evals"
|
|
4
7
|
---
|
|
5
8
|
|
|
6
9
|
# Toxicity Scorer
|
|
@@ -123,7 +126,7 @@ A toxicity score between 0 and 1:
|
|
|
123
126
|
|
|
124
127
|
Evaluate agent responses for toxic, biased, or harmful content:
|
|
125
128
|
|
|
126
|
-
```typescript title="src/example-toxicity.ts"
|
|
129
|
+
```typescript title="src/example-toxicity.ts"
|
|
127
130
|
import { runEvals } from "@mastra/core/evals";
|
|
128
131
|
import { createToxicityScorer } from "@mastra/evals/scorers/prebuilt";
|
|
129
132
|
import { myAgent } from "./agent";
|
|
@@ -1,22 +1,24 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Reference: PinoLogger | Observability"
|
|
3
3
|
description: Documentation for PinoLogger, which provides methods to record events at various severity levels.
|
|
4
|
+
packages:
|
|
5
|
+
- "@mastra/core"
|
|
6
|
+
- "@mastra/loggers"
|
|
4
7
|
---
|
|
5
8
|
|
|
6
9
|
# PinoLogger
|
|
7
10
|
|
|
8
11
|
A Logger instance is created using `new PinoLogger()` and provides methods to record events at various severity levels.
|
|
9
12
|
|
|
10
|
-
When deploying to Mastra Cloud, logs are displayed on the [Logs](/docs/v1/
|
|
13
|
+
When deploying to Mastra Cloud, logs are displayed on the [Logs](/docs/v1/mastra-cloud/observability#logs) page. In self-hosted or custom environments, logs can be directed to files or external services depending on the configured transports.
|
|
11
14
|
|
|
12
15
|
## Usage example
|
|
13
16
|
|
|
14
|
-
```typescript title="src/mastra/index.ts"
|
|
17
|
+
```typescript title="src/mastra/index.ts"
|
|
15
18
|
import { Mastra } from "@mastra/core";
|
|
16
19
|
import { PinoLogger } from "@mastra/loggers";
|
|
17
20
|
|
|
18
21
|
export const mastra = new Mastra({
|
|
19
|
-
// ...
|
|
20
22
|
logger: new PinoLogger({
|
|
21
23
|
name: "Mastra",
|
|
22
24
|
level: "info",
|
|
@@ -63,7 +65,7 @@ export const mastra = new Mastra({
|
|
|
63
65
|
|
|
64
66
|
Writes structured logs to a file using the `FileTransport`. The logger accepts a plain message as the first argument and structured metadata as the second argument. These are internally converted to a `BaseLogMessage` and persisted to the configured file path.
|
|
65
67
|
|
|
66
|
-
```typescript title="src/mastra/loggers/file-transport.ts"
|
|
68
|
+
```typescript title="src/mastra/loggers/file-transport.ts"
|
|
67
69
|
import { FileTransport } from "@mastra/loggers/file";
|
|
68
70
|
import { PinoLogger } from "@mastra/loggers/pino";
|
|
69
71
|
|
|
@@ -76,7 +78,7 @@ export const fileLogger = new PinoLogger({
|
|
|
76
78
|
|
|
77
79
|
### File transport usage
|
|
78
80
|
|
|
79
|
-
```typescript
|
|
81
|
+
```typescript
|
|
80
82
|
fileLogger.warn("Low disk space", {
|
|
81
83
|
destinationPath: "system",
|
|
82
84
|
type: "WORKFLOW",
|
|
@@ -87,7 +89,7 @@ fileLogger.warn("Low disk space", {
|
|
|
87
89
|
|
|
88
90
|
Streams structured logs to a remote Redis list using the `UpstashTransport`. The logger accepts a string message and a structured metadata object. This enables centralized logging for distributed environments, supporting filtering by `destinationPath`, `type`, and `runId`.
|
|
89
91
|
|
|
90
|
-
```typescript title="src/mastra/loggers/upstash-transport.ts"
|
|
92
|
+
```typescript title="src/mastra/loggers/upstash-transport.ts"
|
|
91
93
|
import { UpstashTransport } from "@mastra/loggers/upstash";
|
|
92
94
|
import { PinoLogger } from "@mastra/loggers/pino";
|
|
93
95
|
|
|
@@ -106,7 +108,7 @@ export const upstashLogger = new PinoLogger({
|
|
|
106
108
|
|
|
107
109
|
### Upstash transport usage
|
|
108
110
|
|
|
109
|
-
```typescript
|
|
111
|
+
```typescript
|
|
110
112
|
upstashLogger.info("User signed in", {
|
|
111
113
|
destinationPath: "auth",
|
|
112
114
|
type: "AGENT",
|
|
@@ -122,7 +124,7 @@ You can create custom transports using the `createCustomTransport` utility to in
|
|
|
122
124
|
|
|
123
125
|
Creates a custom transport using `createCustomTransport` and integrates it with a third-party logging stream such as `pino-sentry-transport`. This allows forwarding logs to an external system like Sentry for advanced monitoring and observability.
|
|
124
126
|
|
|
125
|
-
```typescript title="src/mastra/loggers/sentry-transport.ts"
|
|
127
|
+
```typescript title="src/mastra/loggers/sentry-transport.ts"
|
|
126
128
|
import { createCustomTransport } from "@mastra/core/loggers";
|
|
127
129
|
import { PinoLogger } from "@mastra/loggers/pino";
|
|
128
130
|
import pinoSentry from "pino-sentry-transport";
|