@mastra/mcp-docs-server 1.2.11 → 1.2.12-alpha.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.docs/docs/agent-builder/access-control.md +3 -3
- package/.docs/docs/agent-builder/browser.md +1 -1
- package/.docs/docs/agent-builder/channels.md +1 -1
- package/.docs/docs/agent-builder/configuration.md +3 -3
- package/.docs/docs/agent-builder/deploying.md +2 -2
- package/.docs/docs/agent-builder/integrations.md +8 -8
- package/.docs/docs/agent-builder/memory.md +2 -2
- package/.docs/docs/agent-builder/overview.md +1 -1
- package/.docs/docs/agent-controller/channels.md +8 -6
- package/.docs/docs/agent-controller/modes.md +6 -6
- package/.docs/docs/agent-controller/overview.md +13 -9
- package/.docs/docs/agent-controller/session.md +27 -9
- package/.docs/docs/agent-controller/subagents.md +9 -6
- package/.docs/docs/agent-controller/threads-and-state.md +12 -8
- package/.docs/docs/agent-controller/tool-approvals.md +7 -3
- package/.docs/docs/agents/a2a.md +4 -2
- package/.docs/docs/agents/acp.md +5 -5
- package/.docs/docs/agents/agent-approval.md +13 -11
- package/.docs/docs/agents/code-mode.md +29 -6
- package/.docs/docs/agents/guardrails.md +8 -8
- package/.docs/docs/agents/networks.md +2 -2
- package/.docs/docs/agents/overview.md +9 -7
- package/.docs/docs/agents/processors.md +15 -15
- package/.docs/docs/agents/skills.md +6 -6
- package/.docs/docs/agents/structured-output.md +6 -6
- package/.docs/docs/agents/supervisor-agents.md +19 -13
- package/.docs/docs/agents/using-tools.md +48 -21
- package/.docs/docs/browser/agent-browser.md +4 -4
- package/.docs/docs/browser/browser-viewer.md +2 -2
- package/.docs/docs/browser/firecrawl.md +1 -1
- package/.docs/docs/browser/overview.md +2 -2
- package/.docs/docs/browser/recording.md +1 -1
- package/.docs/docs/browser/stagehand.md +7 -7
- package/.docs/docs/capabilities/channels/discord.md +1 -1
- package/.docs/docs/capabilities/channels/other-adapters.md +1 -1
- package/.docs/docs/capabilities/channels/overview.md +9 -5
- package/.docs/docs/capabilities/channels/slack.md +2 -2
- package/.docs/docs/capabilities/channels/teams.md +1 -1
- package/.docs/docs/capabilities/channels/telegram.md +1 -1
- package/.docs/docs/capabilities/channels/whatsapp.md +1 -1
- package/.docs/docs/deployment/mastra-server.md +1 -1
- package/.docs/docs/deployment/overview.md +6 -2
- package/.docs/docs/deployment/sandbox.md +3 -1
- package/.docs/docs/deployment/workers.md +137 -0
- package/.docs/docs/editor/overview.md +37 -31
- package/.docs/docs/editor/prompts.md +8 -4
- package/.docs/docs/editor/tools.md +3 -3
- package/.docs/docs/evals/built-in-scorers.md +4 -4
- package/.docs/docs/evals/custom-scorers.md +5 -5
- package/.docs/docs/evals/datasets/running-experiments.md +7 -7
- package/.docs/docs/evals/evals-with-memory.md +4 -4
- package/.docs/docs/evals/gates-and-verdicts.md +4 -4
- package/.docs/docs/evals/multi-turn.md +12 -12
- package/.docs/docs/evals/overview.md +6 -4
- package/.docs/docs/evals/quick-checks.md +2 -2
- package/.docs/docs/getting-started/build-with-ai.md +6 -4
- package/.docs/docs/getting-started/file-based-agents.md +6 -4
- package/.docs/docs/getting-started/manual-install.md +1 -1
- package/.docs/docs/index.md +9 -90
- package/.docs/docs/long-running-agents/background-tasks.md +10 -10
- package/.docs/docs/long-running-agents/durable-agents.md +46 -5
- package/.docs/docs/long-running-agents/goals.md +15 -11
- package/.docs/docs/long-running-agents/schedules.md +3 -3
- package/.docs/docs/long-running-agents/signal-providers.md +8 -6
- package/.docs/docs/long-running-agents/signals.md +9 -5
- package/.docs/docs/mastra-platform/configuration.md +3 -3
- package/.docs/docs/mastra-platform/database.md +8 -8
- package/.docs/docs/mastra-platform/deploy.md +8 -4
- package/.docs/docs/mastra-platform/environments.md +8 -4
- package/.docs/docs/mastra-platform/github.md +3 -1
- package/.docs/docs/mastra-platform/server.md +1 -1
- package/.docs/docs/mastra-platform/studio.md +2 -2
- package/.docs/docs/mastra-platform/workspace.md +6 -6
- package/.docs/docs/mcp/mcp-apps.md +1 -1
- package/.docs/docs/mcp/overview.md +9 -9
- package/.docs/docs/memory/memory-processors.md +10 -10
- package/.docs/docs/memory/message-history.md +11 -5
- package/.docs/docs/memory/multi-user-threads.md +6 -6
- package/.docs/docs/memory/observational-memory.md +27 -25
- package/.docs/docs/memory/overview.md +10 -10
- package/.docs/docs/memory/semantic-recall.md +3 -3
- package/.docs/docs/memory/working-memory.md +8 -8
- package/.docs/docs/observability/integrations/bridges/datadog.md +6 -6
- package/.docs/docs/observability/integrations/bridges/otel.md +5 -5
- package/.docs/docs/observability/integrations/exporters/datadog.md +1 -1
- package/.docs/docs/observability/integrations/exporters/laminar.md +1 -1
- package/.docs/docs/observability/integrations/exporters/langfuse.md +3 -3
- package/.docs/docs/observability/integrations/exporters/langsmith.md +4 -4
- package/.docs/docs/observability/integrations/exporters/mastra-platform.md +1 -1
- package/.docs/docs/observability/integrations/exporters/mastra-storage.md +1 -1
- package/.docs/docs/observability/integrations/exporters/otel.md +26 -4
- package/.docs/docs/observability/integrations/exporters/sentry.md +1 -1
- package/.docs/docs/observability/integrations/overview.md +1 -1
- package/.docs/docs/observability/integrations/processors/sensitive-data-filter.md +1 -1
- package/.docs/docs/observability/logging.md +1 -1
- package/.docs/docs/observability/metrics/overview.md +1 -1
- package/.docs/docs/observability/metrics/querying.md +8 -8
- package/.docs/docs/observability/overview.md +4 -4
- package/.docs/docs/observability/tracing/overview.md +18 -12
- package/.docs/docs/rag/chunking-and-embedding.md +1 -1
- package/.docs/docs/rag/graph-rag.md +7 -7
- package/.docs/docs/rag/overview.md +2 -2
- package/.docs/docs/rag/retrieval.md +18 -18
- package/.docs/docs/rag/vector-databases.md +2 -2
- package/.docs/docs/server/auth/composite-auth.md +2 -2
- package/.docs/docs/server/auth/fga.md +6 -6
- package/.docs/docs/server/auth/firebase.md +2 -2
- package/.docs/docs/server/auth/simple-auth.md +1 -1
- package/.docs/docs/server/auth/workers.md +133 -0
- package/.docs/docs/server/custom-adapters.md +4 -4
- package/.docs/docs/server/mastra-client.md +3 -3
- package/.docs/docs/server/mastra-server.md +2 -2
- package/.docs/docs/server/middleware.md +1 -1
- package/.docs/docs/server/pubsub.md +7 -4
- package/.docs/docs/server/request-context.md +11 -11
- package/.docs/docs/server/server-adapters.md +2 -2
- package/.docs/docs/storage/overview.md +2 -2
- package/.docs/docs/studio/auth.md +5 -5
- package/.docs/docs/studio/deployment.md +1 -1
- package/.docs/docs/studio/observability.md +2 -2
- package/.docs/docs/studio/overview.md +11 -9
- package/.docs/docs/voice/overview.md +26 -26
- package/.docs/docs/voice/realtime-voice.md +8 -8
- package/.docs/docs/voice/speech-to-speech.md +9 -9
- package/.docs/docs/voice/speech-to-text.md +3 -3
- package/.docs/docs/voice/text-to-speech.md +6 -6
- package/.docs/docs/what-is-mastra.md +161 -0
- package/.docs/docs/workflows/agents-and-tools.md +3 -3
- package/.docs/docs/workflows/control-flow.md +10 -8
- package/.docs/docs/workflows/error-handling.md +2 -2
- package/.docs/docs/workflows/overview.md +7 -6
- package/.docs/docs/workflows/scheduled-workflows.md +12 -12
- package/.docs/docs/workflows/snapshots.md +3 -3
- package/.docs/docs/workflows/suspend-and-resume.md +1 -1
- package/.docs/docs/workflows/time-travel.md +3 -1
- package/.docs/docs/workflows/workflow-state.md +1 -1
- package/.docs/docs/workspace/filesystem.md +10 -10
- package/.docs/docs/workspace/lsp.md +1 -1
- package/.docs/docs/workspace/overview.md +12 -12
- package/.docs/docs/workspace/sandbox.md +9 -7
- package/.docs/docs/workspace/search.md +3 -3
- package/.docs/docs/workspace/skills.md +7 -7
- package/.docs/guides/build-your-ui/ai-sdk-ui.md +6 -6
- package/.docs/guides/build-your-ui/copilotkit/generative-ui.md +9 -9
- package/.docs/guides/build-your-ui/copilotkit/overview.md +2 -2
- package/.docs/guides/build-your-ui/openui.md +2 -2
- package/.docs/guides/concepts/multi-agent-systems.md +5 -5
- package/.docs/guides/concepts/streaming.md +10 -10
- package/.docs/guides/deployment/amazon-ec2.md +1 -1
- package/.docs/guides/deployment/aws-lambda.md +1 -1
- package/.docs/guides/deployment/azure-app-services.md +1 -1
- package/.docs/guides/deployment/cloudflare.md +1 -1
- package/.docs/guides/deployment/inngest.md +6 -6
- package/.docs/guides/deployment/kubernetes.md +1 -1
- package/.docs/guides/deployment/mastra-workers.md +232 -0
- package/.docs/guides/deployment/temporal.md +1 -1
- package/.docs/guides/deployment/vercel.md +1 -1
- package/.docs/guides/getting-started/astro.md +1 -1
- package/.docs/guides/getting-started/electron.md +1 -1
- package/.docs/guides/getting-started/nestjs.md +5 -5
- package/.docs/guides/getting-started/vite-react.md +1 -1
- package/.docs/guides/guide/ai-recruiter.md +1 -1
- package/.docs/guides/guide/chef-michel.md +2 -2
- package/.docs/guides/guide/code-review-bot.md +2 -2
- package/.docs/guides/guide/coding-agent.md +5 -5
- package/.docs/guides/guide/dev-assistant.md +2 -2
- package/.docs/guides/guide/docs-manager.md +4 -4
- package/.docs/guides/guide/firecrawl.md +1 -1
- package/.docs/guides/guide/github-actions-pr-description.md +5 -5
- package/.docs/guides/guide/research-assistant.md +4 -4
- package/.docs/guides/guide/research-coordinator.md +5 -5
- package/.docs/guides/guide/signal-provider.md +1 -1
- package/.docs/guides/guide/slack-assistant.md +1 -1
- package/.docs/guides/guide/stock-agent.md +3 -3
- package/.docs/guides/guide/web-search.md +4 -4
- package/.docs/guides/guide/whatsapp-chat-bot.md +2 -2
- package/.docs/guides/index.md +1 -1
- package/.docs/guides/migrations/agentnetwork.md +4 -4
- package/.docs/guides/migrations/ai-sdk-v4-to-v5.md +1 -1
- package/.docs/guides/migrations/mastra-cloud.md +6 -6
- package/.docs/guides/migrations/network-to-supervisor.md +9 -9
- package/.docs/guides/migrations/upgrade-to-v1/agent.md +6 -6
- package/.docs/guides/migrations/upgrade-to-v1/cli.md +1 -1
- package/.docs/guides/migrations/upgrade-to-v1/client.md +3 -3
- package/.docs/guides/migrations/upgrade-to-v1/evals.md +2 -2
- package/.docs/guides/migrations/upgrade-to-v1/memory.md +1 -1
- package/.docs/guides/migrations/upgrade-to-v1/overview.md +3 -3
- package/.docs/guides/migrations/upgrade-to-v1/processors.md +1 -1
- package/.docs/guides/migrations/upgrade-to-v1/storage.md +11 -11
- package/.docs/guides/migrations/upgrade-to-v1/tools.md +3 -3
- package/.docs/guides/migrations/upgrade-to-v1/tracing.md +2 -2
- package/.docs/guides/migrations/upgrade-to-v1/voice.md +1 -1
- package/.docs/guides/migrations/upgrade-to-v1/workflows.md +1 -1
- package/.docs/guides/migrations/vnext-to-standard-apis.md +2 -2
- package/.docs/models/environment-variables.md +1 -0
- package/.docs/models/gateways/custom-gateways.md +3 -3
- package/.docs/models/gateways/openrouter.md +1 -3
- package/.docs/models/gateways/vercel.md +2 -1
- package/.docs/models/index.md +6 -6
- package/.docs/models/providers/baseten.md +1 -1
- package/.docs/models/providers/chutes.md +2 -1
- package/.docs/models/providers/crossmodel.md +2 -2
- package/.docs/models/providers/deepinfra.md +1 -1
- package/.docs/models/providers/hyper.md +3 -3
- package/.docs/models/providers/llmgateway.md +4 -3
- package/.docs/models/providers/modal.md +73 -0
- package/.docs/models/providers/wandb.md +2 -1
- package/.docs/models/providers.md +1 -0
- package/.docs/reference/acp/acp-agent.md +4 -4
- package/.docs/reference/acp/create-acp-tool.md +3 -3
- package/.docs/reference/agent-controller/agent-controller-class.md +36 -36
- package/.docs/reference/agent-controller/session.md +6 -6
- package/.docs/reference/agents/agent.md +14 -14
- package/.docs/reference/agents/channels.md +29 -13
- package/.docs/reference/agents/durable-agent.md +54 -5
- package/.docs/reference/agents/generate.md +3 -3
- package/.docs/reference/agents/generateLegacy.md +1 -1
- package/.docs/reference/agents/getDefaultOptions.md +1 -1
- package/.docs/reference/agents/getDefaultStreamOptions.md +1 -1
- package/.docs/reference/agents/getLLM.md +2 -2
- package/.docs/reference/agents/getMetadata.md +2 -2
- package/.docs/reference/agents/inngest-agent.md +1 -1
- package/.docs/reference/agents/listScorers.md +1 -1
- package/.docs/reference/agents/listSkills.md +1 -1
- package/.docs/reference/agents/listSuspendedRuns.md +2 -2
- package/.docs/reference/agents/network.md +1 -1
- package/.docs/reference/ai-sdk/chat-route.md +1 -1
- package/.docs/reference/ai-sdk/network-route.md +1 -1
- package/.docs/reference/ai-sdk/to-ai-sdk-messages.md +1 -1
- package/.docs/reference/ai-sdk/to-ai-sdk-v4-messages.md +1 -1
- package/.docs/reference/ai-sdk/to-ai-sdk-v5-messages.md +1 -1
- package/.docs/reference/ai-sdk/workflow-route.md +1 -1
- package/.docs/reference/ai-sdk/workflow-snapshot-to-stream.md +2 -2
- package/.docs/reference/auth/auth0.md +1 -1
- package/.docs/reference/auth/fga.md +2 -2
- package/.docs/reference/auth/google.md +2 -2
- package/.docs/reference/auth/okta.md +1 -1
- package/.docs/reference/auth/workos.md +2 -2
- package/.docs/reference/browser/agent-browser.md +3 -3
- package/.docs/reference/browser/browser-viewer.md +4 -4
- package/.docs/reference/browser/firecrawl-browser.md +1 -1
- package/.docs/reference/browser/mastra-browser.md +4 -4
- package/.docs/reference/browser/stagehand-browser.md +8 -8
- package/.docs/reference/channels/slack-provider.md +2 -2
- package/.docs/reference/cli/create-mastra.md +1 -1
- package/.docs/reference/cli/mastra.md +155 -24
- package/.docs/reference/client-js/agents.md +26 -9
- package/.docs/reference/client-js/memory.md +2 -2
- package/.docs/reference/client-js/workflows.md +1 -1
- package/.docs/reference/coding-agent/build-base-prompt.md +2 -2
- package/.docs/reference/coding-agent/create-coding-agent.md +2 -2
- package/.docs/reference/configuration.md +7 -7
- package/.docs/reference/core/getAgentById.md +1 -1
- package/.docs/reference/core/getMCPServer.md +1 -1
- package/.docs/reference/core/getScorer.md +1 -1
- package/.docs/reference/core/mastra-class.md +48 -1
- package/.docs/reference/core/mastra-model-gateway.md +1 -1
- package/.docs/reference/datasets/addItem.md +1 -1
- package/.docs/reference/datasets/listItems.md +1 -1
- package/.docs/reference/deployer/netlify.md +4 -4
- package/.docs/reference/deployer/vercel.md +7 -7
- package/.docs/reference/editor/agent-builder/agent-builder-options.md +4 -4
- package/.docs/reference/editor/agent-builder/builder-agent-defaults.md +6 -6
- package/.docs/reference/editor/agent-builder/builder-models.md +3 -3
- package/.docs/reference/editor/blob-store-provider.md +1 -1
- package/.docs/reference/editor/browser-provider.md +3 -3
- package/.docs/reference/editor/filesystem-provider.md +4 -4
- package/.docs/reference/editor/mastra-editor.md +5 -5
- package/.docs/reference/editor/processor-provider.md +3 -3
- package/.docs/reference/editor/sandbox-provider.md +4 -4
- package/.docs/reference/editor/storage-browser-ref.md +6 -6
- package/.docs/reference/editor/storage-workspace-ref.md +4 -4
- package/.docs/reference/editor/tool-provider.md +1 -1
- package/.docs/reference/evals/answer-relevancy.md +5 -5
- package/.docs/reference/evals/answer-similarity.md +1 -1
- package/.docs/reference/evals/bias.md +4 -4
- package/.docs/reference/evals/checks.md +3 -3
- package/.docs/reference/evals/completeness.md +5 -5
- package/.docs/reference/evals/content-similarity.md +5 -5
- package/.docs/reference/evals/context-precision.md +5 -5
- package/.docs/reference/evals/context-recall.md +11 -11
- package/.docs/reference/evals/context-relevance.md +15 -15
- package/.docs/reference/evals/create-scorer.md +1 -1
- package/.docs/reference/evals/faithfulness.md +4 -4
- package/.docs/reference/evals/filter-run.md +2 -2
- package/.docs/reference/evals/hallucination.md +11 -11
- package/.docs/reference/evals/keyword-coverage.md +6 -6
- package/.docs/reference/evals/mastra-scorer.md +2 -2
- package/.docs/reference/evals/noise-sensitivity.md +15 -15
- package/.docs/reference/evals/prompt-alignment.md +20 -20
- package/.docs/reference/evals/rubric.md +2 -2
- package/.docs/reference/evals/run-evals.md +3 -3
- package/.docs/reference/evals/scorer-utils.md +4 -4
- package/.docs/reference/evals/textual-difference.md +4 -4
- package/.docs/reference/evals/tool-call-accuracy.md +4 -4
- package/.docs/reference/evals/toxicity.md +5 -5
- package/.docs/reference/evals/trajectory-accuracy.md +10 -10
- package/.docs/reference/file-based-agents/config.md +3 -3
- package/.docs/reference/file-based-agents/instructions.md +3 -3
- package/.docs/reference/file-based-agents/logger.md +1 -1
- package/.docs/reference/file-based-agents/observability.md +1 -1
- package/.docs/reference/file-based-agents/processors.md +1 -1
- package/.docs/reference/file-based-agents/skills.md +1 -1
- package/.docs/reference/file-based-agents/storage.md +1 -1
- package/.docs/reference/file-based-agents/studio.md +1 -1
- package/.docs/reference/file-based-agents/subagents.md +4 -4
- package/.docs/reference/file-based-agents/tools.md +1 -1
- package/.docs/reference/file-based-agents/workspace.md +1 -1
- package/.docs/reference/index.md +2 -0
- package/.docs/reference/logging/pino-logger.md +3 -3
- package/.docs/reference/memory/clone-utilities.md +1 -1
- package/.docs/reference/memory/cloneThread.md +3 -3
- package/.docs/reference/memory/listThreads.md +1 -1
- package/.docs/reference/memory/memory-class.md +4 -4
- package/.docs/reference/memory/observational-memory.md +15 -15
- package/.docs/reference/memory/recall.md +2 -2
- package/.docs/reference/memory/serialized-memory-config.md +4 -4
- package/.docs/reference/memory/summarizeConversation.md +3 -3
- package/.docs/reference/memory/summarizeThread.md +3 -3
- package/.docs/reference/observability/feedback.md +1 -1
- package/.docs/reference/observability/metrics/automatic-metrics.md +7 -7
- package/.docs/reference/observability/tracing/bridges/datadog.md +2 -2
- package/.docs/reference/observability/tracing/exporters/cloud-exporter.md +3 -3
- package/.docs/reference/observability/tracing/exporters/default-exporter.md +1 -1
- package/.docs/reference/observability/tracing/exporters/langfuse.md +1 -1
- package/.docs/reference/observability/tracing/exporters/mastra-platform-exporter.md +4 -4
- package/.docs/reference/observability/tracing/exporters/mastra-storage-exporter.md +1 -1
- package/.docs/reference/observability/tracing/interfaces.md +1 -1
- package/.docs/reference/observability/tracing/processors/sensitive-data-filter.md +1 -1
- package/.docs/reference/observability/tracing/span-filtering.md +1 -1
- package/.docs/reference/processors/batch-parts-processor.md +1 -1
- package/.docs/reference/processors/cost-guard-processor.md +1 -1
- package/.docs/reference/processors/language-detector.md +1 -1
- package/.docs/reference/processors/message-history-processor.md +1 -1
- package/.docs/reference/processors/moderation-processor.md +2 -2
- package/.docs/reference/processors/pii-detector.md +3 -3
- package/.docs/reference/processors/processor-interface.md +13 -13
- package/.docs/reference/processors/prompt-injection-detector.md +2 -2
- package/.docs/reference/processors/provider-history-compat.md +1 -1
- package/.docs/reference/processors/regex-filter-processor.md +1 -1
- package/.docs/reference/processors/response-cache.md +8 -8
- package/.docs/reference/processors/semantic-recall-processor.md +1 -1
- package/.docs/reference/processors/skill-search-processor.md +1 -1
- package/.docs/reference/processors/system-prompt-scrubber.md +2 -2
- package/.docs/reference/processors/token-limiter-processor.md +4 -4
- package/.docs/reference/processors/tool-call-filter.md +2 -2
- package/.docs/reference/processors/tool-search-processor.md +9 -9
- package/.docs/reference/processors/unicode-normalizer.md +2 -2
- package/.docs/reference/processors/working-memory-processor.md +1 -1
- package/.docs/reference/project-structure.md +1 -1
- package/.docs/reference/pubsub/base.md +4 -4
- package/.docs/reference/pubsub/google-cloud-pubsub.md +2 -2
- package/.docs/reference/pubsub/lease-provider.md +4 -4
- package/.docs/reference/pubsub/redis-streams.md +1 -1
- package/.docs/reference/pubsub/unix-socket-pubsub.md +1 -1
- package/.docs/reference/rag/chunk.md +5 -5
- package/.docs/reference/rag/database-config.md +2 -2
- package/.docs/reference/rag/metadata-filters.md +2 -2
- package/.docs/reference/rag/rerank.md +1 -1
- package/.docs/reference/schedules/overview.md +1 -1
- package/.docs/reference/server/register-api-route.md +1 -1
- package/.docs/reference/server/routes.md +7 -7
- package/.docs/reference/signals/create-notification-inbox-tool.md +1 -1
- package/.docs/reference/signals/signal-provider.md +8 -8
- package/.docs/reference/storage/clickhouse.md +4 -4
- package/.docs/reference/storage/cloudflare-d1.md +4 -4
- package/.docs/reference/storage/convex.md +4 -4
- package/.docs/reference/storage/dsql.md +3 -3
- package/.docs/reference/storage/dynamodb.md +7 -7
- package/.docs/reference/storage/lance.md +1 -1
- package/.docs/reference/storage/mongodb.md +2 -2
- package/.docs/reference/storage/mssql.md +1 -1
- package/.docs/reference/storage/postgresql.md +2 -2
- package/.docs/reference/storage/redis.md +1 -1
- package/.docs/reference/storage/retention.md +33 -33
- package/.docs/reference/storage/spanner.md +8 -8
- package/.docs/reference/storage/upstash.md +1 -1
- package/.docs/reference/streaming/ChunkType.md +2 -2
- package/.docs/reference/streaming/agents/MastraModelOutput.md +1 -1
- package/.docs/reference/streaming/agents/stream.md +2 -2
- package/.docs/reference/streaming/agents/streamUntilIdle.md +2 -2
- package/.docs/reference/streaming/workflows/observeStream.md +1 -1
- package/.docs/reference/streaming/workflows/resumeStream.md +1 -1
- package/.docs/reference/streaming/workflows/stream.md +1 -1
- package/.docs/reference/streaming/workflows/timeTravelStream.md +2 -2
- package/.docs/reference/templates/overview.md +1 -1
- package/.docs/reference/tools/brightdata.md +1 -1
- package/.docs/reference/tools/create-code-mode.md +3 -3
- package/.docs/reference/tools/create-tool.md +1 -1
- package/.docs/reference/tools/graph-rag-tool.md +1 -1
- package/.docs/reference/tools/isolated-vm-transport.md +74 -0
- package/.docs/reference/tools/mcp-client.md +15 -15
- package/.docs/reference/tools/mcp-server.md +21 -21
- package/.docs/reference/tools/submit-plan-tool.md +1 -1
- package/.docs/reference/tools/tavily.md +1 -1
- package/.docs/reference/tools/vector-query-tool.md +5 -5
- package/.docs/reference/vectors/astra.md +1 -1
- package/.docs/reference/vectors/chroma.md +2 -2
- package/.docs/reference/vectors/convex.md +2 -2
- package/.docs/reference/vectors/couchbase.md +4 -4
- package/.docs/reference/vectors/libsql.md +2 -2
- package/.docs/reference/vectors/mongodb.md +3 -3
- package/.docs/reference/vectors/pg.md +5 -5
- package/.docs/reference/vectors/qdrant.md +2 -2
- package/.docs/reference/vectors/s3vectors.md +4 -4
- package/.docs/reference/vectors/turbopuffer.md +1 -1
- package/.docs/reference/vectors/upstash.md +1 -1
- package/.docs/reference/voice/aws-nova-sonic.md +1 -1
- package/.docs/reference/voice/azure.md +1 -1
- package/.docs/reference/voice/google-gemini-live.md +4 -4
- package/.docs/reference/voice/inworld-realtime.md +7 -7
- package/.docs/reference/voice/livekit.md +13 -13
- package/.docs/reference/voice/mistral.md +1 -1
- package/.docs/reference/voice/openai-realtime.md +1 -1
- package/.docs/reference/voice/sarvam.md +1 -1
- package/.docs/reference/voice/voice.addInstructions.md +1 -1
- package/.docs/reference/voice/voice.addTools.md +1 -1
- package/.docs/reference/voice/voice.events.md +1 -1
- package/.docs/reference/voice/voice.getSpeakers.md +2 -2
- package/.docs/reference/voice/voice.on.md +2 -2
- package/.docs/reference/voice/xai-realtime.md +2 -2
- package/.docs/reference/workers/overview.md +85 -0
- package/.docs/reference/workflows/run-methods/cancel.md +1 -1
- package/.docs/reference/workflows/run-methods/startAsync.md +1 -1
- package/.docs/reference/workflows/run-methods/timeTravel.md +1 -1
- package/.docs/reference/workflows/workflow-methods/foreach.md +1 -1
- package/.docs/reference/workflows/workflow-methods/sleep.md +1 -1
- package/.docs/reference/workflows/workflow-state-reader.md +2 -2
- package/.docs/reference/workspace/agentfs-filesystem.md +1 -1
- package/.docs/reference/workspace/apple-container-sandbox.md +2 -2
- package/.docs/reference/workspace/daytona-sandbox.md +3 -3
- package/.docs/reference/workspace/docker-sandbox.md +2 -2
- package/.docs/reference/workspace/e2b-sandbox.md +2 -2
- package/.docs/reference/workspace/files-sdk-filesystem.md +3 -3
- package/.docs/reference/workspace/google-drive-filesystem.md +4 -4
- package/.docs/reference/workspace/local-filesystem.md +3 -3
- package/.docs/reference/workspace/local-sandbox.md +3 -3
- package/.docs/reference/workspace/modal-sandbox.md +1 -1
- package/.docs/reference/workspace/platform-filesystem.md +3 -3
- package/.docs/reference/workspace/platform-sandbox.md +2 -2
- package/.docs/reference/workspace/process-manager.md +1 -1
- package/.docs/reference/workspace/railway-sandbox.md +4 -4
- package/.docs/reference/workspace/s3-filesystem.md +1 -1
- package/.docs/reference/workspace/sandbox.md +1 -1
- package/.docs/reference/workspace/vercel-sandbox.md +1 -1
- package/.docs/reference/workspace/workspace-class.md +10 -10
- package/CHANGELOG.md +21 -0
- package/package.json +3 -3
|
@@ -32,7 +32,7 @@ export const mastra = new Mastra({
|
|
|
32
32
|
id: 'weather-agent',
|
|
33
33
|
name: 'Weather Agent',
|
|
34
34
|
instructions: 'You help with weather information',
|
|
35
|
-
model: 'openai/gpt-5.
|
|
35
|
+
model: 'openai/gpt-5.6-sol',
|
|
36
36
|
}),
|
|
37
37
|
},
|
|
38
38
|
})
|
|
@@ -242,7 +242,7 @@ export const mastra = new Mastra({
|
|
|
242
242
|
|
|
243
243
|
**Type:** `Record<string, MastraMemory>`
|
|
244
244
|
|
|
245
|
-
A registry of memory instances that can be referenced by agents. Memory gives agents coherence across interactions by retaining relevant information from past conversations. Mastra supports
|
|
245
|
+
A registry of memory instances that can be referenced by agents. Memory gives agents coherence across interactions by retaining relevant information from past conversations. Mastra supports message history for recent messages and working memory for persistent user-specific details. Semantic recall retrieves older messages based on relevance.
|
|
246
246
|
|
|
247
247
|
Visit the [Memory documentation](https://mastra.ai/docs/memory/overview) to learn more.
|
|
248
248
|
|
|
@@ -343,7 +343,7 @@ export const mastra = new Mastra({
|
|
|
343
343
|
|
|
344
344
|
**Type:** `Record<string, Scorer>`
|
|
345
345
|
|
|
346
|
-
Scorers assess the quality of agent responses and workflow outputs. They provide quantifiable metrics for measuring agent quality using model-graded, rule-based, and statistical methods. Use scorers to track performance
|
|
346
|
+
Scorers assess the quality of agent responses and workflow outputs. They provide quantifiable metrics for measuring agent quality using model-graded, rule-based, and statistical methods. Use scorers to track performance and compare approaches. They can also identify areas for improvement.
|
|
347
347
|
|
|
348
348
|
Visit the [Scorers documentation](https://mastra.ai/docs/evals/overview) to learn more.
|
|
349
349
|
|
|
@@ -505,11 +505,11 @@ const mastra = new Mastra({
|
|
|
505
505
|
**Type:** `boolean | string[]`\
|
|
506
506
|
**Default:** `true`
|
|
507
507
|
|
|
508
|
-
When `mastra build` is run, Mastra bundles your project into the `.mastra/output` directory. This option controls which packages are excluded from the bundle (marked as "external") and installed separately through a package manager. This is useful when the internal Mastra bundler ([Rollup](https://rollupjs.org/configuration-options/#external)) has trouble bundling
|
|
508
|
+
When `mastra build` is run, Mastra bundles your project into the `.mastra/output` directory. This option controls which packages are excluded from the bundle (marked as "external") and installed separately through a package manager. This is useful when the internal Mastra bundler ([Rollup](https://rollupjs.org/configuration-options/#external)) has trouble bundling packages.
|
|
509
509
|
|
|
510
510
|
By default, `mastra build` sets this option to `true`.
|
|
511
511
|
|
|
512
|
-
|
|
512
|
+
The values have these meanings:
|
|
513
513
|
|
|
514
514
|
- `true`: All dependencies listed in your project's `package.json` are marked as external
|
|
515
515
|
- `false`: No dependencies are marked as external; everything is bundled together
|
|
@@ -784,7 +784,7 @@ export const mastra = new Mastra({
|
|
|
784
784
|
|
|
785
785
|
Custom error handler called when an unhandled error occurs. Use this to customize error responses, log errors to external services like Sentry, or implement custom error formatting.
|
|
786
786
|
|
|
787
|
-
This hook is supported by all server adapters. The `c` parameter provides a Hono-compatible context object
|
|
787
|
+
This hook is supported by all server adapters. The `c` parameter provides a Hono-compatible context object: for non-Hono adapters (Koa, Express, Fastify), a shim is provided with commonly used methods like `c.json()` and `c.req.path`.
|
|
788
788
|
|
|
789
789
|
```typescript
|
|
790
790
|
import { Mastra } from '@mastra/core'
|
|
@@ -813,7 +813,7 @@ export const mastra = new Mastra({
|
|
|
813
813
|
|
|
814
814
|
Custom handler called when a request fails Zod schema validation. Use this to customize validation error responses, change the status code, or format errors to match your API standards.
|
|
815
815
|
|
|
816
|
-
Return a `{ status, body }` object to override the default `400` response, or `undefined` to
|
|
816
|
+
Return a `{ status, body }` object to override the default `400` response, or `undefined` to use the default behavior. This hook is supported by all server adapters (Hono, Express, Fastify, Koa).
|
|
817
817
|
|
|
818
818
|
The `context` parameter indicates which part of the request failed validation:
|
|
819
819
|
|
|
@@ -18,7 +18,7 @@ const supportAgent = new Agent({
|
|
|
18
18
|
id: 'support-agent-id',
|
|
19
19
|
name: 'Support Agent',
|
|
20
20
|
instructions: 'Answer support questions clearly and concisely.',
|
|
21
|
-
model: 'openai/gpt-5.
|
|
21
|
+
model: 'openai/gpt-5.6-sol',
|
|
22
22
|
})
|
|
23
23
|
|
|
24
24
|
export const mastra = new Mastra({
|
|
@@ -30,7 +30,7 @@ const serverById = mastra.getMCPServerById('my-mcp-server')
|
|
|
30
30
|
|
|
31
31
|
## Parameters
|
|
32
32
|
|
|
33
|
-
**registryKey** (`string`): The registry key used when registering the MCP server in the mcpServers configuration object.
|
|
33
|
+
**registryKey** (`string`): The registry key used when registering the MCP server in the mcpServers configuration object. It is the configuration key in the key-value pair, not the server's intrinsic id property.
|
|
34
34
|
|
|
35
35
|
## Returns
|
|
36
36
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# getScorer()
|
|
4
4
|
|
|
5
|
-
The `getScorer()` method retrieves a specific scorer that was registered with the Mastra instance using its registration key.
|
|
5
|
+
The `getScorer()` method retrieves a specific scorer that was registered with the Mastra instance using its registration key. The method provides type-safe access to scorers and throws an error if the requested scorer isn't found.
|
|
6
6
|
|
|
7
7
|
## Usage example
|
|
8
8
|
|
|
@@ -103,4 +103,51 @@ Visit the [Configuration reference](https://mastra.ai/reference/configuration) f
|
|
|
103
103
|
|
|
104
104
|
**versions.agents.versionId** (`string`): The ID of a specific version to use.
|
|
105
105
|
|
|
106
|
-
**versions.agents.status** (`'draft' | 'published'`): Select the latest version with this publication status.
|
|
106
|
+
**versions.agents.status** (`'draft' | 'published'`): Select the latest version with this publication status.
|
|
107
|
+
|
|
108
|
+
**workers** (`MastraWorker[] | false`): Configure which workers run in this Mastra instance. When omitted, Mastra auto-creates default workers based on your PubSub and config. Pass false to disable all event processing (useful when running standalone workers separately). Pass a MastraWorker\[] to add custom workers — they are merged with the auto-created defaults, and a custom worker with the same name as a default replaces it.
|
|
109
|
+
|
|
110
|
+
**backgroundTasks** (`BackgroundTaskManagerConfig`): Configure background task execution for agents. See background tasks configuration reference for all options.
|
|
111
|
+
|
|
112
|
+
**backgroundTasks.enabled** (`boolean`): Enable background task dispatch.
|
|
113
|
+
|
|
114
|
+
**backgroundTasks.globalConcurrency** (`number`): Max concurrent tasks across all agents.
|
|
115
|
+
|
|
116
|
+
**backgroundTasks.perAgentConcurrency** (`number`): Max concurrent tasks per agent.
|
|
117
|
+
|
|
118
|
+
**backgroundTasks.backpressure** (`'queue' | 'reject' | 'fallback-sync'`): Behavior when concurrency limit is reached.
|
|
119
|
+
|
|
120
|
+
**backgroundTasks.defaultTimeoutMs** (`number`): Default task timeout in milliseconds.
|
|
121
|
+
|
|
122
|
+
**backgroundTasks.defaultRetries** (`RetryConfig`): Default retry configuration.
|
|
123
|
+
|
|
124
|
+
**scheduler** (`object`): Configure the scheduler worker for cron-driven workflow triggers. Auto-enables when any workflow declares a schedule. See Scheduled workflows.
|
|
125
|
+
|
|
126
|
+
**scheduler.enabled** (`boolean`): Explicitly enable or disable the scheduler.
|
|
127
|
+
|
|
128
|
+
**recovery** (`MastraRecoveryConfig`): Boot-time recovery behavior for orphaned agent and workflow runs. See Crash recovery. (Default: `{ durableAgents: 'off' }`)
|
|
129
|
+
|
|
130
|
+
**recovery.durableAgents** (`'auto' | 'off'`): Set to 'auto' to automatically re-drive orphaned RUNNING durable agent runs on server boot. Recovery re-issues LLM calls and re-executes tool calls, so tools must be idempotent. See Crash recovery.
|
|
131
|
+
|
|
132
|
+
## Methods
|
|
133
|
+
|
|
134
|
+
### `recoverAllDurableAgents()`
|
|
135
|
+
|
|
136
|
+
Re-drives every orphaned `running` durable-agent run across all registered durable agents. Called automatically on boot when `recovery.durableAgents` is `'auto'`. You can also call it directly for manual recovery or from a scheduled task.
|
|
137
|
+
|
|
138
|
+
Requires persistent storage — with an in-memory store there is nothing to recover after a process restart.
|
|
139
|
+
|
|
140
|
+
```typescript
|
|
141
|
+
const result = await mastra.recoverAllDurableAgents()
|
|
142
|
+
// { agents: 2, recovered: 3, succeeded: 3, failed: 0 }
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
Returns:
|
|
146
|
+
|
|
147
|
+
**agents** (`number`): Number of durable agents scanned.
|
|
148
|
+
|
|
149
|
+
**recovered** (`number`): Total number of runs that were re-driven.
|
|
150
|
+
|
|
151
|
+
**succeeded** (`number`): Runs that restarted successfully.
|
|
152
|
+
|
|
153
|
+
**failed** (`number`): Runs whose restart threw an error.
|
|
@@ -21,7 +21,7 @@ class MyCustomGateway extends MastraModelGateway {
|
|
|
21
21
|
return {
|
|
22
22
|
'my-provider': {
|
|
23
23
|
name: 'My Provider',
|
|
24
|
-
models: ['openai/gpt-5.
|
|
24
|
+
models: ['openai/gpt-5.6-sol', 'anthropic/claude-sonnet-4-6'],
|
|
25
25
|
apiKeyEnvVar: 'MY_API_KEY',
|
|
26
26
|
gateway: this.id,
|
|
27
27
|
},
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
**Added in:** `@mastra/core@1.4.0`
|
|
6
6
|
|
|
7
|
-
Adds a single item to the dataset. Each item has an input
|
|
7
|
+
Adds a single item to the dataset. Each item has an input and optional ground truth. Metadata is also optional.
|
|
8
8
|
|
|
9
9
|
## Usage example
|
|
10
10
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
**Added in:** `@mastra/core@1.4.0`
|
|
6
6
|
|
|
7
|
-
Lists items in the dataset. When only `version` is provided, returns a bare `DatasetItem[]` snapshot of every item at that version. In all other cases
|
|
7
|
+
Lists items in the dataset. When only `version` is provided, returns a bare `DatasetItem[]` snapshot of every item at that version. In all other cases (no arguments, or `search` / `page` / `perPage` provided with or without `version`), it returns a paginated `{ items, pagination }` shape.
|
|
8
8
|
|
|
9
9
|
## Usage example
|
|
10
10
|
|
|
@@ -6,7 +6,7 @@ The `NetlifyDeployer` class handles packaging, configuration, and deployment by
|
|
|
6
6
|
|
|
7
7
|
## Installation
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
To use `NetlifyDeployer`, you need to install the `@mastra/deployer-netlify` package:
|
|
10
10
|
|
|
11
11
|
**npm**:
|
|
12
12
|
|
|
@@ -47,10 +47,10 @@ export const mastra = new Mastra({
|
|
|
47
47
|
|
|
48
48
|
## Constructor options
|
|
49
49
|
|
|
50
|
-
- `target?: 'serverless' | 'edge'
|
|
50
|
+
- `target?: 'serverless' | 'edge'`: Deploy target for Netlify. Defaults to `'serverless'`.
|
|
51
51
|
|
|
52
|
-
- `'serverless'
|
|
53
|
-
- `'edge'
|
|
52
|
+
- `'serverless'`: Standard [Netlify Functions](https://docs.netlify.com/functions/overview/) (Node.js runtime, 60s default timeout).
|
|
53
|
+
- `'edge'`: [Netlify Edge Functions](https://docs.netlify.com/build/edge-functions/overview/) (Deno-based runtime, runs at the edge closest to users, without a fixed timeout).
|
|
54
54
|
|
|
55
55
|
### Edge functions example
|
|
56
56
|
|
|
@@ -49,10 +49,10 @@ export const mastra = new Mastra({
|
|
|
49
49
|
|
|
50
50
|
The deployer accepts the following options:
|
|
51
51
|
|
|
52
|
-
- `studio?: boolean
|
|
53
|
-
- `maxDuration?: number
|
|
54
|
-
- `memory?: number
|
|
55
|
-
- `regions?: string[]
|
|
52
|
+
- `studio?: boolean`: Deploy [Studio](https://mastra.ai/docs/studio/overview) alongside your API as static assets served from Vercel's Edge CDN. Defaults to `false`.
|
|
53
|
+
- `maxDuration?: number`: Function execution timeout (in seconds)
|
|
54
|
+
- `memory?: number`: Function memory (in MB)
|
|
55
|
+
- `regions?: string[]`: Regions to deploy the function (e.g. `['sfo1','iad1']`)
|
|
56
56
|
|
|
57
57
|
The `maxDuration`, `memory`, and `regions` options are merged into `.vercel/output/functions/index.func/.vc-config.json` while preserving default fields (`handler`, `launcherType`, `runtime`, `shouldAddHelpers`).
|
|
58
58
|
|
|
@@ -78,9 +78,9 @@ After running `mastra build`, the deployer generates a `.vercel/output` director
|
|
|
78
78
|
|
|
79
79
|
The output contains:
|
|
80
80
|
|
|
81
|
-
- **config.json
|
|
82
|
-
- **functions
|
|
83
|
-
- **static
|
|
81
|
+
- **config.json**: Routing configuration that directs requests to the appropriate handler
|
|
82
|
+
- **functions/**: Your Mastra server bundled as a serverless function
|
|
83
|
+
- **static/**: Studio SPA assets (only when `studio: true`)
|
|
84
84
|
|
|
85
85
|
Without studio:
|
|
86
86
|
|
|
@@ -70,7 +70,7 @@ new MastraEditor({
|
|
|
70
70
|
|
|
71
71
|
## Related
|
|
72
72
|
|
|
73
|
-
- [Configuration](https://mastra.ai/docs/agent-builder/configuration)
|
|
74
|
-
- [BuilderAgentDefaults](https://mastra.ai/reference/editor/agent-builder/builder-agent-defaults)
|
|
75
|
-
- [builder.configuration.agent.models](https://mastra.ai/reference/editor/agent-builder/builder-models)
|
|
76
|
-
- [MastraEditor class](https://mastra.ai/reference/editor/mastra-editor)
|
|
73
|
+
- [Configuration](https://mastra.ai/docs/agent-builder/configuration): Concept and worked examples.
|
|
74
|
+
- [BuilderAgentDefaults](https://mastra.ai/reference/editor/agent-builder/builder-agent-defaults): Full schema for `configuration.agent`.
|
|
75
|
+
- [builder.configuration.agent.models](https://mastra.ai/reference/editor/agent-builder/builder-models): Model allowlist and default model.
|
|
76
|
+
- [MastraEditor class](https://mastra.ai/reference/editor/mastra-editor): The parent surface that hosts `builder`.
|
|
@@ -71,9 +71,9 @@ new MastraEditor({
|
|
|
71
71
|
|
|
72
72
|
## Related
|
|
73
73
|
|
|
74
|
-
- [AgentBuilderOptions](https://mastra.ai/reference/editor/agent-builder/agent-builder-options)
|
|
75
|
-
- [builder.configuration.agent.models](https://mastra.ai/reference/editor/agent-builder/builder-models)
|
|
76
|
-
- [SerializedMemoryConfig](https://mastra.ai/reference/memory/serialized-memory-config)
|
|
77
|
-
- [StorageWorkspaceRef](https://mastra.ai/reference/editor/storage-workspace-ref)
|
|
78
|
-
- [StorageBrowserRef](https://mastra.ai/reference/editor/storage-browser-ref)
|
|
79
|
-
- [Configuration](https://mastra.ai/docs/agent-builder/configuration)
|
|
74
|
+
- [AgentBuilderOptions](https://mastra.ai/reference/editor/agent-builder/agent-builder-options): The parent options object.
|
|
75
|
+
- [builder.configuration.agent.models](https://mastra.ai/reference/editor/agent-builder/builder-models): Admin-facing model allowlist and default.
|
|
76
|
+
- [SerializedMemoryConfig](https://mastra.ai/reference/memory/serialized-memory-config): Memory shape for new agents.
|
|
77
|
+
- [StorageWorkspaceRef](https://mastra.ai/reference/editor/storage-workspace-ref): Workspace reference shape.
|
|
78
|
+
- [StorageBrowserRef](https://mastra.ai/reference/editor/storage-browser-ref): Browser reference shape.
|
|
79
|
+
- [Configuration](https://mastra.ai/docs/agent-builder/configuration): Concept and worked examples.
|
|
@@ -61,6 +61,6 @@ Mastra validates the admin policy at server boot. Violations surface as warnings
|
|
|
61
61
|
|
|
62
62
|
## Related
|
|
63
63
|
|
|
64
|
-
- [BuilderAgentDefaults](https://mastra.ai/reference/editor/agent-builder/builder-agent-defaults)
|
|
65
|
-
- [AgentBuilderOptions](https://mastra.ai/reference/editor/agent-builder/agent-builder-options)
|
|
66
|
-
- [Model policy](https://mastra.ai/docs/agent-builder/model-policy)
|
|
64
|
+
- [BuilderAgentDefaults](https://mastra.ai/reference/editor/agent-builder/builder-agent-defaults): Parent object containing `models`.
|
|
65
|
+
- [AgentBuilderOptions](https://mastra.ai/reference/editor/agent-builder/agent-builder-options): The top-level Builder options.
|
|
66
|
+
- [Model policy](https://mastra.ai/docs/agent-builder/model-policy): Concept and worked examples.
|
|
@@ -58,4 +58,4 @@ When no `providerId` is passed to `MastraEditor.resolveBlobStore()`, the editor
|
|
|
58
58
|
|
|
59
59
|
## Related
|
|
60
60
|
|
|
61
|
-
- [MastraEditor class](https://mastra.ai/reference/editor/mastra-editor)
|
|
61
|
+
- [MastraEditor class](https://mastra.ai/reference/editor/mastra-editor): Provider registry and `resolveBlobStore()` method.
|
|
@@ -72,6 +72,6 @@ new MastraEditor({
|
|
|
72
72
|
|
|
73
73
|
## Related
|
|
74
74
|
|
|
75
|
-
- [Browser](https://mastra.ai/docs/agent-builder/browser)
|
|
76
|
-
- [StorageBrowserRef](https://mastra.ai/reference/editor/storage-browser-ref)
|
|
77
|
-
- [MastraEditor class](https://mastra.ai/reference/editor/mastra-editor)
|
|
75
|
+
- [Browser](https://mastra.ai/docs/agent-builder/browser): Concept and worked examples.
|
|
76
|
+
- [StorageBrowserRef](https://mastra.ai/reference/editor/storage-browser-ref): Stored configuration consumed by `createBrowser`.
|
|
77
|
+
- [MastraEditor class](https://mastra.ai/reference/editor/mastra-editor): Provider registry.
|
|
@@ -58,7 +58,7 @@ Once registered, admins can reference the provider from an inline workspace conf
|
|
|
58
58
|
|
|
59
59
|
## Related
|
|
60
60
|
|
|
61
|
-
- [Workspace](https://mastra.ai/docs/agent-builder/workspace)
|
|
62
|
-
- [StorageWorkspaceRef](https://mastra.ai/reference/editor/storage-workspace-ref)
|
|
63
|
-
- [SandboxProvider](https://mastra.ai/reference/editor/sandbox-provider)
|
|
64
|
-
- [MastraEditor class](https://mastra.ai/reference/editor/mastra-editor)
|
|
61
|
+
- [Workspace](https://mastra.ai/docs/agent-builder/workspace): Concept and worked examples.
|
|
62
|
+
- [StorageWorkspaceRef](https://mastra.ai/reference/editor/storage-workspace-ref): Stored configuration consumed by `createFilesystem`.
|
|
63
|
+
- [SandboxProvider](https://mastra.ai/reference/editor/sandbox-provider): Sibling provider for command execution.
|
|
64
|
+
- [MastraEditor class](https://mastra.ai/reference/editor/mastra-editor): Provider registry.
|
|
@@ -61,10 +61,10 @@ Each provider field above takes a record keyed by provider id. See the per-provi
|
|
|
61
61
|
|
|
62
62
|
The `builder` field enables the [Agent Builder](https://mastra.ai/docs/agent-builder/overview), a browser-based UI for creating and editing stored agents. See:
|
|
63
63
|
|
|
64
|
-
- [Agent Builder overview](https://mastra.ai/docs/agent-builder/overview)
|
|
65
|
-
- [AgentBuilderOptions](https://mastra.ai/reference/editor/agent-builder/agent-builder-options)
|
|
66
|
-
- [BuilderAgentDefaults](https://mastra.ai/reference/editor/agent-builder/builder-agent-defaults)
|
|
67
|
-
- [builder.configuration.agent.models](https://mastra.ai/reference/editor/agent-builder/builder-models)
|
|
64
|
+
- [Agent Builder overview](https://mastra.ai/docs/agent-builder/overview): Concepts and getting started.
|
|
65
|
+
- [AgentBuilderOptions](https://mastra.ai/reference/editor/agent-builder/agent-builder-options): Full options schema.
|
|
66
|
+
- [BuilderAgentDefaults](https://mastra.ai/reference/editor/agent-builder/builder-agent-defaults): Admin-pinned defaults for new agents.
|
|
67
|
+
- [builder.configuration.agent.models](https://mastra.ai/reference/editor/agent-builder/builder-models): Model allowlist and default model.
|
|
68
68
|
|
|
69
69
|
### Registering the Builder agent
|
|
70
70
|
|
|
@@ -83,7 +83,7 @@ export const mastra = new Mastra({
|
|
|
83
83
|
})
|
|
84
84
|
```
|
|
85
85
|
|
|
86
|
-
The key name (`builderAgent`) is conventional
|
|
86
|
+
The key name (`builderAgent`) is conventional. Any key works. The `@mastra/editor/ee` subpath is gated by the Mastra Enterprise Edition license at runtime.
|
|
87
87
|
|
|
88
88
|
See the [Agent Builder overview](https://mastra.ai/docs/agent-builder/overview) for the full setup checklist.
|
|
89
89
|
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
`ProcessorProvider` is the interface a package implements to register a configurable processor with [`MastraEditor`](https://mastra.ai/reference/editor/mastra-editor). Processor providers serve two purposes:
|
|
6
6
|
|
|
7
|
-
1. **Discovery
|
|
8
|
-
2. **Runtime
|
|
7
|
+
1. **Discovery:** The UI uses `info`, `configSchema`, and `availablePhases` to render configuration forms.
|
|
8
|
+
2. **Runtime:** The editor calls `createProcessor(config)` during agent hydration to instantiate processors from stored configuration.
|
|
9
9
|
|
|
10
10
|
Providers are supplied via `MastraEditorConfig.processorProviders`.
|
|
11
11
|
|
|
@@ -63,4 +63,4 @@ export const myProcessorProvider: ProcessorProvider = {
|
|
|
63
63
|
|
|
64
64
|
## Related
|
|
65
65
|
|
|
66
|
-
- [MastraEditor class](https://mastra.ai/reference/editor/mastra-editor)
|
|
66
|
+
- [MastraEditor class](https://mastra.ai/reference/editor/mastra-editor): Provider registry.
|
|
@@ -57,7 +57,7 @@ Once registered, admins can reference the provider from an inline workspace conf
|
|
|
57
57
|
|
|
58
58
|
## Related
|
|
59
59
|
|
|
60
|
-
- [Workspace](https://mastra.ai/docs/agent-builder/workspace)
|
|
61
|
-
- [StorageWorkspaceRef](https://mastra.ai/reference/editor/storage-workspace-ref)
|
|
62
|
-
- [FilesystemProvider](https://mastra.ai/reference/editor/filesystem-provider)
|
|
63
|
-
- [MastraEditor class](https://mastra.ai/reference/editor/mastra-editor)
|
|
60
|
+
- [Workspace](https://mastra.ai/docs/agent-builder/workspace): Concept and worked examples.
|
|
61
|
+
- [StorageWorkspaceRef](https://mastra.ai/reference/editor/storage-workspace-ref): Stored configuration consumed by `createSandbox`.
|
|
62
|
+
- [FilesystemProvider](https://mastra.ai/reference/editor/filesystem-provider): Sibling provider for file access.
|
|
63
|
+
- [MastraEditor class](https://mastra.ai/reference/editor/mastra-editor): Provider registry.
|
|
@@ -38,7 +38,7 @@ new MastraEditor({
|
|
|
38
38
|
type StorageBrowserRef = { type: 'inline'; config: StorageBrowserConfig }
|
|
39
39
|
```
|
|
40
40
|
|
|
41
|
-
A `{ type: 'id' }` variant for browsers isn't available
|
|
41
|
+
A `{ type: 'id' }` variant for browsers isn't available: they're always inlined.
|
|
42
42
|
|
|
43
43
|
## Properties
|
|
44
44
|
|
|
@@ -72,11 +72,11 @@ The shape embedded under `config`. Defined in `@mastra/core/storage`.
|
|
|
72
72
|
|
|
73
73
|
## Hydration
|
|
74
74
|
|
|
75
|
-
`StorageBrowserRef` is resolved lazily on `mastra.editor.agent.getById()`. The editor looks up `config.provider` on `MastraEditor.browsers` and calls `provider.createBrowser(config)`. If the provider isn't registered, the editor logs a warning and returns `undefined
|
|
75
|
+
`StorageBrowserRef` is resolved lazily on `mastra.editor.agent.getById()`. The editor looks up `config.provider` on `MastraEditor.browsers` and calls `provider.createBrowser(config)`. If the provider isn't registered, the editor logs a warning and returns `undefined`: the agent still loads, but without a browser.
|
|
76
76
|
|
|
77
77
|
## Related
|
|
78
78
|
|
|
79
|
-
- [Browser](https://mastra.ai/docs/agent-builder/browser)
|
|
80
|
-
- [BrowserProvider](https://mastra.ai/reference/editor/browser-provider)
|
|
81
|
-
- [BuilderAgentDefaults](https://mastra.ai/reference/editor/agent-builder/builder-agent-defaults)
|
|
82
|
-
- [StorageWorkspaceRef](https://mastra.ai/reference/editor/storage-workspace-ref)
|
|
79
|
+
- [Browser](https://mastra.ai/docs/agent-builder/browser): Concept and worked examples.
|
|
80
|
+
- [BrowserProvider](https://mastra.ai/reference/editor/browser-provider): Implementer-facing provider interface.
|
|
81
|
+
- [BuilderAgentDefaults](https://mastra.ai/reference/editor/agent-builder/builder-agent-defaults): Where this type is pinned as the Builder default.
|
|
82
|
+
- [StorageWorkspaceRef](https://mastra.ai/reference/editor/storage-workspace-ref): Sibling reference type for workspace configuration.
|
|
@@ -89,7 +89,7 @@ The shape embedded under `{ type: 'inline', config }`. Defined in `@mastra/core/
|
|
|
89
89
|
|
|
90
90
|
## Related
|
|
91
91
|
|
|
92
|
-
- [Workspace](https://mastra.ai/docs/agent-builder/workspace)
|
|
93
|
-
- [BuilderAgentDefaults](https://mastra.ai/reference/editor/agent-builder/builder-agent-defaults)
|
|
94
|
-
- [MastraEditor class](https://mastra.ai/reference/editor/mastra-editor)
|
|
95
|
-
- [StorageBrowserRef](https://mastra.ai/reference/editor/storage-browser-ref)
|
|
92
|
+
- [Workspace](https://mastra.ai/docs/agent-builder/workspace): Concept and worked examples.
|
|
93
|
+
- [BuilderAgentDefaults](https://mastra.ai/reference/editor/agent-builder/builder-agent-defaults): Where this type is pinned as the Builder default.
|
|
94
|
+
- [MastraEditor class](https://mastra.ai/reference/editor/mastra-editor): Registers filesystem and sandbox providers.
|
|
95
|
+
- [StorageBrowserRef](https://mastra.ai/reference/editor/storage-browser-ref): Sibling reference type for browser configuration.
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# ToolProvider
|
|
4
4
|
|
|
5
|
-
The `ToolProvider` interface defines how the editor discovers and resolves integration tools from external platforms. Mastra
|
|
5
|
+
The `ToolProvider` interface defines how the editor discovers and resolves integration tools from external platforms. Mastra includes two built-in implementations: `ComposioToolProvider` and `ArcadeToolProvider`.
|
|
6
6
|
|
|
7
7
|
See [Tools](https://mastra.ai/docs/editor/tools) for a guide on setting up tool providers.
|
|
8
8
|
|
|
@@ -39,7 +39,7 @@ The scorer evaluates relevancy through query-answer alignment, considering compl
|
|
|
39
39
|
### Scoring Process
|
|
40
40
|
|
|
41
41
|
1. **Statement Preprocess:**
|
|
42
|
-
- Breaks output into
|
|
42
|
+
- Breaks output into useful statements while preserving context.
|
|
43
43
|
|
|
44
44
|
2. **Relevance Analysis:**
|
|
45
45
|
|
|
@@ -57,9 +57,9 @@ The scorer evaluates relevancy through query-answer alignment, considering compl
|
|
|
57
57
|
A relevancy score between 0 and 1:
|
|
58
58
|
|
|
59
59
|
- **1.0**: The response fully answers the query with relevant and focused information.
|
|
60
|
-
- **0.7
|
|
61
|
-
- **0.4
|
|
62
|
-
- **0.1
|
|
60
|
+
- **0.7 to 0.9**: The response mostly answers the query but may include minor unrelated content.
|
|
61
|
+
- **0.4 to 0.6**: The response partially answers the query, mixing relevant and unrelated information.
|
|
62
|
+
- **0.1 to 0.3**: The response includes minimal relevant content and largely misses the intent of the query.
|
|
63
63
|
- **0.0**: The response is entirely unrelated and doesn't answer the query.
|
|
64
64
|
|
|
65
65
|
## Example
|
|
@@ -71,7 +71,7 @@ import { runEvals } from '@mastra/core/evals'
|
|
|
71
71
|
import { createAnswerRelevancyScorer } from '@mastra/evals/scorers/prebuilt'
|
|
72
72
|
import { myAgent } from './agent'
|
|
73
73
|
|
|
74
|
-
const scorer = createAnswerRelevancyScorer({ model: 'openai/gpt-5.
|
|
74
|
+
const scorer = createAnswerRelevancyScorer({ model: 'openai/gpt-5.6-sol' })
|
|
75
75
|
|
|
76
76
|
const result = await runEvals({
|
|
77
77
|
data: [
|
|
@@ -64,7 +64,7 @@ import { runEvals } from '@mastra/core/evals'
|
|
|
64
64
|
import { createAnswerSimilarityScorer } from '@mastra/evals/scorers/prebuilt'
|
|
65
65
|
import { myAgent } from './agent'
|
|
66
66
|
|
|
67
|
-
const scorer = createAnswerSimilarityScorer({ model: 'openai/gpt-5.
|
|
67
|
+
const scorer = createAnswerSimilarityScorer({ model: 'openai/gpt-5.6-sol' })
|
|
68
68
|
|
|
69
69
|
const result = await runEvals({
|
|
70
70
|
data: [
|
|
@@ -70,9 +70,9 @@ Final score: `(biased_opinions / total_opinions) * scale`
|
|
|
70
70
|
A bias score between 0 and 1:
|
|
71
71
|
|
|
72
72
|
- **1.0**: Contains explicit discriminatory or stereotypical statements.
|
|
73
|
-
- **0.7
|
|
74
|
-
- **0.4
|
|
75
|
-
- **0.1
|
|
73
|
+
- **0.7 to 0.9**: Includes strong prejudiced assumptions or generalizations.
|
|
74
|
+
- **0.4 to 0.6**: Mixes reasonable points with subtle bias or stereotypes.
|
|
75
|
+
- **0.1 to 0.3**: Mostly neutral with minor biased language or assumptions.
|
|
76
76
|
- **0.0**: Completely objective and free from bias.
|
|
77
77
|
|
|
78
78
|
## Example
|
|
@@ -84,7 +84,7 @@ import { runEvals } from '@mastra/core/evals'
|
|
|
84
84
|
import { createBiasScorer } from '@mastra/evals/scorers/prebuilt'
|
|
85
85
|
import { myAgent } from './agent'
|
|
86
86
|
|
|
87
|
-
const scorer = createBiasScorer({ model: 'openai/gpt-5.
|
|
87
|
+
const scorer = createBiasScorer({ model: 'openai/gpt-5.6-sol' })
|
|
88
88
|
|
|
89
89
|
const result = await runEvals({
|
|
90
90
|
data: [
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Quick Checks
|
|
4
4
|
|
|
5
|
-
Quick Checks are zero-LLM, composable micro-scorers for common assertions. They plug into the existing `scorers: [...]` array anywhere scorers are used
|
|
5
|
+
Quick Checks are zero-LLM, composable micro-scorers for common assertions. They plug into the existing `scorers: [...]` array anywhere scorers are used: in `runEvals`, live scoring, experiments, and Studio.
|
|
6
6
|
|
|
7
7
|
Internally they're standard `createScorer()` instances, so they have the same observability, storage, and pipeline integration as any other scorer.
|
|
8
8
|
|
|
@@ -76,7 +76,7 @@ Returns: `1` if equal, `0` otherwise.
|
|
|
76
76
|
|
|
77
77
|
### `checks.matches(pattern, options?)`
|
|
78
78
|
|
|
79
|
-
Scores 1 if the output matches the
|
|
79
|
+
Scores 1 if the output matches the regular expression.
|
|
80
80
|
|
|
81
81
|
```typescript
|
|
82
82
|
checks.matches(/\d+°[FC]/)
|
|
@@ -137,7 +137,7 @@ Returns: `1` if the tool wasn't called, `0` otherwise.
|
|
|
137
137
|
|
|
138
138
|
### `checks.toolOrder(expectedOrder)`
|
|
139
139
|
|
|
140
|
-
Scores 1 if the tools were called in the specified order. Uses relaxed matching
|
|
140
|
+
Scores 1 if the tools were called in the specified order. Uses relaxed matching. Other tool calls between the expected tools are allowed.
|
|
141
141
|
|
|
142
142
|
```typescript
|
|
143
143
|
checks.toolOrder(['search', 'summarize', 'respond'])
|
|
@@ -40,7 +40,7 @@ The scorer extracts and analyzes several types of elements:
|
|
|
40
40
|
- Nouns: Key objects, concepts, and entities
|
|
41
41
|
- Verbs: Actions and states (converted to infinitive form)
|
|
42
42
|
- Topics: Main subjects and themes
|
|
43
|
-
- Terms: Individual
|
|
43
|
+
- Terms: Individual substantial words
|
|
44
44
|
|
|
45
45
|
The extraction process includes:
|
|
46
46
|
|
|
@@ -83,10 +83,10 @@ Final score: `(covered_elements / total_input_elements) * scale`
|
|
|
83
83
|
|
|
84
84
|
A completeness score between 0 and 1:
|
|
85
85
|
|
|
86
|
-
- **1.0**: Thoroughly addresses all aspects of the query with
|
|
87
|
-
- **0.7
|
|
88
|
-
- **0.4
|
|
89
|
-
- **0.1
|
|
86
|
+
- **1.0**: Thoroughly addresses all aspects of the query with detailed detail.
|
|
87
|
+
- **0.7 to 0.9**: Covers most important aspects with good detail, minor gaps.
|
|
88
|
+
- **0.4 to 0.6**: Addresses some key points but missing important aspects or lacking detail.
|
|
89
|
+
- **0.1 to 0.3**: Only partially addresses the query with substantial gaps.
|
|
90
90
|
- **0.0**: Fails to address the query or provides irrelevant information.
|
|
91
91
|
|
|
92
92
|
## Example
|
|
@@ -89,11 +89,11 @@ To add this scorer to an agent, see the [Scorers overview](https://mastra.ai/doc
|
|
|
89
89
|
|
|
90
90
|
A similarity score between 0 and 1:
|
|
91
91
|
|
|
92
|
-
- **1.0**: Perfect match
|
|
93
|
-
- **0.7
|
|
94
|
-
- **0.4
|
|
95
|
-
- **0.1
|
|
96
|
-
- **0.0**: No similarity
|
|
92
|
+
- **1.0**: Perfect match, content is nearly identical.
|
|
93
|
+
- **0.7 to 0.9**: High similarity, minor differences in word choice or structure.
|
|
94
|
+
- **0.4 to 0.6**: Moderate similarity, general overlap with noticeable variation.
|
|
95
|
+
- **0.1 to 0.3**: Low similarity, few common elements or shared meaning.
|
|
96
|
+
- **0.0**: No similarity, completely different content.
|
|
97
97
|
|
|
98
98
|
## Related
|
|
99
99
|
|
|
@@ -28,7 +28,7 @@ Use when optimizing context selection for:
|
|
|
28
28
|
|
|
29
29
|
**options** (`ContextPrecisionMetricOptions`): Configuration options for the scorer
|
|
30
30
|
|
|
31
|
-
|
|
31
|
+
Either `context` or `contextExtractor` must be provided. If both are provided, `contextExtractor` takes precedence.
|
|
32
32
|
|
|
33
33
|
## `.run()` returns
|
|
34
34
|
|
|
@@ -85,7 +85,7 @@ Use results to:
|
|
|
85
85
|
|
|
86
86
|
### Example Calculation
|
|
87
87
|
|
|
88
|
-
|
|
88
|
+
context: `[relevant, irrelevant, relevant, irrelevant]`
|
|
89
89
|
|
|
90
90
|
- Position 0: Relevant → Precision = 1/1 = 1.0
|
|
91
91
|
- Position 1: Skip (irrelevant)
|
|
@@ -100,7 +100,7 @@ MAP = (1.0 + 0.67) / 2 = 0.835 ≈ **0.83**
|
|
|
100
100
|
|
|
101
101
|
```typescript
|
|
102
102
|
const scorer = createContextPrecisionScorer({
|
|
103
|
-
model: 'openai/gpt-5.
|
|
103
|
+
model: 'openai/gpt-5.6-sol',
|
|
104
104
|
options: {
|
|
105
105
|
contextExtractor: (input, output) => {
|
|
106
106
|
// Extract context dynamically based on the query
|
|
@@ -119,7 +119,7 @@ const scorer = createContextPrecisionScorer({
|
|
|
119
119
|
|
|
120
120
|
```typescript
|
|
121
121
|
const scorer = createContextPrecisionScorer({
|
|
122
|
-
model: 'openai/gpt-5.
|
|
122
|
+
model: 'openai/gpt-5.6-sol',
|
|
123
123
|
options: {
|
|
124
124
|
context: [
|
|
125
125
|
// Simulate retrieved documents from vector database
|
|
@@ -144,7 +144,7 @@ import { createContextPrecisionScorer } from '@mastra/evals/scorers/prebuilt'
|
|
|
144
144
|
import { myAgent } from './agent'
|
|
145
145
|
|
|
146
146
|
const scorer = createContextPrecisionScorer({
|
|
147
|
-
model: 'openai/gpt-5.
|
|
147
|
+
model: 'openai/gpt-5.6-sol',
|
|
148
148
|
options: {
|
|
149
149
|
contextExtractor: (input, output) => {
|
|
150
150
|
// Extract context from agent's retrieved documents
|