@mastra/mcp-docs-server 0.13.39 → 1.0.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.docs/organized/changelogs/%40internal%2Fai-sdk-v4.md +1 -0
- package/.docs/organized/changelogs/%40internal%2Fchangeset-cli.md +0 -10
- package/.docs/organized/changelogs/%40internal%2Fexternal-types.md +0 -10
- package/.docs/organized/changelogs/%40internal%2Fstorage-test-utils.md +36 -36
- package/.docs/organized/changelogs/%40internal%2Ftypes-builder.md +0 -10
- package/.docs/organized/changelogs/%40mastra%2Fagent-builder.md +70 -70
- package/.docs/organized/changelogs/%40mastra%2Fai-sdk.md +40 -40
- package/.docs/organized/changelogs/%40mastra%2Fastra.md +19 -19
- package/.docs/organized/changelogs/%40mastra%2Fauth.md +4 -14
- package/.docs/organized/changelogs/%40mastra%2Fchroma.md +18 -18
- package/.docs/organized/changelogs/%40mastra%2Fclickhouse.md +199 -199
- package/.docs/organized/changelogs/%40mastra%2Fclient-js.md +220 -220
- package/.docs/organized/changelogs/%40mastra%2Fcloudflare-d1.md +190 -190
- package/.docs/organized/changelogs/%40mastra%2Fcloudflare.md +199 -199
- package/.docs/organized/changelogs/%40mastra%2Fcodemod.md +7 -0
- package/.docs/organized/changelogs/%40mastra%2Fcore.md +210 -210
- package/.docs/organized/changelogs/%40mastra%2Fcouchbase.md +16 -16
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloud.md +69 -69
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloudflare.md +67 -67
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-netlify.md +70 -70
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-vercel.md +67 -67
- package/.docs/organized/changelogs/%40mastra%2Fdeployer.md +209 -209
- package/.docs/organized/changelogs/%40mastra%2Fdynamodb.md +191 -191
- package/.docs/organized/changelogs/%40mastra%2Fevals.md +34 -34
- package/.docs/organized/changelogs/%40mastra%2Ffastembed.md +5 -13
- package/.docs/organized/changelogs/%40mastra%2Flance.md +182 -182
- package/.docs/organized/changelogs/%40mastra%2Flibsql.md +199 -199
- package/.docs/organized/changelogs/%40mastra%2Floggers.md +20 -20
- package/.docs/organized/changelogs/%40mastra%2Fmcp-docs-server.md +56 -56
- package/.docs/organized/changelogs/%40mastra%2Fmcp-registry-registry.md +20 -20
- package/.docs/organized/changelogs/%40mastra%2Fmcp.md +65 -65
- package/.docs/organized/changelogs/%40mastra%2Fmemory.md +228 -228
- package/.docs/organized/changelogs/%40mastra%2Fmongodb.md +199 -199
- package/.docs/organized/changelogs/%40mastra%2Fmssql.md +206 -206
- package/.docs/organized/changelogs/%40mastra%2Fopensearch.md +19 -19
- package/.docs/organized/changelogs/%40mastra%2Fpg.md +197 -197
- package/.docs/organized/changelogs/%40mastra%2Fpinecone.md +16 -16
- package/.docs/organized/changelogs/%40mastra%2Fplayground-ui.md +216 -216
- package/.docs/organized/changelogs/%40mastra%2Fqdrant.md +16 -16
- package/.docs/organized/changelogs/%40mastra%2Frag.md +61 -61
- package/.docs/organized/changelogs/%40mastra%2Freact.md +66 -66
- package/.docs/organized/changelogs/%40mastra%2Fs3vectors.md +9 -17
- package/.docs/organized/changelogs/%40mastra%2Fschema-compat.md +6 -30
- package/.docs/organized/changelogs/%40mastra%2Fserver.md +203 -203
- package/.docs/organized/changelogs/%40mastra%2Fturbopuffer.md +16 -16
- package/.docs/organized/changelogs/%40mastra%2Fupstash.md +190 -190
- package/.docs/organized/changelogs/%40mastra%2Fvectorize.md +18 -18
- package/.docs/organized/changelogs/%40mastra%2Fvoice-azure.md +21 -21
- package/.docs/organized/changelogs/%40mastra%2Fvoice-cloudflare.md +20 -20
- package/.docs/organized/changelogs/%40mastra%2Fvoice-deepgram.md +20 -20
- package/.docs/organized/changelogs/%40mastra%2Fvoice-elevenlabs.md +20 -20
- package/.docs/organized/changelogs/%40mastra%2Fvoice-gladia.md +20 -20
- package/.docs/organized/changelogs/%40mastra%2Fvoice-google-gemini-live.md +56 -56
- package/.docs/organized/changelogs/%40mastra%2Fvoice-google.md +20 -20
- package/.docs/organized/changelogs/%40mastra%2Fvoice-murf.md +20 -20
- package/.docs/organized/changelogs/%40mastra%2Fvoice-openai-realtime.md +56 -56
- package/.docs/organized/changelogs/%40mastra%2Fvoice-openai.md +20 -20
- package/.docs/organized/changelogs/%40mastra%2Fvoice-playai.md +20 -20
- package/.docs/organized/changelogs/%40mastra%2Fvoice-sarvam.md +20 -20
- package/.docs/organized/changelogs/%40mastra%2Fvoice-speechify.md +20 -20
- package/.docs/organized/changelogs/create-mastra.md +29 -29
- package/.docs/organized/changelogs/mastra.md +93 -93
- package/.docs/organized/code-examples/a2a.md +4 -2
- package/.docs/organized/code-examples/agui.md +12 -9
- package/.docs/organized/code-examples/ai-sdk-useChat.md +12 -18
- package/.docs/organized/code-examples/ai-sdk-v5.md +4 -2
- package/.docs/organized/code-examples/bird-checker-with-express.md +5 -4
- package/.docs/organized/code-examples/bird-checker-with-nextjs-and-eval.md +4 -3
- package/.docs/organized/code-examples/bird-checker-with-nextjs.md +4 -3
- package/.docs/organized/code-examples/client-side-tools.md +1 -0
- package/.docs/organized/code-examples/crypto-chatbot.md +1 -1
- package/.docs/organized/code-examples/experimental-auth-weather-agent.md +8 -177
- package/.docs/organized/code-examples/fireworks-r1.md +2 -2
- package/.docs/organized/code-examples/heads-up-game.md +10 -7
- package/.docs/organized/code-examples/mcp-configuration.md +5 -3
- package/.docs/organized/code-examples/mcp-registry-registry.md +3 -2
- package/.docs/organized/code-examples/memory-per-resource-example.md +4 -2
- package/.docs/organized/code-examples/memory-todo-agent.md +1 -0
- package/.docs/organized/code-examples/memory-with-context.md +2 -1
- package/.docs/organized/code-examples/memory-with-libsql.md +4 -2
- package/.docs/organized/code-examples/memory-with-mongodb.md +4 -2
- package/.docs/organized/code-examples/memory-with-pg.md +4 -2
- package/.docs/organized/code-examples/memory-with-processors.md +13 -8
- package/.docs/organized/code-examples/memory-with-upstash.md +5 -3
- package/.docs/organized/code-examples/openapi-spec-writer.md +32 -41
- package/.docs/organized/code-examples/quick-start.md +5 -32
- package/.docs/organized/code-examples/stock-price-tool.md +6 -5
- package/.docs/organized/code-examples/weather-agent.md +21 -16
- package/.docs/organized/code-examples/workflow-ai-recruiter.md +3 -2
- package/.docs/organized/code-examples/workflow-with-inline-steps.md +9 -12
- package/.docs/organized/code-examples/workflow-with-memory.md +16 -15
- package/.docs/organized/code-examples/workflow-with-separate-steps.md +2 -2
- package/.docs/organized/code-examples/workflow-with-suspend-resume.md +3 -2
- package/.docs/raw/agents/adding-voice.mdx +27 -22
- package/.docs/raw/agents/agent-memory.mdx +24 -16
- package/.docs/raw/agents/guardrails.mdx +33 -12
- package/.docs/raw/agents/networks.mdx +8 -4
- package/.docs/raw/agents/overview.mdx +23 -17
- package/.docs/raw/agents/using-tools.mdx +11 -8
- package/.docs/raw/auth/auth0.mdx +9 -9
- package/.docs/raw/auth/clerk.mdx +7 -7
- package/.docs/raw/auth/firebase.mdx +9 -9
- package/.docs/raw/auth/index.mdx +6 -6
- package/.docs/raw/auth/jwt.mdx +7 -7
- package/.docs/raw/auth/supabase.mdx +8 -8
- package/.docs/raw/auth/workos.mdx +9 -9
- package/.docs/raw/community/contributing-templates.mdx +3 -3
- package/.docs/raw/community/discord.mdx +1 -1
- package/.docs/raw/course/01-first-agent/03-verifying-installation.md +1 -1
- package/.docs/raw/course/01-first-agent/08-exporting-your-agent.md +2 -1
- package/.docs/raw/course/01-first-agent/16-adding-memory-to-agent.md +2 -1
- package/.docs/raw/course/02-agent-tools-mcp/02-installing-mcp.md +1 -1
- package/.docs/raw/course/02-agent-tools-mcp/31-enhancing-memory-configuration.md +2 -0
- package/.docs/raw/course/03-agent-memory/03-installing-memory.md +1 -1
- package/.docs/raw/course/03-agent-memory/04-creating-basic-memory-agent.md +1 -0
- package/.docs/raw/course/03-agent-memory/10-storage-configuration.md +2 -3
- package/.docs/raw/course/03-agent-memory/13-vector-store-configuration.md +2 -0
- package/.docs/raw/course/03-agent-memory/16-configuring-semantic-recall.md +2 -0
- package/.docs/raw/course/03-agent-memory/18-advanced-configuration-semantic-recall.md +1 -0
- package/.docs/raw/course/03-agent-memory/21-configuring-working-memory.md +2 -0
- package/.docs/raw/course/03-agent-memory/22-custom-working-memory-templates.md +1 -0
- package/.docs/raw/course/03-agent-memory/25-combining-memory-features.md +1 -0
- package/.docs/raw/course/03-agent-memory/27-creating-learning-assistant.md +1 -0
- package/.docs/raw/course/04-workflows/08-running-workflows-programmatically.md +2 -2
- package/.docs/raw/deployment/cloud-providers/amazon-ec2.mdx +6 -6
- package/.docs/raw/deployment/cloud-providers/aws-lambda.mdx +8 -6
- package/.docs/raw/deployment/cloud-providers/azure-app-services.mdx +5 -5
- package/.docs/raw/deployment/cloud-providers/digital-ocean.mdx +5 -5
- package/.docs/raw/deployment/cloud-providers/index.mdx +11 -8
- package/.docs/raw/deployment/monorepo.mdx +2 -2
- package/.docs/raw/deployment/overview.mdx +2 -2
- package/.docs/raw/deployment/server-deployment.mdx +2 -10
- package/.docs/raw/deployment/serverless-platforms/cloudflare-deployer.mdx +5 -5
- package/.docs/raw/deployment/serverless-platforms/index.mdx +10 -7
- package/.docs/raw/deployment/serverless-platforms/netlify-deployer.mdx +5 -5
- package/.docs/raw/deployment/serverless-platforms/vercel-deployer.mdx +5 -5
- package/.docs/raw/deployment/web-framework.mdx +8 -8
- package/.docs/raw/{scorers → evals}/custom-scorers.mdx +6 -6
- package/.docs/raw/evals/off-the-shelf-scorers.mdx +50 -0
- package/.docs/raw/{scorers → evals}/overview.mdx +9 -9
- package/.docs/raw/evals/running-in-ci.mdx +113 -0
- package/.docs/raw/frameworks/agentic-uis/ai-sdk.mdx +26 -25
- package/.docs/raw/frameworks/agentic-uis/assistant-ui.mdx +1 -1
- package/.docs/raw/frameworks/agentic-uis/copilotkit.mdx +17 -17
- package/.docs/raw/frameworks/agentic-uis/openrouter.mdx +4 -1
- package/.docs/raw/frameworks/servers/express.mdx +11 -10
- package/.docs/raw/frameworks/web-frameworks/astro.mdx +18 -18
- package/.docs/raw/frameworks/web-frameworks/next-js.mdx +7 -7
- package/.docs/raw/frameworks/web-frameworks/sveltekit.mdx +16 -16
- package/.docs/raw/frameworks/web-frameworks/vite-react.mdx +7 -7
- package/.docs/raw/getting-started/installation.mdx +26 -25
- package/.docs/raw/getting-started/mcp-docs-server.mdx +1 -1
- package/.docs/raw/getting-started/project-structure.mdx +4 -4
- package/.docs/raw/getting-started/studio.mdx +8 -8
- package/.docs/raw/getting-started/templates.mdx +6 -6
- package/.docs/raw/guides/guide/ai-recruiter.mdx +264 -0
- package/.docs/raw/guides/guide/chef-michel.mdx +271 -0
- package/.docs/raw/guides/guide/notes-mcp-server.mdx +450 -0
- package/.docs/raw/guides/guide/research-assistant.mdx +380 -0
- package/.docs/raw/guides/guide/stock-agent.mdx +185 -0
- package/.docs/raw/guides/guide/web-search.mdx +291 -0
- package/.docs/raw/guides/index.mdx +43 -0
- package/.docs/raw/guides/migrations/agentnetwork.mdx +114 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/_template.mdx +50 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/agent.mdx +265 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/cli.mdx +48 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/client.mdx +153 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/evals.mdx +230 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/mastra.mdx +171 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/mcp.mdx +114 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/memory.mdx +241 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/overview.mdx +83 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/processors.mdx +62 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/storage.mdx +270 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/tools.mdx +115 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/tracing.mdx +280 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/vectors.mdx +23 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/voice.mdx +39 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/workflows.mdx +178 -0
- package/.docs/raw/guides/migrations/vnext-to-standard-apis.mdx +367 -0
- package/.docs/raw/guides/quickstarts/nextjs.mdx +275 -0
- package/.docs/raw/index.mdx +9 -9
- package/.docs/raw/{observability/logging.mdx → logging.mdx} +4 -4
- package/.docs/raw/mastra-cloud/dashboard.mdx +2 -2
- package/.docs/raw/mastra-cloud/observability.mdx +6 -6
- package/.docs/raw/mastra-cloud/overview.mdx +2 -2
- package/.docs/raw/mastra-cloud/setting-up.mdx +4 -4
- package/.docs/raw/memory/conversation-history.mdx +1 -0
- package/.docs/raw/memory/memory-processors.mdx +4 -3
- package/.docs/raw/memory/overview.mdx +10 -6
- package/.docs/raw/memory/semantic-recall.mdx +13 -8
- package/.docs/raw/memory/storage/memory-with-libsql.mdx +12 -7
- package/.docs/raw/memory/storage/memory-with-pg.mdx +11 -6
- package/.docs/raw/memory/storage/memory-with-upstash.mdx +11 -6
- package/.docs/raw/memory/threads-and-resources.mdx +11 -13
- package/.docs/raw/memory/working-memory.mdx +30 -14
- package/.docs/raw/observability/overview.mdx +13 -30
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/arize.mdx +11 -19
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/braintrust.mdx +8 -17
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/cloud.mdx +11 -17
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/default.mdx +16 -20
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/langfuse.mdx +8 -17
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/langsmith.mdx +8 -17
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/otel.mdx +12 -21
- package/.docs/raw/observability/{ai-tracing → tracing}/overview.mdx +107 -142
- package/.docs/raw/observability/{ai-tracing → tracing}/processors/sensitive-data-filter.mdx +14 -13
- package/.docs/raw/rag/chunking-and-embedding.mdx +5 -5
- package/.docs/raw/rag/overview.mdx +3 -13
- package/.docs/raw/rag/retrieval.mdx +24 -12
- package/.docs/raw/rag/vector-databases.mdx +7 -1
- package/.docs/raw/reference/agents/agent.mdx +35 -30
- package/.docs/raw/reference/agents/generate.mdx +10 -10
- package/.docs/raw/reference/agents/generateLegacy.mdx +8 -8
- package/.docs/raw/reference/agents/getDefaultGenerateOptions.mdx +21 -15
- package/.docs/raw/reference/agents/getDefaultOptions.mdx +69 -0
- package/.docs/raw/reference/agents/getDefaultStreamOptions.mdx +22 -16
- package/.docs/raw/reference/agents/getDescription.mdx +1 -1
- package/.docs/raw/reference/agents/getInstructions.mdx +8 -8
- package/.docs/raw/reference/agents/getLLM.mdx +9 -9
- package/.docs/raw/reference/agents/getMemory.mdx +9 -9
- package/.docs/raw/reference/agents/getModel.mdx +10 -10
- package/.docs/raw/reference/agents/getVoice.mdx +8 -8
- package/.docs/raw/reference/agents/listAgents.mdx +9 -9
- package/.docs/raw/reference/agents/listScorers.mdx +7 -7
- package/.docs/raw/reference/agents/listTools.mdx +7 -7
- package/.docs/raw/reference/agents/listWorkflows.mdx +7 -7
- package/.docs/raw/reference/agents/network.mdx +11 -10
- package/.docs/raw/reference/auth/auth0.mdx +4 -4
- package/.docs/raw/reference/auth/clerk.mdx +4 -4
- package/.docs/raw/reference/auth/firebase.mdx +6 -6
- package/.docs/raw/reference/auth/jwt.mdx +4 -4
- package/.docs/raw/reference/auth/supabase.mdx +4 -4
- package/.docs/raw/reference/auth/workos.mdx +4 -4
- package/.docs/raw/reference/cli/create-mastra.mdx +10 -10
- package/.docs/raw/reference/cli/mastra.mdx +7 -7
- package/.docs/raw/reference/client-js/agents.mdx +6 -2
- package/.docs/raw/reference/client-js/mastra-client.mdx +7 -7
- package/.docs/raw/reference/client-js/memory.mdx +24 -16
- package/.docs/raw/reference/client-js/observability.mdx +11 -11
- package/.docs/raw/reference/client-js/workflows.mdx +6 -34
- package/.docs/raw/reference/core/getAgent.mdx +1 -1
- package/.docs/raw/reference/core/getAgentById.mdx +1 -1
- package/.docs/raw/reference/core/getDeployer.mdx +2 -2
- package/.docs/raw/reference/core/getLogger.mdx +2 -2
- package/.docs/raw/reference/core/getMCPServer.mdx +31 -15
- package/.docs/raw/reference/core/getMCPServerById.mdx +81 -0
- package/.docs/raw/reference/core/getScorer.mdx +3 -3
- package/.docs/raw/reference/core/getScorerById.mdx +79 -0
- package/.docs/raw/reference/core/getServer.mdx +2 -2
- package/.docs/raw/reference/core/getStorage.mdx +2 -2
- package/.docs/raw/reference/core/getTelemetry.mdx +2 -2
- package/.docs/raw/reference/core/getVector.mdx +2 -2
- package/.docs/raw/reference/core/getWorkflow.mdx +1 -1
- package/.docs/raw/reference/core/listAgents.mdx +1 -1
- package/.docs/raw/reference/core/listLogs.mdx +2 -2
- package/.docs/raw/reference/core/listLogsByRunId.mdx +2 -2
- package/.docs/raw/reference/core/listMCPServers.mdx +65 -0
- package/.docs/raw/reference/core/listScorers.mdx +3 -3
- package/.docs/raw/reference/core/listVectors.mdx +36 -0
- package/.docs/raw/reference/core/listWorkflows.mdx +6 -6
- package/.docs/raw/reference/core/mastra-class.mdx +3 -2
- package/.docs/raw/reference/core/setLogger.mdx +2 -2
- package/.docs/raw/reference/core/setStorage.mdx +3 -2
- package/.docs/raw/reference/core/setTelemetry.mdx +2 -2
- package/.docs/raw/reference/deployer/cloudflare.mdx +2 -2
- package/.docs/raw/reference/deployer/deployer.mdx +0 -6
- package/.docs/raw/reference/deployer/netlify.mdx +2 -2
- package/.docs/raw/reference/deployer/vercel.mdx +3 -3
- package/.docs/raw/reference/evals/answer-relevancy.mdx +164 -126
- package/.docs/raw/reference/{scorers → evals}/answer-similarity.mdx +27 -27
- package/.docs/raw/reference/evals/bias.mdx +149 -115
- package/.docs/raw/reference/evals/completeness.mdx +148 -117
- package/.docs/raw/reference/evals/content-similarity.mdx +126 -113
- package/.docs/raw/reference/evals/context-precision.mdx +290 -133
- package/.docs/raw/reference/{scorers → evals}/context-relevance.mdx +6 -6
- package/.docs/raw/reference/{scorers → evals}/create-scorer.mdx +69 -60
- package/.docs/raw/reference/evals/faithfulness.mdx +163 -121
- package/.docs/raw/reference/evals/hallucination.mdx +159 -132
- package/.docs/raw/reference/evals/keyword-coverage.mdx +169 -125
- package/.docs/raw/reference/{scorers → evals}/mastra-scorer.mdx +7 -5
- package/.docs/raw/reference/{scorers → evals}/noise-sensitivity.mdx +9 -9
- package/.docs/raw/reference/evals/prompt-alignment.mdx +604 -182
- package/.docs/raw/reference/{scorers/run-experiment.mdx → evals/run-evals.mdx} +17 -18
- package/.docs/raw/reference/evals/textual-difference.mdx +149 -117
- package/.docs/raw/reference/evals/tone-consistency.mdx +149 -125
- package/.docs/raw/reference/{scorers → evals}/tool-call-accuracy.mdx +8 -6
- package/.docs/raw/reference/evals/toxicity.mdx +152 -96
- package/.docs/raw/reference/{observability/logging → logging}/pino-logger.mdx +2 -2
- package/.docs/raw/reference/memory/createThread.mdx +5 -5
- package/.docs/raw/reference/memory/deleteMessages.mdx +7 -7
- package/.docs/raw/reference/memory/getThreadById.mdx +4 -4
- package/.docs/raw/reference/memory/listThreadsByResourceId.mdx +110 -0
- package/.docs/raw/reference/memory/memory-class.mdx +13 -9
- package/.docs/raw/reference/memory/query.mdx +58 -57
- package/.docs/raw/reference/memory/recall.mdx +185 -0
- package/.docs/raw/reference/observability/tracing/configuration.mdx +245 -0
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/arize.mdx +13 -13
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/braintrust.mdx +11 -8
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/cloud-exporter.mdx +21 -19
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/console-exporter.mdx +49 -17
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/default-exporter.mdx +42 -41
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/langfuse.mdx +10 -7
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/langsmith.mdx +10 -7
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/otel.mdx +5 -5
- package/.docs/raw/reference/observability/tracing/instances.mdx +168 -0
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/interfaces.mdx +115 -89
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/processors/sensitive-data-filter.mdx +3 -3
- package/.docs/raw/reference/observability/{ai-tracing/span.mdx → tracing/spans.mdx} +59 -41
- package/.docs/raw/reference/processors/batch-parts-processor.mdx +9 -3
- package/.docs/raw/reference/processors/language-detector.mdx +9 -3
- package/.docs/raw/reference/processors/moderation-processor.mdx +9 -3
- package/.docs/raw/reference/processors/pii-detector.mdx +9 -3
- package/.docs/raw/reference/processors/prompt-injection-detector.mdx +9 -3
- package/.docs/raw/reference/processors/system-prompt-scrubber.mdx +9 -3
- package/.docs/raw/reference/processors/token-limiter-processor.mdx +9 -3
- package/.docs/raw/reference/processors/unicode-normalizer.mdx +9 -3
- package/.docs/raw/reference/rag/chunk.mdx +1 -8
- package/.docs/raw/reference/rag/database-config.mdx +7 -7
- package/.docs/raw/reference/rag/metadata-filters.mdx +14 -11
- package/.docs/raw/reference/storage/cloudflare-d1.mdx +1 -1
- package/.docs/raw/reference/storage/cloudflare.mdx +1 -1
- package/.docs/raw/reference/storage/dynamodb.mdx +3 -3
- package/.docs/raw/reference/storage/lance.mdx +1 -1
- package/.docs/raw/reference/storage/libsql.mdx +3 -1
- package/.docs/raw/reference/storage/mongodb.mdx +1 -1
- package/.docs/raw/reference/storage/mssql.mdx +6 -1
- package/.docs/raw/reference/storage/postgresql.mdx +7 -1
- package/.docs/raw/reference/storage/upstash.mdx +2 -1
- package/.docs/raw/reference/streaming/agents/stream.mdx +12 -12
- package/.docs/raw/reference/streaming/agents/streamLegacy.mdx +8 -8
- package/.docs/raw/reference/streaming/workflows/observeStream.mdx +3 -3
- package/.docs/raw/reference/streaming/workflows/observeStreamVNext.mdx +3 -3
- package/.docs/raw/reference/streaming/workflows/resumeStreamVNext.mdx +6 -6
- package/.docs/raw/reference/streaming/workflows/stream.mdx +10 -10
- package/.docs/raw/reference/streaming/workflows/streamVNext.mdx +11 -11
- package/.docs/raw/reference/templates/overview.mdx +3 -3
- package/.docs/raw/reference/tools/create-tool.mdx +52 -35
- package/.docs/raw/reference/tools/graph-rag-tool.mdx +15 -15
- package/.docs/raw/reference/tools/mcp-client.mdx +1 -1
- package/.docs/raw/reference/tools/mcp-server.mdx +119 -35
- package/.docs/raw/reference/tools/vector-query-tool.mdx +27 -26
- package/.docs/raw/reference/vectors/couchbase.mdx +8 -2
- package/.docs/raw/reference/vectors/libsql.mdx +2 -1
- package/.docs/raw/reference/vectors/mongodb.mdx +7 -1
- package/.docs/raw/reference/vectors/pg.mdx +3 -0
- package/.docs/raw/reference/vectors/s3vectors.mdx +1 -1
- package/.docs/raw/reference/vectors/upstash.mdx +1 -0
- package/.docs/raw/reference/voice/google-gemini-live.mdx +1 -1
- package/.docs/raw/reference/voice/voice.addTools.mdx +3 -3
- package/.docs/raw/reference/workflows/run-methods/cancel.mdx +4 -4
- package/.docs/raw/reference/workflows/run-methods/resume.mdx +14 -14
- package/.docs/raw/reference/workflows/run-methods/start.mdx +17 -17
- package/.docs/raw/reference/workflows/run.mdx +1 -8
- package/.docs/raw/reference/workflows/step.mdx +5 -5
- package/.docs/raw/reference/workflows/workflow-methods/branch.mdx +2 -2
- package/.docs/raw/reference/workflows/workflow-methods/commit.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/create-run.mdx +7 -13
- package/.docs/raw/reference/workflows/workflow-methods/dountil.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/dowhile.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/foreach.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/map.mdx +5 -0
- package/.docs/raw/reference/workflows/workflow-methods/parallel.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/sendEvent.mdx +2 -2
- package/.docs/raw/reference/workflows/workflow-methods/sleep.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/sleepUntil.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/then.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/waitForEvent.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow.mdx +1 -1
- package/.docs/raw/server-db/custom-api-routes.mdx +2 -2
- package/.docs/raw/server-db/mastra-client.mdx +23 -22
- package/.docs/raw/server-db/middleware.mdx +7 -7
- package/.docs/raw/server-db/production-server.mdx +4 -4
- package/.docs/raw/server-db/{runtime-context.mdx → request-context.mdx} +46 -45
- package/.docs/raw/server-db/storage.mdx +29 -21
- package/.docs/raw/streaming/events.mdx +3 -3
- package/.docs/raw/streaming/overview.mdx +5 -5
- package/.docs/raw/streaming/tool-streaming.mdx +18 -17
- package/.docs/raw/streaming/workflow-streaming.mdx +1 -1
- package/.docs/raw/tools-mcp/advanced-usage.mdx +5 -4
- package/.docs/raw/tools-mcp/mcp-overview.mdx +33 -20
- package/.docs/raw/tools-mcp/overview.mdx +11 -11
- package/.docs/raw/voice/overview.mdx +63 -43
- package/.docs/raw/voice/speech-to-speech.mdx +5 -3
- package/.docs/raw/voice/speech-to-text.mdx +10 -9
- package/.docs/raw/voice/text-to-speech.mdx +13 -12
- package/.docs/raw/workflows/agents-and-tools.mdx +9 -5
- package/.docs/raw/workflows/control-flow.mdx +3 -3
- package/.docs/raw/workflows/error-handling.mdx +2 -21
- package/.docs/raw/workflows/human-in-the-loop.mdx +7 -4
- package/.docs/raw/workflows/inngest-workflow.mdx +3 -3
- package/.docs/raw/workflows/input-data-mapping.mdx +107 -0
- package/.docs/raw/workflows/overview.mdx +17 -16
- package/.docs/raw/workflows/snapshots.mdx +13 -11
- package/.docs/raw/workflows/suspend-and-resume.mdx +23 -15
- package/CHANGELOG.md +55 -53
- package/README.md +11 -2
- package/dist/{chunk-TUAHUTTB.js → chunk-5NJC7NRO.js} +3 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/prepare-docs/copy-raw.d.ts.map +1 -1
- package/dist/prepare-docs/prepare.js +1 -1
- package/dist/prompts/migration.d.ts +6 -0
- package/dist/prompts/migration.d.ts.map +1 -0
- package/dist/stdio.js +402 -30
- package/dist/tools/migration.d.ts +40 -0
- package/dist/tools/migration.d.ts.map +1 -0
- package/package.json +8 -12
- package/.docs/organized/changelogs/%40mastra%2Fcloud.md +0 -302
- package/.docs/raw/observability/nextjs-tracing.mdx +0 -109
- package/.docs/raw/observability/otel-tracing.mdx +0 -189
- package/.docs/raw/reference/agents/getScorers.mdx +0 -69
- package/.docs/raw/reference/agents/getTools.mdx +0 -69
- package/.docs/raw/reference/agents/getWorkflows.mdx +0 -69
- package/.docs/raw/reference/client-js/workflows-legacy.mdx +0 -143
- package/.docs/raw/reference/core/getAgents.mdx +0 -35
- package/.docs/raw/reference/core/getLogs.mdx +0 -96
- package/.docs/raw/reference/core/getLogsByRunId.mdx +0 -87
- package/.docs/raw/reference/core/getMCPServers.mdx +0 -36
- package/.docs/raw/reference/core/getMemory.mdx +0 -36
- package/.docs/raw/reference/core/getScorerByName.mdx +0 -78
- package/.docs/raw/reference/core/getScorers.mdx +0 -43
- package/.docs/raw/reference/core/getVectors.mdx +0 -36
- package/.docs/raw/reference/core/getWorkflows.mdx +0 -45
- package/.docs/raw/reference/evals/context-position.mdx +0 -197
- package/.docs/raw/reference/evals/context-relevancy.mdx +0 -196
- package/.docs/raw/reference/evals/contextual-recall.mdx +0 -196
- package/.docs/raw/reference/evals/summarization.mdx +0 -212
- package/.docs/raw/reference/legacyWorkflows/after.mdx +0 -89
- package/.docs/raw/reference/legacyWorkflows/afterEvent.mdx +0 -79
- package/.docs/raw/reference/legacyWorkflows/commit.mdx +0 -33
- package/.docs/raw/reference/legacyWorkflows/createRun.mdx +0 -76
- package/.docs/raw/reference/legacyWorkflows/else.mdx +0 -68
- package/.docs/raw/reference/legacyWorkflows/events.mdx +0 -305
- package/.docs/raw/reference/legacyWorkflows/execute.mdx +0 -110
- package/.docs/raw/reference/legacyWorkflows/if.mdx +0 -108
- package/.docs/raw/reference/legacyWorkflows/resume.mdx +0 -158
- package/.docs/raw/reference/legacyWorkflows/resumeWithEvent.mdx +0 -133
- package/.docs/raw/reference/legacyWorkflows/snapshots.mdx +0 -207
- package/.docs/raw/reference/legacyWorkflows/start.mdx +0 -87
- package/.docs/raw/reference/legacyWorkflows/step-class.mdx +0 -100
- package/.docs/raw/reference/legacyWorkflows/step-condition.mdx +0 -137
- package/.docs/raw/reference/legacyWorkflows/step-function.mdx +0 -93
- package/.docs/raw/reference/legacyWorkflows/step-options.mdx +0 -69
- package/.docs/raw/reference/legacyWorkflows/step-retries.mdx +0 -196
- package/.docs/raw/reference/legacyWorkflows/suspend.mdx +0 -70
- package/.docs/raw/reference/legacyWorkflows/then.mdx +0 -72
- package/.docs/raw/reference/legacyWorkflows/until.mdx +0 -168
- package/.docs/raw/reference/legacyWorkflows/watch.mdx +0 -124
- package/.docs/raw/reference/legacyWorkflows/while.mdx +0 -168
- package/.docs/raw/reference/legacyWorkflows/workflow.mdx +0 -234
- package/.docs/raw/reference/memory/getThreadsByResourceId.mdx +0 -79
- package/.docs/raw/reference/memory/getThreadsByResourceIdPaginated.mdx +0 -110
- package/.docs/raw/reference/observability/ai-tracing/ai-tracing.mdx +0 -185
- package/.docs/raw/reference/observability/ai-tracing/configuration.mdx +0 -238
- package/.docs/raw/reference/observability/otel-tracing/otel-config.mdx +0 -117
- package/.docs/raw/reference/observability/otel-tracing/providers/arize-ax.mdx +0 -81
- package/.docs/raw/reference/observability/otel-tracing/providers/arize-phoenix.mdx +0 -121
- package/.docs/raw/reference/observability/otel-tracing/providers/braintrust.mdx +0 -40
- package/.docs/raw/reference/observability/otel-tracing/providers/dash0.mdx +0 -40
- package/.docs/raw/reference/observability/otel-tracing/providers/index.mdx +0 -20
- package/.docs/raw/reference/observability/otel-tracing/providers/keywordsai.mdx +0 -73
- package/.docs/raw/reference/observability/otel-tracing/providers/laminar.mdx +0 -41
- package/.docs/raw/reference/observability/otel-tracing/providers/langfuse.mdx +0 -84
- package/.docs/raw/reference/observability/otel-tracing/providers/langsmith.mdx +0 -48
- package/.docs/raw/reference/observability/otel-tracing/providers/langwatch.mdx +0 -43
- package/.docs/raw/reference/observability/otel-tracing/providers/new-relic.mdx +0 -40
- package/.docs/raw/reference/observability/otel-tracing/providers/signoz.mdx +0 -40
- package/.docs/raw/reference/observability/otel-tracing/providers/traceloop.mdx +0 -40
- package/.docs/raw/reference/scorers/answer-relevancy.mdx +0 -227
- package/.docs/raw/reference/scorers/bias.mdx +0 -228
- package/.docs/raw/reference/scorers/completeness.mdx +0 -214
- package/.docs/raw/reference/scorers/content-similarity.mdx +0 -197
- package/.docs/raw/reference/scorers/context-precision.mdx +0 -352
- package/.docs/raw/reference/scorers/faithfulness.mdx +0 -241
- package/.docs/raw/reference/scorers/hallucination.mdx +0 -252
- package/.docs/raw/reference/scorers/keyword-coverage.mdx +0 -229
- package/.docs/raw/reference/scorers/prompt-alignment.mdx +0 -668
- package/.docs/raw/reference/scorers/textual-difference.mdx +0 -203
- package/.docs/raw/reference/scorers/tone-consistency.mdx +0 -211
- package/.docs/raw/reference/scorers/toxicity.mdx +0 -228
- package/.docs/raw/reference/workflows/run-methods/watch.mdx +0 -73
- package/.docs/raw/scorers/evals-old-api/custom-eval.mdx +0 -24
- package/.docs/raw/scorers/evals-old-api/overview.mdx +0 -106
- package/.docs/raw/scorers/evals-old-api/running-in-ci.mdx +0 -85
- package/.docs/raw/scorers/evals-old-api/textual-evals.mdx +0 -58
- package/.docs/raw/scorers/off-the-shelf-scorers.mdx +0 -50
- package/.docs/raw/workflows-legacy/control-flow.mdx +0 -774
- package/.docs/raw/workflows-legacy/dynamic-workflows.mdx +0 -239
- package/.docs/raw/workflows-legacy/error-handling.mdx +0 -187
- package/.docs/raw/workflows-legacy/nested-workflows.mdx +0 -360
- package/.docs/raw/workflows-legacy/overview.mdx +0 -182
- package/.docs/raw/workflows-legacy/runtime-variables.mdx +0 -156
- package/.docs/raw/workflows-legacy/steps.mdx +0 -115
- package/.docs/raw/workflows-legacy/suspend-and-resume.mdx +0 -406
- package/.docs/raw/workflows-legacy/variables.mdx +0 -318
|
@@ -10,7 +10,7 @@ The MSSQL storage implementation provides a production-ready storage solution us
|
|
|
10
10
|
## Installation
|
|
11
11
|
|
|
12
12
|
```bash copy
|
|
13
|
-
npm install @mastra/mssql@
|
|
13
|
+
npm install @mastra/mssql@beta
|
|
14
14
|
```
|
|
15
15
|
|
|
16
16
|
## Usage
|
|
@@ -19,6 +19,7 @@ npm install @mastra/mssql@latest
|
|
|
19
19
|
import { MSSQLStore } from "@mastra/mssql";
|
|
20
20
|
|
|
21
21
|
const storage = new MSSQLStore({
|
|
22
|
+
id: 'mssql-storage',
|
|
22
23
|
connectionString: process.env.DATABASE_URL,
|
|
23
24
|
});
|
|
24
25
|
```
|
|
@@ -53,17 +54,20 @@ import { MSSQLStore } from "@mastra/mssql";
|
|
|
53
54
|
|
|
54
55
|
// Using a connection string only
|
|
55
56
|
const store1 = new MSSQLStore({
|
|
57
|
+
id: 'mssql-storage-1',
|
|
56
58
|
connectionString: "Server=localhost,1433;Database=mydb;User Id=sa;Password=password;Encrypt=true;TrustServerCertificate=true",
|
|
57
59
|
});
|
|
58
60
|
|
|
59
61
|
// Using a connection string with a custom schema name
|
|
60
62
|
const store2 = new MSSQLStore({
|
|
63
|
+
id: 'mssql-storage-2',
|
|
61
64
|
connectionString: "Server=localhost,1433;Database=mydb;User Id=sa;Password=password;Encrypt=true;TrustServerCertificate=true",
|
|
62
65
|
schemaName: "custom_schema", // optional
|
|
63
66
|
});
|
|
64
67
|
|
|
65
68
|
// Using individual connection parameters
|
|
66
69
|
const store4 = new MSSQLStore({
|
|
70
|
+
id: 'mssql-storage-3',
|
|
67
71
|
server: "localhost",
|
|
68
72
|
port: 1433,
|
|
69
73
|
database: "mydb",
|
|
@@ -73,6 +77,7 @@ const store4 = new MSSQLStore({
|
|
|
73
77
|
|
|
74
78
|
// Individual parameters with schemaName
|
|
75
79
|
const store5 = new MSSQLStore({
|
|
80
|
+
id: 'mssql-storage-4',
|
|
76
81
|
server: "localhost",
|
|
77
82
|
port: 1433,
|
|
78
83
|
database: "mydb",
|
|
@@ -10,7 +10,7 @@ The PostgreSQL storage implementation provides a production-ready storage soluti
|
|
|
10
10
|
## Installation
|
|
11
11
|
|
|
12
12
|
```bash copy
|
|
13
|
-
npm install @mastra/pg@
|
|
13
|
+
npm install @mastra/pg@beta
|
|
14
14
|
```
|
|
15
15
|
|
|
16
16
|
## Usage
|
|
@@ -19,6 +19,7 @@ npm install @mastra/pg@latest
|
|
|
19
19
|
import { PostgresStore } from "@mastra/pg";
|
|
20
20
|
|
|
21
21
|
const storage = new PostgresStore({
|
|
22
|
+
id: 'pg-storage',
|
|
22
23
|
connectionString: process.env.DATABASE_URL,
|
|
23
24
|
});
|
|
24
25
|
```
|
|
@@ -53,17 +54,20 @@ import { PostgresStore } from "@mastra/pg";
|
|
|
53
54
|
|
|
54
55
|
// Using a connection string only
|
|
55
56
|
const store1 = new PostgresStore({
|
|
57
|
+
id: 'pg-storage-1',
|
|
56
58
|
connectionString: "postgresql://user:password@localhost:5432/mydb",
|
|
57
59
|
});
|
|
58
60
|
|
|
59
61
|
// Using a connection string with a custom schema name
|
|
60
62
|
const store2 = new PostgresStore({
|
|
63
|
+
id: 'pg-storage-2',
|
|
61
64
|
connectionString: "postgresql://user:password@localhost:5432/mydb",
|
|
62
65
|
schemaName: "custom_schema", // optional
|
|
63
66
|
});
|
|
64
67
|
|
|
65
68
|
// Using individual connection parameters
|
|
66
69
|
const store4 = new PostgresStore({
|
|
70
|
+
id: 'pg-storage-3',
|
|
67
71
|
host: "localhost",
|
|
68
72
|
port: 5432,
|
|
69
73
|
database: "mydb",
|
|
@@ -73,6 +77,7 @@ const store4 = new PostgresStore({
|
|
|
73
77
|
|
|
74
78
|
// Individual parameters with schemaName
|
|
75
79
|
const store5 = new PostgresStore({
|
|
80
|
+
id: 'pg-storage-4',
|
|
76
81
|
host: "localhost",
|
|
77
82
|
port: 5432,
|
|
78
83
|
database: "mydb",
|
|
@@ -281,6 +286,7 @@ When using custom schemas, indexes are created with schema prefixes:
|
|
|
281
286
|
|
|
282
287
|
```typescript copy
|
|
283
288
|
const storage = new PostgresStore({
|
|
289
|
+
id: 'pg-storage',
|
|
284
290
|
connectionString: process.env.DATABASE_URL,
|
|
285
291
|
schemaName: "custom_schema",
|
|
286
292
|
});
|
|
@@ -16,7 +16,7 @@ The Upstash storage implementation provides a serverless-friendly storage soluti
|
|
|
16
16
|
## Installation
|
|
17
17
|
|
|
18
18
|
```bash copy
|
|
19
|
-
npm install @mastra/upstash@
|
|
19
|
+
npm install @mastra/upstash@beta
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
## Usage
|
|
@@ -25,6 +25,7 @@ npm install @mastra/upstash@latest
|
|
|
25
25
|
import { UpstashStore } from "@mastra/upstash";
|
|
26
26
|
|
|
27
27
|
const storage = new UpstashStore({
|
|
28
|
+
id: 'upstash-storage',
|
|
28
29
|
url: process.env.UPSTASH_URL,
|
|
29
30
|
token: process.env.UPSTASH_TOKEN,
|
|
30
31
|
});
|
|
@@ -118,7 +118,7 @@ const aiSdkStream = await agent.stream("message for agent", {
|
|
|
118
118
|
name: "tracingContext",
|
|
119
119
|
type: "TracingContext",
|
|
120
120
|
isOptional: true,
|
|
121
|
-
description: "
|
|
121
|
+
description: "Tracing context for span hierarchy and metadata.",
|
|
122
122
|
},
|
|
123
123
|
{
|
|
124
124
|
name: "returnScorerData",
|
|
@@ -348,7 +348,7 @@ const aiSdkStream = await agent.stream("message for agent", {
|
|
|
348
348
|
type: "TelemetrySettings",
|
|
349
349
|
isOptional: true,
|
|
350
350
|
description:
|
|
351
|
-
"Settings for OTLP telemetry collection during streaming (not
|
|
351
|
+
"Settings for OTLP telemetry collection during streaming (not Tracing).",
|
|
352
352
|
properties: [
|
|
353
353
|
{
|
|
354
354
|
parameters: [
|
|
@@ -616,27 +616,27 @@ const aiSdkStream = await agent.stream("message for agent", {
|
|
|
616
616
|
"Unique ID for this generation run. Useful for tracking and debugging purposes.",
|
|
617
617
|
},
|
|
618
618
|
{
|
|
619
|
-
name: "
|
|
620
|
-
type: "
|
|
619
|
+
name: "requestContext",
|
|
620
|
+
type: "RequestContext",
|
|
621
621
|
isOptional: true,
|
|
622
622
|
description:
|
|
623
|
-
"
|
|
623
|
+
"Request Context for dependency injection and contextual information.",
|
|
624
624
|
},
|
|
625
625
|
{
|
|
626
626
|
name: "tracingContext",
|
|
627
627
|
type: "TracingContext",
|
|
628
628
|
isOptional: true,
|
|
629
629
|
description:
|
|
630
|
-
"
|
|
630
|
+
"Tracing context for creating child spans and adding metadata. Automatically injected when using Mastra's tracing system.",
|
|
631
631
|
properties: [
|
|
632
632
|
{
|
|
633
633
|
parameters: [
|
|
634
634
|
{
|
|
635
635
|
name: "currentSpan",
|
|
636
|
-
type: "
|
|
636
|
+
type: "Span",
|
|
637
637
|
isOptional: true,
|
|
638
638
|
description:
|
|
639
|
-
"Current
|
|
639
|
+
"Current span for creating child spans and adding metadata. Use this to create custom child spans or update span attributes during execution.",
|
|
640
640
|
},
|
|
641
641
|
],
|
|
642
642
|
},
|
|
@@ -646,7 +646,7 @@ const aiSdkStream = await agent.stream("message for agent", {
|
|
|
646
646
|
name: "tracingOptions",
|
|
647
647
|
type: "TracingOptions",
|
|
648
648
|
isOptional: true,
|
|
649
|
-
description: "Options for
|
|
649
|
+
description: "Options for Tracing configuration.",
|
|
650
650
|
properties: [
|
|
651
651
|
{
|
|
652
652
|
parameters: [
|
|
@@ -686,7 +686,7 @@ const aiSdkStream = await agent.stream("message for agent", {
|
|
|
686
686
|
type: "string",
|
|
687
687
|
isOptional: true,
|
|
688
688
|
description:
|
|
689
|
-
"The trace ID associated with this execution when
|
|
689
|
+
"The trace ID associated with this execution when Tracing is enabled. Use this to correlate logs and debug execution flow.",
|
|
690
690
|
},
|
|
691
691
|
]}
|
|
692
692
|
/>
|
|
@@ -803,5 +803,5 @@ await agent.stream("message for agent", {
|
|
|
803
803
|
|
|
804
804
|
## Related
|
|
805
805
|
|
|
806
|
-
- [Generating responses](/docs/agents/overview#generating-responses)
|
|
807
|
-
- [Streaming responses](/docs/agents/overview#generating-responses)
|
|
806
|
+
- [Generating responses](/docs/v1/agents/overview#generating-responses)
|
|
807
|
+
- [Streaming responses](/docs/v1/agents/overview#generating-responses)
|
|
@@ -7,7 +7,7 @@ description: "Documentation for the legacy `Agent.streamLegacy()` method in Mast
|
|
|
7
7
|
|
|
8
8
|
:::warning
|
|
9
9
|
|
|
10
|
-
**Deprecated**: This method is deprecated and only works with V1 models. For V2 models, use the new [`.stream()`](./stream) method instead. See the [migration guide](
|
|
10
|
+
**Deprecated**: This method is deprecated and only works with V1 models. For V2 models, use the new [`.stream()`](./stream) method instead. See the [migration guide](/guides/v1/migrations/vnext-to-standard-apis) for details on upgrading.
|
|
11
11
|
|
|
12
12
|
:::
|
|
13
13
|
|
|
@@ -399,11 +399,11 @@ await agent.streamLegacy("message for agent");
|
|
|
399
399
|
"Unique ID for this generation run. Useful for tracking and debugging purposes.",
|
|
400
400
|
},
|
|
401
401
|
{
|
|
402
|
-
name: "
|
|
403
|
-
type: "
|
|
402
|
+
name: "requestContext",
|
|
403
|
+
type: "RequestContext",
|
|
404
404
|
isOptional: true,
|
|
405
405
|
description:
|
|
406
|
-
"
|
|
406
|
+
"Request Context for dependency injection and contextual information.",
|
|
407
407
|
},
|
|
408
408
|
{
|
|
409
409
|
name: "maxTokens",
|
|
@@ -550,7 +550,7 @@ await agent.streamLegacy("message for agent", {
|
|
|
550
550
|
|
|
551
551
|
:::info
|
|
552
552
|
|
|
553
|
-
The new `.stream()` method offers enhanced capabilities including AI SDK v5 compatibility, better structured output handling, and improved callback system. See the [migration guide](
|
|
553
|
+
The new `.stream()` method offers enhanced capabilities including AI SDK v5 compatibility, better structured output handling, and improved callback system. See the [migration guide](/guides/v1/migrations/vnext-to-standard-apis) for detailed migration instructions.
|
|
554
554
|
|
|
555
555
|
:::
|
|
556
556
|
|
|
@@ -580,7 +580,7 @@ const result = await agent.stream("message", {
|
|
|
580
580
|
|
|
581
581
|
## Related
|
|
582
582
|
|
|
583
|
-
- [Migration Guide](
|
|
583
|
+
- [Migration Guide](/guides/v1/migrations/vnext-to-standard-apis)
|
|
584
584
|
- [New .stream() method](./stream)
|
|
585
|
-
- [Generating responses](/docs/agents/overview#generating-responses)
|
|
586
|
-
- [Streaming responses](/docs/agents/overview#generating-responses)
|
|
585
|
+
- [Generating responses](/docs/v1/agents/overview#generating-responses)
|
|
586
|
+
- [Streaming responses](/docs/v1/agents/overview#generating-responses)
|
|
@@ -10,7 +10,7 @@ The `.observeStream()` method opens a new `ReadableStream` to a workflow run tha
|
|
|
10
10
|
## Usage example
|
|
11
11
|
|
|
12
12
|
```typescript showLineNumbers copy
|
|
13
|
-
const run = await workflow.
|
|
13
|
+
const run = await workflow.createRun();
|
|
14
14
|
|
|
15
15
|
run.stream({
|
|
16
16
|
inputData: {
|
|
@@ -44,6 +44,6 @@ The stream emits various event types during workflow execution. Each event has a
|
|
|
44
44
|
|
|
45
45
|
## Related
|
|
46
46
|
|
|
47
|
-
- [Workflows overview](/docs/workflows/overview#running-workflows)
|
|
48
|
-
- [Workflow.
|
|
47
|
+
- [Workflows overview](/docs/v1/workflows/overview#running-workflows)
|
|
48
|
+
- [Workflow.createRun()](/reference/v1/workflows/workflow-methods/create-run)
|
|
49
49
|
- [Run.stream()](./stream)
|
|
@@ -10,7 +10,7 @@ The `.observeStreamVNext()` method opens a new `ReadableStream` to a workflow ru
|
|
|
10
10
|
## Usage example
|
|
11
11
|
|
|
12
12
|
```typescript showLineNumbers copy
|
|
13
|
-
const run = await workflow.
|
|
13
|
+
const run = await workflow.createRun();
|
|
14
14
|
|
|
15
15
|
run.streamVNext({
|
|
16
16
|
inputData: {
|
|
@@ -41,7 +41,7 @@ The stream emits various event types during workflow execution. Each event has a
|
|
|
41
41
|
|
|
42
42
|
## Related
|
|
43
43
|
|
|
44
|
-
- [Workflows overview](/docs/workflows/overview#running-workflows)
|
|
45
|
-
- [Workflow.
|
|
44
|
+
- [Workflows overview](/docs/v1/workflows/overview#running-workflows)
|
|
45
|
+
- [Workflow.createRun()](/reference/v1/workflows/workflow-methods/create-run)
|
|
46
46
|
- [Run.streamVNext()](./streamVNext)
|
|
47
47
|
- [Run.resumeStreamVNext()](./resumeStreamVNext)
|
|
@@ -14,7 +14,7 @@ The `.resumeStreamVNext()` method resumes a suspended workflow run with new data
|
|
|
14
14
|
## Usage example
|
|
15
15
|
|
|
16
16
|
```typescript showLineNumbers copy
|
|
17
|
-
const run = await workflow.
|
|
17
|
+
const run = await workflow.createRun();
|
|
18
18
|
|
|
19
19
|
const stream = run.streamVNext({
|
|
20
20
|
inputData: {
|
|
@@ -44,8 +44,8 @@ if (result!.status === "suspended") {
|
|
|
44
44
|
isOptional: true,
|
|
45
45
|
},
|
|
46
46
|
{
|
|
47
|
-
name: "
|
|
48
|
-
type: "
|
|
47
|
+
name: "requestContext",
|
|
48
|
+
type: "RequestContext",
|
|
49
49
|
description: "Request Context data to use during workflow execution",
|
|
50
50
|
isOptional: true,
|
|
51
51
|
},
|
|
@@ -59,7 +59,7 @@ if (result!.status === "suspended") {
|
|
|
59
59
|
name: "tracingOptions",
|
|
60
60
|
type: "TracingOptions",
|
|
61
61
|
isOptional: true,
|
|
62
|
-
description: "Options for
|
|
62
|
+
description: "Options for Tracing configuration.",
|
|
63
63
|
properties: [
|
|
64
64
|
{
|
|
65
65
|
parameters: [
|
|
@@ -117,6 +117,6 @@ The stream emits various event types during workflow execution. Each event has a
|
|
|
117
117
|
|
|
118
118
|
## Related
|
|
119
119
|
|
|
120
|
-
- [Workflows overview](/docs/workflows/overview#running-workflows)
|
|
121
|
-
- [Workflow.
|
|
120
|
+
- [Workflows overview](/docs/v1/workflows/overview#running-workflows)
|
|
121
|
+
- [Workflow.createRun()](/reference/v1/workflows/workflow-methods/create-run)
|
|
122
122
|
- [Run.streamVNext()](./streamVNext)
|
|
@@ -10,7 +10,7 @@ The `.stream()` method allows you to monitor the execution of a workflow run, pr
|
|
|
10
10
|
## Usage example
|
|
11
11
|
|
|
12
12
|
```typescript showLineNumbers copy
|
|
13
|
-
const run = await workflow.
|
|
13
|
+
const run = await workflow.createRun();
|
|
14
14
|
|
|
15
15
|
const { stream } = await run.stream({
|
|
16
16
|
inputData: {
|
|
@@ -30,8 +30,8 @@ const { stream } = await run.stream({
|
|
|
30
30
|
isOptional: true,
|
|
31
31
|
},
|
|
32
32
|
{
|
|
33
|
-
name: "
|
|
34
|
-
type: "
|
|
33
|
+
name: "requestContext",
|
|
34
|
+
type: "RequestContext",
|
|
35
35
|
description: "Request Context data to use during workflow execution",
|
|
36
36
|
isOptional: true,
|
|
37
37
|
},
|
|
@@ -40,16 +40,16 @@ const { stream } = await run.stream({
|
|
|
40
40
|
type: "TracingContext",
|
|
41
41
|
isOptional: true,
|
|
42
42
|
description:
|
|
43
|
-
"
|
|
43
|
+
"Tracing context for creating child spans and adding metadata. Automatically injected when using Mastra's tracing system.",
|
|
44
44
|
properties: [
|
|
45
45
|
{
|
|
46
46
|
parameters: [
|
|
47
47
|
{
|
|
48
48
|
name: "currentSpan",
|
|
49
|
-
type: "
|
|
49
|
+
type: "Span",
|
|
50
50
|
isOptional: true,
|
|
51
51
|
description:
|
|
52
|
-
"Current
|
|
52
|
+
"Current span for creating child spans and adding metadata. Use this to create custom child spans or update span attributes during execution.",
|
|
53
53
|
},
|
|
54
54
|
],
|
|
55
55
|
},
|
|
@@ -59,7 +59,7 @@ const { stream } = await run.stream({
|
|
|
59
59
|
name: "tracingOptions",
|
|
60
60
|
type: "TracingOptions",
|
|
61
61
|
isOptional: true,
|
|
62
|
-
description: "Options for
|
|
62
|
+
description: "Options for Tracing configuration.",
|
|
63
63
|
properties: [
|
|
64
64
|
{
|
|
65
65
|
parameters: [
|
|
@@ -98,7 +98,7 @@ const { stream } = await run.stream({
|
|
|
98
98
|
type: "string",
|
|
99
99
|
isOptional: true,
|
|
100
100
|
description:
|
|
101
|
-
"The trace ID associated with this execution when
|
|
101
|
+
"The trace ID associated with this execution when Tracing is enabled. Use this to correlate logs and debug execution flow.",
|
|
102
102
|
},
|
|
103
103
|
]}
|
|
104
104
|
/>
|
|
@@ -130,5 +130,5 @@ The stream emits various event types during workflow execution. Each event has a
|
|
|
130
130
|
|
|
131
131
|
## Related
|
|
132
132
|
|
|
133
|
-
- [Workflows overview](/docs/workflows/overview#running-workflows)
|
|
134
|
-
- [Workflow.
|
|
133
|
+
- [Workflows overview](/docs/v1/workflows/overview#running-workflows)
|
|
134
|
+
- [Workflow.createRun()](/reference/v1/workflows/workflow-methods/create-run)
|
|
@@ -14,7 +14,7 @@ The `.streamVNext()` method enables real-time streaming of responses from a work
|
|
|
14
14
|
## Usage example
|
|
15
15
|
|
|
16
16
|
```typescript showLineNumbers copy
|
|
17
|
-
const run = await workflow.
|
|
17
|
+
const run = await workflow.createRun();
|
|
18
18
|
|
|
19
19
|
const stream = run.streamVNext({
|
|
20
20
|
inputData: {
|
|
@@ -34,8 +34,8 @@ const stream = run.streamVNext({
|
|
|
34
34
|
isOptional: true,
|
|
35
35
|
},
|
|
36
36
|
{
|
|
37
|
-
name: "
|
|
38
|
-
type: "
|
|
37
|
+
name: "requestContext",
|
|
38
|
+
type: "RequestContext",
|
|
39
39
|
description: "Request Context data to use during workflow execution",
|
|
40
40
|
isOptional: true,
|
|
41
41
|
},
|
|
@@ -44,16 +44,16 @@ const stream = run.streamVNext({
|
|
|
44
44
|
type: "TracingContext",
|
|
45
45
|
isOptional: true,
|
|
46
46
|
description:
|
|
47
|
-
"
|
|
47
|
+
"Tracing context for creating child spans and adding metadata.",
|
|
48
48
|
properties: [
|
|
49
49
|
{
|
|
50
50
|
parameters: [
|
|
51
51
|
{
|
|
52
52
|
name: "currentSpan",
|
|
53
|
-
type: "
|
|
53
|
+
type: "Span",
|
|
54
54
|
isOptional: true,
|
|
55
55
|
description:
|
|
56
|
-
"Current
|
|
56
|
+
"Current span for creating child spans and adding metadata.",
|
|
57
57
|
},
|
|
58
58
|
],
|
|
59
59
|
},
|
|
@@ -63,7 +63,7 @@ const stream = run.streamVNext({
|
|
|
63
63
|
name: "tracingOptions",
|
|
64
64
|
type: "TracingOptions",
|
|
65
65
|
isOptional: true,
|
|
66
|
-
description: "Options for
|
|
66
|
+
description: "Options for Tracing configuration.",
|
|
67
67
|
properties: [
|
|
68
68
|
{
|
|
69
69
|
parameters: [
|
|
@@ -117,7 +117,7 @@ const stream = run.streamVNext({
|
|
|
117
117
|
type: "string",
|
|
118
118
|
isOptional: true,
|
|
119
119
|
description:
|
|
120
|
-
"The trace ID associated with this execution when
|
|
120
|
+
"The trace ID associated with this execution when Tracing is enabled.",
|
|
121
121
|
},
|
|
122
122
|
]}
|
|
123
123
|
/>
|
|
@@ -125,7 +125,7 @@ const stream = run.streamVNext({
|
|
|
125
125
|
## Extended usage example
|
|
126
126
|
|
|
127
127
|
```typescript showLineNumbers copy
|
|
128
|
-
const run = await workflow.
|
|
128
|
+
const run = await workflow.createRun();
|
|
129
129
|
|
|
130
130
|
const stream = run.streamVNext({
|
|
131
131
|
inputData: {
|
|
@@ -148,6 +148,6 @@ The stream emits various event types during workflow execution. Each event has a
|
|
|
148
148
|
|
|
149
149
|
## Related
|
|
150
150
|
|
|
151
|
-
- [Workflows overview](/docs/workflows/overview#running-workflows)
|
|
152
|
-
- [Workflow.
|
|
151
|
+
- [Workflows overview](/docs/v1/workflows/overview#running-workflows)
|
|
152
|
+
- [Workflow.createRun()](/reference/v1/workflows/workflow-methods/create-run)
|
|
153
153
|
- [Run.resumeStreamVNext()](./resumeStreamVNext)
|
|
@@ -21,7 +21,7 @@ Mastra templates are pre-built project structures that demonstrate specific use
|
|
|
21
21
|
Install a template using the `create-mastra` command:
|
|
22
22
|
|
|
23
23
|
```bash copy
|
|
24
|
-
npx create-mastra@
|
|
24
|
+
npx create-mastra@beta --template template-name
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
This creates a complete project with all necessary code and configuration.
|
|
@@ -138,7 +138,7 @@ Templates must be:
|
|
|
138
138
|
- **Framework-free** - No Next.js, Express, or other web framework boilerplate
|
|
139
139
|
- **Mastra-focused** - Demonstrate Mastra functionality without additional layers
|
|
140
140
|
- **Mergeable** - Structure code for easy integration into existing projects
|
|
141
|
-
- **Node.js compatible** - Support Node.js
|
|
141
|
+
- **Node.js compatible** - Support Node.js v22.13.0 and later
|
|
142
142
|
- **ESM modules** - Use ES modules (`"type": "module"` in package.json)
|
|
143
143
|
|
|
144
144
|
### Documentation Requirements
|
|
@@ -196,7 +196,7 @@ Templates must demonstrate:
|
|
|
196
196
|
- **Type safety** - Full TypeScript typing with Zod validation
|
|
197
197
|
- **Testing** - Verified functionality with fresh installations
|
|
198
198
|
|
|
199
|
-
For information on contributing your own templates to the Mastra ecosystem, see the [Contributing Templates](/docs/community/contributing-templates) guide in the community section.
|
|
199
|
+
For information on contributing your own templates to the Mastra ecosystem, see the [Contributing Templates](/docs/v1/community/contributing-templates) guide in the community section.
|
|
200
200
|
|
|
201
201
|
:::info
|
|
202
202
|
|
|
@@ -22,9 +22,8 @@ export const tool = createTool({
|
|
|
22
22
|
outputSchema: z.object({
|
|
23
23
|
output: z.string(),
|
|
24
24
|
}),
|
|
25
|
-
execute: async (
|
|
26
|
-
const
|
|
27
|
-
const reversed = input.split("").reverse().join("");
|
|
25
|
+
execute: async (inputData) => {
|
|
26
|
+
const reversed = inputData.input.split("").reverse().join("");
|
|
28
27
|
|
|
29
28
|
return {
|
|
30
29
|
output: reversed,
|
|
@@ -68,47 +67,65 @@ export const tool = createTool({
|
|
|
68
67
|
name: "execute",
|
|
69
68
|
type: "function",
|
|
70
69
|
description:
|
|
71
|
-
"The function that contains the tool's logic. It receives
|
|
70
|
+
"The function that contains the tool's logic. It receives two parameters: the validated input data (first parameter) and an optional execution context object (second parameter) containing `requestContext`, `tracingContext`, `abortSignal`, and other execution metadata.",
|
|
72
71
|
isOptional: false,
|
|
73
72
|
properties: [
|
|
74
73
|
{
|
|
75
74
|
parameters: [
|
|
76
75
|
{
|
|
77
|
-
name: "
|
|
76
|
+
name: "input",
|
|
78
77
|
type: "z.infer<TInput>",
|
|
79
|
-
description: "The
|
|
80
|
-
},
|
|
81
|
-
],
|
|
82
|
-
},
|
|
83
|
-
{
|
|
84
|
-
parameters: [
|
|
85
|
-
{
|
|
86
|
-
name: "runtimeContext",
|
|
87
|
-
type: "RuntimeContext",
|
|
88
|
-
isOptional: true,
|
|
89
|
-
description:
|
|
90
|
-
"Runtime context for accessing shared state and dependencies",
|
|
78
|
+
description: "The validated input data based on inputSchema",
|
|
91
79
|
},
|
|
92
80
|
],
|
|
93
81
|
},
|
|
94
82
|
{
|
|
95
83
|
parameters: [
|
|
96
84
|
{
|
|
97
|
-
name: "
|
|
98
|
-
type: "
|
|
99
|
-
isOptional: true,
|
|
100
|
-
description:
|
|
101
|
-
"AI tracing context for creating child spans and adding metadata. Automatically injected when the tool is called within a traced operation.",
|
|
102
|
-
},
|
|
103
|
-
],
|
|
104
|
-
},
|
|
105
|
-
{
|
|
106
|
-
parameters: [
|
|
107
|
-
{
|
|
108
|
-
name: "abortSignal",
|
|
109
|
-
type: "AbortSignal",
|
|
85
|
+
name: "context",
|
|
86
|
+
type: "ToolExecutionContext",
|
|
110
87
|
isOptional: true,
|
|
111
|
-
description: "
|
|
88
|
+
description: "Optional execution context containing metadata",
|
|
89
|
+
properties: [
|
|
90
|
+
{
|
|
91
|
+
name: "requestContext",
|
|
92
|
+
type: "RequestContext",
|
|
93
|
+
isOptional: true,
|
|
94
|
+
description:
|
|
95
|
+
"Request Context for accessing shared state and dependencies",
|
|
96
|
+
},
|
|
97
|
+
{
|
|
98
|
+
name: "tracingContext",
|
|
99
|
+
type: "TracingContext",
|
|
100
|
+
isOptional: true,
|
|
101
|
+
description:
|
|
102
|
+
"Tracing context for creating child spans and adding metadata",
|
|
103
|
+
},
|
|
104
|
+
{
|
|
105
|
+
name: "abortSignal",
|
|
106
|
+
type: "AbortSignal",
|
|
107
|
+
isOptional: true,
|
|
108
|
+
description: "Signal for aborting the tool execution",
|
|
109
|
+
},
|
|
110
|
+
{
|
|
111
|
+
name: "agent",
|
|
112
|
+
type: "AgentToolExecutionContext",
|
|
113
|
+
isOptional: true,
|
|
114
|
+
description: "Agent-specific context (messages, suspend, resumeData, etc.)",
|
|
115
|
+
},
|
|
116
|
+
{
|
|
117
|
+
name: "workflow",
|
|
118
|
+
type: "WorkflowToolExecutionContext",
|
|
119
|
+
isOptional: true,
|
|
120
|
+
description: "Workflow-specific context (state, setState, suspend, etc.)",
|
|
121
|
+
},
|
|
122
|
+
{
|
|
123
|
+
name: "mcp",
|
|
124
|
+
type: "MCPToolExecutionContext",
|
|
125
|
+
isOptional: true,
|
|
126
|
+
description: "MCP-specific context (elicitation, etc.)",
|
|
127
|
+
},
|
|
128
|
+
],
|
|
112
129
|
},
|
|
113
130
|
],
|
|
114
131
|
},
|
|
@@ -134,7 +151,7 @@ The `createTool()` function returns a `Tool` object.
|
|
|
134
151
|
|
|
135
152
|
## Related
|
|
136
153
|
|
|
137
|
-
- [Tools Overview](/docs/tools-mcp/overview)
|
|
138
|
-
- [Using Tools with Agents](/docs/agents/using-tools)
|
|
139
|
-
- [Tool
|
|
140
|
-
- [Advanced Tool Usage](/docs/tools-mcp/advanced-usage)
|
|
154
|
+
- [Tools Overview](/docs/v1/tools-mcp/overview)
|
|
155
|
+
- [Using Tools with Agents](/docs/v1/agents/using-tools)
|
|
156
|
+
- [Tool Request Context](/docs/v1/tools-mcp/overview#using-requestcontext)
|
|
157
|
+
- [Advanced Tool Usage](/docs/v1/tools-mcp/advanced-usage)
|