@mastra/mcp-docs-server 1.2.4-alpha.5 → 1.2.4-alpha.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.docs/docs/agent-builder/access-control.md +2 -0
- package/.docs/docs/agent-builder/browser.md +2 -0
- package/.docs/docs/agent-builder/channels.md +2 -0
- package/.docs/docs/agent-builder/configuration.md +2 -0
- package/.docs/docs/agent-builder/deploying.md +2 -0
- package/.docs/docs/agent-builder/integrations.md +2 -0
- package/.docs/docs/agent-builder/memory.md +2 -0
- package/.docs/docs/agent-builder/model-policy.md +2 -0
- package/.docs/docs/agent-builder/overview.md +2 -0
- package/.docs/docs/agent-builder/skill-registries.md +2 -0
- package/.docs/docs/agent-builder/workspace.md +2 -0
- package/.docs/docs/agent-controller/modes.md +2 -0
- package/.docs/docs/agent-controller/overview.md +2 -0
- package/.docs/docs/agent-controller/session.md +2 -0
- package/.docs/docs/agent-controller/subagents.md +2 -0
- package/.docs/docs/agent-controller/threads-and-state.md +2 -0
- package/.docs/docs/agent-controller/tool-approvals.md +2 -0
- package/.docs/docs/agents/a2a.md +2 -0
- package/.docs/docs/agents/acp.md +2 -0
- package/.docs/docs/agents/adding-voice.md +2 -0
- package/.docs/docs/agents/agent-approval.md +2 -0
- package/.docs/docs/agents/background-tasks.md +2 -0
- package/.docs/docs/agents/channels.md +2 -0
- package/.docs/docs/agents/code-mode.md +2 -0
- package/.docs/docs/agents/durable-agents.md +2 -0
- package/.docs/docs/agents/file-based-agents.md +12 -1
- package/.docs/docs/agents/goals.md +2 -0
- package/.docs/docs/agents/guardrails.md +2 -0
- package/.docs/docs/agents/heartbeats.md +2 -0
- package/.docs/docs/agents/networks.md +2 -0
- package/.docs/docs/agents/overview.md +14 -6
- package/.docs/docs/agents/processors.md +2 -0
- package/.docs/docs/agents/sdk-agents.md +2 -0
- package/.docs/docs/agents/signal-providers.md +2 -0
- package/.docs/docs/agents/signals.md +2 -0
- package/.docs/docs/agents/skills.md +2 -0
- package/.docs/docs/agents/structured-output.md +2 -0
- package/.docs/docs/agents/supervisor-agents.md +2 -0
- package/.docs/docs/agents/using-tools.md +2 -0
- package/.docs/docs/browser/agent-browser.md +2 -0
- package/.docs/docs/browser/browser-viewer.md +2 -0
- package/.docs/docs/browser/overview.md +2 -0
- package/.docs/docs/browser/recording.md +6 -2
- package/.docs/docs/browser/stagehand.md +2 -0
- package/.docs/docs/community/contributing-templates.md +2 -0
- package/.docs/docs/community/discord.md +2 -0
- package/.docs/docs/community/licensing.md +2 -0
- package/.docs/docs/deployment/cloud-providers.md +2 -0
- package/.docs/docs/deployment/mastra-server.md +2 -0
- package/.docs/docs/deployment/monorepo.md +2 -0
- package/.docs/docs/deployment/overview.md +2 -0
- package/.docs/docs/deployment/web-framework.md +2 -0
- package/.docs/docs/deployment/workflow-runners.md +2 -0
- package/.docs/docs/editor/overview.md +2 -0
- package/.docs/docs/editor/prompts.md +2 -0
- package/.docs/docs/editor/tools.md +2 -0
- package/.docs/docs/evals/built-in-scorers.md +2 -0
- package/.docs/docs/evals/custom-scorers.md +2 -0
- package/.docs/docs/evals/datasets/overview.md +2 -0
- package/.docs/docs/evals/datasets/running-experiments.md +2 -0
- package/.docs/docs/evals/evals-with-memory.md +2 -0
- package/.docs/docs/evals/gates-and-verdicts.md +2 -0
- package/.docs/docs/evals/overview.md +2 -0
- package/.docs/docs/evals/quick-checks.md +2 -0
- package/.docs/docs/evals/running-in-ci.md +2 -0
- package/.docs/docs/getting-started/build-with-ai.md +2 -0
- package/.docs/docs/getting-started/manual-install.md +2 -0
- package/.docs/docs/getting-started/project-structure.md +2 -0
- package/.docs/docs/index.md +14 -6
- package/.docs/docs/mastra-platform/configuration.md +2 -0
- package/.docs/docs/mastra-platform/database.md +2 -0
- package/.docs/docs/mastra-platform/github.md +2 -0
- package/.docs/docs/mastra-platform/observability.md +2 -0
- package/.docs/docs/mastra-platform/overview.md +2 -0
- package/.docs/docs/mastra-platform/server.md +2 -0
- package/.docs/docs/mastra-platform/studio.md +2 -0
- package/.docs/docs/mcp/mcp-apps.md +2 -0
- package/.docs/docs/mcp/overview.md +2 -0
- package/.docs/docs/memory/memory-processors.md +2 -0
- package/.docs/docs/memory/message-history.md +2 -0
- package/.docs/docs/memory/multi-user-threads.md +2 -0
- package/.docs/docs/memory/observational-memory.md +2 -0
- package/.docs/docs/memory/overview.md +2 -0
- package/.docs/docs/memory/semantic-recall.md +2 -0
- package/.docs/docs/memory/storage.md +6 -0
- package/.docs/docs/memory/working-memory.md +2 -0
- package/.docs/docs/observability/config.md +2 -0
- package/.docs/docs/observability/integrations/bridges/datadog.md +2 -0
- package/.docs/docs/observability/integrations/bridges/otel.md +2 -0
- package/.docs/docs/observability/integrations/exporters/arize.md +2 -0
- package/.docs/docs/observability/integrations/exporters/arthur.md +2 -0
- package/.docs/docs/observability/integrations/exporters/braintrust.md +2 -0
- package/.docs/docs/observability/integrations/exporters/datadog.md +2 -0
- package/.docs/docs/observability/integrations/exporters/laminar.md +2 -0
- package/.docs/docs/observability/integrations/exporters/langfuse.md +2 -0
- package/.docs/docs/observability/integrations/exporters/langsmith.md +2 -0
- package/.docs/docs/observability/integrations/exporters/mastra-platform.md +2 -0
- package/.docs/docs/observability/integrations/exporters/mastra-storage.md +2 -0
- package/.docs/docs/observability/integrations/exporters/otel.md +2 -0
- package/.docs/docs/observability/integrations/exporters/posthog.md +2 -0
- package/.docs/docs/observability/integrations/exporters/sentry.md +2 -0
- package/.docs/docs/observability/integrations/overview.md +2 -0
- package/.docs/docs/observability/integrations/processors/sensitive-data-filter.md +2 -0
- package/.docs/docs/observability/logging.md +2 -0
- package/.docs/docs/observability/metrics/overview.md +2 -0
- package/.docs/docs/observability/metrics/querying.md +2 -0
- package/.docs/docs/observability/overview.md +2 -0
- package/.docs/docs/observability/storage.md +2 -0
- package/.docs/docs/observability/tracing/overview.md +2 -0
- package/.docs/docs/rag/chunking-and-embedding.md +2 -0
- package/.docs/docs/rag/graph-rag.md +2 -0
- package/.docs/docs/rag/overview.md +2 -0
- package/.docs/docs/rag/retrieval.md +2 -0
- package/.docs/docs/rag/vector-databases.md +2 -0
- package/.docs/docs/server/auth/auth0.md +2 -0
- package/.docs/docs/server/auth/better-auth.md +2 -0
- package/.docs/docs/server/auth/clerk.md +2 -0
- package/.docs/docs/server/auth/composite-auth.md +2 -0
- package/.docs/docs/server/auth/custom-auth-provider.md +2 -0
- package/.docs/docs/server/auth/fga.md +2 -0
- package/.docs/docs/server/auth/firebase.md +2 -0
- package/.docs/docs/server/auth/google.md +2 -0
- package/.docs/docs/server/auth/jwt.md +2 -0
- package/.docs/docs/server/auth/okta.md +2 -0
- package/.docs/docs/server/auth/simple-auth.md +2 -0
- package/.docs/docs/server/auth/supabase.md +2 -0
- package/.docs/docs/server/auth/workos.md +2 -0
- package/.docs/docs/server/auth.md +2 -0
- package/.docs/docs/server/custom-adapters.md +2 -0
- package/.docs/docs/server/custom-api-routes.md +2 -0
- package/.docs/docs/server/mastra-client.md +2 -0
- package/.docs/docs/server/mastra-server.md +2 -0
- package/.docs/docs/server/middleware.md +2 -0
- package/.docs/docs/server/pubsub.md +2 -0
- package/.docs/docs/server/request-context.md +2 -0
- package/.docs/docs/server/server-adapters.md +2 -0
- package/.docs/docs/studio/auth.md +2 -0
- package/.docs/docs/studio/deployment.md +2 -0
- package/.docs/docs/studio/observability.md +2 -0
- package/.docs/docs/studio/overview.md +2 -0
- package/.docs/docs/voice/overview.md +2 -0
- package/.docs/docs/voice/speech-to-speech.md +2 -0
- package/.docs/docs/voice/speech-to-text.md +2 -0
- package/.docs/docs/voice/text-to-speech.md +2 -0
- package/.docs/docs/workflows/agents-and-tools.md +2 -0
- package/.docs/docs/workflows/control-flow.md +2 -0
- package/.docs/docs/workflows/error-handling.md +2 -0
- package/.docs/docs/workflows/human-in-the-loop.md +2 -0
- package/.docs/docs/workflows/overview.md +2 -0
- package/.docs/docs/workflows/scheduled-workflows.md +2 -0
- package/.docs/docs/workflows/snapshots.md +2 -0
- package/.docs/docs/workflows/suspend-and-resume.md +2 -0
- package/.docs/docs/workflows/time-travel.md +2 -0
- package/.docs/docs/workflows/workflow-state.md +2 -0
- package/.docs/docs/workspace/filesystem.md +2 -0
- package/.docs/docs/workspace/lsp.md +2 -0
- package/.docs/docs/workspace/overview.md +2 -0
- package/.docs/docs/workspace/sandbox.md +2 -0
- package/.docs/docs/workspace/search.md +2 -0
- package/.docs/docs/workspace/skills.md +2 -0
- package/.docs/guides/agent-frameworks/ai-sdk.md +2 -0
- package/.docs/guides/build-your-ui/ai-sdk-ui.md +2 -0
- package/.docs/guides/build-your-ui/assistant-ui.md +2 -0
- package/.docs/guides/build-your-ui/copilotkit.md +2 -0
- package/.docs/guides/build-your-ui/openui.md +2 -0
- package/.docs/guides/concepts/multi-agent-systems.md +2 -0
- package/.docs/guides/concepts/streaming.md +2 -0
- package/.docs/guides/deployment/amazon-ec2.md +2 -0
- package/.docs/guides/deployment/aws-bedrock-agentcore.md +2 -0
- package/.docs/guides/deployment/aws-lambda.md +2 -0
- package/.docs/guides/deployment/azure-app-services.md +2 -0
- package/.docs/guides/deployment/cloudflare.md +2 -0
- package/.docs/guides/deployment/digital-ocean.md +2 -0
- package/.docs/guides/deployment/inngest.md +2 -0
- package/.docs/guides/deployment/netlify.md +2 -0
- package/.docs/guides/deployment/temporal.md +2 -0
- package/.docs/guides/deployment/vercel.md +2 -0
- package/.docs/guides/getting-started/astro.md +2 -0
- package/.docs/guides/getting-started/electron.md +2 -0
- package/.docs/guides/getting-started/express.md +2 -0
- package/.docs/guides/getting-started/hono.md +2 -0
- package/.docs/guides/getting-started/nestjs.md +2 -0
- package/.docs/guides/getting-started/next-js.md +2 -0
- package/.docs/guides/getting-started/nuxt.md +2 -0
- package/.docs/guides/getting-started/quickstart.md +2 -0
- package/.docs/guides/getting-started/sveltekit.md +2 -0
- package/.docs/guides/getting-started/vite-react.md +2 -0
- package/.docs/guides/guide/ai-recruiter.md +2 -0
- package/.docs/guides/guide/chef-michel.md +2 -0
- package/.docs/guides/guide/code-review-bot.md +2 -0
- package/.docs/guides/guide/dev-assistant.md +2 -0
- package/.docs/guides/guide/docs-manager.md +2 -0
- package/.docs/guides/guide/firecrawl.md +2 -0
- package/.docs/guides/guide/github-actions-pr-description.md +2 -0
- package/.docs/guides/guide/notes-mcp-server.md +2 -0
- package/.docs/guides/guide/publishing-mcp-server.md +2 -0
- package/.docs/guides/guide/research-assistant.md +2 -0
- package/.docs/guides/guide/research-coordinator.md +2 -0
- package/.docs/guides/guide/signal-provider.md +2 -0
- package/.docs/guides/guide/slack-assistant.md +2 -0
- package/.docs/guides/guide/stock-agent.md +2 -0
- package/.docs/guides/guide/web-search.md +2 -0
- package/.docs/guides/guide/whatsapp-chat-bot.md +2 -0
- package/.docs/guides/index.md +2 -0
- package/.docs/guides/migrations/agentnetwork.md +2 -0
- package/.docs/guides/migrations/ai-sdk-v4-to-v5.md +2 -0
- package/.docs/guides/migrations/mastra-cloud.md +2 -0
- package/.docs/guides/migrations/network-to-supervisor.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/agent.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/cli.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/client.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/deployment.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/evals.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/mastra.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/mcp.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/memory.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/overview.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/processors.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/rag.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/storage.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/tools.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/tracing.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/vectors.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/voice.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/workflows.md +2 -0
- package/.docs/guides/migrations/vnext-to-standard-apis.md +2 -0
- package/.docs/models/embeddings.md +2 -0
- package/.docs/models/environment-variables.md +2 -0
- package/.docs/models/gateways/azure-openai.md +2 -0
- package/.docs/models/gateways/custom-gateways.md +2 -0
- package/.docs/models/gateways/mastra.md +2 -0
- package/.docs/models/gateways/netlify.md +2 -0
- package/.docs/models/gateways/openrouter.md +2 -0
- package/.docs/models/gateways/vercel.md +2 -0
- package/.docs/models/gateways.md +2 -0
- package/.docs/models/index.md +2 -0
- package/.docs/models/providers/302ai.md +2 -0
- package/.docs/models/providers/abacus.md +2 -0
- package/.docs/models/providers/abliteration-ai.md +2 -0
- package/.docs/models/providers/agentrouter.md +2 -0
- package/.docs/models/providers/aihubmix.md +2 -0
- package/.docs/models/providers/alibaba-cn.md +2 -0
- package/.docs/models/providers/alibaba-coding-plan-cn.md +2 -0
- package/.docs/models/providers/alibaba-coding-plan.md +2 -0
- package/.docs/models/providers/alibaba-token-plan-cn.md +2 -0
- package/.docs/models/providers/alibaba-token-plan.md +2 -0
- package/.docs/models/providers/alibaba.md +2 -0
- package/.docs/models/providers/amazon-bedrock.md +2 -0
- package/.docs/models/providers/ambient.md +2 -0
- package/.docs/models/providers/anthropic.md +2 -0
- package/.docs/models/providers/anyapi.md +2 -0
- package/.docs/models/providers/atomic-chat.md +2 -0
- package/.docs/models/providers/auriko.md +2 -0
- package/.docs/models/providers/azure.md +2 -0
- package/.docs/models/providers/bailing.md +2 -0
- package/.docs/models/providers/baseten.md +2 -0
- package/.docs/models/providers/berget.md +2 -0
- package/.docs/models/providers/cerebras.md +2 -0
- package/.docs/models/providers/chutes.md +2 -0
- package/.docs/models/providers/clarifai.md +2 -0
- package/.docs/models/providers/claudinio.md +2 -0
- package/.docs/models/providers/cloudferro-sherlock.md +2 -0
- package/.docs/models/providers/cloudflare-ai-gateway.md +2 -0
- package/.docs/models/providers/cloudflare-workers-ai.md +2 -0
- package/.docs/models/providers/cohere.md +2 -0
- package/.docs/models/providers/cortecs.md +2 -0
- package/.docs/models/providers/crof.md +2 -0
- package/.docs/models/providers/databricks.md +2 -0
- package/.docs/models/providers/deepinfra.md +2 -0
- package/.docs/models/providers/deepseek.md +2 -0
- package/.docs/models/providers/digitalocean.md +2 -0
- package/.docs/models/providers/dinference.md +2 -0
- package/.docs/models/providers/drun.md +2 -0
- package/.docs/models/providers/evroc.md +2 -0
- package/.docs/models/providers/fastrouter.md +2 -0
- package/.docs/models/providers/firepass.md +2 -0
- package/.docs/models/providers/fireworks-ai.md +2 -0
- package/.docs/models/providers/firmware.md +2 -0
- package/.docs/models/providers/freemodel.md +2 -0
- package/.docs/models/providers/friendli.md +2 -0
- package/.docs/models/providers/frogbot.md +2 -0
- package/.docs/models/providers/github-models.md +2 -0
- package/.docs/models/providers/gmicloud.md +5 -1
- package/.docs/models/providers/google-vertex.md +2 -0
- package/.docs/models/providers/google.md +2 -0
- package/.docs/models/providers/groq.md +2 -0
- package/.docs/models/providers/helicone.md +2 -0
- package/.docs/models/providers/hpc-ai.md +2 -0
- package/.docs/models/providers/huggingface.md +2 -0
- package/.docs/models/providers/iflowcn.md +2 -0
- package/.docs/models/providers/inception.md +2 -0
- package/.docs/models/providers/inceptron.md +2 -0
- package/.docs/models/providers/inference.md +2 -0
- package/.docs/models/providers/io-intelligence.md +2 -0
- package/.docs/models/providers/io-net.md +2 -0
- package/.docs/models/providers/jiekou.md +2 -0
- package/.docs/models/providers/kilo.md +2 -0
- package/.docs/models/providers/kimi-for-coding.md +2 -0
- package/.docs/models/providers/kiro.md +2 -0
- package/.docs/models/providers/kuae-cloud-coding-plan.md +2 -0
- package/.docs/models/providers/lilac.md +2 -0
- package/.docs/models/providers/llama.md +2 -0
- package/.docs/models/providers/llmgateway.md +4 -1
- package/.docs/models/providers/llmtr.md +2 -0
- package/.docs/models/providers/lmstudio.md +2 -0
- package/.docs/models/providers/lucidquery.md +2 -0
- package/.docs/models/providers/meganova.md +2 -0
- package/.docs/models/providers/minimax-cn-coding-plan.md +2 -0
- package/.docs/models/providers/minimax-cn.md +2 -0
- package/.docs/models/providers/minimax-coding-plan.md +2 -0
- package/.docs/models/providers/minimax.md +2 -0
- package/.docs/models/providers/mistral.md +2 -0
- package/.docs/models/providers/mixlayer.md +2 -0
- package/.docs/models/providers/moark.md +2 -0
- package/.docs/models/providers/modelscope.md +2 -0
- package/.docs/models/providers/moonshotai-cn.md +2 -0
- package/.docs/models/providers/moonshotai.md +2 -0
- package/.docs/models/providers/morph.md +2 -0
- package/.docs/models/providers/nano-gpt.md +2 -0
- package/.docs/models/providers/nearai.md +2 -0
- package/.docs/models/providers/nebius.md +2 -0
- package/.docs/models/providers/neon.md +2 -0
- package/.docs/models/providers/neuralwatt.md +2 -0
- package/.docs/models/providers/nova.md +2 -0
- package/.docs/models/providers/novita-ai.md +2 -0
- package/.docs/models/providers/nvidia.md +2 -0
- package/.docs/models/providers/ollama-cloud.md +2 -0
- package/.docs/models/providers/ollama.md +2 -0
- package/.docs/models/providers/openai.md +2 -0
- package/.docs/models/providers/opencode-go.md +2 -0
- package/.docs/models/providers/opencode.md +2 -0
- package/.docs/models/providers/orcarouter.md +2 -0
- package/.docs/models/providers/ovhcloud.md +2 -0
- package/.docs/models/providers/perplexity-agent.md +2 -0
- package/.docs/models/providers/perplexity.md +2 -0
- package/.docs/models/providers/poe.md +2 -0
- package/.docs/models/providers/poolside.md +2 -0
- package/.docs/models/providers/privatemode-ai.md +2 -0
- package/.docs/models/providers/qihang-ai.md +2 -0
- package/.docs/models/providers/qiniu-ai.md +2 -0
- package/.docs/models/providers/regolo-ai.md +2 -0
- package/.docs/models/providers/requesty.md +2 -0
- package/.docs/models/providers/routing-run.md +2 -0
- package/.docs/models/providers/sakana.md +2 -0
- package/.docs/models/providers/sarvam.md +2 -0
- package/.docs/models/providers/scaleway.md +2 -0
- package/.docs/models/providers/siliconflow-cn.md +2 -0
- package/.docs/models/providers/siliconflow.md +2 -0
- package/.docs/models/providers/snowflake-cortex.md +2 -0
- package/.docs/models/providers/stackit.md +2 -0
- package/.docs/models/providers/stepfun-ai.md +2 -0
- package/.docs/models/providers/stepfun.md +2 -0
- package/.docs/models/providers/subconscious.md +2 -0
- package/.docs/models/providers/submodel.md +2 -0
- package/.docs/models/providers/synthetic.md +4 -5
- package/.docs/models/providers/tencent-coding-plan.md +2 -0
- package/.docs/models/providers/tencent-token-plan.md +2 -0
- package/.docs/models/providers/tencent-tokenhub.md +2 -0
- package/.docs/models/providers/the-grid-ai.md +2 -0
- package/.docs/models/providers/tinfoil.md +2 -0
- package/.docs/models/providers/togetherai.md +2 -0
- package/.docs/models/providers/umans-ai-coding-plan.md +2 -0
- package/.docs/models/providers/umans-ai.md +2 -0
- package/.docs/models/providers/upstage.md +2 -0
- package/.docs/models/providers/venice.md +2 -0
- package/.docs/models/providers/vivgrid.md +2 -0
- package/.docs/models/providers/vultr.md +2 -0
- package/.docs/models/providers/wafer.ai.md +2 -0
- package/.docs/models/providers/wandb.md +2 -0
- package/.docs/models/providers/xai.md +2 -0
- package/.docs/models/providers/xiaomi-token-plan-ams.md +2 -0
- package/.docs/models/providers/xiaomi-token-plan-cn.md +2 -0
- package/.docs/models/providers/xiaomi-token-plan-sgp.md +2 -0
- package/.docs/models/providers/xiaomi.md +2 -0
- package/.docs/models/providers/xpersona.md +2 -0
- package/.docs/models/providers/zai-coding-plan.md +2 -0
- package/.docs/models/providers/zai.md +2 -0
- package/.docs/models/providers/zeldoc.md +2 -0
- package/.docs/models/providers/zenmux.md +2 -0
- package/.docs/models/providers/zhipuai-coding-plan.md +2 -0
- package/.docs/models/providers/zhipuai.md +2 -0
- package/.docs/models/providers.md +2 -0
- package/.docs/reference/acp/acp-agent.md +2 -0
- package/.docs/reference/acp/create-acp-tool.md +2 -0
- package/.docs/reference/agent-controller/agent-controller-class.md +2 -0
- package/.docs/reference/agent-controller/session.md +2 -0
- package/.docs/reference/agents/agent.md +32 -2
- package/.docs/reference/agents/channels.md +2 -0
- package/.docs/reference/agents/createSkill.md +2 -0
- package/.docs/reference/agents/durable-agent.md +2 -0
- package/.docs/reference/agents/generate.md +94 -92
- package/.docs/reference/agents/generateLegacy.md +2 -0
- package/.docs/reference/agents/getDefaultGenerateOptions.md +2 -0
- package/.docs/reference/agents/getDefaultOptions.md +2 -0
- package/.docs/reference/agents/getDefaultStreamOptions.md +2 -0
- package/.docs/reference/agents/getDescription.md +2 -0
- package/.docs/reference/agents/getInstructions.md +2 -0
- package/.docs/reference/agents/getLLM.md +2 -0
- package/.docs/reference/agents/getMemory.md +2 -0
- package/.docs/reference/agents/getMetadata.md +2 -0
- package/.docs/reference/agents/getModel.md +2 -0
- package/.docs/reference/agents/getSkill.md +2 -0
- package/.docs/reference/agents/getTools.md +2 -0
- package/.docs/reference/agents/getVoice.md +2 -0
- package/.docs/reference/agents/inngest-agent.md +2 -0
- package/.docs/reference/agents/listAgents.md +2 -0
- package/.docs/reference/agents/listScorers.md +2 -0
- package/.docs/reference/agents/listSkills.md +2 -0
- package/.docs/reference/agents/listSuspendedRuns.md +2 -0
- package/.docs/reference/agents/listTools.md +2 -0
- package/.docs/reference/agents/listWorkflows.md +2 -0
- package/.docs/reference/agents/network.md +2 -0
- package/.docs/reference/ai-sdk/chat-route.md +2 -0
- package/.docs/reference/ai-sdk/handle-chat-stream.md +2 -0
- package/.docs/reference/ai-sdk/handle-network-stream.md +2 -0
- package/.docs/reference/ai-sdk/handle-workflow-stream.md +2 -0
- package/.docs/reference/ai-sdk/network-route.md +2 -0
- package/.docs/reference/ai-sdk/to-ai-sdk-messages.md +2 -0
- package/.docs/reference/ai-sdk/to-ai-sdk-stream.md +2 -0
- package/.docs/reference/ai-sdk/to-ai-sdk-v4-messages.md +2 -0
- package/.docs/reference/ai-sdk/to-ai-sdk-v5-messages.md +2 -0
- package/.docs/reference/ai-sdk/with-mastra.md +2 -0
- package/.docs/reference/ai-sdk/workflow-route.md +2 -0
- package/.docs/reference/ai-sdk/workflow-snapshot-to-stream.md +2 -0
- package/.docs/reference/auth/auth0.md +2 -0
- package/.docs/reference/auth/better-auth.md +2 -0
- package/.docs/reference/auth/clerk.md +2 -0
- package/.docs/reference/auth/firebase.md +2 -0
- package/.docs/reference/auth/google.md +2 -0
- package/.docs/reference/auth/jwt.md +2 -0
- package/.docs/reference/auth/okta.md +2 -0
- package/.docs/reference/auth/supabase.md +2 -0
- package/.docs/reference/auth/workos.md +2 -0
- package/.docs/reference/browser/agent-browser.md +2 -0
- package/.docs/reference/browser/browser-viewer.md +2 -0
- package/.docs/reference/browser/mastra-browser.md +2 -0
- package/.docs/reference/browser/stagehand-browser.md +2 -0
- package/.docs/reference/channels/channel-provider.md +2 -0
- package/.docs/reference/channels/slack-provider.md +2 -0
- package/.docs/reference/cli/create-mastra.md +2 -0
- package/.docs/reference/cli/mastra.md +2 -0
- package/.docs/reference/client-js/agent-builder.md +2 -0
- package/.docs/reference/client-js/agents.md +2 -0
- package/.docs/reference/client-js/conversations.md +2 -0
- package/.docs/reference/client-js/error-handling.md +2 -0
- package/.docs/reference/client-js/logs.md +2 -0
- package/.docs/reference/client-js/mastra-client.md +2 -0
- package/.docs/reference/client-js/memory.md +2 -0
- package/.docs/reference/client-js/observability.md +2 -0
- package/.docs/reference/client-js/responses.md +2 -0
- package/.docs/reference/client-js/telemetry.md +2 -0
- package/.docs/reference/client-js/tools.md +2 -0
- package/.docs/reference/client-js/vectors.md +2 -0
- package/.docs/reference/client-js/workflows.md +2 -0
- package/.docs/reference/coding-agent/build-base-prompt.md +2 -0
- package/.docs/reference/coding-agent/create-coding-agent.md +2 -0
- package/.docs/reference/configuration.md +2 -0
- package/.docs/reference/core/addGateway.md +2 -0
- package/.docs/reference/core/getAgent.md +2 -0
- package/.docs/reference/core/getAgentById.md +2 -0
- package/.docs/reference/core/getDeployer.md +2 -0
- package/.docs/reference/core/getEditor.md +2 -0
- package/.docs/reference/core/getGateway.md +2 -0
- package/.docs/reference/core/getGatewayById.md +2 -0
- package/.docs/reference/core/getLogger.md +2 -0
- package/.docs/reference/core/getMCPServer.md +2 -0
- package/.docs/reference/core/getMCPServerById.md +2 -0
- package/.docs/reference/core/getMemory.md +2 -0
- package/.docs/reference/core/getScorer.md +2 -0
- package/.docs/reference/core/getScorerById.md +2 -0
- package/.docs/reference/core/getServer.md +2 -0
- package/.docs/reference/core/getStorage.md +2 -0
- package/.docs/reference/core/getTelemetry.md +2 -0
- package/.docs/reference/core/getVector.md +2 -0
- package/.docs/reference/core/getWorkflow.md +2 -0
- package/.docs/reference/core/listAgents.md +2 -0
- package/.docs/reference/core/listGateways.md +2 -0
- package/.docs/reference/core/listLogs.md +2 -0
- package/.docs/reference/core/listLogsByRunId.md +2 -0
- package/.docs/reference/core/listMCPServers.md +2 -0
- package/.docs/reference/core/listMemory.md +2 -0
- package/.docs/reference/core/listScorers.md +2 -0
- package/.docs/reference/core/listVectors.md +2 -0
- package/.docs/reference/core/listWorkflows.md +2 -0
- package/.docs/reference/core/mastra-class.md +2 -0
- package/.docs/reference/core/mastra-model-gateway.md +2 -0
- package/.docs/reference/core/removeWorkspace.md +2 -0
- package/.docs/reference/core/setLogger.md +2 -0
- package/.docs/reference/core/setStorage.md +2 -0
- package/.docs/reference/datasets/addItem.md +2 -0
- package/.docs/reference/datasets/addItems.md +2 -0
- package/.docs/reference/datasets/compareExperiments.md +2 -0
- package/.docs/reference/datasets/create.md +2 -0
- package/.docs/reference/datasets/dataset.md +2 -0
- package/.docs/reference/datasets/datasets-manager.md +2 -0
- package/.docs/reference/datasets/delete.md +2 -0
- package/.docs/reference/datasets/deleteExperiment.md +2 -0
- package/.docs/reference/datasets/deleteItem.md +2 -0
- package/.docs/reference/datasets/deleteItems.md +2 -0
- package/.docs/reference/datasets/get.md +2 -0
- package/.docs/reference/datasets/getDetails.md +2 -0
- package/.docs/reference/datasets/getExperiment.md +2 -0
- package/.docs/reference/datasets/getItem.md +2 -0
- package/.docs/reference/datasets/getItemHistory.md +2 -0
- package/.docs/reference/datasets/list.md +2 -0
- package/.docs/reference/datasets/listExperimentResults.md +2 -0
- package/.docs/reference/datasets/listExperiments.md +2 -0
- package/.docs/reference/datasets/listItems.md +2 -0
- package/.docs/reference/datasets/listVersions.md +2 -0
- package/.docs/reference/datasets/startExperiment.md +2 -0
- package/.docs/reference/datasets/startExperimentAsync.md +2 -0
- package/.docs/reference/datasets/update.md +2 -0
- package/.docs/reference/datasets/updateItem.md +2 -0
- package/.docs/reference/deployer/cloudflare.md +2 -0
- package/.docs/reference/deployer/netlify.md +2 -0
- package/.docs/reference/deployer/vercel.md +2 -0
- package/.docs/reference/deployer.md +2 -0
- package/.docs/reference/editor/agent-builder/agent-builder-options.md +2 -0
- package/.docs/reference/editor/agent-builder/builder-agent-defaults.md +2 -0
- package/.docs/reference/editor/agent-builder/builder-models.md +2 -0
- package/.docs/reference/editor/blob-store-provider.md +2 -0
- package/.docs/reference/editor/browser-provider.md +2 -0
- package/.docs/reference/editor/filesystem-provider.md +2 -0
- package/.docs/reference/editor/mastra-editor.md +2 -0
- package/.docs/reference/editor/processor-provider.md +2 -0
- package/.docs/reference/editor/sandbox-provider.md +2 -0
- package/.docs/reference/editor/storage-browser-ref.md +2 -0
- package/.docs/reference/editor/storage-workspace-ref.md +2 -0
- package/.docs/reference/editor/tool-provider.md +2 -0
- package/.docs/reference/evals/answer-relevancy.md +2 -0
- package/.docs/reference/evals/answer-similarity.md +2 -0
- package/.docs/reference/evals/bias.md +2 -0
- package/.docs/reference/evals/checks.md +2 -0
- package/.docs/reference/evals/completeness.md +2 -0
- package/.docs/reference/evals/content-similarity.md +2 -0
- package/.docs/reference/evals/context-precision.md +2 -0
- package/.docs/reference/evals/context-relevance.md +2 -0
- package/.docs/reference/evals/create-scorer.md +2 -0
- package/.docs/reference/evals/faithfulness.md +2 -0
- package/.docs/reference/evals/filter-run.md +2 -0
- package/.docs/reference/evals/hallucination.md +2 -0
- package/.docs/reference/evals/keyword-coverage.md +2 -0
- package/.docs/reference/evals/mastra-scorer.md +2 -0
- package/.docs/reference/evals/noise-sensitivity.md +2 -0
- package/.docs/reference/evals/prompt-alignment.md +2 -0
- package/.docs/reference/evals/rubric.md +2 -0
- package/.docs/reference/evals/run-evals.md +2 -0
- package/.docs/reference/evals/scorer-utils.md +2 -0
- package/.docs/reference/evals/textual-difference.md +2 -0
- package/.docs/reference/evals/tone-consistency.md +2 -0
- package/.docs/reference/evals/tool-call-accuracy.md +2 -0
- package/.docs/reference/evals/toxicity.md +2 -0
- package/.docs/reference/evals/trajectory-accuracy.md +2 -0
- package/.docs/reference/index.md +3 -0
- package/.docs/reference/logging/pino-logger.md +2 -0
- package/.docs/reference/mastra-platform/api.md +2 -0
- package/.docs/reference/memory/clone-utilities.md +2 -0
- package/.docs/reference/memory/cloneThread.md +2 -0
- package/.docs/reference/memory/createThread.md +2 -0
- package/.docs/reference/memory/deleteMessages.md +2 -0
- package/.docs/reference/memory/getThreadById.md +2 -0
- package/.docs/reference/memory/listThreads.md +2 -0
- package/.docs/reference/memory/memory-class.md +2 -0
- package/.docs/reference/memory/observational-memory.md +2 -0
- package/.docs/reference/memory/recall.md +2 -0
- package/.docs/reference/memory/serialized-memory-config.md +2 -0
- package/.docs/reference/observability/metrics/automatic-metrics.md +2 -0
- package/.docs/reference/observability/tracing/bridges/datadog.md +2 -0
- package/.docs/reference/observability/tracing/bridges/otel.md +2 -0
- package/.docs/reference/observability/tracing/configuration.md +2 -0
- package/.docs/reference/observability/tracing/exporters/arize.md +2 -0
- package/.docs/reference/observability/tracing/exporters/arthur.md +2 -0
- package/.docs/reference/observability/tracing/exporters/braintrust.md +2 -0
- package/.docs/reference/observability/tracing/exporters/cloud-exporter.md +2 -0
- package/.docs/reference/observability/tracing/exporters/console-exporter.md +2 -0
- package/.docs/reference/observability/tracing/exporters/datadog.md +2 -0
- package/.docs/reference/observability/tracing/exporters/default-exporter.md +2 -0
- package/.docs/reference/observability/tracing/exporters/laminar.md +2 -0
- package/.docs/reference/observability/tracing/exporters/langfuse.md +2 -0
- package/.docs/reference/observability/tracing/exporters/langsmith.md +2 -0
- package/.docs/reference/observability/tracing/exporters/mastra-platform-exporter.md +2 -0
- package/.docs/reference/observability/tracing/exporters/mastra-storage-exporter.md +2 -0
- package/.docs/reference/observability/tracing/exporters/otel.md +2 -0
- package/.docs/reference/observability/tracing/exporters/posthog.md +2 -0
- package/.docs/reference/observability/tracing/exporters/sentry.md +2 -0
- package/.docs/reference/observability/tracing/instances.md +2 -0
- package/.docs/reference/observability/tracing/interfaces.md +2 -0
- package/.docs/reference/observability/tracing/processors/sensitive-data-filter.md +2 -0
- package/.docs/reference/observability/tracing/span-filtering.md +2 -0
- package/.docs/reference/observability/tracing/spans.md +2 -0
- package/.docs/reference/processors/batch-parts-processor.md +2 -0
- package/.docs/reference/processors/cost-guard-processor.md +2 -0
- package/.docs/reference/processors/language-detector.md +2 -0
- package/.docs/reference/processors/message-history-processor.md +2 -0
- package/.docs/reference/processors/moderation-processor.md +2 -0
- package/.docs/reference/processors/pii-detector.md +2 -0
- package/.docs/reference/processors/prefill-error-handler.md +2 -0
- package/.docs/reference/processors/processor-interface.md +2 -0
- package/.docs/reference/processors/prompt-injection-detector.md +2 -0
- package/.docs/reference/processors/provider-history-compat.md +2 -0
- package/.docs/reference/processors/regex-filter-processor.md +2 -0
- package/.docs/reference/processors/response-cache.md +2 -0
- package/.docs/reference/processors/semantic-recall-processor.md +2 -0
- package/.docs/reference/processors/skill-search-processor.md +2 -0
- package/.docs/reference/processors/stream-error-retry-processor.md +2 -0
- package/.docs/reference/processors/system-prompt-scrubber.md +2 -0
- package/.docs/reference/processors/token-limiter-processor.md +2 -0
- package/.docs/reference/processors/tool-call-filter.md +2 -0
- package/.docs/reference/processors/tool-search-processor.md +2 -0
- package/.docs/reference/processors/unicode-normalizer.md +2 -0
- package/.docs/reference/processors/working-memory-processor.md +2 -0
- package/.docs/reference/pubsub/base.md +2 -0
- package/.docs/reference/pubsub/caching-pubsub.md +2 -0
- package/.docs/reference/pubsub/event-emitter.md +2 -0
- package/.docs/reference/pubsub/google-cloud-pubsub.md +2 -0
- package/.docs/reference/pubsub/lease-provider.md +2 -0
- package/.docs/reference/pubsub/redis-streams.md +2 -0
- package/.docs/reference/pubsub/unix-socket-pubsub.md +2 -0
- package/.docs/reference/rag/chunk.md +2 -0
- package/.docs/reference/rag/database-config.md +2 -0
- package/.docs/reference/rag/document.md +2 -0
- package/.docs/reference/rag/embeddings.md +2 -0
- package/.docs/reference/rag/extract-params.md +2 -0
- package/.docs/reference/rag/graph-rag.md +2 -0
- package/.docs/reference/rag/metadata-filters.md +2 -0
- package/.docs/reference/rag/rerank.md +2 -0
- package/.docs/reference/rag/rerankWithScorer.md +2 -0
- package/.docs/reference/server/create-route.md +2 -0
- package/.docs/reference/server/express-adapter.md +2 -0
- package/.docs/reference/server/fastify-adapter.md +2 -0
- package/.docs/reference/server/hono-adapter.md +2 -0
- package/.docs/reference/server/koa-adapter.md +2 -0
- package/.docs/reference/server/mastra-server.md +2 -0
- package/.docs/reference/server/nestjs-adapter.md +2 -0
- package/.docs/reference/server/register-api-route.md +2 -0
- package/.docs/reference/server/routes.md +2 -0
- package/.docs/reference/signals/create-notification-inbox-tool.md +2 -0
- package/.docs/reference/signals/signal-provider.md +2 -0
- package/.docs/reference/signals/task-signal-provider.md +2 -0
- package/.docs/reference/signals/webhook-signal-provider.md +2 -0
- package/.docs/reference/storage/clickhouse.md +2 -0
- package/.docs/reference/storage/cloudflare-d1.md +2 -0
- package/.docs/reference/storage/cloudflare.md +2 -0
- package/.docs/reference/storage/composite.md +2 -0
- package/.docs/reference/storage/convex.md +2 -0
- package/.docs/reference/storage/dsql.md +2 -0
- package/.docs/reference/storage/duckdb.md +2 -0
- package/.docs/reference/storage/dynamodb.md +2 -0
- package/.docs/reference/storage/lance.md +2 -0
- package/.docs/reference/storage/libsql.md +2 -0
- package/.docs/reference/storage/mongodb.md +2 -0
- package/.docs/reference/storage/mssql.md +2 -0
- package/.docs/reference/storage/overview.md +2 -0
- package/.docs/reference/storage/postgresql.md +2 -0
- package/.docs/reference/storage/redis.md +2 -0
- package/.docs/reference/storage/retention.md +180 -0
- package/.docs/reference/storage/spanner.md +2 -0
- package/.docs/reference/storage/upstash.md +2 -0
- package/.docs/reference/streaming/ChunkType.md +2 -0
- package/.docs/reference/streaming/agents/MastraModelOutput.md +2 -0
- package/.docs/reference/streaming/agents/stream.md +2 -0
- package/.docs/reference/streaming/agents/streamLegacy.md +2 -0
- package/.docs/reference/streaming/agents/streamUntilIdle.md +2 -0
- package/.docs/reference/streaming/workflows/observeStream.md +2 -0
- package/.docs/reference/streaming/workflows/resumeStream.md +2 -0
- package/.docs/reference/streaming/workflows/stream.md +2 -0
- package/.docs/reference/streaming/workflows/timeTravelStream.md +2 -0
- package/.docs/reference/templates/overview.md +2 -0
- package/.docs/reference/tools/brightdata.md +2 -0
- package/.docs/reference/tools/create-code-mode.md +2 -0
- package/.docs/reference/tools/create-tool.md +62 -60
- package/.docs/reference/tools/document-chunker-tool.md +2 -0
- package/.docs/reference/tools/graph-rag-tool.md +2 -0
- package/.docs/reference/tools/mcp-client.md +2 -0
- package/.docs/reference/tools/mcp-server.md +2 -0
- package/.docs/reference/tools/perplexity.md +2 -0
- package/.docs/reference/tools/tavily.md +2 -0
- package/.docs/reference/tools/vector-query-tool.md +2 -0
- package/.docs/reference/vectors/astra.md +2 -0
- package/.docs/reference/vectors/chroma.md +2 -0
- package/.docs/reference/vectors/convex.md +2 -0
- package/.docs/reference/vectors/couchbase.md +2 -0
- package/.docs/reference/vectors/duckdb.md +2 -0
- package/.docs/reference/vectors/elasticsearch.md +2 -0
- package/.docs/reference/vectors/lance.md +2 -0
- package/.docs/reference/vectors/libsql.md +2 -0
- package/.docs/reference/vectors/mongodb.md +2 -0
- package/.docs/reference/vectors/opensearch.md +2 -0
- package/.docs/reference/vectors/pg.md +2 -0
- package/.docs/reference/vectors/pinecone.md +2 -0
- package/.docs/reference/vectors/qdrant.md +2 -0
- package/.docs/reference/vectors/s3vectors.md +2 -0
- package/.docs/reference/vectors/turbopuffer.md +2 -0
- package/.docs/reference/vectors/upstash.md +2 -0
- package/.docs/reference/vectors/vectorize.md +2 -0
- package/.docs/reference/voice/aws-nova-sonic.md +2 -0
- package/.docs/reference/voice/azure.md +2 -0
- package/.docs/reference/voice/cloudflare.md +2 -0
- package/.docs/reference/voice/composite-voice.md +2 -0
- package/.docs/reference/voice/deepgram.md +2 -0
- package/.docs/reference/voice/elevenlabs.md +2 -0
- package/.docs/reference/voice/google-gemini-live.md +2 -0
- package/.docs/reference/voice/google.md +2 -0
- package/.docs/reference/voice/inworld-realtime.md +2 -0
- package/.docs/reference/voice/inworld.md +2 -0
- package/.docs/reference/voice/mastra-voice.md +2 -0
- package/.docs/reference/voice/murf.md +2 -0
- package/.docs/reference/voice/openai-realtime.md +2 -0
- package/.docs/reference/voice/openai.md +2 -0
- package/.docs/reference/voice/playai.md +2 -0
- package/.docs/reference/voice/sarvam.md +2 -0
- package/.docs/reference/voice/speechify.md +2 -0
- package/.docs/reference/voice/voice.addInstructions.md +2 -0
- package/.docs/reference/voice/voice.addTools.md +2 -0
- package/.docs/reference/voice/voice.answer.md +2 -0
- package/.docs/reference/voice/voice.close.md +2 -0
- package/.docs/reference/voice/voice.connect.md +2 -0
- package/.docs/reference/voice/voice.events.md +2 -0
- package/.docs/reference/voice/voice.getSpeakers.md +2 -0
- package/.docs/reference/voice/voice.listen.md +2 -0
- package/.docs/reference/voice/voice.off.md +2 -0
- package/.docs/reference/voice/voice.on.md +2 -0
- package/.docs/reference/voice/voice.send.md +2 -0
- package/.docs/reference/voice/voice.speak.md +2 -0
- package/.docs/reference/voice/voice.updateConfig.md +2 -0
- package/.docs/reference/voice/xai-realtime.md +2 -0
- package/.docs/reference/workflows/run-methods/cancel.md +2 -0
- package/.docs/reference/workflows/run-methods/restart.md +2 -0
- package/.docs/reference/workflows/run-methods/resume.md +2 -0
- package/.docs/reference/workflows/run-methods/start.md +2 -0
- package/.docs/reference/workflows/run-methods/startAsync.md +2 -0
- package/.docs/reference/workflows/run-methods/timeTravel.md +2 -0
- package/.docs/reference/workflows/run.md +2 -0
- package/.docs/reference/workflows/step.md +2 -0
- package/.docs/reference/workflows/workflow-methods/branch.md +2 -0
- package/.docs/reference/workflows/workflow-methods/commit.md +2 -0
- package/.docs/reference/workflows/workflow-methods/create-run.md +2 -0
- package/.docs/reference/workflows/workflow-methods/dountil.md +2 -0
- package/.docs/reference/workflows/workflow-methods/dowhile.md +2 -0
- package/.docs/reference/workflows/workflow-methods/foreach.md +2 -0
- package/.docs/reference/workflows/workflow-methods/map.md +2 -0
- package/.docs/reference/workflows/workflow-methods/parallel.md +2 -0
- package/.docs/reference/workflows/workflow-methods/sleep.md +2 -0
- package/.docs/reference/workflows/workflow-methods/sleepUntil.md +2 -0
- package/.docs/reference/workflows/workflow-methods/then.md +2 -0
- package/.docs/reference/workflows/workflow-state-reader.md +2 -0
- package/.docs/reference/workflows/workflow.md +2 -0
- package/.docs/reference/workspace/agentcore-runtime-sandbox.md +2 -0
- package/.docs/reference/workspace/agentfs-filesystem.md +2 -0
- package/.docs/reference/workspace/apple-container-sandbox.md +2 -0
- package/.docs/reference/workspace/archil-filesystem.md +2 -0
- package/.docs/reference/workspace/azure-blob-filesystem.md +2 -0
- package/.docs/reference/workspace/blaxel-sandbox.md +2 -0
- package/.docs/reference/workspace/daytona-sandbox.md +2 -0
- package/.docs/reference/workspace/docker-sandbox.md +2 -0
- package/.docs/reference/workspace/e2b-sandbox.md +2 -0
- package/.docs/reference/workspace/files-sdk-filesystem.md +2 -0
- package/.docs/reference/workspace/filesystem.md +2 -0
- package/.docs/reference/workspace/gcs-filesystem.md +2 -0
- package/.docs/reference/workspace/google-drive-filesystem.md +2 -0
- package/.docs/reference/workspace/local-filesystem.md +2 -0
- package/.docs/reference/workspace/local-sandbox.md +2 -0
- package/.docs/reference/workspace/mesa-filesystem.md +2 -0
- package/.docs/reference/workspace/modal-sandbox.md +2 -0
- package/.docs/reference/workspace/process-manager.md +2 -0
- package/.docs/reference/workspace/railway-sandbox.md +2 -0
- package/.docs/reference/workspace/s3-filesystem.md +2 -0
- package/.docs/reference/workspace/sandbox.md +2 -0
- package/.docs/reference/workspace/vercel-microvm-sandbox.md +2 -0
- package/.docs/reference/workspace/vercel.md +2 -0
- package/.docs/reference/workspace/workspace-class.md +2 -0
- package/CHANGELOG.md +8 -0
- package/package.json +4 -4
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Zhipu AI Coding Plan
|
|
2
4
|
|
|
3
5
|
Access 7 Zhipu AI Coding Plan models through Mastra's model router. Authentication is handled automatically using the `ZHIPU_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Zhipu AI
|
|
2
4
|
|
|
3
5
|
Access 13 Zhipu AI models through Mastra's model router. Authentication is handled automatically using the `ZHIPU_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# AcpAgent class
|
|
2
4
|
|
|
3
5
|
The `AcpAgent` class wraps an Agent Client Protocol (ACP)-compatible coding agent as a Mastra subagent. Use it when a parent Mastra agent should delegate repository inspection, code edits, or other ACP-backed tasks to a named subagent.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# createACPTool()
|
|
2
4
|
|
|
3
5
|
The `createACPTool()` function creates a Mastra tool that sends a `task` string to an Agent Client Protocol (ACP)-compatible coding agent and returns the final ACP response as `output`. Use it when a parent agent should decide when to call the ACP agent as a tool.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Agent class
|
|
2
4
|
|
|
3
5
|
The `Agent` class is the foundation for creating AI agents in Mastra. It provides methods for generating responses, streaming interactions, and handling voice capabilities.
|
|
@@ -215,7 +217,7 @@ agent.sendMessage('Continue with the next step.', {
|
|
|
215
217
|
})
|
|
216
218
|
```
|
|
217
219
|
|
|
218
|
-
Returns `{ accepted: Promise<SendAgentSignalAccepted>, signal: CreatedAgentSignal, persisted?: Promise<void> }`. `accepted` resolves at decision-time, once Mastra decides what to do with the message: `{ action: 'wake', runId, output }` when this process runs the agent (it started or won the lease to start the run), `{ action: 'deliver', runId }` when the message is forwarded onto an existing run (including when this process loses a cross-process wake race), or `{ action: 'persist' }` / `{ action: 'discard' }` when nothing ran. `runId` is the authoritative id of the run that handled the message and is present only on `wake` and `deliver`; for `persist`/`discard` use `result.signal.id` to correlate the stored message. `accepted` resolves for routing — a generation error on a `wake` run surfaces through `output.consumeStream()` — and rejects only when the message
|
|
220
|
+
Returns `{ accepted: Promise<SendAgentSignalAccepted>, signal: CreatedAgentSignal, persisted?: Promise<void> }`. `accepted` resolves at decision-time, once Mastra decides what to do with the message: `{ action: 'wake', runId, output }` when this process runs the agent (it started or won the lease to start the run), `{ action: 'deliver', runId }` when the message is forwarded onto an existing run (including when this process loses a cross-process wake race), or `{ action: 'persist' }` / `{ action: 'discard' }` when nothing ran. `runId` is the authoritative id of the run that handled the message and is present only on `wake` and `deliver`; for `persist`/`discard` use `result.signal.id` to correlate the stored message. `accepted` resolves for routing — a generation error on a `wake` run surfaces through `output.consumeStream()` — and rejects only when the message couldn't be routed or started at all (e.g. a misconfigured agent). `persisted` is only present for `persist` behavior and resolves when Mastra finishes writing the message to memory. On the `wake` action, `output` is the agent stream for in-process consumption.
|
|
219
221
|
|
|
220
222
|
### `queueMessage(message, options)`
|
|
221
223
|
|
|
@@ -258,7 +260,7 @@ Sends a signal to an active run or memory thread.
|
|
|
258
260
|
|
|
259
261
|
**options.ifIdle.attributes** (`Record<string, string | number | boolean>`): Attributes merged into the signal when Mastra accepts it while the target thread is idle.
|
|
260
262
|
|
|
261
|
-
Returns `{ accepted: Promise<SendAgentSignalAccepted>, signal: CreatedAgentSignal, persisted?: Promise<void> }`. `accepted` resolves at decision-time, once Mastra decides what to do with the signal: `{ action: 'wake', runId, output }` when this process runs the agent (it started or won the lease to start the run), `{ action: 'deliver', runId }` when the signal is forwarded onto an existing run (including when this process loses a cross-process wake race), or `{ action: 'persist' }` / `{ action: 'discard' }` when nothing ran. `action` mirrors the winning `behavior` from `ifActive`/`ifIdle`. `runId` is the authoritative id of the run that handled the signal and is present only on `wake` and `deliver`; for `persist`/`discard` use `result.signal.id` to correlate the stored signal. `accepted` resolves for routing — a generation error on a `wake` run surfaces through `output.consumeStream()` — and rejects only when the signal
|
|
263
|
+
Returns `{ accepted: Promise<SendAgentSignalAccepted>, signal: CreatedAgentSignal, persisted?: Promise<void> }`. `accepted` resolves at decision-time, once Mastra decides what to do with the signal: `{ action: 'wake', runId, output }` when this process runs the agent (it started or won the lease to start the run), `{ action: 'deliver', runId }` when the signal is forwarded onto an existing run (including when this process loses a cross-process wake race), or `{ action: 'persist' }` / `{ action: 'discard' }` when nothing ran. `action` mirrors the winning `behavior` from `ifActive`/`ifIdle`. `runId` is the authoritative id of the run that handled the signal and is present only on `wake` and `deliver`; for `persist`/`discard` use `result.signal.id` to correlate the stored signal. `accepted` resolves for routing — a generation error on a `wake` run surfaces through `output.consumeStream()` — and rejects only when the signal couldn't be routed or started at all (e.g. a misconfigured agent). `persisted` is only present for `persist` behavior and resolves when Mastra finishes writing the signal to memory. On the `wake` action, `output` is the agent stream for in-process consumption.
|
|
262
264
|
|
|
263
265
|
In serverless handlers, await `accepted` and pass the `wake` output to your platform's `waitUntil` equivalent so the winning process can drain the stream after the HTTP response returns.
|
|
264
266
|
|
|
@@ -477,6 +479,34 @@ Returns an `AgentThreadSubscription` object with these members:
|
|
|
477
479
|
|
|
478
480
|
**editor** (`false | { instructions?: boolean; tools?: boolean | { description?: boolean } }`): Controls which fields the editor can override for this code-defined agent. Omit to allow editing instructions and tools. See Editor overrides below.
|
|
479
481
|
|
|
482
|
+
## `generate()` memory options
|
|
483
|
+
|
|
484
|
+
Pass `memory` when you call `agent.generate()` to choose which conversation thread the run should read from and write to. The common shape is `memory: { resource: string, thread: string }`, where `resource` identifies the owner and `thread` identifies the conversation. See [Threads and resources](https://mastra.ai/docs/memory/storage) for the concept model.
|
|
485
|
+
|
|
486
|
+
```typescript
|
|
487
|
+
const response = await agent.generate('What did we decide about retries?', {
|
|
488
|
+
memory: {
|
|
489
|
+
resource: 'user-123',
|
|
490
|
+
thread: 'support-thread-456',
|
|
491
|
+
},
|
|
492
|
+
})
|
|
493
|
+
```
|
|
494
|
+
|
|
495
|
+
Use a thread object when you need to create or update thread metadata during the call:
|
|
496
|
+
|
|
497
|
+
```typescript
|
|
498
|
+
const response = await agent.generate('Continue the support conversation.', {
|
|
499
|
+
memory: {
|
|
500
|
+
resource: 'user-123',
|
|
501
|
+
thread: {
|
|
502
|
+
id: 'support-thread-456',
|
|
503
|
+
title: 'Billing support',
|
|
504
|
+
metadata: { category: 'billing' },
|
|
505
|
+
},
|
|
506
|
+
},
|
|
507
|
+
})
|
|
508
|
+
```
|
|
509
|
+
|
|
480
510
|
## Tool hooks
|
|
481
511
|
|
|
482
512
|
Use `hooks` to run logic around every tool call the agent makes, including assigned tools, memory tools, toolsets, client tools, and workspace tools.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# DurableAgent
|
|
2
4
|
|
|
3
5
|
`DurableAgent` wraps an existing [`Agent`](https://mastra.ai/reference/agents/agent) with durable execution and resumable streams. It runs the agentic loop so that a client can disconnect and reconnect without missing events, and it streams those events over [PubSub](https://mastra.ai/docs/server/pubsub). Use it when a run must outlive a single request or survive a dropped connection.
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Agent.generate()
|
|
2
4
|
|
|
3
5
|
The `.generate()` method enables non-streaming response generation from an agent with enhanced capabilities. It accepts messages and optional generation options.
|
|
4
6
|
|
|
5
|
-
## Usage
|
|
6
|
-
|
|
7
|
-
### Basic usage
|
|
7
|
+
## Usage example
|
|
8
8
|
|
|
9
9
|
Call the agent with a message to generate a response:
|
|
10
10
|
|
|
@@ -12,94 +12,6 @@ Call the agent with a message to generate a response:
|
|
|
12
12
|
const result = await agent.generate('message for agent')
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
### With model settings
|
|
16
|
-
|
|
17
|
-
Example of limiting output tokens and setting temperature:
|
|
18
|
-
|
|
19
|
-
```ts
|
|
20
|
-
const limitedResult = await agent.generate('Write a short poem about coding', {
|
|
21
|
-
modelSettings: {
|
|
22
|
-
maxOutputTokens: 50,
|
|
23
|
-
temperature: 0.7,
|
|
24
|
-
},
|
|
25
|
-
})
|
|
26
|
-
```
|
|
27
|
-
|
|
28
|
-
### With memory
|
|
29
|
-
|
|
30
|
-
Give your agent access to conversation history and persistence by configuring memory options. This allows the agent to remember previous interactions and maintain context across messages.
|
|
31
|
-
|
|
32
|
-
```ts
|
|
33
|
-
const memoryResult = await agent.generate('Remember my favorite color is blue', {
|
|
34
|
-
memory: {
|
|
35
|
-
thread: 'user-123-thread',
|
|
36
|
-
resource: 'user-123',
|
|
37
|
-
},
|
|
38
|
-
})
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
### Accessing response headers
|
|
42
|
-
|
|
43
|
-
Some model providers return useful information in response headers, such as remaining token counts or rate limit status. You can access these headers from the result object after generation completes.
|
|
44
|
-
|
|
45
|
-
```ts
|
|
46
|
-
const result = await agent.generate('Hello!')
|
|
47
|
-
const remainingRequests = result.response?.headers?.['anthropic-ratelimit-requests-remaining']
|
|
48
|
-
const remainingTokens = result.response?.headers?.['x-ratelimit-remaining-tokens']
|
|
49
|
-
console.log(`Remaining requests: ${remainingRequests}, Remaining tokens: ${remainingTokens}`)
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
### Analyzing images
|
|
53
|
-
|
|
54
|
-
Agents can analyze and describe images by processing both the visual content and any text within them. To enable image analysis, pass an object with `type: 'image'` and the image URL in the `content` array. You can combine image content with text prompts to guide the agent's analysis.
|
|
55
|
-
|
|
56
|
-
```typescript
|
|
57
|
-
const response = await agent.generate([
|
|
58
|
-
{
|
|
59
|
-
role: 'user',
|
|
60
|
-
content: [
|
|
61
|
-
{
|
|
62
|
-
type: 'image',
|
|
63
|
-
image: 'https://placebear.com/cache/395-205.jpg',
|
|
64
|
-
mimeType: 'image/jpeg',
|
|
65
|
-
},
|
|
66
|
-
{
|
|
67
|
-
type: 'text',
|
|
68
|
-
text: 'Describe the image in detail, and extract all the text in the image.',
|
|
69
|
-
},
|
|
70
|
-
],
|
|
71
|
-
},
|
|
72
|
-
])
|
|
73
|
-
|
|
74
|
-
console.log(response.text)
|
|
75
|
-
```
|
|
76
|
-
|
|
77
|
-
### Using `maxSteps`
|
|
78
|
-
|
|
79
|
-
The `maxSteps` parameter controls the maximum number of sequential LLM calls an agent can make. Each step includes generating a response, executing any tool calls, and processing the result. Limiting steps helps prevent infinite loops, reduce latency, and control token usage for agents that use tools. The default is 5, but can be increased:
|
|
80
|
-
|
|
81
|
-
```typescript
|
|
82
|
-
const response = await agent.generate('Help me organize my day', {
|
|
83
|
-
maxSteps: 10,
|
|
84
|
-
})
|
|
85
|
-
|
|
86
|
-
console.log(response.text)
|
|
87
|
-
```
|
|
88
|
-
|
|
89
|
-
### Using `onStepFinish`
|
|
90
|
-
|
|
91
|
-
You can monitor the progress of multi-step operations using the `onStepFinish` callback. This is useful for debugging or providing progress updates to users.
|
|
92
|
-
|
|
93
|
-
`onStepFinish` is only available when streaming or generating text without structured output.
|
|
94
|
-
|
|
95
|
-
```typescript
|
|
96
|
-
const response = await agent.generate('Help me organize my day', {
|
|
97
|
-
onStepFinish: ({ text, toolCalls, toolResults, finishReason, usage }) => {
|
|
98
|
-
console.log({ text, toolCalls, toolResults, finishReason, usage })
|
|
99
|
-
},
|
|
100
|
-
})
|
|
101
|
-
```
|
|
102
|
-
|
|
103
15
|
## Parameters
|
|
104
16
|
|
|
105
17
|
**messages** (`string | string[] | CoreMessage[] | AiMessageType[] | UIMessageWithMetadata[]`): The messages to send to the agent. Can be a single string, array of strings, or structured message objects.
|
|
@@ -454,4 +366,94 @@ For the streaming version of the same chunk shape, see the [ChunkType reference]
|
|
|
454
366
|
|
|
455
367
|
**tripwire** (`StepTripwireData`): Tripwire data if content was blocked by a processor.
|
|
456
368
|
|
|
457
|
-
**scoringData** (`object`): Scoring data for evals when \`returnScorerData\` is enabled.
|
|
369
|
+
**scoringData** (`object`): Scoring data for evals when \`returnScorerData\` is enabled.
|
|
370
|
+
|
|
371
|
+
## More examples
|
|
372
|
+
|
|
373
|
+
### With model settings
|
|
374
|
+
|
|
375
|
+
Example of limiting output tokens and setting temperature:
|
|
376
|
+
|
|
377
|
+
```ts
|
|
378
|
+
const limitedResult = await agent.generate('Write a short poem about coding', {
|
|
379
|
+
modelSettings: {
|
|
380
|
+
maxOutputTokens: 50,
|
|
381
|
+
temperature: 0.7,
|
|
382
|
+
},
|
|
383
|
+
})
|
|
384
|
+
```
|
|
385
|
+
|
|
386
|
+
### With memory
|
|
387
|
+
|
|
388
|
+
Give your agent access to conversation history and persistence by configuring memory options. This allows the agent to remember previous interactions and maintain context across messages.
|
|
389
|
+
|
|
390
|
+
```ts
|
|
391
|
+
const memoryResult = await agent.generate('Remember my favorite color is blue', {
|
|
392
|
+
memory: {
|
|
393
|
+
thread: 'user-123-thread',
|
|
394
|
+
resource: 'user-123',
|
|
395
|
+
},
|
|
396
|
+
})
|
|
397
|
+
```
|
|
398
|
+
|
|
399
|
+
### Accessing response headers
|
|
400
|
+
|
|
401
|
+
Some model providers return useful information in response headers, such as remaining token counts or rate limit status. You can access these headers from the result object after generation completes.
|
|
402
|
+
|
|
403
|
+
```ts
|
|
404
|
+
const result = await agent.generate('Hello!')
|
|
405
|
+
const remainingRequests = result.response?.headers?.['anthropic-ratelimit-requests-remaining']
|
|
406
|
+
const remainingTokens = result.response?.headers?.['x-ratelimit-remaining-tokens']
|
|
407
|
+
console.log(`Remaining requests: ${remainingRequests}, Remaining tokens: ${remainingTokens}`)
|
|
408
|
+
```
|
|
409
|
+
|
|
410
|
+
### Analyzing images
|
|
411
|
+
|
|
412
|
+
Agents can analyze and describe images by processing both the visual content and any text within them. To enable image analysis, pass an object with `type: 'image'` and the image URL in the `content` array. You can combine image content with text prompts to guide the agent's analysis.
|
|
413
|
+
|
|
414
|
+
```typescript
|
|
415
|
+
const response = await agent.generate([
|
|
416
|
+
{
|
|
417
|
+
role: 'user',
|
|
418
|
+
content: [
|
|
419
|
+
{
|
|
420
|
+
type: 'image',
|
|
421
|
+
image: 'https://placebear.com/cache/395-205.jpg',
|
|
422
|
+
mimeType: 'image/jpeg',
|
|
423
|
+
},
|
|
424
|
+
{
|
|
425
|
+
type: 'text',
|
|
426
|
+
text: 'Describe the image in detail, and extract all the text in the image.',
|
|
427
|
+
},
|
|
428
|
+
],
|
|
429
|
+
},
|
|
430
|
+
])
|
|
431
|
+
|
|
432
|
+
console.log(response.text)
|
|
433
|
+
```
|
|
434
|
+
|
|
435
|
+
### Using `maxSteps`
|
|
436
|
+
|
|
437
|
+
The `maxSteps` parameter controls the maximum number of sequential LLM calls an agent can make. Each step includes generating a response, executing any tool calls, and processing the result. Limiting steps helps prevent infinite loops, reduce latency, and control token usage for agents that use tools. The default is 5, but can be increased:
|
|
438
|
+
|
|
439
|
+
```typescript
|
|
440
|
+
const response = await agent.generate('Help me organize my day', {
|
|
441
|
+
maxSteps: 10,
|
|
442
|
+
})
|
|
443
|
+
|
|
444
|
+
console.log(response.text)
|
|
445
|
+
```
|
|
446
|
+
|
|
447
|
+
### Using `onStepFinish`
|
|
448
|
+
|
|
449
|
+
You can monitor the progress of multi-step operations using the `onStepFinish` callback. This is useful for debugging or providing progress updates to users.
|
|
450
|
+
|
|
451
|
+
`onStepFinish` is only available when streaming or generating text without structured output.
|
|
452
|
+
|
|
453
|
+
```typescript
|
|
454
|
+
const response = await agent.generate('Help me organize my day', {
|
|
455
|
+
onStepFinish: ({ text, toolCalls, toolResults, finishReason, usage }) => {
|
|
456
|
+
console.log({ text, toolCalls, toolResults, finishReason, usage })
|
|
457
|
+
},
|
|
458
|
+
})
|
|
459
|
+
```
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Agent.generateLegacy() (Legacy)
|
|
2
4
|
|
|
3
5
|
> **Warning:** **Deprecated**: This method is deprecated and only works with V1 models. For V2 models, use the new [`.generate()`](https://mastra.ai/reference/agents/generate) method instead.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Agent.getDefaultGenerateOptionsLegacy()
|
|
2
4
|
|
|
3
5
|
> **Warning:** **Deprecated**: This method is deprecated and only works with V1 models. For V2 models, use the new [`.getDefaultOptions()`](https://mastra.ai/reference/agents/getDefaultOptions) method instead.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Agent.getDefaultOptions()
|
|
2
4
|
|
|
3
5
|
Agents can be configured with default options for memory usage, output format, and iteration steps. The `.getDefaultOptions()` method returns these defaults, resolving them if they're functions. These options apply to all `stream()` and `generate()` calls unless overridden and are useful for inspecting an agent’s unknown defaults.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Agent.getDefaultStreamOptionsLegacy()
|
|
2
4
|
|
|
3
5
|
> **Warning:** **Deprecated**: This method is deprecated and only works with V1 models. For V2 models, use the new [`.getDefaultOptions()`](https://mastra.ai/reference/agents/getDefaultOptions) method instead.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Agent.getDescription()
|
|
2
4
|
|
|
3
5
|
The `.getDescription()` method retrieves the description configured for an agent. This method returns a string description that describes the agent's purpose and capabilities.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Agent.getInstructions()
|
|
2
4
|
|
|
3
5
|
The `.getInstructions()` method retrieves the instructions configured for an agent, resolving them if they're a function. These instructions guide the agent's behavior and define its capabilities and constraints.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Agent.getLLM()
|
|
2
4
|
|
|
3
5
|
The `.getLLM()` method retrieves the language model instance configured for an agent, resolving it if it's a function. You can also pass a request-scoped `model` override without mutating the agent's configured model.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Agent.getMemory()
|
|
2
4
|
|
|
3
5
|
The `.getMemory()` method retrieves the memory system associated with an agent. This method is used to access the agent's memory capabilities for storing and retrieving information across conversations.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Agent.getMetadata()
|
|
2
4
|
|
|
3
5
|
The `.getMetadata()` method retrieves the metadata configured for an agent, resolving it if it's a function. Use metadata to classify agents in clients without encoding that data in the agent ID or name.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Agent.getModel()
|
|
2
4
|
|
|
3
5
|
The `.getModel()` method retrieves the language model configured for an agent, resolving it if it's a function. This method is used to access the underlying model that powers the agent's capabilities.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Agent.getTools()
|
|
2
4
|
|
|
3
5
|
The `.getTools()` method retrieves the tools configured for an agent, resolving them if they're a function. These tools extend the agent's capabilities, allowing it to perform specific actions or access external systems.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Agent.getVoice()
|
|
2
4
|
|
|
3
5
|
The `.getVoice()` method retrieves the voice provider configured for an agent, resolving it if it's a function. This method is used to access the agent's speech capabilities for text-to-speech and speech-to-text functionality.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# `createInngestAgent()`
|
|
2
4
|
|
|
3
5
|
`createInngestAgent()` wraps an existing [`Agent`](https://mastra.ai/reference/agents/agent) with [Inngest](https://www.inngest.com/docs)-powered durable execution. Like [`createDurableAgent()`](https://mastra.ai/reference/agents/durable-agent), it streams events over [PubSub](https://mastra.ai/docs/server/pubsub) and supports resumable streams, but runs the agentic loop on Inngest's execution engine instead of in-process. Use it when a run must survive process restarts or run in a distributed environment.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Agent.listAgents()
|
|
2
4
|
|
|
3
5
|
The `.listAgents()` method retrieves the subagents configured for an agent, resolving them if they're a function. These subagents enable the agent to access other agents and perform complex actions.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Agent.listScorers()
|
|
2
4
|
|
|
3
5
|
The `.listScorers()` method retrieves the scoring configuration configured for an agent, resolving it if it's a function. This method provides access to the scoring system used for evaluating agent responses and performance.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Agent.listTools()
|
|
2
4
|
|
|
3
5
|
The `.listTools()` method retrieves the tools configured for an agent, resolving them if they're a function. These tools extend the agent's capabilities, allowing it to perform specific actions or access external systems.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Agent.listWorkflows()
|
|
2
4
|
|
|
3
5
|
The `.listWorkflows()` method retrieves the workflows configured for an agent, resolving them if they're a function. These workflows enable the agent to execute complex, multi-step processes with defined execution paths.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# chatRoute()
|
|
2
4
|
|
|
3
5
|
Creates a chat route handler for streaming agent conversations using the AI SDK format. This function registers an HTTP `POST` endpoint that accepts messages, executes an agent, and streams the response back to the client in AI SDK-compatible format. You have to use it inside a [custom API route](https://mastra.ai/docs/server/custom-api-routes).
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# handleChatStream()
|
|
2
4
|
|
|
3
5
|
Framework-agnostic handler for streaming agent chat in AI SDK-compatible format. Use this function directly when you need to handle chat streaming outside Hono or Mastra's own [apiRoutes](https://mastra.ai/docs/server/custom-api-routes) feature.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# handleNetworkStream()
|
|
2
4
|
|
|
3
5
|
> **Deprecated:** Agent networks are deprecated and will be removed in a future release. Use [supervisor agents](https://mastra.ai/docs/agents/supervisor-agents) with `agent.stream()` or `agent.generate()` instead. See the [migration guide](https://mastra.ai/guides/migrations/network-to-supervisor) to upgrade.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# handleWorkflowStream()
|
|
2
4
|
|
|
3
5
|
Framework-agnostic handler for streaming workflow execution in AI SDK-compatible format. Use this function directly when you need to handle workflow streaming outside Hono or Mastra's own [apiRoutes](https://mastra.ai/docs/server/custom-api-routes) feature.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# networkRoute()
|
|
2
4
|
|
|
3
5
|
> **Deprecated:** Agent networks are deprecated and will be removed in a future release. Use [supervisor agents](https://mastra.ai/docs/agents/supervisor-agents) with `agent.stream()` or `agent.generate()` instead. See the [migration guide](https://mastra.ai/guides/migrations/network-to-supervisor) to upgrade.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# toAISdkMessages()
|
|
2
4
|
|
|
3
5
|
Converts messages from various input formats to AI SDK UI message format. `toAISdkMessages()` keeps the existing AI SDK v5/default behavior. If your app is typed against AI SDK v6, pass `version: 'v6'`.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# toAISdkStream()
|
|
2
4
|
|
|
3
5
|
Converts Mastra streams (agent, network, or workflow) to AI SDK-compatible streams. Use this function when you need to manually transform Mastra streams for use with AI SDK's `createUIMessageStream()` and `createUIMessageStreamResponse()`.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# toAISdkV4Messages()
|
|
2
4
|
|
|
3
5
|
Converts messages from various input formats to AI SDK V4 UI message format. This function accepts messages in multiple formats (strings, AI SDK V4/V5 messages, Mastra DB messages, etc.) and normalizes them to the AI SDK V4 `UIMessage` format, which is suitable for use with AI SDK UI components like `useChat()`.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# toAISdkV5Messages()
|
|
2
4
|
|
|
3
5
|
Converts messages from various input formats to AI SDK V5 (and later) UI message format. This function accepts messages in multiple formats (strings, AI SDK V4/V5 messages, Mastra DB messages, etc.) and normalizes them to the AI SDK V5+ `UIMessage` format, which is suitable for use with AI SDK UI components like `useChat()`.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# workflowRoute()
|
|
2
4
|
|
|
3
5
|
Creates a workflow route handler for streaming workflow execution using the AI SDK format. This function registers an HTTP `POST` endpoint that accepts input data, executes a workflow, and streams the response back to the client in AI SDK-compatible format. You have to use it inside a [custom API route](https://mastra.ai/docs/server/custom-api-routes).
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# workflowSnapshotToStream()
|
|
2
4
|
|
|
3
5
|
Converts a `WorkflowState` object (as returned by `workflow.getWorkflowRunById()`) into a `ReadableStream` of AI SDK UIMessage data parts. The stream contains the same `WorkflowDataPart` and `WorkflowStepDataPart` chunks that the live [`workflowRoute()`](https://mastra.ai/reference/ai-sdk/workflow-route) produces.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# MastraAuthAuth0 class
|
|
2
4
|
|
|
3
5
|
The `MastraAuthAuth0` class provides authentication for Mastra using Auth0. It verifies incoming requests using Auth0-issued JWT tokens and integrates with the Mastra server using the `auth` option.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# MastraAuthBetterAuth class
|
|
2
4
|
|
|
3
5
|
The `MastraAuthBetterAuth` class provides authentication for Mastra applications using Better Auth. It verifies incoming requests with Better Auth sessions and integrates with the Mastra server using the `auth` option.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# MastraAuthClerk class
|
|
2
4
|
|
|
3
5
|
The `MastraAuthClerk` class provides authentication for Mastra applications using Clerk. It verifies incoming requests with Clerk-issued JWT tokens and integrates with the Mastra server using the `auth` option.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# MastraAuthFirebase class
|
|
2
4
|
|
|
3
5
|
The `MastraAuthFirebase` class provides authentication for Mastra using Firebase Authentication. It verifies incoming requests using Firebase ID tokens and integrates with the Mastra server using the `auth` option.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# MastraJwtAuth class
|
|
2
4
|
|
|
3
5
|
The `MastraJwtAuth` class provides a lightweight authentication mechanism for Mastra using JSON Web Tokens (JWTs). It verifies incoming requests based on a shared secret and integrates with the Mastra server using the `auth` option.
|