@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
|
@@ -81,7 +81,7 @@ export function CopilotKitComponent({ runtimeUrl }: { runtimeUrl: string }) {
|
|
|
81
81
|
|
|
82
82
|
<StepItem>
|
|
83
83
|
|
|
84
|
-
If you have not yet set up your Mastra server, follow the [getting started guide](/docs/getting-started/installation) to set up a new Mastra project.
|
|
84
|
+
If you have not yet set up your Mastra server, follow the [getting started guide](/docs/v1/getting-started/installation) to set up a new Mastra project.
|
|
85
85
|
|
|
86
86
|
In your Mastra server, install additional packages for CopilotKit integration:
|
|
87
87
|
|
|
@@ -89,21 +89,21 @@ In your Mastra server, install additional packages for CopilotKit integration:
|
|
|
89
89
|
<TabItem value="npm" label="npm">
|
|
90
90
|
|
|
91
91
|
```bash copy
|
|
92
|
-
npm install @copilotkit/runtime @ag-ui/mastra
|
|
92
|
+
npm install @copilotkit/runtime @ag-ui/mastra@beta
|
|
93
93
|
```
|
|
94
94
|
|
|
95
95
|
</TabItem>
|
|
96
96
|
<TabItem value="yarn" label="yarn">
|
|
97
97
|
|
|
98
98
|
```bash copy
|
|
99
|
-
yarn add @copilotkit/runtime @ag-ui/mastra
|
|
99
|
+
yarn add @copilotkit/runtime @ag-ui/mastra@beta
|
|
100
100
|
```
|
|
101
101
|
|
|
102
102
|
</TabItem>
|
|
103
103
|
<TabItem value="pnpm" label="pnpm">
|
|
104
104
|
|
|
105
105
|
```bash copy
|
|
106
|
-
pnpm add @copilotkit/runtime @ag-ui/mastra
|
|
106
|
+
pnpm add @copilotkit/runtime @ag-ui/mastra@beta
|
|
107
107
|
```
|
|
108
108
|
|
|
109
109
|
</TabItem>
|
|
@@ -116,11 +116,11 @@ pnpm add @copilotkit/runtime @ag-ui/mastra
|
|
|
116
116
|
Configure your Mastra instance to include CopilotKit's runtime endpoint:
|
|
117
117
|
|
|
118
118
|
```typescript title="src/mastra/index.ts" copy {2,5-8,12-28}
|
|
119
|
-
import { Mastra } from "@mastra/core
|
|
119
|
+
import { Mastra } from "@mastra/core";
|
|
120
120
|
import { registerCopilotKit } from "@ag-ui/mastra/copilotkit";
|
|
121
121
|
import { weatherAgent } from "./agents/weather-agent";
|
|
122
122
|
|
|
123
|
-
type
|
|
123
|
+
type WeatherRequestContext = {
|
|
124
124
|
"user-id": string;
|
|
125
125
|
"temperature-scale": "celsius" | "fahrenheit";
|
|
126
126
|
};
|
|
@@ -134,15 +134,15 @@ export const mastra = new Mastra({
|
|
|
134
134
|
allowHeaders: ["*"],
|
|
135
135
|
},
|
|
136
136
|
apiRoutes: [
|
|
137
|
-
registerCopilotKit<
|
|
137
|
+
registerCopilotKit<WeatherRequestContext>({
|
|
138
138
|
path: "/copilotkit",
|
|
139
139
|
resourceId: "weatherAgent",
|
|
140
|
-
setContext: (c,
|
|
141
|
-
|
|
140
|
+
setContext: (c, requestContext) => {
|
|
141
|
+
requestContext.set(
|
|
142
142
|
"user-id",
|
|
143
143
|
c.req.header("X-User-ID") || "anonymous",
|
|
144
144
|
);
|
|
145
|
-
|
|
145
|
+
requestContext.set("temperature-scale", "celsius");
|
|
146
146
|
},
|
|
147
147
|
}),
|
|
148
148
|
],
|
|
@@ -185,21 +185,21 @@ In your Next.js app, install the required packages:
|
|
|
185
185
|
<TabItem value="npm" label="npm">
|
|
186
186
|
|
|
187
187
|
```bash copy
|
|
188
|
-
npm install @copilotkit/react-core @copilotkit/react-ui @copilotkit/runtime @ag-ui/mastra
|
|
188
|
+
npm install @copilotkit/react-core @copilotkit/react-ui @copilotkit/runtime @ag-ui/mastra@beta
|
|
189
189
|
```
|
|
190
190
|
|
|
191
191
|
</TabItem>
|
|
192
192
|
<TabItem value="yarn" label="yarn">
|
|
193
193
|
|
|
194
194
|
```bash copy
|
|
195
|
-
yarn add @copilotkit/react-core @copilotkit/react-ui @copilotkit/runtime @ag-ui/mastra
|
|
195
|
+
yarn add @copilotkit/react-core @copilotkit/react-ui @copilotkit/runtime @ag-ui/mastra@beta
|
|
196
196
|
```
|
|
197
197
|
|
|
198
198
|
</TabItem>
|
|
199
199
|
<TabItem value="pnpm" label="pnpm">
|
|
200
200
|
|
|
201
201
|
```bash copy
|
|
202
|
-
pnpm add @copilotkit/react-core @copilotkit/react-ui @copilotkit/runtime @ag-ui/mastra
|
|
202
|
+
pnpm add @copilotkit/react-core @copilotkit/react-ui @copilotkit/runtime @ag-ui/mastra@beta
|
|
203
203
|
```
|
|
204
204
|
|
|
205
205
|
</TabItem>
|
|
@@ -287,21 +287,21 @@ Install the Mastra Client SDK.
|
|
|
287
287
|
<TabItem value="npm" label="npm">
|
|
288
288
|
|
|
289
289
|
```bash copy
|
|
290
|
-
npm install @mastra/client-js
|
|
290
|
+
npm install @mastra/client-js@beta
|
|
291
291
|
```
|
|
292
292
|
|
|
293
293
|
</TabItem>
|
|
294
294
|
<TabItem value="yarn" label="yarn">
|
|
295
295
|
|
|
296
296
|
```bash copy
|
|
297
|
-
yarn add @mastra/client-js
|
|
297
|
+
yarn add @mastra/client-js@beta
|
|
298
298
|
```
|
|
299
299
|
|
|
300
300
|
</TabItem>
|
|
301
301
|
<TabItem value="pnpm" label="pnpm">
|
|
302
302
|
|
|
303
303
|
```bash copy
|
|
304
|
-
pnpm add @mastra/client-js
|
|
304
|
+
pnpm add @mastra/client-js@beta
|
|
305
305
|
```
|
|
306
306
|
|
|
307
307
|
</TabItem>
|
|
@@ -379,4 +379,4 @@ Start building the future!
|
|
|
379
379
|
|
|
380
380
|
- [CopilotKit Documentation](https://docs.copilotkit.ai) - Complete CopilotKit reference
|
|
381
381
|
- [React Hooks with CopilotKit](https://docs.copilotkit.ai/reference/hooks/useCoAgent) - Advanced React integration patterns
|
|
382
|
-
- [Next.js Integration with Mastra](/docs/frameworks/web-frameworks/next-js) - Full-stack Next.js setup guide
|
|
382
|
+
- [Next.js Integration with Mastra](/docs/v1/frameworks/web-frameworks/next-js) - Full-stack Next.js setup guide
|
|
@@ -17,7 +17,7 @@ Integrate OpenRouter with Mastra to leverage the numerous models available on Op
|
|
|
17
17
|
The simplest way to get started with Mastra is to use the `mastra` CLI to initialize a new project:
|
|
18
18
|
|
|
19
19
|
```bash copy
|
|
20
|
-
npx create-mastra@
|
|
20
|
+
npx create-mastra@beta
|
|
21
21
|
```
|
|
22
22
|
|
|
23
23
|
You'll be guided through prompts to set up your project. For this example, select:
|
|
@@ -65,6 +65,7 @@ const openrouter = createOpenRouter({
|
|
|
65
65
|
});
|
|
66
66
|
|
|
67
67
|
export const assistant = new Agent({
|
|
68
|
+
id: "assistant",
|
|
68
69
|
name: "assistant",
|
|
69
70
|
instructions: "You are a helpful assistant.",
|
|
70
71
|
model: openrouter("anthropic/claude-sonnet-4"),
|
|
@@ -119,6 +120,7 @@ const openrouter = createOpenRouter({
|
|
|
119
120
|
});
|
|
120
121
|
|
|
121
122
|
export const assistant = new Agent({
|
|
123
|
+
id: "assistant",
|
|
122
124
|
name: "assistant",
|
|
123
125
|
instructions: "You are a helpful assistant.",
|
|
124
126
|
model: openrouter("anthropic/claude-sonnet-4"),
|
|
@@ -138,6 +140,7 @@ const openrouter = createOpenRouter({
|
|
|
138
140
|
});
|
|
139
141
|
|
|
140
142
|
export const assistant = new Agent({
|
|
143
|
+
id: "assistant",
|
|
141
144
|
name: "assistant",
|
|
142
145
|
instructions: "You are a helpful assistant.",
|
|
143
146
|
model: openrouter("anthropic/claude-sonnet-4", {
|
|
@@ -18,15 +18,15 @@ In this guide you'll learn how to install the necessary Mastra dependencies, cre
|
|
|
18
18
|
## Prerequisites
|
|
19
19
|
|
|
20
20
|
- An existing Express app set up with TypeScript
|
|
21
|
-
- Node.js `
|
|
22
|
-
- An API key from a supported [Model Provider](/models)
|
|
21
|
+
- Node.js `v22.13.0` or later
|
|
22
|
+
- An API key from a supported [Model Provider](/models/v1)
|
|
23
23
|
|
|
24
24
|
## Adding Mastra
|
|
25
25
|
|
|
26
|
-
First, install the necessary Mastra dependencies to run an Agent. This guide uses OpenAI as its model but you can use any supported [model provider](/models).
|
|
26
|
+
First, install the necessary Mastra dependencies to run an Agent. This guide uses OpenAI as its model but you can use any supported [model provider](/models/v1).
|
|
27
27
|
|
|
28
28
|
```bash copy
|
|
29
|
-
npm install mastra@
|
|
29
|
+
npm install mastra@beta @mastra/core@beta @mastra/libsql@beta zod@^3.0.0 @ai-sdk/openai@^1.0.0
|
|
30
30
|
```
|
|
31
31
|
|
|
32
32
|
If not existent yet, create an `.env` file and add your OpenAI API key:
|
|
@@ -44,7 +44,7 @@ Each LLM provider uses a different env var. See [Model Capabilities](https://sdk
|
|
|
44
44
|
Create a Mastra configuration file at `src/mastra/index.ts`:
|
|
45
45
|
|
|
46
46
|
```ts title="src/mastra/index.ts" copy
|
|
47
|
-
import { Mastra } from "@mastra/core
|
|
47
|
+
import { Mastra } from "@mastra/core";
|
|
48
48
|
|
|
49
49
|
export const mastra = new Mastra({});
|
|
50
50
|
```
|
|
@@ -80,13 +80,14 @@ import { Agent } from "@mastra/core/agent";
|
|
|
80
80
|
import { weatherTool } from "../tools/weather-tool";
|
|
81
81
|
|
|
82
82
|
export const weatherAgent = new Agent({
|
|
83
|
+
id: "weather-agent",
|
|
83
84
|
name: "Weather Agent",
|
|
84
85
|
instructions: `
|
|
85
86
|
You are a helpful weather assistant that provides accurate weather information.
|
|
86
87
|
|
|
87
88
|
Your primary function is to help users get weather details for specific locations. When responding:
|
|
88
89
|
- Always ask for a location if none is provided
|
|
89
|
-
- If the location name isn
|
|
90
|
+
- If the location name isn't in English, please translate it
|
|
90
91
|
- If giving a location with multiple parts (e.g. "New York, NY"), use the most relevant part (e.g. "New York")
|
|
91
92
|
- Include relevant details like humidity, wind conditions, and precipitation
|
|
92
93
|
- Keep responses concise but informative
|
|
@@ -101,7 +102,7 @@ export const weatherAgent = new Agent({
|
|
|
101
102
|
Lastly, add the `weatherAgent` to `src/mastra/index.ts`:
|
|
102
103
|
|
|
103
104
|
```ts title="src/mastra/index.ts" copy {2, 5}
|
|
104
|
-
import { Mastra } from "@mastra/core
|
|
105
|
+
import { Mastra } from "@mastra/core";
|
|
105
106
|
import { weatherAgent } from "./agents/weather-agent";
|
|
106
107
|
|
|
107
108
|
export const mastra = new Mastra({
|
|
@@ -168,11 +169,11 @@ app.listen(port, () => {
|
|
|
168
169
|
});
|
|
169
170
|
```
|
|
170
171
|
|
|
171
|
-
By importing the `src/mastra/index.ts` file you can use methods like [`.getAgent()`](/reference/core/getAgent) to get programmatic access. With [`.generate()`](/reference/agents/generate) you then can interact with the respective agent.
|
|
172
|
+
By importing the `src/mastra/index.ts` file you can use methods like [`.getAgent()`](/reference/v1/core/getAgent) to get programmatic access. With [`.generate()`](/reference/v1/agents/generate) you then can interact with the respective agent.
|
|
172
173
|
|
|
173
174
|
:::note
|
|
174
175
|
|
|
175
|
-
Read the [Agent reference docs](/reference/agents/agent) to learn more.
|
|
176
|
+
Read the [Agent reference docs](/reference/v1/agents/agent) to learn more.
|
|
176
177
|
|
|
177
178
|
:::
|
|
178
179
|
|
|
@@ -190,7 +191,7 @@ The weather in London is currently sunny. If you need more details like humidity
|
|
|
190
191
|
|
|
191
192
|
## Running the Agent Server
|
|
192
193
|
|
|
193
|
-
In production it's not necessary to run Mastra alongside your Express server. But for development Mastra offers a [Local Development Environment](/docs/getting-started/studio) which you can use to improve and debug your agent.
|
|
194
|
+
In production it's not necessary to run Mastra alongside your Express server. But for development Mastra offers a [Local Development Environment](/docs/v1/getting-started/studio) which you can use to improve and debug your agent.
|
|
194
195
|
|
|
195
196
|
Add a script to your `package.json`:
|
|
196
197
|
|
|
@@ -37,28 +37,28 @@ Install the required Mastra packages:
|
|
|
37
37
|
<TabItem value="npm" label="npm">
|
|
38
38
|
|
|
39
39
|
```bash copy
|
|
40
|
-
npm install mastra@
|
|
40
|
+
npm install mastra@beta @mastra/core@beta @mastra/libsql@beta
|
|
41
41
|
```
|
|
42
42
|
|
|
43
43
|
</TabItem>
|
|
44
44
|
<TabItem value="yarn" label="yarn">
|
|
45
45
|
|
|
46
46
|
```bash copy
|
|
47
|
-
yarn add mastra@
|
|
47
|
+
yarn add mastra@beta @mastra/core@beta @mastra/libsql@beta
|
|
48
48
|
```
|
|
49
49
|
|
|
50
50
|
</TabItem>
|
|
51
51
|
<TabItem value="pnpm" label="pnpm">
|
|
52
52
|
|
|
53
53
|
```bash copy
|
|
54
|
-
pnpm add mastra@
|
|
54
|
+
pnpm add mastra@beta @mastra/core@beta @mastra/libsql@beta
|
|
55
55
|
```
|
|
56
56
|
|
|
57
57
|
</TabItem>
|
|
58
58
|
<TabItem value="bun" label="bun">
|
|
59
59
|
|
|
60
60
|
```bash copy
|
|
61
|
-
bun add mastra@
|
|
61
|
+
bun add mastra@beta @mastra/core@beta @mastra/libsql@beta
|
|
62
62
|
```
|
|
63
63
|
|
|
64
64
|
</TabItem>
|
|
@@ -75,17 +75,17 @@ To integrate Mastra into your project, you have two options:
|
|
|
75
75
|
Run the following command to quickly scaffold the default Weather agent with sensible defaults:
|
|
76
76
|
|
|
77
77
|
```bash copy
|
|
78
|
-
npx mastra@
|
|
78
|
+
npx mastra@beta init --default
|
|
79
79
|
```
|
|
80
80
|
|
|
81
|
-
> See [mastra init](/reference/cli/create-mastra) for more information.
|
|
81
|
+
> See [mastra init](/reference/v1/cli/create-mastra) for more information.
|
|
82
82
|
|
|
83
83
|
- Use the Interactive CLI
|
|
84
84
|
|
|
85
85
|
If you prefer to customize the setup, run the `init` command and choose from the options when prompted:
|
|
86
86
|
|
|
87
87
|
```bash copy
|
|
88
|
-
npx mastra@
|
|
88
|
+
npx mastra@beta init
|
|
89
89
|
```
|
|
90
90
|
|
|
91
91
|
Add the `dev` and `build` scripts to `package.json`:
|
|
@@ -175,7 +175,7 @@ mastra dev:mastra
|
|
|
175
175
|
</TabItem>
|
|
176
176
|
</Tabs>
|
|
177
177
|
|
|
178
|
-
> Once running, your agents are available locally. See [Local Development Environment](/docs/getting-started/studio) for more information.
|
|
178
|
+
> Once running, your agents are available locally. See [Local Development Environment](/docs/v1/getting-started/studio) for more information.
|
|
179
179
|
|
|
180
180
|
</StepItem>
|
|
181
181
|
|
|
@@ -215,7 +215,7 @@ export const server = {
|
|
|
215
215
|
city: z.string(),
|
|
216
216
|
}),
|
|
217
217
|
handler: async (input) => {
|
|
218
|
-
const city =
|
|
218
|
+
const city = inputData.city;
|
|
219
219
|
const agent = mastra.getAgent("weatherAgent");
|
|
220
220
|
|
|
221
221
|
const result = await agent.generate(
|
|
@@ -330,28 +330,28 @@ Install the required Mastra packages:
|
|
|
330
330
|
<TabItem value="npm" label="npm">
|
|
331
331
|
|
|
332
332
|
```bash copy
|
|
333
|
-
npm install mastra@
|
|
333
|
+
npm install mastra@beta @mastra/core@beta @mastra/libsql@beta
|
|
334
334
|
```
|
|
335
335
|
|
|
336
336
|
</TabItem>
|
|
337
337
|
<TabItem value="yarn" label="yarn">
|
|
338
338
|
|
|
339
339
|
```bash copy
|
|
340
|
-
yarn add mastra@
|
|
340
|
+
yarn add mastra@beta @mastra/core@beta @mastra/libsql@beta
|
|
341
341
|
```
|
|
342
342
|
|
|
343
343
|
</TabItem>
|
|
344
344
|
<TabItem value="pnpm" label="pnpm">
|
|
345
345
|
|
|
346
346
|
```bash copy
|
|
347
|
-
pnpm add mastra@
|
|
347
|
+
pnpm add mastra@beta @mastra/core@beta @mastra/libsql@beta
|
|
348
348
|
```
|
|
349
349
|
|
|
350
350
|
</TabItem>
|
|
351
351
|
<TabItem value="bun" label="bun">
|
|
352
352
|
|
|
353
353
|
```bash copy
|
|
354
|
-
bun add mastra@
|
|
354
|
+
bun add mastra@beta @mastra/core@beta @mastra/libsql@beta
|
|
355
355
|
```
|
|
356
356
|
|
|
357
357
|
</TabItem>
|
|
@@ -368,17 +368,17 @@ To integrate Mastra into your project, you have two options:
|
|
|
368
368
|
Run the following command to quickly scaffold the default Weather agent with sensible defaults:
|
|
369
369
|
|
|
370
370
|
```bash copy
|
|
371
|
-
npx mastra@
|
|
371
|
+
npx mastra@beta init --default
|
|
372
372
|
```
|
|
373
373
|
|
|
374
|
-
> See [mastra init](/reference/cli/create-mastra) for more information.
|
|
374
|
+
> See [mastra init](/reference/v1/cli/create-mastra) for more information.
|
|
375
375
|
|
|
376
376
|
- Use the Interactive CLI
|
|
377
377
|
|
|
378
378
|
If you prefer to customize the setup, run the `init` command and choose from the options when prompted:
|
|
379
379
|
|
|
380
380
|
```bash copy
|
|
381
|
-
npx mastra@
|
|
381
|
+
npx mastra@beta init
|
|
382
382
|
```
|
|
383
383
|
|
|
384
384
|
Add the `dev` and `build` scripts to `package.json`:
|
|
@@ -468,7 +468,7 @@ mastra dev:mastra
|
|
|
468
468
|
</TabItem>
|
|
469
469
|
</Tabs>
|
|
470
470
|
|
|
471
|
-
> Once running, your agents are available locally. See [Local Development Environment](/docs/getting-started/studio) for more information.
|
|
471
|
+
> Once running, your agents are available locally. See [Local Development Environment](/docs/v1/getting-started/studio) for more information.
|
|
472
472
|
|
|
473
473
|
</StepItem>
|
|
474
474
|
|
|
@@ -598,5 +598,5 @@ Let me know if you need more information!
|
|
|
598
598
|
|
|
599
599
|
## Next Steps
|
|
600
600
|
|
|
601
|
-
- [Deployment | With Astro on Vercel](/docs/deployment/web-framework#with-astro-on-vercel)
|
|
601
|
+
- [Deployment | With Astro on Vercel](/docs/v1/deployment/web-framework#with-astro-on-vercel)
|
|
602
602
|
- [Monorepo Deployment](../../deployment/monorepo)
|
|
@@ -38,17 +38,17 @@ To integrate Mastra into your project, you have two options:
|
|
|
38
38
|
Run the following command to quickly scaffold the default Weather agent with sensible defaults:
|
|
39
39
|
|
|
40
40
|
```bash copy
|
|
41
|
-
npx mastra@
|
|
41
|
+
npx mastra@beta init --dir . --components agents,tools --example --llm openai
|
|
42
42
|
```
|
|
43
43
|
|
|
44
|
-
> See [mastra init](/reference/cli/create-mastra) for more information.
|
|
44
|
+
> See [mastra init](/reference/v1/cli/create-mastra) for more information.
|
|
45
45
|
|
|
46
46
|
- Use the Interactive CLI
|
|
47
47
|
|
|
48
48
|
If you prefer to customize the setup, run the `init` command and choose from the options when prompted:
|
|
49
49
|
|
|
50
50
|
```bash copy
|
|
51
|
-
npx mastra@
|
|
51
|
+
npx mastra@beta init
|
|
52
52
|
```
|
|
53
53
|
|
|
54
54
|
:::warning
|
|
@@ -225,17 +225,17 @@ To integrate Mastra into your project, you have two options:
|
|
|
225
225
|
Run the following command to quickly scaffold the default Weather agent with sensible defaults:
|
|
226
226
|
|
|
227
227
|
```bash copy
|
|
228
|
-
npx mastra@
|
|
228
|
+
npx mastra@beta init --dir . --components agents,tools --example --llm openai
|
|
229
229
|
```
|
|
230
230
|
|
|
231
|
-
> See [mastra init](/reference/cli/create-mastra) for more information.
|
|
231
|
+
> See [mastra init](/reference/v1/cli/create-mastra) for more information.
|
|
232
232
|
|
|
233
233
|
- Use the Interactive CLI
|
|
234
234
|
|
|
235
235
|
If you prefer to customize the setup, run the `init` command and choose from the options when prompted:
|
|
236
236
|
|
|
237
237
|
```bash copy
|
|
238
|
-
npx mastra@
|
|
238
|
+
npx mastra@beta init
|
|
239
239
|
```
|
|
240
240
|
|
|
241
241
|
:::warning
|
|
@@ -375,5 +375,5 @@ Let me know if you need more information!
|
|
|
375
375
|
|
|
376
376
|
## Next Steps
|
|
377
377
|
|
|
378
|
-
- [Deployment | With Next.js on Vercel](/docs/deployment/web-framework#with-nextjs-on-vercel)
|
|
378
|
+
- [Deployment | With Next.js on Vercel](/docs/v1/deployment/web-framework#with-nextjs-on-vercel)
|
|
379
379
|
- [Monorepo Deployment](../../deployment/monorepo)
|
|
@@ -32,22 +32,22 @@ Install the required Mastra packages:
|
|
|
32
32
|
<Tabs>
|
|
33
33
|
<TabItem value="npm" label="npm">
|
|
34
34
|
```bash copy
|
|
35
|
-
npm install mastra@
|
|
35
|
+
npm install mastra@beta @mastra/core@beta @mastra/libsql@beta
|
|
36
36
|
```
|
|
37
37
|
</TabItem>
|
|
38
38
|
<TabItem value="yarn" label="yarn">
|
|
39
39
|
```bash copy
|
|
40
|
-
yarn add mastra@
|
|
40
|
+
yarn add mastra@beta @mastra/core@beta @mastra/libsql@beta
|
|
41
41
|
```
|
|
42
42
|
</TabItem>
|
|
43
43
|
<TabItem value="pnpm" label="pnpm">
|
|
44
44
|
```bash copy
|
|
45
|
-
pnpm add mastra@
|
|
45
|
+
pnpm add mastra@beta @mastra/core@beta @mastra/libsql@beta
|
|
46
46
|
```
|
|
47
47
|
</TabItem>
|
|
48
48
|
<TabItem value="bun" label="bun">
|
|
49
49
|
```bash copy
|
|
50
|
-
bun add mastra@
|
|
50
|
+
bun add mastra@beta @mastra/core@beta @mastra/libsql@beta
|
|
51
51
|
```
|
|
52
52
|
</TabItem>
|
|
53
53
|
</Tabs>
|
|
@@ -63,17 +63,17 @@ To integrate Mastra into your project, you have two options:
|
|
|
63
63
|
Run the following command to quickly scaffold the default Weather agent with sensible defaults:
|
|
64
64
|
|
|
65
65
|
```bash copy
|
|
66
|
-
npx mastra@
|
|
66
|
+
npx mastra@beta init --default
|
|
67
67
|
```
|
|
68
68
|
|
|
69
|
-
> See [mastra init](/reference/cli/create-mastra) for more information.
|
|
69
|
+
> See [mastra init](/reference/v1/cli/create-mastra) for more information.
|
|
70
70
|
|
|
71
71
|
- Use the Interactive CLI
|
|
72
72
|
|
|
73
73
|
If you prefer to customize the setup, run the `init` command and choose from the options when prompted:
|
|
74
74
|
|
|
75
75
|
```bash copy
|
|
76
|
-
npx mastra@
|
|
76
|
+
npx mastra@beta init
|
|
77
77
|
```
|
|
78
78
|
|
|
79
79
|
Add the `dev` and `build` scripts to `package.json`:
|
|
@@ -161,7 +161,7 @@ Start the Mastra Dev Server to expose your agents as REST endpoints:
|
|
|
161
161
|
</TabItem>
|
|
162
162
|
</Tabs>
|
|
163
163
|
|
|
164
|
-
> Once running, your agents are available locally. See [Local Development Environment](/docs/getting-started/studio) for more information.
|
|
164
|
+
> Once running, your agents are available locally. See [Local Development Environment](/docs/v1/getting-started/studio) for more information.
|
|
165
165
|
|
|
166
166
|
</StepItem>
|
|
167
167
|
|
|
@@ -263,22 +263,22 @@ Install the required Mastra packages:
|
|
|
263
263
|
<Tabs>
|
|
264
264
|
<TabItem value="npm" label="npm">
|
|
265
265
|
```bash copy
|
|
266
|
-
npm install mastra@
|
|
266
|
+
npm install mastra@beta @mastra/core@beta @mastra/libsql@beta
|
|
267
267
|
```
|
|
268
268
|
</TabItem>
|
|
269
269
|
<TabItem value="yarn" label="yarn">
|
|
270
270
|
```bash copy
|
|
271
|
-
yarn add mastra@
|
|
271
|
+
yarn add mastra@beta @mastra/core@beta @mastra/libsql@beta
|
|
272
272
|
```
|
|
273
273
|
</TabItem>
|
|
274
274
|
<TabItem value="pnpm" label="pnpm">
|
|
275
275
|
```bash copy
|
|
276
|
-
pnpm add mastra@
|
|
276
|
+
pnpm add mastra@beta @mastra/core@beta @mastra/libsql@beta
|
|
277
277
|
```
|
|
278
278
|
</TabItem>
|
|
279
279
|
<TabItem value="bun" label="bun">
|
|
280
280
|
```bash copy
|
|
281
|
-
bun add mastra@
|
|
281
|
+
bun add mastra@beta @mastra/core@beta @mastra/libsql@beta
|
|
282
282
|
```
|
|
283
283
|
</TabItem>
|
|
284
284
|
</Tabs>
|
|
@@ -294,17 +294,17 @@ To integrate Mastra into your project, you have two options:
|
|
|
294
294
|
Run the following command to quickly scaffold the default Weather agent with sensible defaults:
|
|
295
295
|
|
|
296
296
|
```bash copy
|
|
297
|
-
npx mastra@
|
|
297
|
+
npx mastra@beta init --default
|
|
298
298
|
```
|
|
299
299
|
|
|
300
|
-
> See [mastra init](/reference/cli/create-mastra) for more information.
|
|
300
|
+
> See [mastra init](/reference/v1/cli/create-mastra) for more information.
|
|
301
301
|
|
|
302
302
|
- Use the Interactive CLI
|
|
303
303
|
|
|
304
304
|
If you prefer to customize the setup, run the `init` command and choose from the options when prompted:
|
|
305
305
|
|
|
306
306
|
```bash copy
|
|
307
|
-
npx mastra@
|
|
307
|
+
npx mastra@beta init
|
|
308
308
|
```
|
|
309
309
|
|
|
310
310
|
Add the `dev` and `build` scripts to `package.json`:
|
|
@@ -392,7 +392,7 @@ Start the Mastra Dev Server to expose your agents as REST endpoints:
|
|
|
392
392
|
</TabItem>
|
|
393
393
|
</Tabs>
|
|
394
394
|
|
|
395
|
-
> Once running, your agents are available locally. See [Local Development Environment](/docs/getting-started/studio) for more information.
|
|
395
|
+
> Once running, your agents are available locally. See [Local Development Environment](/docs/v1/getting-started/studio) for more information.
|
|
396
396
|
|
|
397
397
|
</StepItem>
|
|
398
398
|
|
|
@@ -30,28 +30,28 @@ Install the required Mastra packages:
|
|
|
30
30
|
<TabItem value="npm" label="npm">
|
|
31
31
|
|
|
32
32
|
```bash copy
|
|
33
|
-
npm install mastra@
|
|
33
|
+
npm install mastra@beta @mastra/core@beta @mastra/libsql@beta @mastra/client-js@beta
|
|
34
34
|
```
|
|
35
35
|
|
|
36
36
|
</TabItem>
|
|
37
37
|
<TabItem value="yarn" label="yarn">
|
|
38
38
|
|
|
39
39
|
```bash copy
|
|
40
|
-
yarn add mastra@
|
|
40
|
+
yarn add mastra@beta @mastra/core@beta @mastra/libsql@beta @mastra/client-js@beta
|
|
41
41
|
```
|
|
42
42
|
|
|
43
43
|
</TabItem>
|
|
44
44
|
<TabItem value="pnpm" label="pnpm">
|
|
45
45
|
|
|
46
46
|
```bash copy
|
|
47
|
-
pnpm add mastra@
|
|
47
|
+
pnpm add mastra@beta @mastra/core@beta @mastra/libsql@beta @mastra/client-js@beta
|
|
48
48
|
```
|
|
49
49
|
|
|
50
50
|
</TabItem>
|
|
51
51
|
<TabItem value="bun" label="bun">
|
|
52
52
|
|
|
53
53
|
```bash copy
|
|
54
|
-
bun add mastra@
|
|
54
|
+
bun add mastra@beta @mastra/core@beta @mastra/libsql@beta @mastra/client-js@beta
|
|
55
55
|
```
|
|
56
56
|
|
|
57
57
|
</TabItem>
|
|
@@ -66,10 +66,10 @@ To integrate Mastra into your project, you have two options:
|
|
|
66
66
|
Run the following command to quickly scaffold the default Weather agent with sensible defaults:
|
|
67
67
|
|
|
68
68
|
```bash copy
|
|
69
|
-
npx mastra@
|
|
69
|
+
npx mastra@beta init --dir . --components agents,tools --example --llm openai
|
|
70
70
|
```
|
|
71
71
|
|
|
72
|
-
> See [mastra init](/reference/cli/create-mastra) for more information.
|
|
72
|
+
> See [mastra init](/reference/v1/cli/create-mastra) for more information.
|
|
73
73
|
|
|
74
74
|
### 2. Use the Interactive CLI
|
|
75
75
|
|
|
@@ -164,7 +164,7 @@ mastra dev:mastra
|
|
|
164
164
|
</TabItem>
|
|
165
165
|
</Tabs>
|
|
166
166
|
|
|
167
|
-
> Once running, your agents are available locally. See [Local Development Environment](/docs/getting-started/studio) for more information.
|
|
167
|
+
> Once running, your agents are available locally. See [Local Development Environment](/docs/v1/getting-started/studio) for more information.
|
|
168
168
|
|
|
169
169
|
## Start Vite Dev Server
|
|
170
170
|
|