@mastra/mcp-docs-server 1.1.4 → 1.1.5-alpha.0

package/.docs/reference/ai-sdk/chat-route.md

@@ -1,82 +0,0 @@
-# chatRoute()
-
-Creates a chat route handler for streaming agent conversations using the AI SDK format. This function registers an HTTP `POST` endpoint that accepts messages, executes an agent, and streams the response back to the client in AI SDK-compatible format. You have to use it inside a [custom API route](https://mastra.ai/docs/server/custom-api-routes).
-
-Use [`handleChatStream()`](https://mastra.ai/reference/ai-sdk/handle-chat-stream) if you need a framework-agnostic handler.
-
-## Usage example
-
-This example shows how to set up a chat route at the `/chat` endpoint that uses an agent with the ID `weatherAgent`.
-
-```typescript
-import { Mastra } from "@mastra/core";
-import { chatRoute } from "@mastra/ai-sdk";
-
-export const mastra = new Mastra({
-  server: {
-    apiRoutes: [
-      chatRoute({
-        path: "/chat",
-        agent: "weatherAgent",
-      }),
-    ],
-  },
-});
-```
-
-You can also use dynamic agent routing based on an `agentId`. The URL `/chat/weatherAgent` will resolve to the agent with the ID `weatherAgent`.
-
-```typescript
-import { Mastra } from "@mastra/core";
-import { chatRoute } from "@mastra/ai-sdk";
-
-export const mastra = new Mastra({
-  server: {
-    apiRoutes: [
-      chatRoute({
-        path: "/chat/:agentId",
-      }),
-    ],
-  },
-});
-```
-
-## Parameters
-
-**path:** (`string`): The route path (e.g., \`/chat\` or \`/chat/:agentId\`). Include \`:agentId\` for dynamic agent routing. (Default: `'/chat/:agentId'`)
-
-**agent?:** (`string`): The ID of the agent to use for this chat route. Required if the path doesn't include \`:agentId\`.
-
-**defaultOptions?:** (`AgentExecutionOptions`): Default options passed to agent execution. These can include instructions, memory configuration, maxSteps, and other execution settings.
-
-**sendStart?:** (`boolean`): Whether to send start events in the stream. (Default: `true`)
-
-**sendFinish?:** (`boolean`): Whether to send finish events in the stream. (Default: `true`)
-
-**sendReasoning?:** (`boolean`): Whether to include reasoning steps in the stream. (Default: `false`)
-
-**sendSources?:** (`boolean`): Whether to include source citations in the stream. (Default: `false`)
-
-## Additional configuration
-
-You can use [`prepareSendMessagesRequest`](https://ai-sdk.dev/docs/reference/ai-sdk-ui/use-chat#transport.default-chat-transport.prepare-send-messages-request) to customize the request sent to the chat route, for example to pass additional configuration to the agent:
-
-```typescript
-const { error, status, sendMessage, messages, regenerate, stop } = useChat({
-  transport: new DefaultChatTransport({
-    api: "http://localhost:4111/chat",
-    prepareSendMessagesRequest({ messages }) {
-      return {
-        body: {
-          messages,
-          // Pass memory config
-          memory: {
-            thread: "user-1",
-            resource: "user-1",
-          },
-        },
-      };
-    },
-  }),
-});
-```

package/.docs/reference/ai-sdk/handle-chat-stream.md

@@ -1,53 +0,0 @@
-# handleChatStream()
-
-Framework-agnostic handler for streaming agent chat in AI SDK-compatible format. Use this function directly when you need to handle chat streaming outside Hono or Mastra's own [apiRoutes](https://mastra.ai/docs/server/custom-api-routes) feature.
-
-`handleChatStream()` returns a `ReadableStream` that you can wrap with [`createUIMessageStreamResponse()`](https://ai-sdk.dev/docs/reference/ai-sdk-ui/create-ui-message-stream-response).
-
-Use [`chatRoute()`](https://mastra.ai/reference/ai-sdk/chat-route) if you want to create a chat route inside a Mastra server.
-
-## Usage example
-
-Next.js App Router example:
-
-```typescript
-import { handleChatStream } from '@mastra/ai-sdk';
-import { createUIMessageStreamResponse } from 'ai';
-import { mastra } from '@/src/mastra';
-
-export async function POST(req: Request) {
-  const params = await req.json();
-  const stream = await handleChatStream({
-    mastra,
-    agentId: 'weatherAgent',
-    params,
-  });
-  return createUIMessageStreamResponse({ stream });
-}
-```
-
-## Parameters
-
-**mastra:** (`Mastra`): The Mastra instance containing registered agents.
-
-**agentId:** (`string`): The ID of the agent to use for chat.
-
-**params:** (`ChatStreamHandlerParams`): Parameters for the chat stream, including messages and optional resume data.
-
-**params.messages:** (`UIMessage[]`): Array of messages in the conversation.
-
-**params.resumeData?:** (`Record<string, any>`): Data for resuming a suspended agent execution. Requires \`runId\` to be set.
-
-**params.runId?:** (`string`): The run ID. Required when \`resumeData\` is provided.
-
-**params.requestContext?:** (`RequestContext`): Request context to pass to the agent execution.
-
-**defaultOptions?:** (`AgentExecutionOptions`): Default options passed to agent execution. These are merged with params, with params taking precedence.
-
-**sendStart?:** (`boolean`): Whether to send start events in the stream. (Default: `true`)
-
-**sendFinish?:** (`boolean`): Whether to send finish events in the stream. (Default: `true`)
-
-**sendReasoning?:** (`boolean`): Whether to include reasoning steps in the stream. (Default: `false`)
-
-**sendSources?:** (`boolean`): Whether to include source citations in the stream. (Default: `false`)

package/.docs/reference/ai-sdk/handle-network-stream.md

@@ -1,37 +0,0 @@
-# handleNetworkStream()
-
-Framework-agnostic handler for streaming network execution in AI SDK-compatible format. Use this function directly when you need to handle network streaming outside Hono or Mastra's own [apiRoutes](https://mastra.ai/docs/server/custom-api-routes) feature.
-
-`handleNetworkStream()` returns a `ReadableStream` that you can wrap with [`createUIMessageStreamResponse()`](https://ai-sdk.dev/docs/reference/ai-sdk-ui/create-ui-message-stream-response).
-
-Use [`networkRoute()`](https://mastra.ai/reference/ai-sdk/network-route) if you want to create a network route inside a Mastra server.
-
-## Usage example
-
-Next.js App Router example:
-
-```typescript
-import { handleNetworkStream } from '@mastra/ai-sdk';
-import { createUIMessageStreamResponse } from 'ai';
-import { mastra } from '@/src/mastra';
-
-export async function POST(req: Request) {
-  const params = await req.json();
-  const stream = await handleNetworkStream({
-    mastra,
-    agentId: 'routingAgent',
-    params,
-  });
-  return createUIMessageStreamResponse({ stream });
-}
-```
-
-## Parameters
-
-**mastra:** (`Mastra`): The Mastra instance to use for agent lookup and execution.
-
-**agentId:** (`string`): The ID of the routing agent to execute as a network.
-
-**params:** (`NetworkStreamHandlerParams`): The request parameters containing messages and execution options. Includes \`messages\` (required) and any AgentExecutionOptions like \`memory\`, \`maxSteps\`, \`runId\`, etc.
-
-**defaultOptions?:** (`AgentExecutionOptions`): Default options passed to agent execution. These are merged with params, with params taking precedence.

package/.docs/reference/ai-sdk/handle-workflow-stream.md

@@ -1,55 +0,0 @@
-# handleWorkflowStream()
-
-Framework-agnostic handler for streaming workflow execution in AI SDK-compatible format. Use this function directly when you need to handle workflow streaming outside Hono or Mastra's own [apiRoutes](https://mastra.ai/docs/server/custom-api-routes) feature.
-
-`handleWorkflowStream()` returns a `ReadableStream` that you can wrap with [`createUIMessageStreamResponse()`](https://ai-sdk.dev/docs/reference/ai-sdk-ui/create-ui-message-stream-response).
-
-Use [`workflowRoute()`](https://mastra.ai/reference/ai-sdk/workflow-route) if you want to create a workflow route inside a Mastra server.
-
-> **Agent streaming in workflows:** When a workflow step pipes an agent's stream to the workflow writer (e.g., `await response.fullStream.pipeTo(writer)`), the agent's text chunks and tool calls are forwarded to the UI stream in real time, even when the agent runs inside workflow steps.
->
-> See [Workflow Streaming](https://mastra.ai/docs/streaming/workflow-streaming) for more details.
-
-## Usage example
-
-Next.js App Router example:
-
-```typescript
-import { handleWorkflowStream } from '@mastra/ai-sdk';
-import { createUIMessageStreamResponse } from 'ai';
-import { mastra } from '@/src/mastra';
-
-export async function POST(req: Request) {
-  const params = await req.json();
-  const stream = await handleWorkflowStream({
-    mastra,
-    workflowId: 'weatherWorkflow',
-    params,
-  });
-  return createUIMessageStreamResponse({ stream });
-}
-```
-
-## Parameters
-
-**mastra:** (`Mastra`): The Mastra instance containing registered workflows.
-
-**workflowId:** (`string`): The ID of the workflow to execute.
-
-**params:** (`WorkflowStreamHandlerParams`): Parameters for the workflow stream.
-
-**params.runId?:** (`string`): Optional run ID for the workflow execution.
-
-**params.resourceId?:** (`string`): Optional resource ID for the workflow run.
-
-**params.inputData?:** (`Record<string, any>`): Input data for starting a new workflow execution.
-
-**params.resumeData?:** (`Record<string, any>`): Data for resuming a suspended workflow execution.
-
-**params.requestContext?:** (`RequestContext`): Request context to pass to the workflow execution.
-
-**params.tracingOptions?:** (`TracingOptions`): Options for tracing and observability.
-
-**params.step?:** (`string`): Specific step to target in the workflow.
-
-**includeTextStreamParts?:** (`boolean`): Whether to include text stream parts in the output. (Default: `true`)

package/.docs/reference/ai-sdk/network-route.md

@@ -1,74 +0,0 @@
-# networkRoute()
-
-Creates a network route handler for streaming network execution using the AI SDK format. This function registers an HTTP `POST` endpoint that accepts messages, executes an agent network, and streams the response back to the client in AI SDK-compatible format. Agent networks allow a routing agent to delegate tasks to other agents. You have to use it inside a [custom API route](https://mastra.ai/docs/server/custom-api-routes).
-
-Use [`handleNetworkStream()`](https://mastra.ai/reference/ai-sdk/handle-network-stream) if you need a framework-agnostic handler.
-
-## Usage example
-
-This example shows how to set up a network route at the `/network` endpoint that uses an agent with the ID `weatherAgent`.
-
-```typescript
-import { Mastra } from "@mastra/core";
-import { networkRoute } from "@mastra/ai-sdk";
-
-export const mastra = new Mastra({
-  server: {
-    apiRoutes: [
-      networkRoute({
-        path: "/network",
-        agent: "weatherAgent",
-      }),
-    ],
-  },
-});
-```
-
-You can also use dynamic agent routing based on an `agentId`. The URL `/network/weatherAgent` will resolve to the agent with the ID `weatherAgent`.
-
-```typescript
-import { Mastra } from "@mastra/core";
-import { networkRoute } from "@mastra/ai-sdk";
-
-export const mastra = new Mastra({
-  server: {
-    apiRoutes: [
-      networkRoute({
-        path: "/network/:agentId",
-      }),
-    ],
-  },
-});
-```
-
-## Parameters
-
-**path:** (`string`): The route path (e.g., \`/network\` or \`/network/:agentId\`). Include \`:agentId\` for dynamic agent routing. (Default: `'/network/:agentId'`)
-
-**agent?:** (`string`): The ID of the routing agent to use for this network route. Required if the path doesn't include \`:agentId\`.
-
-**defaultOptions?:** (`AgentExecutionOptions`): Default options passed to agent execution. These can include instructions, memory configuration, maxSteps, and other execution settings.
-
-## Additional configuration
-
-You can use [`prepareSendMessagesRequest`](https://ai-sdk.dev/docs/reference/ai-sdk-ui/use-chat#transport.default-chat-transport.prepare-send-messages-request) to customize the request sent to the network route, for example to pass additional configuration to the agent:
-
-```typescript
-const { error, status, sendMessage, messages, regenerate, stop } = useChat({
-  transport: new DefaultChatTransport({
-    api: "http://localhost:4111/network",
-    prepareSendMessagesRequest({ messages }) {
-      return {
-        body: {
-          messages,
-          // Pass memory config
-          memory: {
-            thread: "user-1",
-            resource: "user-1",
-          },
-        },
-      };
-    },
-  }),
-});
-```

package/.docs/reference/ai-sdk/to-ai-sdk-stream.md

@@ -1,232 +0,0 @@
-# toAISdkStream()
-
-Converts Mastra streams (agent, network, or workflow) to AI SDK-compatible streams. Use this function when you need to manually transform Mastra streams for use with AI SDK's `createUIMessageStream()` and `createUIMessageStreamResponse()`.
-
-This is useful when building custom streaming endpoints outside Mastra's provided route helpers such as [`chatRoute()`](https://mastra.ai/reference/ai-sdk/chat-route) or [`workflowRoute()`](https://mastra.ai/reference/ai-sdk/workflow-route).
-
-## Usage example
-
-Next.js App Router example:
-
-```typescript
-import { mastra } from "../../mastra";
-import { createUIMessageStream, createUIMessageStreamResponse } from "ai";
-import { toAISdkStream } from "@mastra/ai-sdk";
-
-export async function POST(req: Request) {
-  const { messages } = await req.json();
-  const myAgent = mastra.getAgent("weatherAgent");
-  const stream = await myAgent.stream(messages);
-
-  const uiMessageStream = createUIMessageStream({
-    originalMessages: messages,
-    execute: async ({ writer }) => {
-      for await (const part of toAISdkStream(stream, { from: "agent" })) {
-        await writer.write(part);
-      }
-    },
-  });
-
-  return createUIMessageStreamResponse({
-    stream: uiMessageStream,
-  });
-}
-```
-
-> **Tip:** Pass `messages` to `originalMessages` in `createUIMessageStream()` to avoid duplicated assistant messages in the UI. See [Troubleshooting: Repeated Assistant Messages](https://ai-sdk.dev/docs/troubleshooting/repeated-assistant-messages) for details.
-
-## Parameters
-
-The first parameter is the Mastra stream to convert. It can be one of:
-
-- `MastraModelOutput` - An agent stream from `agent.stream()`
-- `MastraAgentNetworkStream` - A network stream from `agent.network()`
-- `MastraWorkflowStream` or `WorkflowRunOutput` - A workflow stream
-
-The second parameter is an options object:
-
-**from:** (`'agent' | 'network' | 'workflow'`): The type of Mastra stream being converted. (Default: `'agent'`)
-
-**lastMessageId?:** (`string`): (Agent only) The ID of the last message in the conversation.
-
-**sendStart?:** (`boolean`): (Agent only) Whether to send start events in the stream. (Default: `true`)
-
-**sendFinish?:** (`boolean`): (Agent only) Whether to send finish events in the stream. (Default: `true`)
-
-**sendReasoning?:** (`boolean`): (Agent only) Whether to include reasoning-delta chunks in the stream. Set to true to stream reasoning content from models that support extended thinking. (Default: `false`)
-
-**sendSources?:** (`boolean`): (Agent only) Whether to include source citations in the output. (Default: `false`)
-
-**includeTextStreamParts?:** (`boolean`): (Workflow only) Whether to include text stream parts in the output. (Default: `true`)
-
-**messageMetadata?:** (`(options: { part: UIMessageStreamPart }) => Record<string, unknown> | undefined`): (Agent only) A function that receives the current stream part and returns metadata to attach to start and finish chunks.
-
-**onError?:** (`(error: unknown) => string`): (Agent only) A function to handle errors during stream conversion. Receives the error and should return a string representation.
-
-## Examples
-
-### Converting a workflow stream
-
-```typescript
-import { mastra } from "../../mastra";
-import { createUIMessageStream, createUIMessageStreamResponse } from "ai";
-import { toAISdkStream } from "@mastra/ai-sdk";
-
-export async function POST(req: Request) {
-  const { input } = await req.json();
-  const workflow = mastra.getWorkflow("myWorkflow");
-  const run = workflow.createRun();
-  const stream = await run.stream({ inputData: input });
-
-  const uiMessageStream = createUIMessageStream({
-    execute: async ({ writer }) => {
-      for await (const part of toAISdkStream(stream, { from: "workflow" })) {
-        await writer.write(part);
-      }
-    },
-  });
-
-  return createUIMessageStreamResponse({
-    stream: uiMessageStream,
-  });
-}
-```
-
-### Converting a network stream
-
-```typescript
-import { mastra } from "../../mastra";
-import { createUIMessageStream, createUIMessageStreamResponse } from "ai";
-import { toAISdkStream } from "@mastra/ai-sdk";
-
-export async function POST(req: Request) {
-  const { messages } = await req.json();
-  const routingAgent = mastra.getAgent("routingAgent");
-  const stream = await routingAgent.network(messages);
-
-  const uiMessageStream = createUIMessageStream({
-    execute: async ({ writer }) => {
-      for await (const part of toAISdkStream(stream, { from: "network" })) {
-        await writer.write(part);
-      }
-    },
-  });
-
-  return createUIMessageStreamResponse({
-    stream: uiMessageStream,
-  });
-}
-```
-
-### Converting an agent stream with reasoning enabled
-
-```typescript
-import { mastra } from "../../mastra";
-import { createUIMessageStream, createUIMessageStreamResponse } from "ai";
-import { toAISdkStream } from "@mastra/ai-sdk";
-
-export async function POST(req: Request) {
-  const { messages } = await req.json();
-  const reasoningAgent = mastra.getAgent("reasoningAgent");
-  const stream = await reasoningAgent.stream(messages, {
-    providerOptions: {
-      openai: { reasoningEffort: "high" },
-    },
-  });
-
-  const uiMessageStream = createUIMessageStream({
-    originalMessages: messages,
-    execute: async ({ writer }) => {
-      for await (const part of toAISdkStream(stream, {
-        from: "agent",
-        sendReasoning: true,
-      })) {
-        await writer.write(part);
-      }
-    },
-  });
-
-  return createUIMessageStreamResponse({
-    stream: uiMessageStream,
-  });
-}
-```
-
-### Using messageMetadata
-
-```typescript
-import { mastra } from "../../mastra";
-import { createUIMessageStream, createUIMessageStreamResponse } from "ai";
-import { toAISdkStream } from "@mastra/ai-sdk";
-
-export async function POST(req: Request) {
-  const { messages } = await req.json();
-  const myAgent = mastra.getAgent("weatherAgent");
-  const stream = await myAgent.stream(messages);
-
-  const uiMessageStream = createUIMessageStream({
-    originalMessages: messages,
-    execute: async ({ writer }) => {
-      for await (const part of toAISdkStream(stream, {
-        from: "agent",
-        messageMetadata: ({ part }) => ({
-          timestamp: Date.now(),
-          partType: part.type,
-        }),
-      })) {
-        await writer.write(part);
-      }
-    },
-  });
-
-  return createUIMessageStreamResponse({
-    stream: uiMessageStream,
-  });
-}
-```
-
-### Client-side stream transformation
-
-If you're using the Mastra client SDK (`@mastra/client-js`) on the client side and want to convert streams to AI SDK format:
-
-```typescript
-import { MastraClient } from "@mastra/client-js";
-import { createUIMessageStream } from "ai";
-import { toAISdkStream } from "@mastra/ai-sdk";
-import type { ChunkType, MastraModelOutput } from "@mastra/core/stream";
-
-const client = new MastraClient({
-  baseUrl: "http://localhost:4111",
-});
-
-const agent = client.getAgent("weatherAgent");
-const response = await agent.stream("What is the weather in Tokyo?");
-
-// Convert the client SDK stream to a ReadableStream<ChunkType>
-const chunkStream = new ReadableStream<ChunkType>({
-  async start(controller) {
-    await response.processDataStream({
-      onChunk: async (chunk) => {
-        controller.enqueue(chunk);
-      },
-    });
-    controller.close();
-  },
-});
-
-// Transform to AI SDK format
-const uiMessageStream = createUIMessageStream({
-  execute: async ({ writer }) => {
-    for await (const part of toAISdkStream(
-      chunkStream as unknown as MastraModelOutput,
-      { from: "agent" }
-    )) {
-      await writer.write(part);
-    }
-  },
-});
-
-for await (const part of uiMessageStream) {
-  console.log(part);
-}
-```

package/.docs/reference/ai-sdk/to-ai-sdk-v4-messages.md

@@ -1,79 +0,0 @@
-# toAISdkV4Messages()
-
-Converts messages from various input formats to AI SDK V4 UI message format. This function accepts messages in multiple formats (strings, AI SDK V4/V5 messages, Mastra DB messages, etc.) and normalizes them to the AI SDK V4 `UIMessage` format, which is suitable for use with AI SDK UI components like `useChat()`.
-
-## Usage example
-
-```typescript
-import { toAISdkV4Messages } from "@mastra/ai-sdk";
-import { useChat } from "ai/react"; // AI SDK V4
-
-// Stored messages from your database, memory or API
-const storedMessages = [
-  { id: "1", role: "user", parts: [{ type: "text", text: "Hello" }] },
-  { id: "2", role: "assistant", parts: [{ type: "text", text: "Hi there!" }] }
-];
-
-export default function Chat() {
-  const { messages } = useChat({
-    initialMessages: toAISdkV4Messages(storedMessages)
-  });
-
-  return (
-    <div>
-      {messages.map((message) => (
-        <div key={message.id}>
-          {message.role}: {message.content}
-        </div>
-      ))}
-    </div>
-  );
-}
-```
-
-## Parameters
-
-**messages:** (`MessageListInput`): Messages to convert. Can be a string, array of strings, a single message object, or an array of message objects in any supported format.
-
-## Returns
-
-Returns an array of AI SDK V4 `UIMessage` objects with the following structure:
-
-**id:** (`string`): Unique message identifier.
-
-**role:** (`'user' | 'assistant' | 'system'`): The role of the message sender.
-
-**content:** (`string`): Text content of the message.
-
-**parts:** (`UIMessagePart[]`): Array of UI parts including text, tool-invocation, file, reasoning, source, and step markers.
-
-**createdAt:** (`Date`): Message creation timestamp.
-
-**toolInvocations?:** (`ToolInvocation[]`): Array of tool invocations for assistant messages.
-
-**experimental\_attachments?:** (`Attachment[]`): File attachments on the message.
-
-**metadata?:** (`Record<string, unknown>`): Custom metadata attached to the message.
-
-## Examples
-
-### Converting simple text messages
-
-```typescript
-import { toAISdkV4Messages } from "@mastra/ai-sdk";
-
-const messages = toAISdkV4Messages(["Hello", "How can I help you today?"]);
-// Returns array of UIMessage objects with user role and content string
-```
-
-### Loading messages with Mastra client
-
-```typescript
-import { MastraClient } from "@mastra/client-js";
-import { toAISdkV4Messages } from "@mastra/ai-sdk";
-
-const client = new MastraClient();
-
-const { messages } = await client.listThreadMessages("thread-id", { agentId: "myAgent" });
-const uiMessages = toAISdkV4Messages(messages);
-```

package/.docs/reference/ai-sdk/to-ai-sdk-v5-messages.md

@@ -1,73 +0,0 @@
-# toAISdkV5Messages()
-
-Converts messages from various input formats to AI SDK V5 (and later) UI message format. This function accepts messages in multiple formats (strings, AI SDK V4/V5 messages, Mastra DB messages, etc.) and normalizes them to the AI SDK V5+ `UIMessage` format, which is suitable for use with AI SDK UI components like `useChat()`.
-
-## Usage example
-
-```typescript
-import { toAISdkV5Messages } from "@mastra/ai-sdk/ui";
-import { useChat } from "ai/react";
-
-// Stored messages from your database, memory or API
-const storedMessages = [
-  { id: "1", role: "user", content: "Hello", parts: [{ type: "text", text: "Hello" }] },
-  { id: "2", role: "assistant", content: "Hi there!", parts: [{ type: "text", text: "Hi there!" }] }
-];
-
-export default function Chat() {
-  const { messages } = useChat({
-    initialMessages: toAISdkV5Messages(storedMessages)
-  });
-
-  return (
-    <div>
-      {messages.map((message) => (
-        <div key={message.id}>
-          {message.role}: {message.parts.map(part =>
-            part.type === "text" ? part.text : null
-          )}
-        </div>
-      ))}
-    </div>
-  );
-}
-```
-
-## Parameters
-
-**messages:** (`MessageListInput`): Messages to convert. Can be a string, array of strings, a single message object, or an array of message objects in any supported format.
-
-## Returns
-
-Returns an array of AI SDK V5+ `UIMessage` objects with the following structure:
-
-**id:** (`string`): Unique message identifier.
-
-**role:** (`'user' | 'assistant' | 'system'`): The role of the message sender.
-
-**parts:** (`UIMessagePart[]`): Array of UI parts including text, tool results, files, reasoning, sources, and step markers.
-
-**metadata?:** (`Record<string, unknown>`): Optional metadata including createdAt, threadId, resourceId, and custom fields.
-
-## Examples
-
-### Converting simple text messages
-
-```typescript
-import { toAISdkV5Messages } from "@mastra/ai-sdk/ui";
-
-const messages = toAISdkV5Messages(["Hello", "How can I help you today?"]);
-// Returns array of UIMessage objects with user role
-```
-
-### Loading messages with Mastra client
-
-```typescript
-import { MastraClient } from "@mastra/client-js";
-import { toAISdkV5Messages } from "@mastra/ai-sdk/ui";
-
-const client = new MastraClient();
-
-const { messages } = await client.listThreadMessages("thread-id", { agentId: "myAgent" });
-const uiMessages = toAISdkV5Messages(messages);
-```