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

package/.docs/raw/docs/migrations/v0-7.mdx

@@ -1,188 +0,0 @@
----
-title: Migration to v0.7
----
-
-import { Callout } from "fumadocs-ui/components/callout";
-
-This guide serves as a reference for users facing breaking changes during upgrade to v0.7. You do not need to read this guide to upgrade to v0.7.
-
-All breaking changes in v0.7 are renames or removals of existing APIs. Therefore, all breaking changes should cause a Typescript error, so you can simply check for errors after upgrading.
-
-### Component Property Types moved to `Component.Props`
-
-Component property types are now neatly organized under the component itself.
-
-```diff
--import { ThreadPrimitiveMessagesProps } from "@assistant-ui/react";
-+import { ThreadPrimitive } from "@assistant-ui/react";
-
--type Props = ThreadPrimitiveMessagesProps;
-+type Props = ThreadPrimitive.Messages.Props;
-```
-
-## Context API simplifications
-
-### `useThreadContext`, `useMessageContext`, ... replaced with direct imports of stores
-
-`useAssistantContext`, `useThreadContext`, `useMessageContext` and `useMessagePartContext` have been removed in favor of direct exports from `@assistant-ui/react`;
-
-```diff
--const { useThread } = useThreadContext();
-
-+import { useThread } from "@assistant-ui/react";
-```
-
-# Assistant Context API simplifications
-
-### `useAssistantActions` replaced with `useAssistantRuntime`
-
-`useAssistantActions` has been removed in favor of `useAssistantRuntime`.
-
-```diff
--const switchToNewThread = useAssistantActions(a => a.switchToNewThread);
-+const runtime = useAssistantRuntime();
-+runtime.switchToNewThread();
-```
-
-### `switchToThread(null)` replaced with `switchToNewThread()`
-
-```diff
--useThreadRuntime().switchToThread(null);
-+useThreadRuntime().switchToNewThread();
-```
-
-### useSwtichToNewThread() moved to useAssistantRuntime().switchToNewThread()
-
-```diff
--useSwitchToNewThread();
-+const runtime = useAssistantRuntime()
-+runtime.switchToNewThread();
-```
-
-### `runtime.subscribe` removed, `subscribeToMainThread` removed
-
-Previously, you needed to subscribe to the runtime to receive updates whenever the main thread changed and resubscribe to the main thread whenever you switched to a new thread. The `runtime.thread` value now always refers to the current main thread, there is no need to subscribe to the runtime anymore.
-
-## ThreadRuntime API simplifications
-
-### `useAppendMessage` moved to `useThreadRuntime().append()`
-
-```diff
--const append = useAppendMessage();
-+const threadRuntime = useThreadRuntime();
--append("hello world");
-+threadRuntime.append("hello world");
-```
-
-### `useThreadActions` replaced with `useThreadRuntime`
-
-`useThreadActions` has been removed in favor of `useThreadRuntime`.
-
-```diff
--const reload = useThreadActions(a => a.reload);
-+const threadRuntime = useThreadRuntime();
-+threadRuntime.reload();
-```
-
-### State values moved to `threadRuntime.getState()`
-
-In order to make it clear that accessing the state only provides a snapshot of the current state and will not cause a re-render on changes, the state values of `useThreadRuntime` have been moved to `threadRuntime.getState()`.
-
-```diff
--const isRunning = useThreadRuntime().isRunning; // anti-pattern, your code will not update on change
-+const isRunning = useThread(t => t.isRunning);
-```
-
-### `useThreadStore` replaced with `useThreadRuntime().getState()`
-
-`useThreadStore` has been removed in favor of `useThreadRuntime().getState()`.
-
-### `threadRuntime.getBranches()` replaced with `useThreadRuntime().getMessageByIndex(idx).getState().branchNumber/Count`
-
-The branch IDs are an internal implementation detail. The new Message Runtime API provides `branchNumber` and `branchCount` state fields that can be used instead.
-
-### New Message Runtime API replaces several methods from `useThreadRuntime`
-
-A few methods from `useThreadRuntime` have been moved to `useMessageRuntime()`.
-
-- `threadRuntime.switchToBranch()` has been removed in favor of `useThreadRuntime().getMessageByIndex(idx).switchToBranch()`.
-- `threadRuntime.addToolResult()` has been removed in favor of `useThreadRuntime().getMessageByIndex(idx).getMessagePartByToolCallId(toolCallId).addToolResult()`.
-- `threadRuntime.speak()` has been removed in favor of `useThreadRuntime().getMessageByIndex(idx).speak()`.
-- `threadRuntime.submitFeedback()` has been removed in favor of `useThreadRuntime().getMessageByIndex(idx).submitFeedback()`.
-- `threadRuntime.getEditComposer()` has been removed in favor of `useThreadRuntime().getMessageById(id).getMessageByIndex(idx).composer`.
-- `threadRuntime.beginEdit()` has been removed in favor of `useThreadRuntime().getMessageById(id).getMessageByIndex(idx).composer.beginEdit()`.
-
-## Composer Runtime API simplifications
-
-### Methods inside `useComposer` moved to `useComposerRuntime`
-
-`useComposer()` used to provide several methods such as `setText`, `addAttachment`, `send`, `edit`, `cancel`, ...
-These methods have been moved to `useComposerRuntime()`.
-
-### `useComposerStore` replaced with `useComposerRuntime().getState()`
-
-`useComposerStore` has been removed in favor of `useComposerRuntime().getState()`.
-
-### `value` `setValue` replaced with `text` `setText`
-
-```diff
--useComposer(c => c.value);
-+useComposer(c => c.text);
-```
-
-### `focus`, `onFocus` methods removed
-
-These methods have been removed.
-
-## Message Context API simplifications
-
-### Flattened context values `useMessage().message` -> `useMessage()`
-
-`MessageState` is now itself a message, so you no longer need to access the nested `useMessage().message` field.
-
-```diff
--useMessage(m => m.message.content);
-+useMessage(m => m.content);
-```
-
-### `useMessageStore` replaced with `useMessageRuntime().getState()`
-
-`useMessageStore` has been removed in favor of `useMessageRuntime().getState()`.
-
-## Message part Context API simplifications
-
-### Flattened context values `useMessagePart().part` -> `useMessagePart()`
-
-`MessagePartState` is now itself a message part, so you no longer need to access the nested `useMessagePart().part` field.
-
-```diff
--useMessagePart(c => c.part.type);
-+useMessagePart(c => c.type);
-```
-
-This also applies to tool UI render functions:
-
-```diff
- makeAssistantToolUI({
-   ...
--  render: ({ part: { args } }) => <>{args}</>,
-+  render: ({ args }) => <>{args}</>,
- });
-```
-
-## Attachment Context API simplifications
-
-### Flattened context values `useAttachment().attachment` -> `useAttachment()`
-
-`AttachmentState` is now itself an attachment, so you no longer need to access the nested `useAttachment().attachment` field.
-
-```diff
--useAttachment(a => a.attachment.type);
-+useAttachment(a => a.type);
-```
-
-## Roundtrips renamed to steps
-
-`AssistantMessage.roundtrips` was renamed to `AssistantMessage.metadata.steps`.
-
-Edge runtime's `maxToolRoundtrips` was replaced with `maxSteps` (which is `maxToolRoundtrips` + 1; if you had `maxToolRoundtrips` at 2, set `maxSteps` to 3).

package/.docs/raw/docs/migrations/v0-8.mdx

@@ -1,160 +0,0 @@
----
-title: Migration to v0.8
----
-
-## Styled Components moved to @assistant-ui/react-ui
-
-All styled components (Thread, ThreadList, AssistantModal, makeMarkdownText, etc.) have been moved to a new package, `@assistant-ui/react-ui`.
-
-To migrate, use the migration codemod:
-
-```sh
-# IMPORTANT: make sure to commit all changes to git / creating a backup before running the codemod
-npx assistant-ui upgrade
-```
-
-## Vercel AI SDK RSC requires additional setup
-
-Built-in RSC support in assistant-ui has been removed, so an additional setup step is required.
-The RSC runtime now requires additional setup to display React Server Components.
-
-```ts
-import { RSCDisplay } from "@assistant-ui/react-ai-sdk";
-
-// if you are using the default Thread component
-// add RSCDisplay to assistantMessage.components.Text
-<Thread assistantMessage={{ components: { Text: RSCDisplay } }} />
-
-
-// if you are using unstyled primitives, update MyThread.tsx
-<MessagePrimitive.Parts components={{ Text: RSCDisplay }} />
-```
-
-## Migrate away from UIMessagePart
-
-For instructions on migrating for Vercel AI SDK RSC, see section above.
-This migration guide is for users of `useExternalStoreRuntime`.
-
-### Recommended Approach: Use ToolUI
-
-First, reconsider your approach.
-
-Creating UI components in the `convertMessage` callback is considered an anti-pattern.
-The recommended alternative approach is to pass tool-call message parts, and use `makeAssistantToolUI` to map these tool calls to UI components.
-
-This ensures that the data layer is separate and decoupled from the UI layer.
-
-#### Example
-
-Consider the following example, where you are using a UIMessagePart to show a loading indicator.
-
-```ts title="bad.ts"
-// THIS IS BAD
-const convertMessage = (message: MyMessage): ThreadMessageLike => {
-  if (message.isLoading) {
-    return { content: [{ type: "ui", display:< MyLoader /> }] };
-  }
-  // ...
-};
-```
-
-```ts title="good.ts"
-const convertMessage = (message: MyMessage): ThreadMessageLike => {
-  if (message.isLoading) {
-    return { content: [] };
-  }
-  // ...
-};
-
-// use the empty message part to show the loading indicator
-<Thread assistantMessage={{ components: { Empty: MyLoader } }} />;
-```
-
-(if you are using unstyled primitives, update MyThread.tsx, and pass the component to MessagePrimitive.Parts)
-
-#### Example 2
-
-Consider the following example, where you are displaying a custom chart based on data received from an external source.
-
-```ts title="bad.ts"
-// THIS IS BAD
-const convertMessage = (message: MyMessage): ThreadMessageLike => {
-  return { content: [{ type: "ui", display: <MyChart data={message.chartData} /> }] };
-};
-```
-
-```ts title="good.ts"
-const convertMessage = (message: MyMessage): ThreadMessageLike => {
-  return {
-    content: [
-      {
-        type: "tool-call",
-        toolName: "chart",
-        args: message.chartData,
-      },
-    ],
-  };
-};
-
-const ChartToolUI = makeAssistantToolUI({
-  toolName: "chart",
-  render: ({ args }) => <MyChart data={args} />,
-});
-
-// use tool UI to display the chart
-<Thread tools={[ChartToolUI]} />;
-```
-
-(if you are using unstyled primitives, render the `<ChartToolUI />` component anywhere inside your AssistantRuntimeProvider)
-
-### Fallback Approach: Override MessagePartText
-
-However, sometimes you receive UI components from an external source.
-
-The example below assumes that your custom `MyMessage` type has a `display` field.
-
-First, we define a dummy `UI_PLACEHOLDER` message part, which we will replace with the UI component later:
-
-```ts
-const UI_PLACEHOLDER = Object.freeze({
-  type: "text",
-  text: "UI content placeholder",
-});
-const convertMessage = (message: MyMessage): ThreadMessageLike => ({
-  content: [
-    // other message parts,
-    UI_PLACEHOLDER,
-  ],
-});
-```
-
-Then, we define a custom `TextMessagePartComponent`:
-
-```tsx
-const MyText: TextMessagePartComponent = () => {
-  const isUIPlaceholder = useMessagePart((p) => p === UI_PLACEHOLDER);
-
-  // this assumes that you have a `display` field on your original message objects before conversion.
-  const ui = useMessage((m) =>
-    isUIPlaceholder ? getExternalStoreMessage(m).display : undefined,
-  );
-  if (ui) {
-    return ui;
-  }
-
-  return <MarkdownText />; // your default text component
-};
-```
-
-We pass this component to our Thread:
-
-```tsx
-<Thread
-  assistantMessage={{ components: { Text: MyText } }}
-  userMessage={{ components: { Text: MyText } }}
-/>
-```
-
-(if you are using unstyled primitives, update MyThread.tsx, and pass the component to MessagePrimitive.Parts)
-
-Now, the `UI_PLACEHOLDER` message part is replaced with the UI component we defined earlier.

package/.docs/raw/docs/migrations/v0-9.mdx

@@ -1,75 +0,0 @@
----
-title: Migration to v0.9
----
-
-## Edge Runtime moved to @assistant-ui/react-edge
-
-The edge runtime, as well as the `CoreMessage` type, moved to `@assistant-ui/react-edge`.
-
-The following components and types have been moved to `@assistant-ui/react-edge`:
-
-- Edge Runtime
-
-  - `useEdgeRuntime`
-  - `EdgeRuntimeOptions`
-  - `EdgeModelAdapter`
-  - `EdgeChatAdapter`
-  - `EdgeRuntimeRequestOptions`
-  - `createEdgeRuntimeAPI`
-  - `getEdgeRuntimeResponse`
-
-- Core Types
-  - `CoreMessage`
-  - `CoreUserMessage`
-  - `CoreAssistantMessage`
-  - `CoreSystemMessage`
-  - `CoreUserMessagePart`
-  - `CoreAssistantMessagePart`
-  - `CoreToolCallMessagePart`
-- Core message converters
-  - `fromCoreMessages`
-  - `fromCoreMessage`
-  - `toCoreMessages`
-  - `toCoreMessage`
-
-To migrate, use the migration codemod:
-
-```sh
-# IMPORTANT: make sure to commit all changes to git / creating a backup before running the codemod
-npx assistant-ui upgrade
-```
-
-## Language Model converters and useDangerousInBrowserRuntime moved to @assistant-ui/react-ai-sdk
-
-The following methods have been moved to `@assistant-ui/react-ai-sdk`:
-
-- Language Model converters
-  - `toLanguageModelMessages`
-  - `toLanguageModelTools`
-  - `fromLanguageModelMessages`
-  - `fromLanguageModelTools`
-- Dangerous in Browser Runtime
-  - `useDangerousInBrowserRuntime`
-
-To migrate, use the migration codemod:
-
-```sh
-# IMPORTANT: make sure to commit all changes to git / creating a backup before running the codemod
-npx assistant-ui upgrade
-```
-
-## LangGraph `unstable_allowImageAttachments` removed
-
-The `unstable_allowImageAttachments` option has been removed. Use the `adapters` option instead.
-
-```ts
-useLangGraphRuntime({
-  adapters: {
-    attachments: new SimpleImageAttachmentAdapter(),
-  },
-});
-```
-
-## Markdown `components.by_language` removed
-
-The `components.by_language` option has been removed. Use the `componentsByLanguage` option instead.

package/.docs/raw/docs/ui/primitives/Thread.mdx

@@ -1,197 +0,0 @@
----
-title: Thread
----
-
-A conversation between a user and an assistant.
-
-import { ParametersTable } from "@/components/docs";
-
-## Anatomy
-
-```tsx
-import { ThreadPrimitive } from "@assistant-ui/react";
-
-const Thread = () => (
-  <ThreadPrimitive.Root>
-    <ThreadPrimitive.Viewport>
-      <ThreadPrimitive.Empty>...</ThreadPrimitive.Empty>
-      <ThreadPrimitive.Messages components={...} />
-    </ThreadPrimitive.Viewport>
-    <Composer />
-  </ThreadPrimitive.Root>
-);
-```
-
-## API Reference
-
-### Root
-
-Contains all parts of the thread.
-
-This primitive renders a `<div>` element unless `asChild` is set.
-
-<ParametersTable
-  type="ThreadPrimitiveRootProps"
-  parameters={[
-    {
-      name: "asChild",
-    },
-  ]}
-/>
-
-### Viewport
-
-The scrollable area containing all messages. Anchors scroll to the bottom as new messages are added.
-
-This primitive renders a `<div>` element unless `asChild` is set.
-
-<ParametersTable
-  type="ThreadPrimitiveViewportProps"
-  parameters={[
-    {
-      name: "asChild",
-    },
-    {
-      name: "autoScroll",
-      type: "boolean",
-      default: "true",
-      description:
-        "Whether to automatically scroll to the bottom of the viewport when new messages are added while the viewport is was previously scrolled to the bottom.",
-    },
-  ]}
-/>
-
-### Messages
-
-Renders all messages. This primitive renders a separate component for each message.
-
-<ParametersTable
-  type="ThreadPrimitiveMessagesProps"
-  parameters={[
-    {
-      name: "components",
-      type: "MessageComponents",
-      description: "The component to render for each message.",
-      children: [
-        {
-          type: "MessageComponents",
-          parameters: [
-            {
-              name: "Message",
-              type: "ComponentType",
-              description: "The component to render for each message.",
-            },
-            {
-              name: "UserMessage",
-              type: "ComponentType",
-              description: "The component to render for user messages.",
-            },
-            {
-              name: "EditComposer",
-              type: "ComponentType",
-              description:
-                "The component to render for user messages that are being edited.",
-            },
-            {
-              name: "AssistantMessage",
-              type: "ComponentType",
-              description: "The component to render for assistant messages.",
-            },
-          ],
-        },
-      ],
-    },
-  ]}
-/>
-
-### Empty
-
-Renders children only when there are no messages.
-
-### ScrollToBottom
-
-A button to scroll the viewport to the bottom. Disabled when the viewport is already at bottom.
-
-This primitive renders a `<button>` element unless `asChild` is set.
-
-<ParametersTable
-  type="ThreadPrimitiveScrollToBottomProps"
-  parameters={[
-    {
-      name: "asChild",
-    },
-  ]}
-/>
-
-### `ThreadPrimitive.Suggestion`
-
-Shows a suggestion to the user. When the user clicks on the suggestion, the composer's value is set to the suggestion's prompt.
-
-This primitive renders a `<button>` element unless `asChild` is set.
-
-```tsx
-import { ThreadPrimitive } from "@assistant-ui/react";
-
-const Suggestion = () => {
-  return (
-    <ThreadPrimitive.Suggestion
-      prompt="I need help with product search"
-      method="replace"
-      autoSend
-    />
-  );
-};
-```
-
-<ParametersTable
-  type="ThreadPrimitiveSuggestionProps"
-  parameters={[
-    {
-      name: "prompt",
-      type: "string",
-      description: "The suggestion's prompt.",
-    },
-    {
-      name: "method",
-      type: "'replace'",
-      description:
-        "How does the suggestion interact with the composer's existing value.",
-    },
-    {
-      name: "autoSend",
-      type: "boolean",
-      description:
-        "Whether to automatically send the suggestion when the user clicks on it.",
-      default: "false",
-    },
-  ]}
-/>
-
-### If
-
-Renders children if a condition is met.
-
-<ParametersTable
-  type="ThreadPrimitiveIfProps"
-  parameters={[
-    {
-      name: "empty",
-      type: "boolean | undefined",
-      description: "Render children if the thread is empty.",
-    },
-    {
-      name: "running",
-      type: "boolean | undefined",
-      description: "Render children if the thread is running.",
-    },
-  ]}
-/>
-
-```tsx
-<Thread.If empty>
-  {/* equivalent to <Thread.Empty> */}
-</Thread.If>
-<Thread.If empty={false}>
-  {/* rendered if thread is not empty */}
-</Thread.If>
-```