@mastra/mcp-docs-server 0.13.39 → 1.0.0-beta.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.docs/organized/changelogs/%40internal%2Fai-sdk-v4.md +1 -0
- package/.docs/organized/changelogs/%40internal%2Fchangeset-cli.md +0 -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 +223 -223
- 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 +214 -214
- package/.docs/organized/changelogs/%40mastra%2Fcouchbase.md +16 -16
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloud.md +74 -74
- 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 +58 -58
- 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 +217 -217
- 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 +70 -70
- 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 +206 -206
- 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 +33 -33
- package/.docs/organized/changelogs/mastra.md +86 -86
- package/.docs/organized/code-examples/a2a.md +4 -2
- package/.docs/organized/code-examples/agui.md +12 -9
- package/.docs/organized/code-examples/ai-sdk-useChat.md +12 -18
- package/.docs/organized/code-examples/ai-sdk-v5.md +4 -2
- package/.docs/organized/code-examples/bird-checker-with-express.md +5 -4
- package/.docs/organized/code-examples/bird-checker-with-nextjs-and-eval.md +4 -3
- package/.docs/organized/code-examples/bird-checker-with-nextjs.md +4 -3
- package/.docs/organized/code-examples/client-side-tools.md +1 -0
- package/.docs/organized/code-examples/crypto-chatbot.md +1 -1
- package/.docs/organized/code-examples/experimental-auth-weather-agent.md +8 -177
- package/.docs/organized/code-examples/fireworks-r1.md +2 -2
- package/.docs/organized/code-examples/heads-up-game.md +10 -7
- package/.docs/organized/code-examples/mcp-configuration.md +5 -3
- package/.docs/organized/code-examples/mcp-registry-registry.md +3 -2
- package/.docs/organized/code-examples/memory-per-resource-example.md +4 -2
- package/.docs/organized/code-examples/memory-todo-agent.md +1 -0
- package/.docs/organized/code-examples/memory-with-context.md +2 -1
- package/.docs/organized/code-examples/memory-with-libsql.md +4 -2
- package/.docs/organized/code-examples/memory-with-mongodb.md +4 -2
- package/.docs/organized/code-examples/memory-with-pg.md +4 -2
- package/.docs/organized/code-examples/memory-with-processors.md +13 -8
- package/.docs/organized/code-examples/memory-with-upstash.md +5 -3
- package/.docs/organized/code-examples/openapi-spec-writer.md +32 -41
- package/.docs/organized/code-examples/quick-start.md +5 -32
- package/.docs/organized/code-examples/stock-price-tool.md +6 -5
- package/.docs/organized/code-examples/weather-agent.md +21 -16
- package/.docs/organized/code-examples/workflow-ai-recruiter.md +3 -2
- package/.docs/organized/code-examples/workflow-with-inline-steps.md +9 -12
- package/.docs/organized/code-examples/workflow-with-memory.md +16 -15
- package/.docs/organized/code-examples/workflow-with-separate-steps.md +2 -2
- package/.docs/organized/code-examples/workflow-with-suspend-resume.md +3 -2
- package/.docs/raw/agents/adding-voice.mdx +27 -22
- package/.docs/raw/agents/agent-memory.mdx +23 -15
- package/.docs/raw/agents/guardrails.mdx +33 -12
- package/.docs/raw/agents/networks.mdx +8 -4
- package/.docs/raw/agents/overview.mdx +21 -15
- package/.docs/raw/agents/using-tools.mdx +11 -8
- package/.docs/raw/auth/auth0.mdx +8 -8
- package/.docs/raw/auth/clerk.mdx +6 -6
- package/.docs/raw/auth/firebase.mdx +8 -8
- package/.docs/raw/auth/index.mdx +6 -6
- package/.docs/raw/auth/jwt.mdx +6 -6
- package/.docs/raw/auth/supabase.mdx +7 -7
- package/.docs/raw/auth/workos.mdx +8 -8
- package/.docs/raw/community/contributing-templates.mdx +3 -3
- package/.docs/raw/community/discord.mdx +1 -1
- package/.docs/raw/course/01-first-agent/08-exporting-your-agent.md +2 -1
- package/.docs/raw/course/01-first-agent/16-adding-memory-to-agent.md +2 -1
- package/.docs/raw/course/02-agent-tools-mcp/31-enhancing-memory-configuration.md +2 -0
- package/.docs/raw/course/03-agent-memory/04-creating-basic-memory-agent.md +1 -0
- package/.docs/raw/course/03-agent-memory/10-storage-configuration.md +2 -3
- package/.docs/raw/course/03-agent-memory/13-vector-store-configuration.md +2 -0
- package/.docs/raw/course/03-agent-memory/16-configuring-semantic-recall.md +2 -0
- package/.docs/raw/course/03-agent-memory/18-advanced-configuration-semantic-recall.md +1 -0
- package/.docs/raw/course/03-agent-memory/21-configuring-working-memory.md +2 -0
- package/.docs/raw/course/03-agent-memory/22-custom-working-memory-templates.md +1 -0
- package/.docs/raw/course/03-agent-memory/25-combining-memory-features.md +1 -0
- package/.docs/raw/course/03-agent-memory/27-creating-learning-assistant.md +1 -0
- package/.docs/raw/course/04-workflows/08-running-workflows-programmatically.md +2 -2
- package/.docs/raw/deployment/cloud-providers/amazon-ec2.mdx +5 -5
- package/.docs/raw/deployment/cloud-providers/aws-lambda.mdx +7 -5
- package/.docs/raw/deployment/cloud-providers/azure-app-services.mdx +3 -3
- package/.docs/raw/deployment/cloud-providers/digital-ocean.mdx +4 -4
- package/.docs/raw/deployment/cloud-providers/index.mdx +11 -8
- package/.docs/raw/deployment/monorepo.mdx +2 -2
- package/.docs/raw/deployment/overview.mdx +2 -2
- package/.docs/raw/deployment/server-deployment.mdx +2 -10
- package/.docs/raw/deployment/serverless-platforms/cloudflare-deployer.mdx +4 -4
- package/.docs/raw/deployment/serverless-platforms/index.mdx +10 -7
- package/.docs/raw/deployment/serverless-platforms/netlify-deployer.mdx +4 -4
- package/.docs/raw/deployment/serverless-platforms/vercel-deployer.mdx +4 -4
- package/.docs/raw/deployment/web-framework.mdx +8 -8
- package/.docs/raw/{scorers → evals}/custom-scorers.mdx +6 -6
- package/.docs/raw/evals/off-the-shelf-scorers.mdx +50 -0
- package/.docs/raw/{scorers → evals}/overview.mdx +8 -8
- package/.docs/raw/evals/running-in-ci.mdx +113 -0
- package/.docs/raw/frameworks/agentic-uis/ai-sdk.mdx +22 -21
- package/.docs/raw/frameworks/agentic-uis/copilotkit.mdx +8 -8
- package/.docs/raw/frameworks/agentic-uis/openrouter.mdx +3 -0
- package/.docs/raw/frameworks/servers/express.mdx +10 -9
- package/.docs/raw/frameworks/web-frameworks/astro.mdx +6 -6
- package/.docs/raw/frameworks/web-frameworks/next-js.mdx +3 -3
- package/.docs/raw/frameworks/web-frameworks/sveltekit.mdx +4 -4
- package/.docs/raw/frameworks/web-frameworks/vite-react.mdx +2 -2
- package/.docs/raw/getting-started/installation.mdx +13 -12
- package/.docs/raw/getting-started/mcp-docs-server.mdx +1 -1
- package/.docs/raw/getting-started/project-structure.mdx +4 -4
- package/.docs/raw/getting-started/studio.mdx +8 -8
- package/.docs/raw/getting-started/templates.mdx +1 -1
- package/.docs/raw/guides/guide/ai-recruiter.mdx +264 -0
- package/.docs/raw/guides/guide/chef-michel.mdx +271 -0
- package/.docs/raw/guides/guide/notes-mcp-server.mdx +450 -0
- package/.docs/raw/guides/guide/research-assistant.mdx +389 -0
- package/.docs/raw/guides/guide/stock-agent.mdx +185 -0
- package/.docs/raw/guides/guide/web-search.mdx +291 -0
- package/.docs/raw/guides/index.mdx +43 -0
- package/.docs/raw/guides/migrations/agentnetwork.mdx +114 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/_template.mdx +50 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/agent.mdx +265 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/cli.mdx +48 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/client.mdx +153 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/evals.mdx +230 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/mastra.mdx +171 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/mcp.mdx +114 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/memory.mdx +241 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/overview.mdx +83 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/processors.mdx +62 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/storage.mdx +270 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/tools.mdx +115 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/tracing.mdx +280 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/vectors.mdx +23 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/voice.mdx +39 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/workflows.mdx +178 -0
- package/.docs/raw/guides/migrations/vnext-to-standard-apis.mdx +367 -0
- package/.docs/raw/index.mdx +9 -9
- package/.docs/raw/{observability/logging.mdx → logging.mdx} +4 -4
- package/.docs/raw/mastra-cloud/dashboard.mdx +2 -2
- package/.docs/raw/mastra-cloud/observability.mdx +6 -6
- package/.docs/raw/mastra-cloud/overview.mdx +2 -2
- package/.docs/raw/mastra-cloud/setting-up.mdx +4 -4
- package/.docs/raw/memory/conversation-history.mdx +1 -0
- package/.docs/raw/memory/memory-processors.mdx +4 -3
- package/.docs/raw/memory/overview.mdx +9 -5
- package/.docs/raw/memory/semantic-recall.mdx +12 -7
- package/.docs/raw/memory/storage/memory-with-libsql.mdx +10 -5
- package/.docs/raw/memory/storage/memory-with-pg.mdx +9 -4
- package/.docs/raw/memory/storage/memory-with-upstash.mdx +9 -4
- package/.docs/raw/memory/threads-and-resources.mdx +11 -13
- package/.docs/raw/memory/working-memory.mdx +30 -14
- package/.docs/raw/observability/overview.mdx +13 -30
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/arize.mdx +10 -18
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/braintrust.mdx +7 -16
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/cloud.mdx +11 -17
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/default.mdx +16 -20
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/langfuse.mdx +7 -16
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/langsmith.mdx +7 -16
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/otel.mdx +9 -18
- package/.docs/raw/observability/{ai-tracing → tracing}/overview.mdx +107 -142
- package/.docs/raw/observability/{ai-tracing → tracing}/processors/sensitive-data-filter.mdx +14 -13
- package/.docs/raw/rag/chunking-and-embedding.mdx +5 -5
- package/.docs/raw/rag/overview.mdx +3 -13
- package/.docs/raw/rag/retrieval.mdx +24 -12
- package/.docs/raw/rag/vector-databases.mdx +7 -1
- package/.docs/raw/reference/agents/agent.mdx +33 -28
- package/.docs/raw/reference/agents/generate.mdx +10 -10
- package/.docs/raw/reference/agents/generateLegacy.mdx +8 -8
- package/.docs/raw/reference/agents/getDefaultGenerateOptions.mdx +21 -15
- package/.docs/raw/reference/agents/getDefaultOptions.mdx +69 -0
- package/.docs/raw/reference/agents/getDefaultStreamOptions.mdx +22 -16
- package/.docs/raw/reference/agents/getDescription.mdx +1 -1
- package/.docs/raw/reference/agents/getInstructions.mdx +8 -8
- package/.docs/raw/reference/agents/getLLM.mdx +9 -9
- package/.docs/raw/reference/agents/getMemory.mdx +9 -9
- package/.docs/raw/reference/agents/getModel.mdx +10 -10
- package/.docs/raw/reference/agents/getVoice.mdx +8 -8
- package/.docs/raw/reference/agents/listAgents.mdx +9 -9
- package/.docs/raw/reference/agents/listScorers.mdx +7 -7
- package/.docs/raw/reference/agents/listTools.mdx +7 -7
- package/.docs/raw/reference/agents/listWorkflows.mdx +7 -7
- package/.docs/raw/reference/agents/network.mdx +11 -10
- package/.docs/raw/reference/auth/auth0.mdx +4 -4
- package/.docs/raw/reference/auth/clerk.mdx +4 -4
- package/.docs/raw/reference/auth/firebase.mdx +6 -6
- package/.docs/raw/reference/auth/jwt.mdx +4 -4
- package/.docs/raw/reference/auth/supabase.mdx +4 -4
- package/.docs/raw/reference/auth/workos.mdx +4 -4
- package/.docs/raw/reference/cli/mastra.mdx +7 -7
- package/.docs/raw/reference/client-js/agents.mdx +6 -2
- package/.docs/raw/reference/client-js/mastra-client.mdx +7 -7
- package/.docs/raw/reference/client-js/memory.mdx +24 -16
- package/.docs/raw/reference/client-js/observability.mdx +11 -11
- package/.docs/raw/reference/client-js/workflows.mdx +6 -34
- package/.docs/raw/reference/core/getAgent.mdx +1 -1
- package/.docs/raw/reference/core/getAgentById.mdx +1 -1
- package/.docs/raw/reference/core/getDeployer.mdx +2 -2
- package/.docs/raw/reference/core/getLogger.mdx +2 -2
- package/.docs/raw/reference/core/getMCPServer.mdx +31 -15
- package/.docs/raw/reference/core/getMCPServerById.mdx +81 -0
- package/.docs/raw/reference/core/getScorer.mdx +3 -3
- package/.docs/raw/reference/core/getScorerById.mdx +79 -0
- package/.docs/raw/reference/core/getServer.mdx +2 -2
- package/.docs/raw/reference/core/getStorage.mdx +2 -2
- package/.docs/raw/reference/core/getTelemetry.mdx +2 -2
- package/.docs/raw/reference/core/getVector.mdx +2 -2
- package/.docs/raw/reference/core/getWorkflow.mdx +1 -1
- package/.docs/raw/reference/core/listAgents.mdx +1 -1
- package/.docs/raw/reference/core/listLogs.mdx +2 -2
- package/.docs/raw/reference/core/listLogsByRunId.mdx +2 -2
- package/.docs/raw/reference/core/listMCPServers.mdx +65 -0
- package/.docs/raw/reference/core/listScorers.mdx +3 -3
- package/.docs/raw/reference/core/listVectors.mdx +36 -0
- package/.docs/raw/reference/core/listWorkflows.mdx +6 -6
- package/.docs/raw/reference/core/mastra-class.mdx +3 -2
- package/.docs/raw/reference/core/setLogger.mdx +2 -2
- package/.docs/raw/reference/core/setStorage.mdx +3 -2
- package/.docs/raw/reference/core/setTelemetry.mdx +2 -2
- package/.docs/raw/reference/deployer/cloudflare.mdx +2 -2
- package/.docs/raw/reference/deployer/deployer.mdx +0 -6
- package/.docs/raw/reference/deployer/netlify.mdx +2 -2
- package/.docs/raw/reference/deployer/vercel.mdx +3 -3
- package/.docs/raw/reference/evals/answer-relevancy.mdx +164 -126
- package/.docs/raw/reference/{scorers → evals}/answer-similarity.mdx +27 -27
- package/.docs/raw/reference/evals/bias.mdx +149 -115
- package/.docs/raw/reference/evals/completeness.mdx +148 -117
- package/.docs/raw/reference/evals/content-similarity.mdx +126 -113
- package/.docs/raw/reference/evals/context-precision.mdx +290 -133
- package/.docs/raw/reference/{scorers → evals}/context-relevance.mdx +6 -6
- package/.docs/raw/reference/{scorers → evals}/create-scorer.mdx +11 -11
- package/.docs/raw/reference/evals/faithfulness.mdx +163 -121
- package/.docs/raw/reference/evals/hallucination.mdx +159 -132
- package/.docs/raw/reference/evals/keyword-coverage.mdx +169 -125
- package/.docs/raw/reference/{scorers → evals}/mastra-scorer.mdx +5 -5
- package/.docs/raw/reference/{scorers → evals}/noise-sensitivity.mdx +9 -9
- package/.docs/raw/reference/evals/prompt-alignment.mdx +604 -182
- package/.docs/raw/reference/{scorers/run-experiment.mdx → evals/run-evals.mdx} +17 -18
- package/.docs/raw/reference/evals/textual-difference.mdx +149 -117
- package/.docs/raw/reference/evals/tone-consistency.mdx +149 -125
- package/.docs/raw/reference/{scorers → evals}/tool-call-accuracy.mdx +8 -6
- package/.docs/raw/reference/evals/toxicity.mdx +152 -96
- package/.docs/raw/reference/{observability/logging → logging}/pino-logger.mdx +2 -2
- package/.docs/raw/reference/memory/createThread.mdx +5 -5
- package/.docs/raw/reference/memory/deleteMessages.mdx +7 -7
- package/.docs/raw/reference/memory/getThreadById.mdx +4 -4
- package/.docs/raw/reference/memory/listThreadsByResourceId.mdx +110 -0
- package/.docs/raw/reference/memory/memory-class.mdx +13 -9
- package/.docs/raw/reference/memory/query.mdx +58 -57
- package/.docs/raw/reference/memory/recall.mdx +185 -0
- package/.docs/raw/reference/observability/tracing/configuration.mdx +245 -0
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/arize.mdx +13 -13
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/braintrust.mdx +11 -8
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/cloud-exporter.mdx +21 -19
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/console-exporter.mdx +49 -17
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/default-exporter.mdx +42 -41
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/langfuse.mdx +10 -7
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/langsmith.mdx +10 -7
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/otel.mdx +5 -5
- package/.docs/raw/reference/observability/tracing/instances.mdx +168 -0
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/interfaces.mdx +115 -89
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/processors/sensitive-data-filter.mdx +3 -3
- package/.docs/raw/reference/observability/{ai-tracing/span.mdx → tracing/spans.mdx} +59 -41
- package/.docs/raw/reference/processors/batch-parts-processor.mdx +1 -1
- package/.docs/raw/reference/processors/language-detector.mdx +1 -1
- package/.docs/raw/reference/processors/moderation-processor.mdx +1 -1
- package/.docs/raw/reference/processors/pii-detector.mdx +1 -1
- package/.docs/raw/reference/processors/prompt-injection-detector.mdx +1 -1
- package/.docs/raw/reference/processors/system-prompt-scrubber.mdx +1 -1
- package/.docs/raw/reference/processors/token-limiter-processor.mdx +1 -1
- package/.docs/raw/reference/processors/unicode-normalizer.mdx +1 -1
- package/.docs/raw/reference/rag/chunk.mdx +1 -8
- package/.docs/raw/reference/rag/database-config.mdx +7 -7
- package/.docs/raw/reference/rag/metadata-filters.mdx +14 -11
- package/.docs/raw/reference/storage/libsql.mdx +2 -0
- package/.docs/raw/reference/storage/mssql.mdx +5 -0
- package/.docs/raw/reference/storage/postgresql.mdx +6 -0
- package/.docs/raw/reference/storage/upstash.mdx +1 -0
- package/.docs/raw/reference/streaming/agents/stream.mdx +12 -12
- package/.docs/raw/reference/streaming/agents/streamLegacy.mdx +8 -8
- package/.docs/raw/reference/streaming/workflows/observeStream.mdx +3 -3
- package/.docs/raw/reference/streaming/workflows/observeStreamVNext.mdx +3 -3
- package/.docs/raw/reference/streaming/workflows/resumeStreamVNext.mdx +6 -6
- package/.docs/raw/reference/streaming/workflows/stream.mdx +10 -10
- package/.docs/raw/reference/streaming/workflows/streamVNext.mdx +11 -11
- package/.docs/raw/reference/templates/overview.mdx +2 -2
- package/.docs/raw/reference/tools/create-tool.mdx +52 -35
- package/.docs/raw/reference/tools/graph-rag-tool.mdx +15 -15
- package/.docs/raw/reference/tools/mcp-client.mdx +1 -1
- package/.docs/raw/reference/tools/mcp-server.mdx +119 -35
- package/.docs/raw/reference/tools/vector-query-tool.mdx +27 -26
- package/.docs/raw/reference/vectors/libsql.mdx +1 -0
- package/.docs/raw/reference/vectors/pg.mdx +3 -0
- package/.docs/raw/reference/vectors/upstash.mdx +1 -0
- package/.docs/raw/reference/voice/google-gemini-live.mdx +1 -1
- package/.docs/raw/reference/voice/voice.addTools.mdx +3 -3
- package/.docs/raw/reference/workflows/run-methods/cancel.mdx +4 -4
- package/.docs/raw/reference/workflows/run-methods/resume.mdx +14 -14
- package/.docs/raw/reference/workflows/run-methods/start.mdx +17 -17
- package/.docs/raw/reference/workflows/run.mdx +1 -8
- package/.docs/raw/reference/workflows/step.mdx +5 -5
- package/.docs/raw/reference/workflows/workflow-methods/branch.mdx +2 -2
- package/.docs/raw/reference/workflows/workflow-methods/commit.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/create-run.mdx +7 -13
- package/.docs/raw/reference/workflows/workflow-methods/dountil.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/dowhile.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/foreach.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/map.mdx +5 -0
- package/.docs/raw/reference/workflows/workflow-methods/parallel.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/sendEvent.mdx +2 -2
- package/.docs/raw/reference/workflows/workflow-methods/sleep.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/sleepUntil.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/then.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/waitForEvent.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow.mdx +1 -1
- package/.docs/raw/server-db/custom-api-routes.mdx +2 -2
- package/.docs/raw/server-db/mastra-client.mdx +19 -18
- package/.docs/raw/server-db/middleware.mdx +7 -7
- package/.docs/raw/server-db/production-server.mdx +4 -4
- package/.docs/raw/server-db/{runtime-context.mdx → request-context.mdx} +46 -45
- package/.docs/raw/server-db/storage.mdx +29 -21
- package/.docs/raw/streaming/events.mdx +3 -3
- package/.docs/raw/streaming/overview.mdx +5 -5
- package/.docs/raw/streaming/tool-streaming.mdx +18 -17
- package/.docs/raw/streaming/workflow-streaming.mdx +1 -1
- package/.docs/raw/tools-mcp/advanced-usage.mdx +5 -4
- package/.docs/raw/tools-mcp/mcp-overview.mdx +32 -19
- package/.docs/raw/tools-mcp/overview.mdx +11 -11
- package/.docs/raw/voice/overview.mdx +63 -43
- package/.docs/raw/voice/speech-to-speech.mdx +5 -3
- package/.docs/raw/voice/speech-to-text.mdx +9 -8
- package/.docs/raw/voice/text-to-speech.mdx +12 -11
- package/.docs/raw/workflows/agents-and-tools.mdx +9 -5
- package/.docs/raw/workflows/control-flow.mdx +3 -3
- package/.docs/raw/workflows/error-handling.mdx +2 -21
- package/.docs/raw/workflows/human-in-the-loop.mdx +7 -4
- package/.docs/raw/workflows/inngest-workflow.mdx +2 -2
- package/.docs/raw/workflows/input-data-mapping.mdx +107 -0
- package/.docs/raw/workflows/overview.mdx +17 -16
- package/.docs/raw/workflows/snapshots.mdx +13 -11
- package/.docs/raw/workflows/suspend-and-resume.mdx +23 -15
- package/CHANGELOG.md +52 -57
- 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
|
@@ -1,18 +1,18 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Reference:
|
|
2
|
+
title: "Reference: Spans | Observability | Mastra Docs"
|
|
3
3
|
description: Span interfaces, methods, and lifecycle events
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
import PropertiesTable from "@site/src/components/PropertiesTable";
|
|
7
7
|
|
|
8
|
-
#
|
|
8
|
+
# Spans
|
|
9
9
|
|
|
10
10
|
## BaseSpan
|
|
11
11
|
|
|
12
12
|
Base interface for all span types.
|
|
13
13
|
|
|
14
14
|
```typescript
|
|
15
|
-
interface BaseSpan<TType extends
|
|
15
|
+
interface BaseSpan<TType extends SpanType> {
|
|
16
16
|
/** Unique span identifier */
|
|
17
17
|
id: string;
|
|
18
18
|
|
|
@@ -32,7 +32,7 @@ interface BaseSpan<TType extends AISpanType> {
|
|
|
32
32
|
endTime?: Date;
|
|
33
33
|
|
|
34
34
|
/** Type-specific attributes */
|
|
35
|
-
attributes?:
|
|
35
|
+
attributes?: SpanTypeMap[TType];
|
|
36
36
|
|
|
37
37
|
/** User-defined metadata */
|
|
38
38
|
metadata?: Record<string, any>;
|
|
@@ -57,20 +57,20 @@ interface BaseSpan<TType extends AISpanType> {
|
|
|
57
57
|
}
|
|
58
58
|
```
|
|
59
59
|
|
|
60
|
-
##
|
|
60
|
+
## Span
|
|
61
61
|
|
|
62
|
-
|
|
62
|
+
Span interface, used internally for tracing. Extends BaseSpan with lifecycle methods and properties.
|
|
63
63
|
|
|
64
64
|
```typescript
|
|
65
|
-
interface
|
|
65
|
+
interface Span<TType extends SpanType> extends BaseSpan<TType> {
|
|
66
66
|
/** Is an internal span? (spans internal to the operation of mastra) */
|
|
67
67
|
isInternal: boolean;
|
|
68
68
|
|
|
69
69
|
/** Parent span reference (undefined for root spans) */
|
|
70
|
-
parent?:
|
|
70
|
+
parent?: AnySpan;
|
|
71
71
|
|
|
72
|
-
/** Pointer to the
|
|
73
|
-
|
|
72
|
+
/** Pointer to the ObservabilityInstance instance */
|
|
73
|
+
observabilityInstance: ObservabilityInstance;
|
|
74
74
|
}
|
|
75
75
|
```
|
|
76
76
|
|
|
@@ -87,7 +87,7 @@ get isValid(): boolean
|
|
|
87
87
|
getParentSpanId(includeInternalSpans?: boolean): string | undefined
|
|
88
88
|
|
|
89
89
|
/** Returns a lightweight span ready for export */
|
|
90
|
-
exportSpan(includeInternalSpans?: boolean):
|
|
90
|
+
exportSpan(includeInternalSpans?: boolean): ExportedSpan<TType> | undefined
|
|
91
91
|
```
|
|
92
92
|
|
|
93
93
|
### Methods
|
|
@@ -116,7 +116,7 @@ Ends the span and triggers export to configured exporters. Sets the `endTime` an
|
|
|
116
116
|
},
|
|
117
117
|
{
|
|
118
118
|
name: "attributes",
|
|
119
|
-
type: "Partial<
|
|
119
|
+
type: "Partial<SpanTypeMap[TType]>",
|
|
120
120
|
description: "Type-specific attributes to update",
|
|
121
121
|
required: false,
|
|
122
122
|
},
|
|
@@ -153,7 +153,7 @@ Records an error on the span. Sets the `errorInfo` field and can optionally end
|
|
|
153
153
|
},
|
|
154
154
|
{
|
|
155
155
|
name: "attributes",
|
|
156
|
-
type: "Partial<
|
|
156
|
+
type: "Partial<SpanTypeMap[TType]>",
|
|
157
157
|
description: "Type-specific attributes to update",
|
|
158
158
|
required: false,
|
|
159
159
|
},
|
|
@@ -190,7 +190,7 @@ Updates span data while it's still active. Can modify `input`, `output`, `metada
|
|
|
190
190
|
},
|
|
191
191
|
{
|
|
192
192
|
name: "attributes",
|
|
193
|
-
type: "Partial<
|
|
193
|
+
type: "Partial<SpanTypeMap[TType]>",
|
|
194
194
|
description: "Type-specific attributes to update",
|
|
195
195
|
required: false,
|
|
196
196
|
},
|
|
@@ -200,9 +200,9 @@ Updates span data while it's still active. Can modify `input`, `output`, `metada
|
|
|
200
200
|
#### createChildSpan
|
|
201
201
|
|
|
202
202
|
```typescript
|
|
203
|
-
createChildSpan<TChildType extends
|
|
203
|
+
createChildSpan<TChildType extends SpanType>(
|
|
204
204
|
options: ChildSpanOptions<TChildType>
|
|
205
|
-
):
|
|
205
|
+
): Span<TChildType>
|
|
206
206
|
```
|
|
207
207
|
|
|
208
208
|
Creates a child span under this span. Child spans track sub-operations and inherit the trace context.
|
|
@@ -223,7 +223,7 @@ Creates a child span under this span. Child spans track sub-operations and inher
|
|
|
223
223
|
},
|
|
224
224
|
{
|
|
225
225
|
name: "attributes",
|
|
226
|
-
type: "
|
|
226
|
+
type: "SpanTypeMap[TChildType]",
|
|
227
227
|
description: "Type-specific attributes",
|
|
228
228
|
required: false,
|
|
229
229
|
},
|
|
@@ -245,9 +245,9 @@ Creates a child span under this span. Child spans track sub-operations and inher
|
|
|
245
245
|
#### createEventSpan
|
|
246
246
|
|
|
247
247
|
```typescript
|
|
248
|
-
createEventSpan<TChildType extends
|
|
248
|
+
createEventSpan<TChildType extends SpanType>(
|
|
249
249
|
options: ChildEventOptions<TChildType>
|
|
250
|
-
):
|
|
250
|
+
): Span<TChildType>
|
|
251
251
|
```
|
|
252
252
|
|
|
253
253
|
Creates an event span under this span. Event spans represent point-in-time occurrences with no duration.
|
|
@@ -268,7 +268,7 @@ Creates an event span under this span. Event spans represent point-in-time occur
|
|
|
268
268
|
},
|
|
269
269
|
{
|
|
270
270
|
name: "attributes",
|
|
271
|
-
type: "
|
|
271
|
+
type: "SpanTypeMap[TChildType]",
|
|
272
272
|
description: "Type-specific attributes",
|
|
273
273
|
required: false,
|
|
274
274
|
},
|
|
@@ -293,12 +293,12 @@ Creates an event span under this span. Event spans represent point-in-time occur
|
|
|
293
293
|
]}
|
|
294
294
|
/>
|
|
295
295
|
|
|
296
|
-
##
|
|
296
|
+
## ExportedSpan
|
|
297
297
|
|
|
298
|
-
Exported
|
|
298
|
+
Exported Span interface, used for tracing exporters. A lightweight version of Span without methods or circular references.
|
|
299
299
|
|
|
300
300
|
```typescript
|
|
301
|
-
interface
|
|
301
|
+
interface ExportedSpan<TType extends SpanType> extends BaseSpan<TType> {
|
|
302
302
|
/** Parent span id reference (undefined for root spans) */
|
|
303
303
|
parentSpanId?: string;
|
|
304
304
|
|
|
@@ -311,10 +311,10 @@ interface ExportedAISpan<TType extends AISpanType> extends BaseSpan<TType> {
|
|
|
311
311
|
|
|
312
312
|
Events emitted during the span lifecycle.
|
|
313
313
|
|
|
314
|
-
###
|
|
314
|
+
### TracingEventType
|
|
315
315
|
|
|
316
316
|
```typescript
|
|
317
|
-
enum
|
|
317
|
+
enum TracingEventType {
|
|
318
318
|
/** Emitted when a span is created and started */
|
|
319
319
|
SPAN_STARTED = "span_started",
|
|
320
320
|
|
|
@@ -326,49 +326,67 @@ enum AITracingEventType {
|
|
|
326
326
|
}
|
|
327
327
|
```
|
|
328
328
|
|
|
329
|
-
###
|
|
329
|
+
### TracingEvent
|
|
330
330
|
|
|
331
331
|
```typescript
|
|
332
|
-
type
|
|
333
|
-
| { type: "span_started"; exportedSpan:
|
|
334
|
-
| { type: "span_updated"; exportedSpan:
|
|
335
|
-
| { type: "span_ended"; exportedSpan:
|
|
332
|
+
type TracingEvent =
|
|
333
|
+
| { type: "span_started"; exportedSpan: AnyExportedSpan }
|
|
334
|
+
| { type: "span_updated"; exportedSpan: AnyExportedSpan }
|
|
335
|
+
| { type: "span_ended"; exportedSpan: AnyExportedSpan };
|
|
336
336
|
```
|
|
337
337
|
|
|
338
338
|
Exporters receive these events to process and send trace data to observability platforms.
|
|
339
339
|
|
|
340
340
|
## Union Types
|
|
341
341
|
|
|
342
|
-
###
|
|
342
|
+
### AnySpan
|
|
343
343
|
|
|
344
344
|
```typescript
|
|
345
|
-
type
|
|
345
|
+
type AnySpan = Span<keyof SpanTypeMap>;
|
|
346
346
|
```
|
|
347
347
|
|
|
348
348
|
Union type for cases that need to handle any span type.
|
|
349
349
|
|
|
350
|
-
###
|
|
350
|
+
### AnyExportedSpan
|
|
351
351
|
|
|
352
352
|
```typescript
|
|
353
|
-
type
|
|
353
|
+
type AnyExportedSpan = ExportedSpan<keyof SpanTypeMap>;
|
|
354
354
|
```
|
|
355
355
|
|
|
356
356
|
Union type for cases that need to handle any exported span type.
|
|
357
357
|
|
|
358
|
+
## NO-OP Spans
|
|
359
|
+
|
|
360
|
+
When tracing is disabled (sampling returns false), NO-OP spans are returned:
|
|
361
|
+
|
|
362
|
+
### NoOpSpan
|
|
363
|
+
|
|
364
|
+
```typescript
|
|
365
|
+
class NoOpSpan<TType extends SpanType> extends BaseSpan<TType>
|
|
366
|
+
```
|
|
367
|
+
|
|
368
|
+
A span that performs no operations. All methods are no-ops:
|
|
369
|
+
|
|
370
|
+
- `id` returns `'no-op'`
|
|
371
|
+
- `traceId` returns `'no-op-trace'`
|
|
372
|
+
- `isValid` returns `false`
|
|
373
|
+
- `end()`, `error()`, `update()` do nothing
|
|
374
|
+
- `createChildSpan()` returns another NO-OP span
|
|
375
|
+
|
|
358
376
|
## See Also
|
|
359
377
|
|
|
360
378
|
### Documentation
|
|
361
379
|
|
|
362
|
-
- [
|
|
363
|
-
- [Creating Child Spans]
|
|
364
|
-
- [Retrieving Trace IDs]
|
|
380
|
+
- [Tracing Overview]/docs/v1/observability/tracing/overview) - Concepts and usage
|
|
381
|
+
- [Creating Child Spans]/docs/v1/observability/tracing/overview#creating-child-spans) - Practical examples
|
|
382
|
+
- [Retrieving Trace IDs]/docs/v1/observability/tracing/overview#retrieving-trace-ids) - Using trace IDs
|
|
365
383
|
|
|
366
384
|
### Reference
|
|
367
385
|
|
|
368
|
-
- [
|
|
369
|
-
- [Interfaces]
|
|
370
|
-
- [Configuration]
|
|
386
|
+
- [Tracing Classes]/reference/v1/observability/tracing/instances) - Core tracing classes
|
|
387
|
+
- [Interfaces]/reference/v1/observability/tracing/interfaces) - Complete type reference
|
|
388
|
+
- [Configuration]/reference/v1/observability/tracing/configuration) - Configuration options
|
|
371
389
|
|
|
372
390
|
### Examples
|
|
373
391
|
|
|
374
|
-
- [Basic
|
|
392
|
+
- [Basic Tracing]/examples/v1/observability/basic-tracing) - Working with spans
|
|
@@ -62,13 +62,6 @@ The following parameters are available for all chunking strategies.
|
|
|
62
62
|
description:
|
|
63
63
|
"Maximum size of each chunk. **Note:** Some strategy configurations (markdown with headers, HTML with headers) ignore this parameter.",
|
|
64
64
|
},
|
|
65
|
-
{
|
|
66
|
-
name: "size",
|
|
67
|
-
type: "number",
|
|
68
|
-
isOptional: true,
|
|
69
|
-
description:
|
|
70
|
-
"**Deprecated:** Use `maxSize` instead. This parameter will be removed in the next major version.",
|
|
71
|
-
},
|
|
72
65
|
{
|
|
73
66
|
name: "overlap",
|
|
74
67
|
type: "number",
|
|
@@ -113,7 +106,7 @@ The following parameters are available for all chunking strategies.
|
|
|
113
106
|
]}
|
|
114
107
|
/>
|
|
115
108
|
|
|
116
|
-
See [ExtractParams reference](/reference/rag/extract-params) for details on the `extract` parameter.
|
|
109
|
+
See [ExtractParams reference](/reference/v1/rag/extract-params) for details on the `extract` parameter.
|
|
117
110
|
|
|
118
111
|
## Strategy-Specific Options
|
|
119
112
|
|
|
@@ -188,7 +188,7 @@ whereDocument: { "$contains": "API documentation" }
|
|
|
188
188
|
### Runtime Configuration Override
|
|
189
189
|
|
|
190
190
|
```typescript
|
|
191
|
-
import {
|
|
191
|
+
import { RequestContext } from '@mastra/core/request-context';
|
|
192
192
|
|
|
193
193
|
// Initial configuration
|
|
194
194
|
const vectorTool = createVectorQueryTool({
|
|
@@ -203,8 +203,8 @@ whereDocument: { "$contains": "API documentation" }
|
|
|
203
203
|
});
|
|
204
204
|
|
|
205
205
|
// Override at runtime
|
|
206
|
-
const
|
|
207
|
-
|
|
206
|
+
const requestContext = new RequestContext();
|
|
207
|
+
requestContext.set('databaseConfig', {
|
|
208
208
|
pinecone: {
|
|
209
209
|
namespace: 'production'
|
|
210
210
|
}
|
|
@@ -213,7 +213,7 @@ whereDocument: { "$contains": "API documentation" }
|
|
|
213
213
|
await vectorTool.execute({
|
|
214
214
|
context: { queryText: 'search query' },
|
|
215
215
|
mastra,
|
|
216
|
-
|
|
216
|
+
requestContext
|
|
217
217
|
});
|
|
218
218
|
```
|
|
219
219
|
|
|
@@ -347,6 +347,6 @@ const vectorTool = createVectorQueryTool({
|
|
|
347
347
|
|
|
348
348
|
## Related
|
|
349
349
|
|
|
350
|
-
- [createVectorQueryTool()](/reference/tools/vector-query-tool)
|
|
351
|
-
- [Hybrid Vector Search](/examples/rag/query/hybrid-vector-search)
|
|
352
|
-
- [Metadata Filters](/reference/rag/metadata-filters)
|
|
350
|
+
- [createVectorQueryTool()](/reference/v1/tools/vector-query-tool)
|
|
351
|
+
- [Hybrid Vector Search](/examples/v1/rag/query/hybrid-vector-search)
|
|
352
|
+
- [Metadata Filters](/reference/v1/rag/metadata-filters)
|
|
@@ -12,7 +12,10 @@ Mastra provides a unified metadata filtering syntax across all vector stores, ba
|
|
|
12
12
|
```typescript
|
|
13
13
|
import { PgVector } from "@mastra/pg";
|
|
14
14
|
|
|
15
|
-
const store = new PgVector({
|
|
15
|
+
const store = new PgVector({
|
|
16
|
+
id: 'pg-vector',
|
|
17
|
+
connectionString
|
|
18
|
+
});
|
|
16
19
|
|
|
17
20
|
const results = await store.query({
|
|
18
21
|
indexName: "my_index",
|
|
@@ -332,13 +335,13 @@ const results = await store.query({
|
|
|
332
335
|
|
|
333
336
|
## Related
|
|
334
337
|
|
|
335
|
-
- [Astra](/reference/vectors/astra)
|
|
336
|
-
- [Chroma](/reference/vectors/chroma)
|
|
337
|
-
- [Cloudflare Vectorize](/reference/vectors/vectorize)
|
|
338
|
-
- [LibSQL](/reference/vectors/libsql)
|
|
339
|
-
- [MongoDB](/reference/vectors/mongodb)
|
|
340
|
-
- [PgStore](/reference/vectors/pg)
|
|
341
|
-
- [Pinecone](/reference/vectors/pinecone)
|
|
342
|
-
- [Qdrant](/reference/vectors/qdrant)
|
|
343
|
-
- [Upstash](/reference/vectors/upstash)
|
|
344
|
-
- [Amazon S3 Vectors](/reference/vectors/s3vectors)
|
|
338
|
+
- [Astra](/reference/v1/vectors/astra)
|
|
339
|
+
- [Chroma](/reference/v1/vectors/chroma)
|
|
340
|
+
- [Cloudflare Vectorize](/reference/v1/vectors/vectorize)
|
|
341
|
+
- [LibSQL](/reference/v1/vectors/libsql)
|
|
342
|
+
- [MongoDB](/reference/v1/vectors/mongodb)
|
|
343
|
+
- [PgStore](/reference/v1/vectors/pg)
|
|
344
|
+
- [Pinecone](/reference/v1/vectors/pinecone)
|
|
345
|
+
- [Qdrant](/reference/v1/vectors/qdrant)
|
|
346
|
+
- [Upstash](/reference/v1/vectors/upstash)
|
|
347
|
+
- [Amazon S3 Vectors](/reference/v1/vectors/s3vectors)
|
|
@@ -20,11 +20,13 @@ import { LibSQLStore } from "@mastra/libsql";
|
|
|
20
20
|
|
|
21
21
|
// File database (development)
|
|
22
22
|
const storage = new LibSQLStore({
|
|
23
|
+
id: 'libsql-storage',
|
|
23
24
|
url: "file:./storage.db",
|
|
24
25
|
});
|
|
25
26
|
|
|
26
27
|
// Persistent database (production)
|
|
27
28
|
const storage = new LibSQLStore({
|
|
29
|
+
id: 'libsql-storage',
|
|
28
30
|
url: process.env.DATABASE_URL,
|
|
29
31
|
});
|
|
30
32
|
```
|
|
@@ -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",
|
|
@@ -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
|
});
|
|
@@ -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)
|