@mastra/mcp-docs-server 1.0.0-beta.0 → 1.0.0-beta.2

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.
Files changed (133) hide show
  1. package/.docs/organized/changelogs/%40mastra%2Fai-sdk.md +10 -10
  2. package/.docs/organized/changelogs/%40mastra%2Fclient-js.md +17 -17
  3. package/.docs/organized/changelogs/%40mastra%2Fcodemod.md +8 -0
  4. package/.docs/organized/changelogs/%40mastra%2Fcore.md +18 -18
  5. package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloud.md +19 -19
  6. package/.docs/organized/changelogs/%40mastra%2Fdeployer.md +19 -19
  7. package/.docs/organized/changelogs/%40mastra%2Fmcp-docs-server.md +18 -18
  8. package/.docs/organized/changelogs/%40mastra%2Fmcp.md +12 -12
  9. package/.docs/organized/changelogs/%40mastra%2Fmssql.md +16 -16
  10. package/.docs/organized/changelogs/%40mastra%2Fplayground-ui.md +32 -32
  11. package/.docs/organized/changelogs/%40mastra%2Freact.md +15 -15
  12. package/.docs/organized/changelogs/%40mastra%2Fserver.md +15 -15
  13. package/.docs/organized/changelogs/create-mastra.md +7 -7
  14. package/.docs/organized/changelogs/mastra.md +13 -13
  15. package/.docs/raw/agents/agent-memory.mdx +1 -1
  16. package/.docs/raw/agents/overview.mdx +2 -2
  17. package/.docs/raw/auth/auth0.mdx +1 -1
  18. package/.docs/raw/auth/clerk.mdx +1 -1
  19. package/.docs/raw/auth/firebase.mdx +1 -1
  20. package/.docs/raw/auth/jwt.mdx +1 -1
  21. package/.docs/raw/auth/supabase.mdx +1 -1
  22. package/.docs/raw/auth/workos.mdx +1 -1
  23. package/.docs/raw/course/01-first-agent/03-verifying-installation.md +1 -1
  24. package/.docs/raw/course/02-agent-tools-mcp/02-installing-mcp.md +1 -1
  25. package/.docs/raw/course/03-agent-memory/03-installing-memory.md +1 -1
  26. package/.docs/raw/deployment/cloud-providers/amazon-ec2.mdx +1 -1
  27. package/.docs/raw/deployment/cloud-providers/aws-lambda.mdx +1 -1
  28. package/.docs/raw/deployment/cloud-providers/azure-app-services.mdx +2 -2
  29. package/.docs/raw/deployment/cloud-providers/digital-ocean.mdx +1 -1
  30. package/.docs/raw/deployment/serverless-platforms/cloudflare-deployer.mdx +1 -1
  31. package/.docs/raw/deployment/serverless-platforms/netlify-deployer.mdx +1 -1
  32. package/.docs/raw/deployment/serverless-platforms/vercel-deployer.mdx +1 -1
  33. package/.docs/raw/evals/overview.mdx +1 -1
  34. package/.docs/raw/frameworks/agentic-uis/ai-sdk.mdx +8 -4
  35. package/.docs/raw/frameworks/agentic-uis/assistant-ui.mdx +1 -1
  36. package/.docs/raw/frameworks/agentic-uis/copilotkit.mdx +9 -9
  37. package/.docs/raw/frameworks/agentic-uis/openrouter.mdx +1 -1
  38. package/.docs/raw/frameworks/servers/express.mdx +1 -1
  39. package/.docs/raw/frameworks/web-frameworks/astro.mdx +12 -12
  40. package/.docs/raw/frameworks/web-frameworks/next-js.mdx +4 -4
  41. package/.docs/raw/frameworks/web-frameworks/sveltekit.mdx +12 -12
  42. package/.docs/raw/frameworks/web-frameworks/vite-react.mdx +5 -5
  43. package/.docs/raw/getting-started/installation.mdx +13 -13
  44. package/.docs/raw/getting-started/templates.mdx +5 -5
  45. package/.docs/raw/guides/guide/notes-mcp-server.mdx +1 -1
  46. package/.docs/raw/guides/guide/research-assistant.mdx +1 -10
  47. package/.docs/raw/guides/migrations/upgrade-to-v1/agent.mdx +16 -6
  48. package/.docs/raw/guides/migrations/upgrade-to-v1/client.mdx +42 -2
  49. package/.docs/raw/guides/migrations/upgrade-to-v1/evals.mdx +31 -1
  50. package/.docs/raw/guides/migrations/upgrade-to-v1/mastra.mdx +28 -4
  51. package/.docs/raw/guides/migrations/upgrade-to-v1/mcp.mdx +3 -3
  52. package/.docs/raw/guides/migrations/upgrade-to-v1/memory.mdx +28 -0
  53. package/.docs/raw/guides/migrations/upgrade-to-v1/overview.mdx +50 -36
  54. package/.docs/raw/guides/migrations/upgrade-to-v1/storage.mdx +80 -0
  55. package/.docs/raw/guides/migrations/upgrade-to-v1/tools.mdx +2 -2
  56. package/.docs/raw/guides/migrations/upgrade-to-v1/tracing.mdx +13 -13
  57. package/.docs/raw/guides/migrations/upgrade-to-v1/vectors.mdx +25 -1
  58. package/.docs/raw/guides/migrations/upgrade-to-v1/voice.mdx +1 -1
  59. package/.docs/raw/guides/migrations/upgrade-to-v1/workflows.mdx +32 -2
  60. package/.docs/raw/guides/quickstarts/nextjs.mdx +275 -0
  61. package/.docs/raw/index.mdx +1 -1
  62. package/.docs/raw/logging.mdx +3 -3
  63. package/.docs/raw/mastra-cloud/observability.mdx +6 -6
  64. package/.docs/raw/memory/overview.mdx +2 -2
  65. package/.docs/raw/memory/semantic-recall.mdx +2 -2
  66. package/.docs/raw/memory/storage/memory-with-libsql.mdx +2 -2
  67. package/.docs/raw/memory/storage/memory-with-mongodb.mdx +152 -0
  68. package/.docs/raw/memory/storage/memory-with-pg.mdx +2 -2
  69. package/.docs/raw/memory/storage/memory-with-upstash.mdx +2 -2
  70. package/.docs/raw/observability/overview.mdx +5 -5
  71. package/.docs/raw/observability/tracing/exporters/arize.mdx +2 -2
  72. package/.docs/raw/observability/tracing/exporters/braintrust.mdx +2 -2
  73. package/.docs/raw/observability/tracing/exporters/cloud.mdx +2 -2
  74. package/.docs/raw/observability/tracing/exporters/default.mdx +5 -5
  75. package/.docs/raw/observability/tracing/exporters/langfuse.mdx +2 -2
  76. package/.docs/raw/observability/tracing/exporters/langsmith.mdx +2 -2
  77. package/.docs/raw/observability/tracing/exporters/otel.mdx +5 -5
  78. package/.docs/raw/observability/tracing/overview.mdx +21 -21
  79. package/.docs/raw/observability/tracing/processors/sensitive-data-filter.mdx +2 -2
  80. package/.docs/raw/rag/overview.mdx +1 -1
  81. package/.docs/raw/reference/agents/agent.mdx +2 -2
  82. package/.docs/raw/reference/cli/create-mastra.mdx +10 -10
  83. package/.docs/raw/reference/cli/mastra.mdx +7 -7
  84. package/.docs/raw/reference/core/getLogger.mdx +2 -2
  85. package/.docs/raw/reference/core/getMCPServer.mdx +2 -2
  86. package/.docs/raw/reference/core/getMCPServerById.mdx +4 -4
  87. package/.docs/raw/reference/core/getTelemetry.mdx +2 -2
  88. package/.docs/raw/reference/core/listLogs.mdx +2 -2
  89. package/.docs/raw/reference/core/listLogsByRunId.mdx +2 -2
  90. package/.docs/raw/reference/core/listMCPServers.mdx +4 -4
  91. package/.docs/raw/reference/core/setLogger.mdx +2 -2
  92. package/.docs/raw/reference/core/setTelemetry.mdx +2 -2
  93. package/.docs/raw/reference/evals/create-scorer.mdx +58 -49
  94. package/.docs/raw/reference/evals/mastra-scorer.mdx +2 -0
  95. package/.docs/raw/reference/observability/tracing/configuration.mdx +12 -12
  96. package/.docs/raw/reference/observability/tracing/exporters/arize.mdx +1 -1
  97. package/.docs/raw/reference/observability/tracing/exporters/cloud-exporter.mdx +8 -8
  98. package/.docs/raw/reference/observability/tracing/exporters/console-exporter.mdx +8 -8
  99. package/.docs/raw/reference/observability/tracing/exporters/default-exporter.mdx +8 -8
  100. package/.docs/raw/reference/observability/tracing/instances.mdx +8 -8
  101. package/.docs/raw/reference/observability/tracing/interfaces.mdx +7 -7
  102. package/.docs/raw/reference/observability/tracing/spans.mdx +7 -7
  103. package/.docs/raw/reference/processors/batch-parts-processor.mdx +8 -2
  104. package/.docs/raw/reference/processors/language-detector.mdx +8 -2
  105. package/.docs/raw/reference/processors/moderation-processor.mdx +8 -2
  106. package/.docs/raw/reference/processors/pii-detector.mdx +8 -2
  107. package/.docs/raw/reference/processors/prompt-injection-detector.mdx +8 -2
  108. package/.docs/raw/reference/processors/system-prompt-scrubber.mdx +8 -2
  109. package/.docs/raw/reference/processors/token-limiter-processor.mdx +8 -2
  110. package/.docs/raw/reference/processors/unicode-normalizer.mdx +8 -2
  111. package/.docs/raw/reference/storage/cloudflare-d1.mdx +1 -1
  112. package/.docs/raw/reference/storage/cloudflare.mdx +1 -1
  113. package/.docs/raw/reference/storage/dynamodb.mdx +3 -3
  114. package/.docs/raw/reference/storage/lance.mdx +1 -1
  115. package/.docs/raw/reference/storage/libsql.mdx +1 -1
  116. package/.docs/raw/reference/storage/mongodb.mdx +1 -1
  117. package/.docs/raw/reference/storage/mssql.mdx +1 -1
  118. package/.docs/raw/reference/storage/postgresql.mdx +1 -1
  119. package/.docs/raw/reference/storage/upstash.mdx +1 -1
  120. package/.docs/raw/reference/templates/overview.mdx +1 -1
  121. package/.docs/raw/reference/tools/mcp-server.mdx +49 -0
  122. package/.docs/raw/reference/vectors/couchbase.mdx +8 -2
  123. package/.docs/raw/reference/vectors/libsql.mdx +1 -1
  124. package/.docs/raw/reference/vectors/mongodb.mdx +7 -1
  125. package/.docs/raw/reference/vectors/s3vectors.mdx +1 -1
  126. package/.docs/raw/server-db/mastra-client.mdx +4 -4
  127. package/.docs/raw/tools-mcp/mcp-overview.mdx +1 -1
  128. package/.docs/raw/voice/speech-to-text.mdx +1 -1
  129. package/.docs/raw/voice/text-to-speech.mdx +1 -1
  130. package/.docs/raw/workflows/inngest-workflow.mdx +1 -1
  131. package/CHANGELOG.md +17 -0
  132. package/dist/stdio.js +11 -15
  133. package/package.json +4 -4
@@ -0,0 +1,152 @@
1
+ ---
2
+ title: "Example: Memory with MongoDB | Memory | Mastra Docs"
3
+ description: Example for how to use Mastra's memory system with MongoDB storage and vector capabilities.
4
+ ---
5
+
6
+ # Memory with MongoDB
7
+
8
+ This example demonstrates how to use Mastra's memory system with MongoDB as the storage backend.
9
+
10
+ ## Prerequisites
11
+
12
+ This example uses the `openai` model and requires a MongoDB database. Make sure to add the following to your `.env` file:
13
+
14
+ ```bash title=".env" copy
15
+ OPENAI_API_KEY=<your-api-key>
16
+ MONGODB_URI=<your-connection-string>
17
+ MONGODB_DB_NAME=<your-db-name>
18
+ ```
19
+
20
+ And install the following package:
21
+
22
+ ```bash copy
23
+ npm install @mastra/mongodb@beta
24
+ ```
25
+
26
+ ## Adding memory to an agent
27
+
28
+ To add MongoDB memory to an agent use the `Memory` class and create a new `storage` key using `MongoDBStore`. The configuration supports both local and remote MongoDB instances.
29
+
30
+ ```typescript title="src/mastra/agents/example-mongodb-agent.ts" showLineNumbers copy
31
+ import { Memory } from "@mastra/memory";
32
+ import { Agent } from "@mastra/core/agent";
33
+ import { openai } from "@ai-sdk/openai";
34
+ import { MongoDBStore } from "@mastra/mongodb";
35
+
36
+ export const mongodbAgent = new Agent({
37
+ id: "mongodb-agent",
38
+ name: "mongodb-agent",
39
+ instructions:
40
+ "You are an AI agent with the ability to automatically recall memories from previous interactions.",
41
+ model: openai("gpt-4o"),
42
+ memory: new Memory({
43
+ storage: new MongoDBStore({
44
+ url: process.env.MONGODB_URI!,
45
+ dbName: process.env.MONGODB_DB_NAME!,
46
+ }),
47
+ options: {
48
+ threads: {
49
+ generateTitle: true,
50
+ },
51
+ },
52
+ }),
53
+ });
54
+ ```
55
+
56
+ ## Vector embeddings with MongoDB
57
+
58
+ Embeddings are numeric vectors used by memory's `semanticRecall` to retrieve related messages by meaning (not keywords).
59
+
60
+ > Note: You must use a deployment hosted on MongoDB Atlas to successfully use the MongoDB Vector database.
61
+
62
+ This setup uses FastEmbed, a local embedding model, to generate vector embeddings.
63
+ To use this, install `@mastra/fastembed`:
64
+
65
+ ```bash copy
66
+ npm install @mastra/fastembed@beta
67
+ ```
68
+
69
+ Add the following to your agent:
70
+
71
+ ```typescript title="src/mastra/agents/example-mongodb-agent.ts" showLineNumbers copy
72
+ import { Memory } from "@mastra/memory";
73
+ import { Agent } from "@mastra/core/agent";
74
+ import { openai } from "@ai-sdk/openai";
75
+ import { MongoDBStore, MongoDBVector } from "@mastra/mongodb";
76
+ import { fastembed } from "@mastra/fastembed";
77
+
78
+ export const mongodbAgent = new Agent({
79
+ id: "mongodb-agent",
80
+ name: "mongodb-agent",
81
+ instructions:
82
+ "You are an AI agent with the ability to automatically recall memories from previous interactions.",
83
+ model: openai("gpt-4o"),
84
+ memory: new Memory({
85
+ storage: new MongoDBStore({
86
+ url: process.env.MONGODB_URI!,
87
+ dbName: process.env.MONGODB_DB_NAME!,
88
+ }),
89
+ vector: new MongoDBVector({
90
+ uri: process.env.MONGODB_URI!,
91
+ dbName: process.env.MONGODB_DB_NAME!,
92
+ }),
93
+ embedder: fastembed,
94
+ options: {
95
+ lastMessages: 10,
96
+ semanticRecall: {
97
+ topK: 3,
98
+ messageRange: 2,
99
+ },
100
+ threads: {
101
+ generateTitle: true, // generates descriptive thread titles automatically
102
+ },
103
+ },
104
+ }),
105
+ });
106
+ ```
107
+
108
+ ## Usage example
109
+
110
+ Use `memoryOptions` to scope recall for this request. Set `lastMessages: 5` to limit recency-based recall, and use `semanticRecall` to fetch the `topK: 3` most relevant messages, including `messageRange: 2` neighboring messages for context around each match.
111
+
112
+ ```typescript title="src/test-mongodb-agent.ts" showLineNumbers copy
113
+ import "dotenv/config";
114
+
115
+ import { mastra } from "./mastra";
116
+
117
+ const threadId = "123";
118
+ const resourceId = "user-456";
119
+
120
+ const agent = mastra.getAgent("mongodbAgent");
121
+
122
+ const message = await agent.stream("My name is Mastra", {
123
+ memory: {
124
+ thread: threadId,
125
+ resource: resourceId,
126
+ },
127
+ });
128
+
129
+ await message.textStream.pipeTo(new WritableStream());
130
+
131
+ const stream = await agent.stream("What's my name?", {
132
+ memory: {
133
+ thread: threadId,
134
+ resource: resourceId,
135
+ },
136
+ memoryOptions: {
137
+ lastMessages: 5,
138
+ semanticRecall: {
139
+ topK: 3,
140
+ messageRange: 2,
141
+ },
142
+ },
143
+ });
144
+
145
+ for await (const chunk of stream.textStream) {
146
+ process.stdout.write(chunk);
147
+ }
148
+ ```
149
+
150
+ ## Related
151
+
152
+ - [Calling Agents](/docs/v1/agents/overview)
@@ -19,7 +19,7 @@ DATABASE_URL=<your-connection-string>
19
19
  And install the following package:
20
20
 
21
21
  ```bash copy
22
- npm install @mastra/pg
22
+ npm install @mastra/pg@beta
23
23
  ```
24
24
 
25
25
  ## Adding memory to an agent
@@ -57,7 +57,7 @@ Embeddings are numeric vectors used by memory’s `semanticRecall` to retrieve r
57
57
  Install `fastembed` to get started:
58
58
 
59
59
  ```bash copy
60
- npm install @mastra/fastembed
60
+ npm install @mastra/fastembed@beta
61
61
  ```
62
62
 
63
63
  Add the following to your agent:
@@ -24,7 +24,7 @@ You can get your Upstash credentials by signing up at [upstash.com](https://upst
24
24
  And install the following package:
25
25
 
26
26
  ```bash copy
27
- npm install @mastra/upstash
27
+ npm install @mastra/upstash@beta
28
28
  ```
29
29
 
30
30
  ## Adding memory to an agent
@@ -63,7 +63,7 @@ Embeddings are numeric vectors used by memory’s `semanticRecall` to retrieve r
63
63
  Install `fastembed` to get started:
64
64
 
65
65
  ```bash copy
66
- npm install @mastra/fastembed
66
+ npm install @mastra/fastembed@beta
67
67
  ```
68
68
 
69
69
  Add the following to your agent:
@@ -43,11 +43,11 @@ export const mastra = new Mastra({
43
43
 
44
44
  With this basic setup, you will see Traces and Logs in both Studio and in Mastra Cloud.
45
45
 
46
- We also support various external tracing providers like Langfuse, Braintrust, and any OpenTelemetry-compatible platform (Datadog, New Relic, SigNoz, etc.). See more about this in the [Tracing]/docs/v1/observability/tracing/overview) documentation.
46
+ We also support various external tracing providers like Langfuse, Braintrust, and any OpenTelemetry-compatible platform (Datadog, New Relic, SigNoz, etc.). See more about this in the [Tracing](/docs/v1/observability/tracing/overview) documentation.
47
47
 
48
48
  ## What's Next?
49
49
 
50
- - **[Set up Tracing]/docs/v1/observability/tracing/overview)**: Configure tracing for your application
51
- - **[Configure Logging]/docs/v1/logging)**: Add structured logging
52
- - **[View Examples]/examples/v1/observability/basic-tracing)**: See observability in action
53
- - **[API Reference]/reference/v1/observability/tracing/instances)**: Detailed configuration options
50
+ - **[Set up Tracing](/docs/v1/observability/tracing/overview)**: Configure tracing for your application
51
+ - **[Configure Logging](/docs/v1/logging)**: Add structured logging
52
+ - **[View Examples](/examples/v1/observability/basic-tracing)**: See observability in action
53
+ - **[API Reference](/reference/v1/observability/tracing/instances)**: Detailed configuration options
@@ -10,7 +10,7 @@ description: "Send traces to Arize Phoenix or Arize AX using OpenTelemetry and O
10
10
  ## Installation
11
11
 
12
12
  ```bash npm2yarn
13
- npm install @mastra/arize
13
+ npm install @mastra/arize@beta
14
14
  ```
15
15
 
16
16
  ## Configuration
@@ -188,7 +188,7 @@ This exporter implements the [OpenInference Semantic Conventions](https://github
188
188
 
189
189
  ## Related
190
190
 
191
- - [Tracing Overview]/docs/v1/observability/tracing/overview)
191
+ - [Tracing Overview](/docs/v1/observability/tracing/overview)
192
192
  - [Phoenix Documentation](https://docs.arize.com/phoenix)
193
193
  - [Arize AX Documentation](https://docs.arize.com/)
194
194
  - [OpenInference Specification](https://github.com/Arize-ai/openinference/tree/main/spec)
@@ -10,7 +10,7 @@ description: "Send traces to Braintrust for evaluation and monitoring"
10
10
  ## Installation
11
11
 
12
12
  ```bash npm2yarn
13
- npm install @mastra/braintrust
13
+ npm install @mastra/braintrust@beta
14
14
  ```
15
15
 
16
16
  ## Configuration
@@ -67,5 +67,5 @@ new BraintrustExporter({
67
67
 
68
68
  ## Related
69
69
 
70
- - [Tracing Overview]/docs/v1/observability/tracing/overview)
70
+ - [Tracing Overview](/docs/v1/observability/tracing/overview)
71
71
  - [Braintrust Documentation](https://www.braintrust.dev/docs)
@@ -110,6 +110,6 @@ CloudExporter uses intelligent batching to optimize network usage. Traces are bu
110
110
 
111
111
  ## Related
112
112
 
113
- - [Tracing Overview]/docs/v1/observability/tracing/overview)
114
- - [DefaultExporter]/docs/v1/observability/tracing/exporters/default)
113
+ - [Tracing Overview](/docs/v1/observability/tracing/overview)
114
+ - [DefaultExporter](/docs/v1/observability/tracing/exporters/default)
115
115
  - [Mastra Cloud Documentation](https://cloud.mastra.ai/docs)
@@ -102,8 +102,8 @@ If you set the strategy to `'auto'`, the `DefaultExporter` automatically selects
102
102
 
103
103
  | Storage Provider | Preferred Strategy | Supported Strategies | Notes |
104
104
  | ----------------------------------------------- | ------------------ | ----------------------------------------- | ------------------------------------- |
105
- | **[LibSQL]/reference/v1/storage/libsql)** | batch-with-updates | realtime, batch-with-updates, insert-only | Default storage, good for development |
106
- | **[PostgreSQL]/reference/v1/storage/postgresql)** | batch-with-updates | batch-with-updates, insert-only | Recommended for production |
105
+ | **[LibSQL](/reference/v1/storage/libsql)** | batch-with-updates | realtime, batch-with-updates, insert-only | Default storage, good for development |
106
+ | **[PostgreSQL](/reference/v1/storage/postgresql)** | batch-with-updates | batch-with-updates, insert-only | Recommended for production |
107
107
 
108
108
  ### Strategy Benefits
109
109
 
@@ -158,6 +158,6 @@ new DefaultExporter({
158
158
 
159
159
  ## Related
160
160
 
161
- - [Tracing Overview]/docs/v1/observability/tracing/overview)
162
- - [CloudExporter]/docs/v1/observability/tracing/exporters/cloud)
163
- - [Storage Configuration]/docs/v1/server-db/storage)
161
+ - [Tracing Overview](/docs/v1/observability/tracing/overview)
162
+ - [CloudExporter](/docs/v1/observability/tracing/exporters/cloud)
163
+ - [Storage Configuration](/docs/v1/server-db/storage)
@@ -10,7 +10,7 @@ description: "Send traces to Langfuse for LLM observability and analytics"
10
10
  ## Installation
11
11
 
12
12
  ```bash npm2yarn
13
- npm install @mastra/langfuse
13
+ npm install @mastra/langfuse@beta
14
14
  ```
15
15
 
16
16
  ## Configuration
@@ -109,5 +109,5 @@ new LangfuseExporter({
109
109
 
110
110
  ## Related
111
111
 
112
- - [Tracing Overview]/docs/v1/observability/tracing/overview)
112
+ - [Tracing Overview](/docs/v1/observability/tracing/overview)
113
113
  - [Langfuse Documentation](https://langfuse.com/docs)
@@ -10,7 +10,7 @@ description: "Send traces to LangSmith for LLM observability and evaluation"
10
10
  ## Installation
11
11
 
12
12
  ```bash npm2yarn
13
- npm install @mastra/langsmith
13
+ npm install @mastra/langsmith@beta
14
14
  ```
15
15
 
16
16
  ## Configuration
@@ -75,5 +75,5 @@ new LangSmithExporter({
75
75
 
76
76
  ## Related
77
77
 
78
- - [Tracing Overview]/docs/v1/observability/tracing/overview)
78
+ - [Tracing Overview](/docs/v1/observability/tracing/overview)
79
79
  - [LangSmith Documentation](https://docs.smith.langchain.com/)
@@ -20,19 +20,19 @@ Each provider requires specific protocol packages. Install the base exporter plu
20
20
  ### For HTTP/Protobuf Providers (SigNoz, New Relic, Laminar)
21
21
 
22
22
  ```bash npm2yarn
23
- npm install @mastra/otel-exporter @opentelemetry/exporter-trace-otlp-proto
23
+ npm install @mastra/otel-exporter@beta @opentelemetry/exporter-trace-otlp-proto
24
24
  ```
25
25
 
26
26
  ### For gRPC Providers (Dash0)
27
27
 
28
28
  ```bash npm2yarn
29
- npm install @mastra/otel-exporter @opentelemetry/exporter-trace-otlp-grpc @grpc/grpc-js
29
+ npm install @mastra/otel-exporter@beta @opentelemetry/exporter-trace-otlp-grpc @grpc/grpc-js
30
30
  ```
31
31
 
32
32
  ### For HTTP/JSON Providers (Traceloop)
33
33
 
34
34
  ```bash npm2yarn
35
- npm install @mastra/otel-exporter @opentelemetry/exporter-trace-otlp-http
35
+ npm install @mastra/otel-exporter@beta @opentelemetry/exporter-trace-otlp-http
36
36
  ```
37
37
 
38
38
  ## Provider Configurations
@@ -249,6 +249,6 @@ Install the suggested package for your provider.
249
249
 
250
250
  ## Related
251
251
 
252
- - [Tracing Overview]/docs/v1/observability/tracing/overview)
252
+ - [Tracing Overview](/docs/v1/observability/tracing/overview)
253
253
  - [OpenTelemetry GenAI Conventions](https://opentelemetry.io/docs/specs/semconv/gen-ai/)
254
- - [OTEL Exporter Reference]/reference/v1/observability/tracing/exporters/otel)
254
+ - [OTEL Exporter Reference](/reference/v1/observability/tracing/exporters/otel)
@@ -85,18 +85,18 @@ Exporters determine where your trace data is sent and how it's stored. Choosing
85
85
 
86
86
  Mastra provides two built-in exporters that work out of the box:
87
87
 
88
- - **[Default]/docs/v1/observability/tracing/exporters/default)** - Persists traces to local storage for viewing in Studio
89
- - **[Cloud]/docs/v1/observability/tracing/exporters/cloud)** - Sends traces to Mastra Cloud for production monitoring and collaboration
88
+ - **[Default](/docs/v1/observability/tracing/exporters/default)** - Persists traces to local storage for viewing in Studio
89
+ - **[Cloud](/docs/v1/observability/tracing/exporters/cloud)** - Sends traces to Mastra Cloud for production monitoring and collaboration
90
90
 
91
91
  ### External Exporters
92
92
 
93
93
  In addition to the internal exporters, Mastra supports integration with popular observability platforms. These exporters allow you to leverage your existing monitoring infrastructure and take advantage of platform-specific features like alerting, dashboards, and correlation with other application metrics.
94
94
 
95
- - **[Arize]/docs/v1/observability/tracing/exporters/arize)** - Exports traces to Arize Phoenix or Arize AX using OpenInference semantic conventions
96
- - **[Braintrust]/docs/v1/observability/tracing/exporters/braintrust)** - Exports traces to Braintrust's eval and observability platform
97
- - **[Langfuse]/docs/v1/observability/tracing/exporters/langfuse)** - Sends traces to the Langfuse open-source LLM engineering platform
98
- - **[LangSmith]/docs/v1/observability/tracing/exporters/langsmith)** - Pushes traces into LangSmith's observability and evaluation toolkit
99
- - **[OpenTelemetry]/docs/v1/observability/tracing/exporters/otel)** - Deliver traces to any OpenTelemetry-compatible observability system
95
+ - **[Arize](/docs/v1/observability/tracing/exporters/arize)** - Exports traces to Arize Phoenix or Arize AX using OpenInference semantic conventions
96
+ - **[Braintrust](/docs/v1/observability/tracing/exporters/braintrust)** - Exports traces to Braintrust's eval and observability platform
97
+ - **[Langfuse](/docs/v1/observability/tracing/exporters/langfuse)** - Sends traces to the Langfuse open-source LLM engineering platform
98
+ - **[LangSmith](/docs/v1/observability/tracing/exporters/langsmith)** - Pushes traces into LangSmith's observability and evaluation toolkit
99
+ - **[OpenTelemetry](/docs/v1/observability/tracing/exporters/otel)** - Deliver traces to any OpenTelemetry-compatible observability system
100
100
  - Supports: Dash0, Laminar, New Relic, SigNoz, Traceloop, Zipkin, and others!
101
101
 
102
102
  ## Sampling Strategies
@@ -522,7 +522,7 @@ Span processors allow you to transform, filter, or enrich trace data before it's
522
522
 
523
523
  ### Built-in Processors
524
524
 
525
- - [Sensitive Data Filter]/docs/v1/observability/tracing/processors/sensitive-data-filter) redacts sensitive information. It is enabled in the default observability config.
525
+ - [Sensitive Data Filter](/docs/v1/observability/tracing/processors/sensitive-data-filter) redacts sensitive information. It is enabled in the default observability config.
526
526
 
527
527
  ### Creating Custom Processors
528
528
 
@@ -753,25 +753,25 @@ Mastra automatically creates spans for:
753
753
 
754
754
  ### Examples
755
755
 
756
- - [Basic Tracing Example]/examples/v1/observability/basic-tracing) - Working implementation
756
+ - [Basic Tracing Example](/examples/v1/observability/basic-tracing) - Working implementation
757
757
 
758
758
  ### Reference Documentation
759
759
 
760
- - [Configuration API]/reference/v1/observability/tracing/configuration) - ObservabilityConfig details
761
- - [Tracing Classes]/reference/v1/observability/tracing/instances) - Core classes and methods
762
- - [Span Interfaces]/reference/v1/observability/tracing/spans) - Span types and lifecycle
763
- - [Type Definitions]/reference/v1/observability/tracing/interfaces) - Complete interface reference
760
+ - [Configuration API](/reference/v1/observability/tracing/configuration) - ObservabilityConfig details
761
+ - [Tracing Classes](/reference/v1/observability/tracing/instances) - Core classes and methods
762
+ - [Span Interfaces](/reference/v1/observability/tracing/spans) - Span types and lifecycle
763
+ - [Type Definitions](/reference/v1/observability/tracing/interfaces) - Complete interface reference
764
764
 
765
765
  ### Exporters
766
766
 
767
- - [DefaultExporter]/reference/v1/observability/tracing/exporters/default-exporter) - Storage persistence
768
- - [CloudExporter]/reference/v1/observability/tracing/exporters/cloud-exporter) - Mastra Cloud integration
769
- - [ConsoleExporter]/reference/v1/observability/tracing/exporters/console-exporter) - Debug output
770
- - [Arize]/reference/v1/observability/tracing/exporters/arize) - Arize Phoenix and Arize AX integration
771
- - [Braintrust]/reference/v1/observability/tracing/exporters/braintrust) - Braintrust integration
772
- - [Langfuse]/reference/v1/observability/tracing/exporters/langfuse) - Langfuse integration
773
- - [OpenTelemetry]/reference/v1/observability/tracing/exporters/otel) - OTEL-compatible platforms
767
+ - [DefaultExporter](/reference/v1/observability/tracing/exporters/default-exporter) - Storage persistence
768
+ - [CloudExporter](/reference/v1/observability/tracing/exporters/cloud-exporter) - Mastra Cloud integration
769
+ - [ConsoleExporter](/reference/v1/observability/tracing/exporters/console-exporter) - Debug output
770
+ - [Arize](/reference/v1/observability/tracing/exporters/arize) - Arize Phoenix and Arize AX integration
771
+ - [Braintrust](/reference/v1/observability/tracing/exporters/braintrust) - Braintrust integration
772
+ - [Langfuse](/reference/v1/observability/tracing/exporters/langfuse) - Langfuse integration
773
+ - [OpenTelemetry](/reference/v1/observability/tracing/exporters/otel) - OTEL-compatible platforms
774
774
 
775
775
  ### Processors
776
776
 
777
- - [Sensitive Data Filter]/docs/v1/observability/tracing/processors/sensitive-data-filter) - Data redaction
777
+ - [Sensitive Data Filter](/docs/v1/observability/tracing/processors/sensitive-data-filter) - Data redaction
@@ -292,5 +292,5 @@ This ensures that processing errors don't prevent traces from being exported or
292
292
 
293
293
  ## Related
294
294
 
295
- - [SensitiveDataFilter API]/reference/v1/observability/tracing/processors/sensitive-data-filter)
296
- - [Basic Tracing Example]/examples/v1/observability/basic-tracing)
295
+ - [SensitiveDataFilter API](/reference/v1/observability/tracing/processors/sensitive-data-filter)
296
+ - [Basic Tracing Example](/examples/v1/observability/basic-tracing)
@@ -73,5 +73,5 @@ Mastra supports multiple vector stores for embedding persistence and similarity
73
73
 
74
74
  ## More resources
75
75
 
76
- - [Chain of Thought RAG Example]/examples/v1/rag/usage/cot-rag)
76
+ - [Chain of Thought RAG Example](/examples/v1/rag/usage/cot-rag)
77
77
  - [All RAG Examples](/examples/v1/) (including different chunking strategies, embedding models, and vector stores)
@@ -110,13 +110,13 @@ export const agent = new Agent({
110
110
  type: "string",
111
111
  isOptional: true,
112
112
  description:
113
- "Optional unique identifier for the agent. Defaults to `name` if not provided.",
113
+ "Unique identifier for the agent. Defaults to `name` if not provided.",
114
114
  },
115
115
  {
116
116
  name: "name",
117
117
  type: "string",
118
118
  isOptional: false,
119
- description: "Unique identifier for the agent.",
119
+ description: "Display name for the agent. Used as the identifier if `id` is not provided.",
120
120
  },
121
121
  {
122
122
  name: "description",
@@ -16,28 +16,28 @@ The `create-mastra` command **creates** a new standalone Mastra project. Use thi
16
16
  <TabItem value="npm" label="npm">
17
17
 
18
18
  ```bash copy
19
- npx create-mastra@latest
19
+ npx create-mastra@beta
20
20
  ```
21
21
 
22
22
  </TabItem>
23
23
  <TabItem value="yarn" label="yarn">
24
24
 
25
25
  ```bash copy
26
- yarn dlx create-mastra@latest
26
+ yarn dlx create-mastra@beta
27
27
  ```
28
28
 
29
29
  </TabItem>
30
30
  <TabItem value="pnpm" label="pnpm">
31
31
 
32
32
  ```bash copy
33
- pnpm create mastra@latest
33
+ pnpm create mastra@beta
34
34
  ```
35
35
 
36
36
  </TabItem>
37
37
  <TabItem value="bun" label="bun">
38
38
 
39
39
  ```bash copy
40
- bun create mastra@latest
40
+ bun create mastra@beta
41
41
  ```
42
42
 
43
43
  </TabItem>
@@ -49,28 +49,28 @@ bun create mastra@latest
49
49
  <TabItem value="npm" label="npm">
50
50
 
51
51
  ```bash copy
52
- npx create-mastra@latest my-mastra-project -- --template coding-agent
52
+ npx create-mastra@beta my-mastra-project -- --template coding-agent
53
53
  ```
54
54
 
55
55
  </TabItem>
56
56
  <TabItem value="yarn" label="yarn">
57
57
 
58
58
  ```bash copy
59
- yarn dlx create-mastra@latest --template coding-agent
59
+ yarn dlx create-mastra@beta --template coding-agent
60
60
  ```
61
61
 
62
62
  </TabItem>
63
63
  <TabItem value="pnpm" label="pnpm">
64
64
 
65
65
  ```bash copy
66
- pnpm create mastra@latest --template coding-agent
66
+ pnpm create mastra@beta --template coding-agent
67
67
  ```
68
68
 
69
69
  </TabItem>
70
70
  <TabItem value="bun" label="bun">
71
71
 
72
72
  ```bash copy
73
- bun create mastra@latest --template coding-agent
73
+ bun create mastra@beta --template coding-agent
74
74
  ```
75
75
 
76
76
  </TabItem>
@@ -81,7 +81,7 @@ Check out the [full list](https://mastra.ai/api/templates.json) of templates and
81
81
  You can also use any GitHub repo as a template (it has to be a valid Mastra project):
82
82
 
83
83
  ```bash
84
- npx create-mastra@latest my-mastra-project -- --template mastra-ai/template-coding-agent
84
+ npx create-mastra@beta my-mastra-project -- --template mastra-ai/template-coding-agent
85
85
  ```
86
86
 
87
87
  ## CLI flags
@@ -190,5 +190,5 @@ MASTRA_TELEMETRY_DISABLED=1
190
190
  You can also set this while using other `mastra` commands:
191
191
 
192
192
  ```bash copy
193
- MASTRA_TELEMETRY_DISABLED=1 npx create-mastra@latest
193
+ MASTRA_TELEMETRY_DISABLED=1 npx create-mastra@beta
194
194
  ```
@@ -9,9 +9,9 @@ You can use the Command-Line Interface (CLI) provided by Mastra to develop, buil
9
9
 
10
10
  ## `mastra dev`
11
11
 
12
- Starts a server which exposes [Studio]/docs/v1/getting-started/studio) and REST endpoints for your agents, tools, and workflows. You can visit [http://localhost:4111/swagger-ui](http://localhost:4111/swagger-ui) for an overview of all available endpoints once `mastra dev` is running.
12
+ Starts a server which exposes [Studio](/docs/v1/getting-started/studio) and REST endpoints for your agents, tools, and workflows. You can visit [http://localhost:4111/swagger-ui](http://localhost:4111/swagger-ui) for an overview of all available endpoints once `mastra dev` is running.
13
13
 
14
- You can also [configure the server]/docs/v1/getting-started/studio#configuration).
14
+ You can also [configure the server](/docs/v1/getting-started/studio#configuration).
15
15
 
16
16
  ### Flags
17
17
 
@@ -19,7 +19,7 @@ The command accepts [common flags][common-flags] and the following additional fl
19
19
 
20
20
  #### `--https`
21
21
 
22
- Enable local HTTPS support. [Learn more]/docs/v1/getting-started/studio#local-https).
22
+ Enable local HTTPS support. [Learn more](/docs/v1/getting-started/studio#local-https).
23
23
 
24
24
  #### `--inspect`
25
25
 
@@ -85,7 +85,7 @@ Under the hood Mastra's Rollup server locates your Mastra entry file and bundles
85
85
 
86
86
  The output in `.mastra` can be deployed to any cloud server using [`mastra start`](#mastra-start).
87
87
 
88
- If you're deploying to a [serverless platform]/docs/v1/deployment/serverless-platforms) you need to install the correct deployer in order to receive the correct output in `.mastra`.
88
+ If you're deploying to a [serverless platform](/docs/v1/deployment/serverless-platforms) you need to install the correct deployer in order to receive the correct output in `.mastra`.
89
89
 
90
90
  It accepts [common flags][common-flags].
91
91
 
@@ -109,7 +109,7 @@ You need to run `mastra build` before using `mastra start`.
109
109
 
110
110
  :::
111
111
 
112
- Starts a local server to serve your built Mastra application in production mode. By default, [OTEL Tracing]/docs/v1/observability/tracing/overview) is enabled.
112
+ Starts a local server to serve your built Mastra application in production mode. By default, [OTEL Tracing](/docs/v1/observability/tracing/overview) is enabled.
113
113
 
114
114
  ### Flags
115
115
 
@@ -121,7 +121,7 @@ The path to your built Mastra output directory. Defaults to `.mastra/output`.
121
121
 
122
122
  #### `--no-telemetry`
123
123
 
124
- Disable the [OTEL Tracing]/docs/v1/observability/tracing/overview).
124
+ Disable the [OTEL Tracing](/docs/v1/observability/tracing/overview).
125
125
 
126
126
  ## `mastra lint`
127
127
 
@@ -133,7 +133,7 @@ It accepts [common flags][common-flags].
133
133
 
134
134
  The `mastra scorers` command provides management capabilities for evaluation scorers that measure the quality, accuracy, and performance of AI-generated outputs.
135
135
 
136
- Read the [Scorers overview]/docs/v1/evals/overview) to learn more.
136
+ Read the [Scorers overview](/docs/v1/evals/overview) to learn more.
137
137
 
138
138
  ### `add`
139
139
 
@@ -32,5 +32,5 @@ This method does not accept any parameters.
32
32
 
33
33
  ## Related
34
34
 
35
- - [Logging overview]/docs/v1/logging)
36
- - [Logger reference]/reference/v1/logging/pino-logger)
35
+ - [Logging overview](/docs/v1/logging)
36
+ - [Logger reference](/reference/v1/logging/pino-logger)
@@ -59,8 +59,8 @@ const serverById = mastra.getMCPServerById('my-mcp-server');
59
59
 
60
60
  ## Related Methods
61
61
 
62
- - [Mastra.getMCPServerById()]/reference/v1/core/getMCPServerById) - Retrieve an MCP server by its intrinsic `id` property
63
- - [Mastra.listMCPServers()]/reference/v1/core/listMCPServers) - List all registered MCP servers
62
+ - [Mastra.getMCPServerById()](/reference/v1/core/getMCPServerById) - Retrieve an MCP server by its intrinsic `id` property
63
+ - [Mastra.listMCPServers()](/reference/v1/core/listMCPServers) - List all registered MCP servers
64
64
 
65
65
  ## See Also
66
66
 
@@ -72,10 +72,10 @@ const serverByKey = mastra.getMCPServer('customKey');
72
72
 
73
73
  ## Related Methods
74
74
 
75
- - [Mastra.getMCPServer()]/reference/v1/core/getMCPServer) - Retrieve an MCP server by its registry key
76
- - [Mastra.listMCPServers()]/reference/v1/core/listMCPServers) - List all registered MCP servers
75
+ - [Mastra.getMCPServer()](/reference/v1/core/getMCPServer) - Retrieve an MCP server by its registry key
76
+ - [Mastra.listMCPServers()](/reference/v1/core/listMCPServers) - List all registered MCP servers
77
77
 
78
78
  ## See Also
79
79
 
80
- - [MCP overview]/docs/v1/tools-mcp/mcp-overview)
81
- - [MCP server reference]/reference/v1/tools/mcp-server)
80
+ - [MCP overview](/docs/v1/tools-mcp/mcp-overview)
81
+ - [MCP server reference](/reference/v1/tools/mcp-server)
@@ -32,5 +32,5 @@ This method does not accept any parameters.
32
32
 
33
33
  ## Related
34
34
 
35
- - [Tracing]/docs/v1/observability/tracing/overview)
36
- - [Observability Configuration]/reference/v1/observability/tracing/configuration)
35
+ - [Tracing](/docs/v1/observability/tracing/overview)
36
+ - [Observability Configuration](/reference/v1/observability/tracing/configuration)
@@ -92,5 +92,5 @@ mastra.listLogs("456");
92
92
 
93
93
  ## Related
94
94
 
95
- - [Logging overview]/docs/v1/logging)
96
- - [Logger reference]/reference/v1/logging/pino-logger)
95
+ - [Logging overview](/docs/v1/logging)
96
+ - [Logger reference](/reference/v1/logging/pino-logger)
@@ -83,5 +83,5 @@ mastra.listLogsByRunId({ runId: "123", transportId: "456" });
83
83
 
84
84
  ## Related
85
85
 
86
- - [Logging overview]/docs/v1/logging)
87
- - [Logger reference]/reference/v1/logging/pino-logger)
86
+ - [Logging overview](/docs/v1/logging)
87
+ - [Logger reference](/reference/v1/logging/pino-logger)