npm - @assistant-ui/mcp-docs-server - Versions diffs - 0.1.6 → 0.1.8 - Mend

@assistant-ui/mcp-docs-server 0.1.6 → 0.1.8

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 (47) hide show

package/.docs/organized/code-examples/with-ai-sdk-v5.md +15 -13
package/.docs/organized/code-examples/with-cloud.md +19 -25
package/.docs/organized/code-examples/with-external-store.md +9 -7
package/.docs/organized/code-examples/with-ffmpeg.md +21 -21
package/.docs/organized/code-examples/with-langgraph.md +72 -46
package/.docs/organized/code-examples/with-parent-id-grouping.md +9 -7
package/.docs/organized/code-examples/with-react-hook-form.md +19 -21
package/.docs/raw/docs/api-reference/integrations/react-data-stream.mdx +194 -0
package/.docs/raw/docs/api-reference/overview.mdx +7 -4
package/.docs/raw/docs/api-reference/primitives/Composer.mdx +31 -0
package/.docs/raw/docs/api-reference/primitives/Message.mdx +108 -3
package/.docs/raw/docs/api-reference/primitives/Thread.mdx +59 -0
package/.docs/raw/docs/api-reference/primitives/ThreadList.mdx +128 -0
package/.docs/raw/docs/api-reference/primitives/ThreadListItem.mdx +160 -0
package/.docs/raw/docs/api-reference/runtimes/AssistantRuntime.mdx +0 -11
package/.docs/raw/docs/api-reference/runtimes/ComposerRuntime.mdx +3 -3
package/.docs/raw/docs/copilots/assistant-frame.mdx +397 -0
package/.docs/raw/docs/getting-started.mdx +53 -52
package/.docs/raw/docs/guides/Attachments.mdx +7 -115
package/.docs/raw/docs/guides/ToolUI.mdx +3 -3
package/.docs/raw/docs/guides/Tools.mdx +152 -92
package/.docs/raw/docs/guides/context-api.mdx +574 -0
package/.docs/raw/docs/migrations/v0-12.mdx +125 -0
package/.docs/raw/docs/runtimes/ai-sdk/use-chat.mdx +134 -55
package/.docs/raw/docs/runtimes/ai-sdk/v4-legacy.mdx +182 -0
package/.docs/raw/docs/runtimes/custom/local.mdx +16 -3
package/.docs/raw/docs/runtimes/data-stream.mdx +287 -0
package/.docs/raw/docs/runtimes/langgraph/index.mdx +0 -1
package/.docs/raw/docs/runtimes/langserve.mdx +9 -11
package/.docs/raw/docs/runtimes/pick-a-runtime.mdx +5 -0
package/.docs/raw/docs/ui/ThreadList.mdx +54 -16
package/dist/{chunk-L4K23SWI.js → chunk-NVNFQ5ZO.js} +4 -1
package/dist/index.js +1 -1
package/dist/prepare-docs/prepare.js +1 -1
package/dist/stdio.js +1 -1
package/package.json +7 -7
package/.docs/organized/code-examples/local-ollama.md +0 -1135
package/.docs/organized/code-examples/search-agent-for-e-commerce.md +0 -1721
package/.docs/organized/code-examples/with-ai-sdk.md +0 -1082
package/.docs/organized/code-examples/with-openai-assistants.md +0 -1175
package/.docs/raw/docs/concepts/architecture.mdx +0 -19
package/.docs/raw/docs/concepts/runtime-layer.mdx +0 -163
package/.docs/raw/docs/concepts/why.mdx +0 -9
package/.docs/raw/docs/runtimes/ai-sdk/rsc.mdx +0 -226
package/.docs/raw/docs/runtimes/ai-sdk/use-assistant-hook.mdx +0 -195
package/.docs/raw/docs/runtimes/ai-sdk/use-chat-hook.mdx +0 -138
package/.docs/raw/docs/runtimes/ai-sdk/use-chat-v5.mdx +0 -212

package/.docs/raw/docs/runtimes/ai-sdk/use-chat.mdx CHANGED Viewed

@@ -1,11 +1,13 @@
 ---
-title: useChatRuntime
+title: AI SDK v5
 ---
+import { Callout } from "fumadocs-ui/components/callout";
 ## Overview
-Integration with the Vercel AI SDK UI's `useChat` hook.
-It allows integration with OpenAI, Anthropic, Mistral, Perplexity, AWS Bedrock, Azure, Google Gemini, Hugging Face, Fireworks, Cohere, LangChain, Replicate, Ollama, and more.
+Integration with the Vercel AI SDK v5 using the new `useChatRuntime` hook from `@assistant-ui/react-ai-sdk`.
+This provides a streamlined way to integrate AI SDK v5 features including the new streamText API and improved TypeScript support.
 ## Getting Started
@@ -23,7 +25,7 @@ cd my-app
   </Step>
   <Step>
-### Install Vercel AI SDK and `@assistant-ui/react`
+### Install AI SDK v5 and `@assistant-ui/react`
 ```sh npm2yarn
 npm install @assistant-ui/react @assistant-ui/react-ai-sdk ai @ai-sdk/openai
@@ -38,99 +40,176 @@ npm install @assistant-ui/react @assistant-ui/react-ai-sdk ai @ai-sdk/openai
 ```tsx
 import { openai } from "@ai-sdk/openai";
-import { convertToCoreMessages, streamText } from "ai";
+import { streamText, UIMessage, convertToModelMessages, tool } from "ai";
+import { frontendTools } from "@assistant-ui/assistant-stream/ai-sdk";
+import { z } from "zod";
+// Allow streaming responses up to 30 seconds
 export const maxDuration = 30;
 export async function POST(req: Request) {
-  const { messages } = await req.json();
+  const {
+    messages,
+    system,
+    tools,
+  }: {
+    messages: UIMessage[];
+    system?: string; // System message forwarded from AssistantChatTransport
+    tools?: any; // Frontend tools forwarded from AssistantChatTransport
+  } = await req.json();
   const result = streamText({
     model: openai("gpt-4o"),
-    messages: convertToCoreMessages(messages),
+    system, // Use the system message from the frontend if provided
+    messages: convertToModelMessages(messages),
+    tools: {
+      // Wrap frontend tools with frontendTools helper
+      ...frontendTools(tools),
+      // Backend tools
+      get_current_weather: tool({
+        description: "Get the current weather",
+        inputSchema: z.object({
+          city: z.string(),
+        }),
+        execute: async ({ city }) => {
+          return `The weather in ${city} is sunny`;
+        },
+      }),
+    },
   });
-  return result.toDataStreamResponse();
+  return result.toUIMessageStreamResponse();
 }
 ```
   </Step>
   <Step>
-### Define a `MyRuntimeProvider` component
+### Wrap your app with `AssistantRuntimeProvider` using `useChatRuntime`
-`@/app/MyRuntimeProvider.tsx`
+`@/app/page.tsx`
 ```tsx
 "use client";
-import { useChat } from "@ai-sdk/react";
+import { Thread } from "@/components/assistant-ui/thread";
 import { AssistantRuntimeProvider } from "@assistant-ui/react";
 import { useChatRuntime } from "@assistant-ui/react-ai-sdk";
-export function MyRuntimeProvider({
-  children,
-}: Readonly<{
-  children: React.ReactNode;
-}>) {
-  const runtime = useChatRuntime({
-    api: "/api/chat",
-  });
+export default function Home() {
+  const runtime = useChatRuntime();
   return (
     <AssistantRuntimeProvider runtime={runtime}>
-      {children}
+      <div className="h-full">
+        <Thread />
+      </div>
     </AssistantRuntimeProvider>
   );
 }
 ```
   </Step>
-  <Step>
+</Steps>
-### Wrap your app in `MyRuntimeProvider`
+## API Reference
-`@/app/layout.tsx`
+### useChatRuntime
-```tsx {1,11,17}
-import { MyRuntimeProvider } from '@/app/MyRuntimeProvider';
+Creates a runtime directly with AI SDK v5's `useChat` hook integration.
-...
+```tsx
+import { useChatRuntime } from "@assistant-ui/react-ai-sdk";
-export default function RootLayout({
-  children,
-}: Readonly<{
-  children: React.ReactNode;
-}>) {
-  return (
-    <MyRuntimeProvider>
-      <html lang="en">
-        <body className={inter.className}>
-          {children}
-        </body>
-      </html>
-    </MyRuntimeProvider>
-  )
-}
+const runtime = useChatRuntime({
+  api: "/api/chat",
+  // All standard useChat options are supported
+});
 ```
-  </Step>
-</Steps>
+<Callout type="info">
+  By default, `useChatRuntime` uses `AssistantChatTransport` which automatically
+  forwards system messages and frontend tools to your backend API. This enables
+  your backend to receive the full context from the Assistant UI.
+</Callout>
-## Accessing AI SDK Messages
+### Custom Transport Configuration
-You can use the `getExternalStoreMessages` utility to convert `ThreadMessage`s back to `Message`s from AI SDK.
+If you need to customize the transport configuration:
 ```tsx
-const MyAssistantMessage = () => {
-  const aiSDKMessages = useMessage((m) => getExternalStoreMessages(m));
-  // ...
-};
-const WeatherToolUI = makeAssistantToolUI({
-  render: () => {
-    const aiSDKMessage = useMessagePart((p) => getExternalStoreMessages(p)[0]);
-    // ...
-  },
+import { DefaultChatTransport } from "ai";
+import { AssistantChatTransport } from "@assistant-ui/react-ai-sdk";
+import { useChatRuntime } from "@assistant-ui/react-ai-sdk";
+// Example 1: Custom API URL while keeping system/tools forwarding
+const runtime = useChatRuntime({
+  transport: new AssistantChatTransport({
+    api: "/my-custom-api/chat", // Custom API URL with forwarding
+  }),
+});
+// Example 2: Disable system/tools forwarding
+const runtime = useChatRuntime({
+  api: "/api/chat",
+  transport: new DefaultChatTransport(), // Standard AI SDK transport without forwarding
 });
 ```
+<Callout type="warning">
+  When customizing the API URL, you must explicitly use `AssistantChatTransport`
+  if you want to keep frontend system messages and tools forwarding. Simply
+  passing `api` to `useChatRuntime` will use the default transport
+  configuration.
+</Callout>
+#### Transport Options
+- **`AssistantChatTransport`** (default): Automatically forwards system messages and frontend tools from the Assistant UI context to your backend
+- **`DefaultChatTransport`**: Standard AI SDK transport without automatic forwarding
+### Using Frontend Tools with `frontendTools`
+When using `AssistantChatTransport`, frontend tools are forwarded to your backend. Use the `frontendTools` helper to properly integrate them:
+```tsx
+import { frontendTools } from "@assistant-ui/assistant-stream/ai-sdk";
+export async function POST(req: Request) {
+  const { messages, system, tools } = await req.json();
+  const result = streamText({
+    model: openai("gpt-4o"),
+    system,
+    messages: convertToModelMessages(messages),
+    tools: {
+      // Wrap frontend tools with the helper
+      ...frontendTools(tools),
+      // Your backend tools
+      myBackendTool: tool({
+        // ...
+      }),
+    },
+  });
+  return result.toUIMessageStreamResponse();
+}
+```
+The `frontendTools` helper converts frontend tool definitions to the AI SDK format and ensures they are properly handled by the streaming response.
+### useAISDKRuntime (Advanced)
+For advanced use cases where you need direct access to the `useChat` hook:
+```tsx
+import { useChat } from "@ai-sdk/react";
+import { useAISDKRuntime } from "@assistant-ui/react-ai-sdk";
+const chat = useChat();
+const runtime = useAISDKRuntime(chat);
+```
+## Example
+For a complete example, check out the [AI SDK v5 example](https://github.com/assistant-ui/assistant-ui/tree/main/examples/with-ai-sdk-v5) in our repository.

package/.docs/raw/docs/runtimes/ai-sdk/v4-legacy.mdx ADDED Viewed

@@ -0,0 +1,182 @@
+---
+title: AI SDK v4 (Legacy)
+---
+import { Callout } from "fumadocs-ui/components/callout";
+## Overview
+If you're using AI SDK v4 (legacy), you can integrate with assistant-ui using the `@assistant-ui/react-data-stream` package and its `useDataStreamRuntime` hook. This provides a compatible runtime that works with AI SDK v4's streaming responses.
+<Callout type="warning">
+  AI SDK v4 is now considered legacy. We recommend upgrading to [AI SDK
+  v5](/docs/runtimes/ai-sdk/use-chat) for improved features and better
+  TypeScript support. This documentation is provided for projects that haven't
+  migrated yet.
+</Callout>
+## Getting Started
+import { Steps, Step } from "fumadocs-ui/components/steps";
+### Option 1: Using @assistant-ui/react-data-stream (Recommended)
+<Steps>
+  <Step>
+  ### Install the required packages
+Install `@assistant-ui/react-data-stream` alongside assistant-ui and AI SDK v4:
+```sh npm2yarn
+npm install @assistant-ui/react @assistant-ui/react-data-stream ai@^4
+```
+  </Step>
+  <Step>
+### Setup your backend route
+Create an API route that uses AI SDK v4's streaming capabilities:
+`@/app/api/chat/route.ts`
+```tsx
+import { streamText } from "ai";
+import { openai } from "@ai-sdk/openai";
+export async function POST(req: Request) {
+  const { messages } = await req.json();
+  const result = streamText({
+    model: openai("gpt-4"),
+    messages,
+  });
+  return result.toDataStreamResponse();
+}
+```
+  </Step>
+  <Step>
+### Use `useDataStreamRuntime` in your component
+`@/app/page.tsx`
+```tsx
+"use client";
+import { Thread } from "@assistant-ui/react";
+import { AssistantRuntimeProvider } from "@assistant-ui/react";
+import { useDataStreamRuntime } from "@assistant-ui/react-data-stream";
+export default function Home() {
+  const runtime = useDataStreamRuntime({
+    api: "/api/chat",
+  });
+  return (
+    <AssistantRuntimeProvider runtime={runtime}>
+      <div className="h-full">
+        <Thread />
+      </div>
+    </AssistantRuntimeProvider>
+  );
+}
+```
+  </Step>
+</Steps>
+### Option 2: Using @assistant-ui/react-ai-sdk v0.1.10 (Legacy)
+Alternatively, you can use the older version of the AI SDK integration package, though this version is no longer actively maintained:
+```sh npm2yarn
+npm install @assistant-ui/react @assistant-ui/react-ai-sdk@0.1.10 ai@^4
+```
+<Callout type="warning">
+  Version 0.1.10 of `@assistant-ui/react-ai-sdk` is no longer actively
+  maintained. We recommend using the `@assistant-ui/react-data-stream` approach
+  or upgrading to AI SDK v5 for continued support.
+</Callout>
+With this legacy version, you would use the `useVercelUseChatRuntime` hook:
+```tsx
+"use client";
+import { useChat } from "ai/react";
+import { Thread } from "@assistant-ui/react";
+import { AssistantRuntimeProvider } from "@assistant-ui/react";
+import { useVercelUseChatRuntime } from "@assistant-ui/react-ai-sdk";
+export default function Home() {
+  const chat = useChat({
+    api: "/api/chat",
+  });
+  const runtime = useVercelUseChatRuntime(chat);
+  return (
+    <AssistantRuntimeProvider runtime={runtime}>
+      <div className="h-full">
+        <Thread />
+      </div>
+    </AssistantRuntimeProvider>
+  );
+}
+```
+## API Reference
+### `useDataStreamRuntime`
+The `useDataStreamRuntime` hook creates a runtime compatible with assistant-ui from AI SDK v4's streaming responses.
+```tsx
+import { useDataStreamRuntime } from "@assistant-ui/react-data-stream";
+const runtime = useDataStreamRuntime({
+  api: "/api/chat",
+  // Options similar to AI SDK v4's useChat
+  initialMessages: [],
+  onFinish: (message) => {
+    console.log("Message completed:", message);
+  },
+  onError: (error) => {
+    console.error("Chat error:", error);
+  },
+});
+```
+#### Options
+The `useDataStreamRuntime` hook accepts options similar to AI SDK v4's `useChat` hook:
+- **`api`**: The API endpoint for chat requests (required)
+- **`initialMessages`**: Initial messages to populate the chat
+- **`onFinish`**: Callback when a message completes streaming
+- **`onError`**: Callback for handling errors
+- **`headers`**: Additional headers to send with requests
+- **`body`**: Additional body parameters to send with requests
+<Callout type="info">
+  The `useDataStreamRuntime` API is designed to be familiar to developers
+  already using AI SDK v4's `useChat` hook, making migration straightforward.
+</Callout>
+## Migration to AI SDK v5
+When you're ready to upgrade to AI SDK v5:
+1. Replace `@assistant-ui/react-data-stream` with `@assistant-ui/react-ai-sdk`
+2. Update your backend to use AI SDK v5's `streamText` API
+3. Switch from `useDataStreamRuntime` to `useChatRuntime`
+4. Take advantage of improved TypeScript support and automatic system/tool forwarding
+See our [AI SDK v5 documentation](/docs/runtimes/ai-sdk/use-chat) for the complete migration guide.
+## Example
+For a working example with AI SDK v4, you can adapt the patterns from our [AI SDK examples](https://github.com/assistant-ui/assistant-ui/tree/main/examples) using the `@assistant-ui/react-data-stream` package instead of the v5 integration.

package/.docs/raw/docs/runtimes/custom/local.mdx CHANGED Viewed

@@ -414,6 +414,8 @@ import {
   type RemoteThreadListAdapter,
   type ThreadHistoryAdapter,
 } from "@assistant-ui/react";
+import { createAssistantStream } from "assistant-stream";
+import { useMemo } from "react";
 // Implement your custom adapter with proper message persistence
 const myDatabaseAdapter: RemoteThreadListAdapter = {
@@ -453,9 +455,16 @@ const myDatabaseAdapter: RemoteThreadListAdapter = {
   async generateTitle(remoteId, messages) {
     // Generate title from messages using your AI
-    const title = await generateTitle(messages);
-    await db.threads.update(remoteId, { title });
-    return new ReadableStream(); // Return empty stream
+    const newTitle = await generateTitle(messages);
+    // Persist the title in your DB
+    await db.threads.update(remoteId, { title: newTitle });
+    // IMPORTANT: Return an AssistantStream so the UI updates
+    return createAssistantStream((controller) => {
+      controller.appendText(newTitle);
+      controller.close();
+    });
   },
 };
@@ -528,6 +537,10 @@ export function MyRuntimeProvider({ children }) {
 }
 ```
+<Callout type="info" title="Returning a title from generateTitle">
+  The `generateTitle` method must return an <code>AssistantStream</code> containing the title text. The easiest, type-safe way is to use <code>createAssistantStream</code> and call <code>controller.appendText(newTitle)</code> followed by <code>controller.close()</code>. Returning a raw <code>ReadableStream</code> won't update the thread list UI.
+</Callout>
 #### Understanding the Architecture
 <Callout type="info">