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

package/.docs/raw/getting-started/templates.mdx

@@ -17,22 +17,22 @@ Install a template using the `create-mastra` command:
 <Tabs>
   <TabItem value="npm" label="npm">
     ```bash copy
-    npx create-mastra@latest --template template-name
+    npx create-mastra@beta --template template-name
     ```
   </TabItem>
   <TabItem value="yarn" label="yarn">
     ```bash copy
-    yarn dlx create-mastra@latest --template template-name
+    yarn dlx create-mastra@beta --template template-name
     ```
   </TabItem>
   <TabItem value="pnpm" label="pnpm">
     ```bash copy
-    pnpm create mastra@latest --template template-name
+    pnpm create mastra@beta --template template-name
     ```
   </TabItem>
   <TabItem value="bun" label="bun">
     ```bash copy
-    bun create mastra@latest --template template-name
+    bun create mastra@beta --template template-name
     ```
   </TabItem>
 </Tabs>
@@ -40,7 +40,7 @@ Install a template using the `create-mastra` command:
 For example, to create a text-to-SQL application:
 
 ```bash copy
-npx create-mastra@latest --template text-to-sql
+npx create-mastra@beta --template text-to-sql
 ```
 
 ## Setting Up a Template

package/.docs/raw/guides/guide/notes-mcp-server.mdx

@@ -31,7 +31,7 @@ Before you can create an MCP server you first need to install additional depende
 Add `@mastra/mcp` to your project:
 
 ```bash copy
-npm install @mastra/mcp
+npm install @mastra/mcp@beta
 ```
 
 </StepItem>

package/.docs/raw/guides/guide/research-assistant.mdx

@@ -60,17 +60,8 @@ Install additional dependencies
 After running the [installation guide](/docs/v1/getting-started/installation) you'll need to install additional dependencies:
 
 ```bash copy
-npm install @mastra/rag@latest ai@^4.0.0
+npm install @mastra/rag@beta ai@^4.0.0
 ```
-
-:::info
-
-Mastra currently does not support v5 of the AI SDK (see [support
-thread](https://github.com/mastra-ai/mastra/issues/5470)). For this guide
-you'll need to use v4.
-
-:::
-
 </StepItem>
 
 <StepItem title="Define the Agent">

package/.docs/raw/guides/migrations/upgrade-to-v1/agent.mdx

@@ -25,7 +25,7 @@ To migrate, replace all calls to `mastra.getAgents()` with `mastra.listAgents()`
 You can use Mastra's codemod CLI to update your code automatically:
 
 ```shell
-npx @mastra/codemod v1/agent-get-agents .
+npx @mastra/codemod@beta v1/mastra-plural-apis .
 ```
 
 :::
@@ -54,7 +54,7 @@ To migrate, update all imports and parameter names from `RuntimeContext`/`runtim
 You can use Mastra's codemod CLI to update your code automatically:
 
 ```shell
-npx @mastra/codemod v1/runtime-context .
+npx @mastra/codemod@beta v1/runtime-context .
 ```
 
 :::
@@ -79,7 +79,7 @@ To migrate, replace property access with the corresponding getter methods.
 You can use Mastra's codemod CLI to update your code automatically:
 
 ```shell
-npx @mastra/codemod v1/agent-property-access .
+npx @mastra/codemod@beta v1/agent-property-access .
 ```
 
 :::
@@ -104,7 +104,7 @@ To migrate, update voice method calls to use the `agent.voice` namespace.
 You can use Mastra's codemod CLI to update your code automatically:
 
 ```shell
-npx @mastra/codemod v1/agent-voice .
+npx @mastra/codemod@beta v1/agent-voice .
 ```
 
 :::
@@ -140,7 +140,7 @@ To migrate, update processor method names.
 You can use Mastra's codemod CLI to update your code automatically:
 
 ```shell
-npx @mastra/codemod v1/agent-processor-methods .
+npx @mastra/codemod@beta v1/agent-processor-methods .
 ```
 
 :::
@@ -177,6 +177,16 @@ To migrate, move `abortSignal` from `modelSettings` to the top level.
   });
 ```
 
+:::tip[Codemod]
+
+You can use Mastra's codemod CLI to update your code automatically:
+
+```shell
+npx @mastra/codemod@beta v1/agent-abort-signal .
+```
+
+:::
+
 ### `output` to `structuredOutput.schema`
 
 The deprecated `output` and `experimental_output` options have been removed. This change consolidates on a single, stable API for structured output.
@@ -212,7 +222,7 @@ To migrate, use the standard `generate()` and `stream()` methods.
 You can use Mastra's codemod CLI to update your code automatically:
 
 ```shell
-npx @mastra/codemod v1/agent-generate-stream-v-next .
+npx @mastra/codemod@beta v1/agent-generate-stream-v-next .
 ```
 
 :::

package/.docs/raw/guides/migrations/upgrade-to-v1/client.mdx

@@ -28,6 +28,16 @@ To migrate, update type imports to use the new naming pattern.
 + } from '@mastra/client-js';
 ```
 
+:::tip[Codemod]
+
+You can use Mastra's codemod CLI to update your code automatically:
+
+```shell
+npx @mastra/codemod@beta v1/client-sdk-types .
+```
+
+:::
+
 ### Pagination parameters from `offset/limit` to `page/perPage`
 
 All client SDK methods that used `offset/limit` now use `page/perPage`. This change provides a more intuitive pagination model aligned with web pagination patterns.
@@ -44,6 +54,16 @@ To migrate, update pagination parameters in all client SDK method calls. Example
   });
 ```
 
+:::tip[Codemod]
+
+You can use Mastra's codemod CLI to update your code automatically:
+
+```shell
+npx @mastra/codemod@beta v1/client-offset-limit .
+```
+
+:::
+
 ### `getMemoryThread` parameter structure
 
 The `getMemoryThread` method parameter structure has been updated. This change provides a more consistent API across memory methods.
@@ -51,10 +71,20 @@ The `getMemoryThread` method parameter structure has been updated. This change p
 To migrate, update the method call with the new parameter structure. Check the updated API documentation for the specific changes.
 
 ```diff
-- const thread = await client.memory.getMemoryThread(threadId, agentId);
-+ const thread = await client.memory.getMemoryThread({ threadId, agentId });
+- const thread = await client.getMemoryThread(threadId, agentId);
++ const thread = await client.getMemoryThread({ threadId, agentId });
 ```
 
+:::tip[Codemod]
+
+You can use Mastra's codemod CLI to update your code automatically:
+
+```shell
+npx @mastra/codemod@beta v1/client-get-memory-thread .
+```
+
+:::
+
 ## Removed
 
 ### `toAISdkFormat` function
@@ -70,6 +100,16 @@ To migrate, use `toAISdkStream()` instead.
 + const stream = toAISdkStream(agentStream, { from: 'agent' });
 ```
 
+:::tip[Codemod]
+
+You can use Mastra's codemod CLI to update your code automatically:
+
+```shell
+npx @mastra/codemod@beta v1/client-to-ai-sdk-format .
+```
+
+:::
+
 ### Network memory methods
 
 Network memory methods have been removed from `@mastra/client-js`. The `NetworkMemoryThread` class and all network memory-related methods are no longer available. This change simplifies the memory API by removing specialized network memory functionality.

package/.docs/raw/guides/migrations/upgrade-to-v1/evals.mdx

@@ -25,7 +25,7 @@ To migrate, replace all calls to `getScorers()` with `listScorers()`.
 You can use Mastra's codemod CLI to update your code automatically:
 
 ```shell
-npx @mastra/codemod v1/evals-get-scorers .
+npx @mastra/codemod@beta v1/mastra-plural-apis .
 ```
 
 :::
@@ -50,6 +50,16 @@ To migrate, update function calls from `runExperiment` to `runEvals`.
 + const result = await runEvals({ target: myAgent, scorers: [scorer], data: inputs });
 ```
 
+:::tip[Codemod]
+
+You can use Mastra's codemod CLI to update your code automatically:
+
+```shell
+npx @mastra/codemod@beta v1/evals-run-experiment .
+```
+
+:::
+
 ### `getScorerByName` to `getScorerById`
 
 The `getScorerByName()` method has been renamed to `getScorerById()`. Scorers now require an `id` field instead of `name`. This change aligns with the broader API pattern of using `id` for entity identification.
@@ -67,6 +77,16 @@ To migrate, update method calls and scorer configuration to use `id` instead of
 + const scorer = mastra.getScorerById('helpfulness-scorer');
 ```
 
+:::tip[Codemod]
+
+You can use Mastra's codemod CLI to update your code automatically:
+
+```shell
+npx @mastra/codemod@beta v1/evals-scorer-by-name .
+```
+
+:::
+
 ### Scorer configuration from `name` to `id`
 
 Scorers now require an `id` field instead of `name`. The `name` field is now optional. This change provides consistency with other Mastra entities.
@@ -120,6 +140,16 @@ To migrate, update import statements to use the new `scorers/prebuilt` path.
 + import { createCompletenessScorer } from '@mastra/evals/scorers/prebuilt';
 ```
 
+:::tip[Codemod]
+
+You can use Mastra's codemod CLI to update your code automatically:
+
+```shell
+npx @mastra/codemod@beta v1/evals-prebuilt-imports .
+```
+
+:::
+
 ### Scorer message types from `UIMessage` to `MastraDBMessage`
 
 Scorer input and output types now use `MastraDBMessage[]` instead of `UIMessage`. This change aligns scorers with the database-persisted message format for consistency across the framework.

package/.docs/raw/guides/migrations/upgrade-to-v1/mastra.mdx

@@ -28,7 +28,7 @@ To migrate, update all imports from `@mastra/core` to use the appropriate subpat
 You can use Mastra's codemod CLI to update your code automatically:
 
 ```shell
-npx @mastra/codemod v1/mastra-core-imports .
+npx @mastra/codemod@beta v1/mastra-core-imports .
 ```
 
 :::
@@ -53,16 +53,16 @@ To migrate, rename the `experimental_auth` key to `auth` in your Mastra configur
 You can use Mastra's codemod CLI to update your code automatically:
 
 ```shell
-npx @mastra/codemod v1/experimental-auth .
+npx @mastra/codemod@beta v1/experimental-auth .
 ```
 
 :::
 
 ### Required `id` parameter for all mastra primitives
 
-All storage, vector stores, agents, workflows, mcpServers, processors, scorers, tools now require an `id` parameter during initialization. This enables the standardized Mastra API and prevents ID conflicts.
+All storages, vector stores, agents, workflows, mcpServers, processors, scorers, and tools now require an `id` parameter during initialization. This enables the standardized Mastra API and prevents ID conflicts.
 
-All these primitives also now have a `get`, `list`, and `add` functions.
+All these primitives also now have `get`, `list`, and `add` functions.
 
 To migrate, add an `id` parameter to all storage and vector store instantiations. When using the same storage/vector class multiple times, ensure each instance has a unique ID.
 
@@ -105,11 +105,35 @@ When using separate instances for different purposes, use descriptive unique IDs
 
 ### Primitive plural APIs changes from `get<primitives>` to `list<primitive>`
 
+`get*` functions that returned all instances of a primitive have been renamed to `list*` to better reflect their purpose.
+
 ```diff
+- const agents = mastra.getAgents();
++ const agents = mastra.listAgents();
+- const vectors = mastra.getVectors();
++ const vectors = mastra.listVectors();
+- const workflows = mastra.getWorkflows();
++ const workflows = mastra.listWorkflows();
+- const scorers = mastra.getScorers();
++ const scorers = mastra.listScorers();
 - const mcpServers = mastra.getMCPServers();
 + const mcpServers = mastra.listMCPServers();
+- const logsByRunId = await mastra.getLogsByRunId({ runId: 'id', transportId: 'id' });
++ const logsByRunId = await mastra.listLogsByRunId({ runId: 'id', transportId: 'id' });
+- const logs = await mastra.getLogs('transportId');
++ const logs = await mastra.listLogs('transportId');
+```
+
+:::tip[Codemod]
+
+You can use Mastra's codemod CLI to update your code automatically:
+
+```shell
+npx @mastra/codemod@beta v1/mastra-plural-apis .
 ```
 
+:::
+
 ### Each primtive has a `getById` and a `get` function
 
 ```typescript

package/.docs/raw/guides/migrations/upgrade-to-v1/mcp.mdx

@@ -25,7 +25,7 @@ To migrate, replace all calls to `mastra.getMCPServers()` with `mastra.listMCPSe
 You can use Mastra's codemod CLI to update your code automatically:
 
 ```shell
-npx @mastra/codemod v1/mcp-get-mcp-servers .
+npx @mastra/codemod@beta v1/mastra-plural-apis .
 ```
 
 :::
@@ -46,7 +46,7 @@ To migrate, replace all calls to `mcp.getTools()` with `mcp.listTools()`.
 You can use Mastra's codemod CLI to update your code automatically:
 
 ```shell
-npx @mastra/codemod v1/mcp-get-tools .
+npx @mastra/codemod@beta v1/mcp-get-tools .
 ```
 
 :::
@@ -67,7 +67,7 @@ To migrate, replace all calls to `mcp.getToolsets()` with `mcp.listToolsets()`.
 You can use Mastra's codemod CLI to update your code automatically:
 
 ```shell
-npx @mastra/codemod v1/mcp-get-toolsets .
+npx @mastra/codemod@beta v1/mcp-get-toolsets .
 ```
 
 :::

package/.docs/raw/guides/migrations/upgrade-to-v1/memory.mdx

@@ -111,6 +111,16 @@ To migrate, rename `query()` to `recall()` and update code that expects the old
 + const messages = result.messages;
 ```
 
+:::tip[Codemod]
+
+You can use Mastra's codemod CLI to update your code automatically:
+
+```shell
+npx @mastra/codemod@beta v1/memory-query-to-recall .
+```
+
+:::
+
 ### `Memory.recall()` parameter changes
 
 The `Memory.recall()` method now uses `StorageListMessagesInput` format with pagination, and the `vectorMessageSearch` parameter has been renamed to `vectorSearchString`. These changes align the memory API with the storage pagination API and provide more consistent naming.
@@ -132,6 +142,16 @@ To migrate, update method name, query parameters, and the vector search paramete
   });
 ```
 
+:::tip[Codemod]
+
+You can use Mastra's codemod CLI to update your code automatically:
+
+```shell
+npx @mastra/codemod@beta v1/memory-vector-search-param .
+```
+
+:::
+
 ### `MastraMessageV2` type renamed to `MastraDBMessage`
 
 The `MastraMessageV2` type has been renamed to `MastraDBMessage` for clarity. This change better describes the purpose of this type as the database message format.
@@ -145,7 +165,15 @@ To migrate, replace all instances of `MastraMessageV2` with `MastraDBMessage`.
 + function yourCustomFunction(input: MastraDBMessage) {}
 ```
 
+:::tip[Codemod]
+
+You can use Mastra's codemod CLI to update your code automatically:
+
+```shell
+npx @mastra/codemod@beta v1/memory-message-v2-type .
+```
 
+:::
 
 ## Removed
 

package/.docs/raw/guides/migrations/upgrade-to-v1/overview.mdx

@@ -19,65 +19,79 @@ Use your package manager to update your project's versions. Be sure to update **
 
 ### Update Node.js version
 
-Mastra v1 requires Node.js 22.13.0 or higher. Update your development and production environments accordingly.
+Mastra v1 requires Node.js **22.13.0** or higher. Update your development and production environments accordingly.
+
+### Go through migration checklist
+
+Work through the [migration checklist](#migration-checklist) below to update your codebase. Each item links to a detailed guide for that specific change.
+
+:::info[Codemods]
+
+We prepared automated [codemods](https://github.com/mastra-ai/mastra/tree/main/packages/codemod) for you. If you want, you can run all v1 codemods at once:
+
+```sh
+npx @mastra/codemod@beta v1
+```
+
+:::
 
 ## Breaking Changes by Area
 
-- **[Mastra Class]/guides/v1/migrations/upgrade-to-v1/mastra)** - Import restructuring and property access changes.
-- **[Agent Class]/guides/v1/migrations/upgrade-to-v1/agent)** - Voice methods moved to namespace and streaming API updates.
-- **[Tools]/guides/v1/migrations/upgrade-to-v1/tools)** - CreateTool execute signature changed to separate input and context.
-- **[Workflows]/guides/v1/migrations/upgrade-to-v1/workflows)** - Function name changes and legacy features removed.
-- **[Memory]/guides/v1/migrations/upgrade-to-v1/memory)** - Configuration now requires explicit parameters and defaults changed.
-- **[Storage]/guides/v1/migrations/upgrade-to-v1/storage)** - Pagination standardized and methods renamed to list pattern.
-- **[Vectors]/guides/v1/migrations/upgrade-to-v1/vectors)** - Vector store methods renamed to list pattern.
-- **[MCP]/guides/v1/migrations/upgrade-to-v1/mcp)** - Tool context reorganized and deprecated client classes removed.
-- **[Tracing]/guides/v1/migrations/upgrade-to-v1/tracing)** - OTEL telemetry replaced with dedicated observability package and exporters.
-- **[Evals & Scorers]/guides/v1/migrations/upgrade-to-v1/evals)** - Scorers API consolidated with new naming conventions.
-- **[CLI]/guides/v1/migrations/upgrade-to-v1/cli)** - Commands and flags removed for simpler interface.
-- **[Client SDKs]/guides/v1/migrations/upgrade-to-v1/client)** - Types and utilities renamed for consistency.
-- **[Voice Packages]/guides/v1/migrations/upgrade-to-v1/voice)** - Packages renamed from speech to voice.
+- **[Mastra Class](/guides/v1/migrations/upgrade-to-v1/mastra)** - Import restructuring and property access changes.
+- **[Agent Class](/guides/v1/migrations/upgrade-to-v1/agent)** - Voice methods moved to namespace and streaming API updates.
+- **[Tools](/guides/v1/migrations/upgrade-to-v1/tools)** - CreateTool execute signature changed to separate input and context.
+- **[Workflows](/guides/v1/migrations/upgrade-to-v1/workflows)** - Function name changes and legacy features removed.
+- **[Memory](/guides/v1/migrations/upgrade-to-v1/memory)** - Configuration now requires explicit parameters and defaults changed.
+- **[Storage](/guides/v1/migrations/upgrade-to-v1/storage)** - Pagination standardized and methods renamed to list pattern.
+- **[Vectors](/guides/v1/migrations/upgrade-to-v1/vectors)** - Vector store methods renamed to list pattern.
+- **[MCP](/guides/v1/migrations/upgrade-to-v1/mcp)** - Tool context reorganized and deprecated client classes removed.
+- **[Tracing](/guides/v1/migrations/upgrade-to-v1/tracing)** - OTEL telemetry replaced with dedicated observability package and exporters.
+- **[Evals & Scorers](/guides/v1/migrations/upgrade-to-v1/evals)** - Scorers API consolidated with new naming conventions.
+- **[CLI](/guides/v1/migrations/upgrade-to-v1/cli)** - Commands and flags removed for simpler interface.
+- **[Client SDKs](/guides/v1/migrations/upgrade-to-v1/client)** - Types and utilities renamed for consistency.
+- **[Voice Packages](/guides/v1/migrations/upgrade-to-v1/voice)** - Packages renamed from speech to voice.
 
 ## Migration Checklist
 
 Work through this checklist in order, starting with high-impact changes that affect most applications.
 
-:::info[Codemod]
+:::info[Codemods]
 
 We prepared automated [codemods](https://github.com/mastra-ai/mastra/tree/main/packages/codemod) for you. Throughout the migration guide you'll find instructions on how to use them for specific changes.
 
 If you want, you can run all v1 codemods at once:
 
 ```sh
-npx @mastra/codemod v1
+npx @mastra/codemod@beta v1
 ```
 
 :::
 
 ### High Impact Changes
 
-- Update `createTool` tool signatures to `(inputData, context)` format - [Tools]/guides/v1/migrations/upgrade-to-v1/tools)
-- Restructure `@mastra/core` imports to use subpath imports - [Mastra Class]/guides/v1/migrations/upgrade-to-v1/mastra)
-- Update pagination from `offset/limit` to `page/perPage` - [Storage]/guides/v1/migrations/upgrade-to-v1/storage)
-- Install `@mastra/observability` and wrap configuration with `new Observability()` - [Tracing]/guides/v1/migrations/upgrade-to-v1/tracing)
-- Migrate from `telemetry:` to `observability:` configuration (if upgrading from 0.x OTEL) - [Tracing]/guides/v1/migrations/upgrade-to-v1/tracing)
+- Update `createTool` tool signatures to `(inputData, context)` format - [Tools](/guides/v1/migrations/upgrade-to-v1/tools)
+- Restructure `@mastra/core` imports to use subpath imports - [Mastra Class](/guides/v1/migrations/upgrade-to-v1/mastra)
+- Update pagination from `offset/limit` to `page/perPage` - [Storage](/guides/v1/migrations/upgrade-to-v1/storage)
+- Install `@mastra/observability` and wrap configuration with `new Observability()` - [Tracing](/guides/v1/migrations/upgrade-to-v1/tracing)
+- Migrate from `telemetry:` to `observability:` configuration (if upgrading from 0.x OTEL) - [Tracing](/guides/v1/migrations/upgrade-to-v1/tracing)
 
 ### Medium Impact Changes
 
-- Rename `RuntimeContext` to `RequestContext` throughout codebase - [Agent Class]/guides/v1/migrations/upgrade-to-v1/agent), [Tools]/guides/v1/migrations/upgrade-to-v1/tools), [Workflows]/guides/v1/migrations/upgrade-to-v1/workflows)
-- Update storage methods from `get*` to `list*` pattern - [Storage]/guides/v1/migrations/upgrade-to-v1/storage)
-- Replace direct property access with getter methods - [Mastra Class]/guides/v1/migrations/upgrade-to-v1/mastra), [Agent Class]/guides/v1/migrations/upgrade-to-v1/agent)
-- Update memory scope if relying on default `thread` scope - [Memory]/guides/v1/migrations/upgrade-to-v1/memory)
-- Update vector store calls to use named arguments - [Storage]/guides/v1/migrations/upgrade-to-v1/storage)
-- Remove `format` parameter from agent methods - [Agent Class]/guides/v1/migrations/upgrade-to-v1/agent)
-- Update voice methods to use `agent.voice` namespace - [Agent Class]/guides/v1/migrations/upgrade-to-v1/agent)
-- Rename configuration property `processors` to `spanOutputProcessors` (if using custom processors) - [Tracing]/guides/v1/migrations/upgrade-to-v1/tracing)
+- Rename `RuntimeContext` to `RequestContext` throughout codebase - [Agent Class](/guides/v1/migrations/upgrade-to-v1/agent), [Tools](/guides/v1/migrations/upgrade-to-v1/tools), [Workflows](/guides/v1/migrations/upgrade-to-v1/workflows)
+- Update storage methods from `get*` to `list*` pattern - [Storage](/guides/v1/migrations/upgrade-to-v1/storage)
+- Replace direct property access with getter methods - [Mastra Class](/guides/v1/migrations/upgrade-to-v1/mastra), [Agent Class](/guides/v1/migrations/upgrade-to-v1/agent)
+- Update memory scope if relying on default `thread` scope - [Memory](/guides/v1/migrations/upgrade-to-v1/memory)
+- Update vector store calls to use named arguments - [Storage](/guides/v1/migrations/upgrade-to-v1/storage)
+- Remove `format` parameter from agent methods - [Agent Class](/guides/v1/migrations/upgrade-to-v1/agent)
+- Update voice methods to use `agent.voice` namespace - [Agent Class](/guides/v1/migrations/upgrade-to-v1/agent)
+- Rename configuration property `processors` to `spanOutputProcessors` (if using custom processors) - [Tracing](/guides/v1/migrations/upgrade-to-v1/tracing)
 
 ### Low Impact Changes
 
-- Rename `createRunAsync` to `createRun` - [Workflows]/guides/v1/migrations/upgrade-to-v1/workflows)
-- Update voice package names from `@mastra/speech-*` to `@mastra/voice-*` - [Voice Packages]/guides/v1/migrations/upgrade-to-v1/voice)
-- Update scorer methods: `runExperiment` → `runEvals`, `getScorerByName` → `getScorerById` - [Evals & Scorers]/guides/v1/migrations/upgrade-to-v1/evals)
-- Remove deprecated CLI flags - [CLI]/guides/v1/migrations/upgrade-to-v1/cli)
-- Update client SDK types from `Get*` to `List*` - [Client SDKs]/guides/v1/migrations/upgrade-to-v1/client)
-- Replace `runCount` with `retryCount` - [Workflows]/guides/v1/migrations/upgrade-to-v1/workflows)
-- Update custom exporter method `exportEvent` to `exportTracingEvent` (if using custom exporters) - [Tracing]/guides/v1/migrations/upgrade-to-v1/tracing)
+- Rename `createRunAsync` to `createRun` - [Workflows](/guides/v1/migrations/upgrade-to-v1/workflows)
+- Update voice package names from `@mastra/speech-*` to `@mastra/voice-*` - [Voice Packages](/guides/v1/migrations/upgrade-to-v1/voice)
+- Update scorer methods: `runExperiment` → `runEvals`, `getScorerByName` → `getScorerById` - [Evals & Scorers](/guides/v1/migrations/upgrade-to-v1/evals)
+- Remove deprecated CLI flags - [CLI](/guides/v1/migrations/upgrade-to-v1/cli)
+- Update client SDK types from `Get*` to `List*` - [Client SDKs](/guides/v1/migrations/upgrade-to-v1/client)
+- Replace `runCount` with `retryCount` - [Workflows](/guides/v1/migrations/upgrade-to-v1/workflows)
+- Update custom exporter method `exportEvent` to `exportTracingEvent` (if using custom exporters) - [Tracing](/guides/v1/migrations/upgrade-to-v1/tracing)

package/.docs/raw/guides/migrations/upgrade-to-v1/storage.mdx

@@ -9,6 +9,26 @@ Storage APIs have been standardized with consistent pagination and naming patter
 
 ## Changed
 
+### Required `id` property for storage instances
+
+Storage instances now require an `id` property. This unique identifier is used for tracking and managing storage instances within Mastra. The `id` should be a descriptive, unique string for each storage instance in your application.
+
+To migrate, add an `id` field to your storage constructor.
+
+```diff
+  const storage = new PostgresStore({
++   id: 'main-postgres-store',
+    connectionString: process.env.POSTGRES_CONNECTION_STRING,
+    schemaName: 'public',
+  });
+
+  const upstashStore = new UpstashStore({
++   id: 'upstash-cache-store',
+    url: process.env.UPSTASH_REDIS_REST_URL,
+    token: process.env.UPSTASH_REDIS_REST_TOKEN,
+  });
+```
+
 ### Pagination from `offset/limit` to `page/perPage`
 
 All pagination APIs now use `page` and `perPage` instead of `offset` and `limit`. This change provides a more intuitive pagination model that aligns with common web pagination patterns.
@@ -50,6 +70,16 @@ To migrate, rename the method and update pagination parameters. You can now use
 + });
 ```
 
+:::tip[Codemod]
+
+You can use Mastra's codemod CLI to update your code automatically:
+
+```shell
+npx @mastra/codemod@beta v1/storage-get-messages-paginated .
+```
+
+:::
+
 ### `getThreadsByResourceId` to `listThreadsByResourceId`
 
 The `getThreadsByResourceId()` method has been renamed to `listThreadsByResourceId()`. This change aligns with the convention that `list*` methods return collections.
@@ -65,6 +95,16 @@ To migrate, rename the method call and update pagination parameters.
   });
 ```
 
+:::tip[Codemod]
+
+You can use Mastra's codemod CLI to update your code automatically:
+
+```shell
+npx @mastra/codemod@beta v1/storage-get-threads-by-resource .
+```
+
+:::
+
 ### `getWorkflowRuns` to `listWorkflowRuns`
 
 The `getWorkflowRuns()` method has been renamed to `listWorkflowRuns()`. This change aligns with the convention that `list*` methods return collections.
@@ -81,6 +121,16 @@ To migrate, rename the method call and update pagination parameters.
   });
 ```
 
+:::tip[Codemod]
+
+You can use Mastra's codemod CLI to update your code automatically:
+
+```shell
+npx @mastra/codemod@beta v1/storage-list-workflow-runs .
+```
+
+:::
+
 ### `getMessagesById` to `listMessagesById`
 
 The `getMessagesById()` method has been renamed to `listMessagesById()`. This change aligns with the convention that `list*` methods return collections.
@@ -94,6 +144,16 @@ To migrate, rename the method call.
   });
 ```
 
+:::tip[Codemod]
+
+You can use Mastra's codemod CLI to update your code automatically:
+
+```shell
+npx @mastra/codemod@beta v1/storage-list-messages-by-id .
+```
+
+:::
+
 ### Storage `getMessages` and `saveMessages` signatures
 
 The `getMessages()` and `saveMessages()` methods have changed signatures and return types. Format overloads have been removed, and the methods now always work with `MastraDBMessage`. This change simplifies the API by removing format variations.
@@ -169,6 +229,16 @@ To migrate, pass the connection string as an object property.
 + });
 ```
 
+:::tip[Codemod]
+
+You can use Mastra's codemod CLI to update your code automatically:
+
+```shell
+npx @mastra/codemod@beta v1/vector-pg-constructor .
+```
+
+:::
+
 ### PGVector `defineIndex` to `buildIndex`
 
 The `defineIndex()` method has been removed in favor of `buildIndex()`. This change provides clearer naming for the index building operation.
@@ -198,6 +268,16 @@ To migrate, rename the parameter.
   });
 ```
 
+:::tip[Codemod]
+
+You can use Mastra's codemod CLI to update your code automatically:
+
+```shell
+npx @mastra/codemod@beta v1/storage-postgres-schema-name .
+```
+
+:::
+
 ### Score storage methods to `listScoresBy*` pattern
 
 Score storage APIs have been renamed to follow the `listScoresBy*` pattern. This change provides consistency with the broader API naming conventions.