@assistant-ui/mcp-docs-server 0.1.7 → 0.1.9

package/.docs/raw/docs/api-reference/integrations/react-data-stream.mdx

@@ -0,0 +1,194 @@
+---
+title: "@assistant-ui/react-data-stream"
+---
+
+Data Stream protocol integration for assistant-ui.
+
+import { ParametersTable } from "@/components/docs";
+
+## API Reference
+
+### `useDataStreamRuntime`
+
+Create a runtime that connects to a data stream protocol endpoint.
+
+```tsx
+import { useDataStreamRuntime } from "@assistant-ui/react-data-stream";
+
+const MyRuntimeProvider = ({ children }: { children: React.ReactNode }) => {
+  const runtime = useDataStreamRuntime({
+    api: "/api/chat",
+  });
+
+  return (
+    <AssistantRuntimeProvider runtime={runtime}>
+      {children}
+    </AssistantRuntimeProvider>
+  );
+};
+```
+
+<ParametersTable
+  parameters={[
+    {
+      name: "api",
+      type: "string",
+      description: "The API endpoint URL for the data stream protocol.",
+    },
+    {
+      name: "onResponse",
+      type: "(response: Response) => void | Promise<void>",
+      description: "Optional callback called when a response is received.",
+    },
+    {
+      name: "onFinish",
+      type: "(message: ThreadMessage) => void",
+      description: "Optional callback called when a message is finished.",
+    },
+    {
+      name: "onError",
+      type: "(error: Error) => void",
+      description: "Optional callback called when an error occurs.",
+    },
+    {
+      name: "onCancel",
+      type: "() => void",
+      description: "Optional callback called when a request is cancelled.",
+    },
+    {
+      name: "credentials",
+      type: "RequestCredentials",
+      description: "Optional credentials mode for the fetch request.",
+    },
+    {
+      name: "headers",
+      type: "Record<string, string> | Headers | (() => Promise<Record<string, string> | Headers>)",
+      description: "Optional headers to include in the request.",
+    },
+    {
+      name: "body",
+      type: "object",
+      description: "Optional additional body parameters to include in the request.",
+    },
+    {
+      name: "sendExtraMessageFields",
+      type: "boolean",
+      description: "Whether to include extra message fields like IDs in the request.",
+    },
+  ]}
+/>
+
+### `useCloudRuntime`
+
+Create a runtime that connects to Assistant Cloud using the data stream protocol.
+
+```tsx
+import { useCloudRuntime } from "@assistant-ui/react-data-stream";
+
+const MyRuntimeProvider = ({ children }: { children: React.ReactNode }) => {
+  const runtime = useCloudRuntime({
+    cloud: assistantCloud,
+    assistantId: "my-assistant-id",
+  });
+
+  return (
+    <AssistantRuntimeProvider runtime={runtime}>
+      {children}
+    </AssistantRuntimeProvider>
+  );
+};
+```
+
+<ParametersTable
+  parameters={[
+    {
+      name: "cloud",
+      type: "AssistantCloud",
+      description: "The Assistant Cloud instance.",
+    },
+    {
+      name: "assistantId",
+      type: "string",
+      description: "The ID of the assistant to connect to.",
+    },
+    {
+      name: "onResponse",
+      type: "(response: Response) => void | Promise<void>",
+      description: "Optional callback called when a response is received.",
+    },
+    {
+      name: "onFinish",
+      type: "(message: ThreadMessage) => void",
+      description: "Optional callback called when a message is finished.",
+    },
+    {
+      name: "onError",
+      type: "(error: Error) => void",
+      description: "Optional callback called when an error occurs.",
+    },
+    {
+      name: "onCancel",
+      type: "() => void",
+      description: "Optional callback called when a request is cancelled.",
+    },
+    {
+      name: "credentials",
+      type: "RequestCredentials",
+      description: "Optional credentials mode for the fetch request.",
+    },
+    {
+      name: "headers",
+      type: "Record<string, string> | Headers | (() => Promise<Record<string, string> | Headers>)",
+      description: "Optional headers to include in the request.",
+    },
+    {
+      name: "body",
+      type: "object",
+      description: "Optional additional body parameters to include in the request.",
+    },
+    {
+      name: "sendExtraMessageFields",
+      type: "boolean",
+      description: "Whether to include extra message fields like IDs in the request.",
+    },
+  ]}
+/>
+
+### `toLanguageModelMessages`
+
+Convert assistant-ui messages to language model format.
+
+```tsx
+import { toLanguageModelMessages } from "@assistant-ui/react-data-stream";
+
+const languageModelMessages = toLanguageModelMessages(messages, {
+  unstable_includeId: true,
+});
+```
+
+<ParametersTable
+  parameters={[
+    {
+      name: "messages",
+      type: "readonly ThreadMessage[]",
+      description: "The messages to convert.",
+    },
+    {
+      name: "options",
+      type: "{ unstable_includeId?: boolean }",
+      description: "Optional conversion options.",
+      children: [
+        {
+          type: "{ unstable_includeId?: boolean }",
+          parameters: [
+            {
+              name: "unstable_includeId",
+              type: "boolean",
+              description: "Whether to include message IDs in the converted messages.",
+            },
+          ],
+        },
+      ],
+    },
+  ]}
+/>

package/.docs/raw/docs/api-reference/overview.mdx

@@ -31,6 +31,12 @@ export const contextColors = {
 - [`useChatRuntime`](#use-chat-runtime)
 - [`useAISDKRuntime`](#use-aisdk-runtime)
 
+### Data Stream
+
+- [`useDataStreamRuntime`](#use-data-stream-runtime)
+- [`useCloudRuntime`](#use-cloud-runtime)
+- [`toLanguageModelMessages`](#to-language-model-messages)
+
 ### LangGraph
 
 - [`useLangGraphRuntime`](#use-lang-graph-runtime)

package/.docs/raw/docs/api-reference/primitives/Composer.mdx

@@ -168,6 +168,37 @@ Renders attachments. This primitive renders a separate component for each attach
   ]}
 />
 
+### AttachmentByIndex
+
+Renders a single attachment at the specified index within the composer.
+
+```tsx
+<ComposerPrimitive.AttachmentByIndex
+  index={0}
+  components={{
+    Image: MyImageAttachment,
+    Document: MyDocumentAttachment
+  }}
+/>
+```
+
+<ParametersTable
+  type="ComposerPrimitive.AttachmentByIndex.Props"
+  parameters={[
+    {
+      name: "index",
+      type: "number",
+      required: true,
+      description: "The index of the attachment to render.",
+    },
+    {
+      name: "components",
+      type: "ComposerAttachmentsComponents",
+      description: "The components to render for the attachment.",
+    },
+  ]}
+/>
+
 ### AddAttachment
 
 Renders a button to add an attachment.

package/.docs/raw/docs/api-reference/primitives/Message.mdx

@@ -13,7 +13,7 @@ import { MessagePrimitive } from "@assistant-ui/react";
 
 const UserMessage = () => (
   <MessagePrimitive.Root>
-    User: <MessagePrimitive.Content />
+    User: <MessagePrimitive.Parts />
     <BranchPicker />
     <ActionBar />
   </MessagePrimitive.Root>
@@ -21,7 +21,7 @@ const UserMessage = () => (
 
 const AssistantMessage = () => (
   <MessagePrimitive.Root>
-    Assistant: <MessagePrimitive.Content />
+    Assistant: <MessagePrimitive.Parts />
     <BranchPicker />
     <ActionBar />
   </MessagePrimitive.Root>
@@ -45,7 +45,7 @@ This primitive renders a `<div>` element unless `asChild` is set.
   ]}
 />
 
-### Content
+### Parts
 
 The content of the message. This renders a separate component for each content part of the message.
 
@@ -154,6 +154,111 @@ The content of the message. This renders a separate component for each content p
   ]}
 />
 
+### PartByIndex
+
+Renders a single message part at the specified index.
+
+```tsx
+<MessagePrimitive.PartByIndex
+  index={0}
+  components={{
+    Text: MyTextComponent,
+    Image: MyImageComponent
+  }}
+/>
+```
+
+<ParametersTable
+  type="MessagePrimitive.PartByIndex.Props"
+  parameters={[
+    {
+      name: "index",
+      type: "number",
+      required: true,
+      description: "The index of the message part to render.",
+    },
+    {
+      name: "components",
+      required: false,
+      type: "ContentPartComponents",
+      description: "The components to render for the message part.",
+    },
+  ]}
+/>
+
+### Attachments
+
+Renders all attachments of the message.
+
+<ParametersTable
+  type="MessagePrimitive.Attachments.Props"
+  parameters={[
+    {
+      name: "components",
+      type: "AttachmentComponents",
+      description: "The components to render for each attachment.",
+      children: [
+        {
+          type: "AttachmentComponents",
+          parameters: [
+            {
+              name: "Image",
+              type: "ComponentType",
+              description: "The component to render for image attachments.",
+            },
+            {
+              name: "Document",
+              type: "ComponentType",
+              description: "The component to render for document attachments.",
+            },
+            {
+              name: "File",
+              type: "ComponentType",
+              description: "The component to render for file attachments.",
+            },
+            {
+              name: "Attachment",
+              type: "ComponentType",
+              description: "The fallback component to render for any attachment type.",
+            },
+          ],
+        },
+      ],
+    },
+  ]}
+/>
+
+### AttachmentByIndex
+
+Renders a single attachment at the specified index within the message.
+
+```tsx
+<MessagePrimitive.AttachmentByIndex
+  index={0}
+  components={{
+    Image: MyImageAttachment,
+    Document: MyDocumentAttachment
+  }}
+/>
+```
+
+<ParametersTable
+  type="MessagePrimitive.AttachmentByIndex.Props"
+  parameters={[
+    {
+      name: "index",
+      type: "number",
+      required: true,
+      description: "The index of the attachment to render.",
+    },
+    {
+      name: "components",
+      type: "AttachmentComponents",
+      description: "The components to render for the attachment.",
+    },
+  ]}
+/>
+
 ### If
 
 Renders children if a condition is met.

package/.docs/raw/docs/api-reference/primitives/Thread.mdx

@@ -104,6 +104,65 @@ Renders all messages. This primitive renders a separate component for each messa
   ]}
 />
 
+### MessageByIndex
+
+Renders a single message at the specified index in the current thread.
+
+```tsx
+<ThreadPrimitive.MessageByIndex
+  index={0}
+  components={{
+    UserMessage: MyUserMessage,
+    AssistantMessage: MyAssistantMessage
+  }}
+/>
+```
+
+<ParametersTable
+  type="ThreadPrimitive.MessageByIndex.Props"
+  parameters={[
+    {
+      name: "index",
+      type: "number",
+      required: true,
+      description: "The index of the message to render.",
+    },
+    {
+      name: "components",
+      type: "MessageComponents",
+      description: "The component configuration for rendering the 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.

package/.docs/raw/docs/api-reference/primitives/ThreadList.mdx

@@ -0,0 +1,128 @@
+---
+title: ThreadListPrimitive
+---
+
+Displays a list of conversation threads.
+
+import { ParametersTable } from "@/components/docs";
+
+## Anatomy
+
+```tsx
+import { ThreadListPrimitive } from "@assistant-ui/react";
+
+const ThreadList = () => (
+  <ThreadListPrimitive.Root>
+    <ThreadListPrimitive.New />
+    <ThreadListPrimitive.Items
+      components={{
+        ThreadListItem: MyThreadListItem
+      }}
+    />
+  </ThreadListPrimitive.Root>
+);
+```
+
+## API Reference
+
+### Root
+
+Contains all parts of the thread list.
+
+This primitive renders a `<div>` element unless `asChild` is set.
+
+<ParametersTable
+  type="ThreadListPrimitiveRootProps"
+  parameters={[
+    {
+      name: "asChild",
+    },
+  ]}
+/>
+
+### New
+
+A button to create a new thread.
+
+This primitive renders a `<button>` element unless `asChild` is set.
+
+<ParametersTable
+  type="ThreadListPrimitiveNewProps"
+  parameters={[
+    {
+      name: "asChild",
+    },
+  ]}
+/>
+
+### Items
+
+Renders all items in the thread list.
+
+<ParametersTable
+  type="ThreadListPrimitive.Items.Props"
+  parameters={[
+    {
+      name: "archived",
+      type: "boolean",
+      default: "false",
+      description: "Whether to show archived threads instead of active threads.",
+    },
+    {
+      name: "components",
+      type: "ThreadListItemComponents",
+      required: true,
+      description: "The components to render for each thread list item.",
+      children: [
+        {
+          type: "ThreadListItemComponents",
+          parameters: [
+            {
+              name: "ThreadListItem",
+              type: "ComponentType",
+              required: true,
+              description: "The component to render for each thread in the list.",
+            },
+          ],
+        },
+      ],
+    },
+  ]}
+/>
+
+### ItemByIndex
+
+Renders a single thread list item at the specified index.
+
+```tsx
+<ThreadListPrimitive.ItemByIndex
+  index={0}
+  components={{
+    ThreadListItem: MyThreadListItem
+  }}
+/>
+```
+
+<ParametersTable
+  type="ThreadListPrimitive.ItemByIndex.Props"
+  parameters={[
+    {
+      name: "index",
+      type: "number",
+      required: true,
+      description: "The index of the thread list item to render.",
+    },
+    {
+      name: "archived",
+      type: "boolean",
+      default: "false",
+      description: "Whether to render from archived threads instead of active threads.",
+    },
+    {
+      name: "components",
+      type: "ThreadListItemComponents",
+      required: true,
+      description: "The components to render for the thread list item.",
+    },
+  ]}
+/>