@assistant-ui/mcp-docs-server 0.1.1

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

@@ -0,0 +1,264 @@
+---
+title: ActionBarPrimitive
+---
+
+Buttons to interact with the message.
+
+import { ParametersTable, DataAttributesTable } from "@/components/docs";
+import { Code } from "@radix-ui/themes";
+
+## Anatomy
+
+```tsx
+import { ActionBarPrimitive } from "@assistant-ui/react";
+
+const UserMessageBar = () => (
+  <ActionBarPrimitive.Root>
+    <ActionBarPrimitive.Edit />
+    <ActionBarPrimitive.Copy />
+  </ActionBarPrimitive.Root>
+);
+
+const AssistantMessageBar = () => (
+  <ActionBarPrimitive.Root>
+    <ActionBarPrimitive.Reload />
+    <ActionBarPrimitive.Copy />
+  </ActionBarPrimitive.Root>
+);
+```
+
+## API Reference
+
+### Container
+
+Containts all parts of the action bar.
+
+This primitive renders a `<div>` element unless `asChild` is set.
+
+<ParametersTable
+  type="ActionBarPrimitiveRootProps"
+  parameters={[
+    {
+      name: "asChild",
+    },
+    {
+      name: "hideWhenRunning",
+      type: "boolean",
+      default: "false",
+      description: (
+        <span>
+          Do not render the ActionBar when the thread is in running state.
+        </span>
+      ),
+    },
+    {
+      name: "autohide",
+      type: '"always" | "not-last" | "never"',
+      default: '"never"',
+      description: (
+        <span>
+          Do not render the ActionBar unless the mouse is hovering over the
+          message.
+          <br />
+          <br />
+          <Code>"always"</Code>: always autohide.
+          <br />
+          <Code>"not-last"</Code>; only autohide if the message is not the last
+          one in the thread.
+        </span>
+      ),
+    },
+    {
+      name: "autohideFloat",
+      type: '"always" | "single-branch" | "never"',
+      default: '"never"',
+      description: (
+        <span>
+          Float the ActionBar during autohide.
+          <br />
+          <br />
+          <Code>"always"</Code>: always float during autohide.
+          <br />
+          <Code>"single-branch"</Code>: only float if the message is the only
+          one in the thread.
+          <br />
+          <br />
+          Note: this only sets `data-floating` on the ActionBar. You need to set
+          the appropriate styles on the ActionBar to make it float.
+        </span>
+      ),
+    },
+  ]}
+/>
+
+<DataAttributesTable
+  data={[
+    {
+      attribute: "[data-floating]",
+      values: "Present when floating",
+    },
+  ]}
+/>
+
+### Edit
+
+Enables edit mode on user message.
+
+This primitive renders a `<button>` element unless `asChild` is set.
+
+<ParametersTable
+  type="ActionBarPrimitiveEditProps"
+  parameters={[
+    {
+      name: "asChild",
+    },
+  ]}
+/>
+
+### Reload
+
+Regenerates the assistant message.
+
+This primitive renders a `<button>` element unless `asChild` is set.
+
+<ParametersTable
+  type="ActionBarPrimitiveReloadProps"
+  parameters={[
+    {
+      name: "asChild",
+    },
+  ]}
+/>{" "}
+
+### Copy
+
+Copies the message to the clipboard.
+
+This primitive renders a `<button>` element unless `asChild` is set.
+
+<ParametersTable
+  type="ActionBarPrimitiveCopyProps"
+  parameters={[
+    {
+      name: "asChild",
+    },
+    {
+      name: "copiedDuration",
+      type: "number",
+      description:
+        "The duration in milliseconds to change the message status to 'copied'.",
+      default: "3000",
+    },
+  ]}
+/>
+
+<DataAttributesTable
+  data={[
+    {
+      attribute: "[data-copied]",
+      values: "Present when the message was recently copied.",
+    },
+  ]}
+/>
+
+#### Copied state
+
+Show a different icon for a few seconds after the message is copied.
+
+```tsx
+<ActionBarPrimitive.Copy>
+  <MessagePrimitive.If copied={false}>
+    <CopyIcon />
+  </MessagePrimitive.If>
+  <MessagePrimitive.If copied>
+    <CopySuccessIcon />
+  </MessagePrimitive.If>
+</ActionBarPrimitive.Copy>
+```
+
+or using the `data-copied` attribute:
+
+```tsx
+<ActionBarPrimitive.Copy className="group">
+  <CopyIcon className="group-data-[copied]:hidden" />
+  <CheckIcon className="hidden group-data-[copied]:block" />
+</ActionBarPrimitive.Copy>
+```
+
+### Speak
+
+Plays the message text as speech.
+
+This primitive renders a `<button>` element unless `asChild` is set.
+
+<ParametersTable
+  type="ActionBarPrimitiveSpeakProps"
+  parameters={[
+    {
+      name: "asChild",
+    },
+  ]}
+/>
+
+### StopSpeaking
+
+Stops the message text from being played as speech.
+
+This primitive renders a `<button>` element unless `asChild` is set.
+
+<ParametersTable
+  type="ActionBarPrimitiveStopSpeakingProps"
+  parameters={[
+    {
+      name: "asChild",
+    },
+  ]}
+/>
+
+### Feedback Positive
+
+Shows a positive feedback submission button.
+
+This primitive renders a `<button>` element unless `asChild` is set.
+
+<ParametersTable
+  type="ActionBarPrimitiveFeedbackPositiveProps"
+  parameters={[
+    {
+      name: "asChild",
+    },
+  ]}
+/>
+
+<DataAttributesTable
+  data={[
+    {
+      attribute: "[data-submitted]",
+      values: "Present when positive feedback was submitted.",
+    },
+  ]}
+/>
+
+### Feedback Negative
+
+Shows a negative feedback submission button.
+
+This primitive renders a `<button>` element unless `asChild` is set.
+
+<ParametersTable
+  type="ActionBarPrimitiveFeedbackNegativeProps"
+  parameters={[
+    {
+      name: "asChild",
+    },
+  ]}
+/>
+
+<DataAttributesTable
+  data={[
+    {
+      attribute: "[data-submitted]",
+      values: "Present when negative feedback was submitted.",
+    },
+  ]}
+/>

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

@@ -0,0 +1,129 @@
+---
+title: AssistantModalPrimitive
+---
+
+A modal chat UI usually displayed in the bottom right corner of the screen.
+
+import { Code } from "@radix-ui/themes";
+import { ParametersTable, DataAttributesTable } from "@/components/docs";
+
+## Anatomy
+
+```tsx
+import { AssistantModalPrimitive } from "@assistant-ui/react";
+
+const Thread = () => (
+  <AssistantModalPrimitive.Root>
+    <AssistantModalPrimitive.Trigger>
+      <FloatingAssistantButton />
+    </AssistantModalPrimitive.Trigger>
+    <AssistantModalPrimitive.Content>
+      <Thread />
+    </AssistantModalPrimitive.Content>
+  </AssistantModalPrimitive.Root>
+);
+```
+
+## API Reference
+
+### Root
+
+Contains all parts of the assistant modal.
+
+<ParametersTable
+  type="AssistantModalPrimitiveRootProps"
+  parameters={[
+    {
+      name: "defaultOpen",
+      type: "boolean",
+      default: "false",
+      description:
+        "The open state of the assistant modal when it is initially rendered. Use when you do not need to control its open state.",
+    },
+    {
+      name: "open",
+      type: "boolean",
+      description:
+        "Not recommended. The controlled open state of the assistant modal. Must be used in conjunction with onOpenChange.",
+    },
+    {
+      name: "onOpenChange",
+      type: "(open: boolean) => void",
+      description:
+        "Event handler called when the open state of the assistant modal changes.",
+    },
+    {
+      name: "modal",
+      type: "boolean",
+      default: "false",
+      description:
+        "The modality of the assistant modal. When set to true, interaction with outside elements will be disabled and only modal content will be visible to screen readers.",
+    },
+  ]}
+/>
+
+### Trigger
+
+A button that toggles the open state of the assistant modal. `AssistantModalPrimitive.Content` will position itself against this button.
+
+This primitive renders a `<button>` element unless `asChild` is set.
+
+<ParametersTable
+  type="AssistantModalPrimitiveTriggerProps"
+  parameters={[
+    {
+      name: "asChild",
+    },
+  ]}
+/>
+
+<DataAttributesTable
+  data={[
+    {
+      attribute: "[data-state]",
+      values: <Code>"open" | "closed"</Code>,
+    },
+  ]}
+/>
+
+### Anchor
+
+The anchor element that the assistant modal is attached to. Defaults to the `Trigger` element.
+
+This primitive renders a `<div>` element unless `asChild` is set.
+
+### Content
+
+The component that pops out when the assistant modal is open.
+
+This primitive renders a `<div>` element unless `asChild` is set.
+
+<ParametersTable
+  type="AssistantModalPrimitiveContentProps"
+  parameters={[
+    {
+      name: "asChild",
+    },
+    {
+      name: "side",
+      type: "'top' | 'right' | 'bottom' | 'left'",
+      default: "'top'",
+      description: "The side of the assistant modal to position against.",
+    },
+    {
+      name: "align",
+      type: "'start' | 'center' | 'end'",
+      default: "'end'",
+      description: "The alignment of the assistant modal to position against.",
+    },
+    {
+      name: "dissmissOnInteractOutside",
+      type: "boolean",
+      default: "false",
+      description:
+        "Dismiss the assistant modal when the user interacts outside of it.",
+    },
+  ]}
+/>
+
+Refer to Radix UI's Documentation for [Popover.Content](https://www.radix-ui.com/primitives/docs/components/popover#content) for more details.

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

@@ -0,0 +1,96 @@
+---
+title: AttachmentPrimitive
+---
+
+Buttons to interact with attachments.
+
+import { ParametersTable, DataAttributesTable } from "@/components/docs";
+import { Code } from "@radix-ui/themes";
+import { Callout } from "fumadocs-ui/components/callout";
+
+<Callout>
+  **Dual Use!** Attachments can appear in both messages and composers.
+</Callout>
+
+## Anatomy
+
+```tsx
+import { AttachmentPrimitive } from "@assistant-ui/react";
+
+const MyMessageAttachment = () => (
+  <AttachmentPrimitive.Root>
+    <AttachmentPrimitive.Thumbnail />
+    <AttachmentPrimitive.Name />
+  </AttachmentPrimitive.Root>
+);
+
+const MyComposerAttachment = () => (
+  <AttachmentPrimitive.Root>
+    <AttachmentPrimitive.Thumbnail />
+    <AttachmentPrimitive.Name />
+    <AttachmentPrimitive.Remove />
+  </AttachmentPrimitive.Root>
+);
+```
+
+## API Reference
+
+### Container
+
+Containts all parts of the attachment.
+
+This primitive renders a `<div>` element unless `asChild` is set.
+
+<ParametersTable
+  type="AttachmentPrimitiveRootProps"
+  parameters={[
+    {
+      name: "asChild",
+    },
+  ]}
+/>
+
+### Thumbnail
+
+The thumbnail of the attachment.
+
+This primitive renders a `<div>` element unless `asChild` is set.
+
+<ParametersTable
+  type="AttachmentPrimitiveThumbnailProps"
+  parameters={[
+    {
+      name: "asChild",
+    },
+  ]}
+/>
+
+### Name
+
+The name of the attachment.
+
+This primitive renders a `<div>` element unless `asChild` is set.
+
+<ParametersTable
+  type="AttachmentPrimitiveNameProps"
+  parameters={[
+    {
+      name: "asChild",
+    },
+  ]}
+/>
+
+### Remove
+
+Removes the attachment.
+
+This primitive renders a `<button>` element unless `asChild` is set.
+
+<ParametersTable
+  type="AttachmentPrimitiveRemoveProps"
+  parameters={[
+    {
+      name: "asChild",
+    },
+  ]}
+/>

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

@@ -0,0 +1,87 @@
+---
+title: BranchPickerPrimitive
+---
+
+View and switch between branches.
+
+import { ParametersTable } from "@/components/docs";
+
+## Anatomy
+
+```tsx
+import { BranchPickerPrimitive } from "@assistant-ui/react";
+
+const BranchPicker = () => (
+  <BranchPickerPrimitive.Root>
+    <BranchPickerPrimitive.Previous />
+    <BranchPickerPrimitive.Number /> / <BranchPickerPrimitive.Count />
+    <BranchPickerPrimitive.Next />
+  </BranchPickerPrimitive.Root>
+);
+```
+
+## API Reference
+
+### Root
+
+Containts all parts of the branch picker.
+
+This primitive renders a `<div>` element unless `asChild` is set.
+
+<ParametersTable
+  type="BranchPickerPrimitiveRootProps"
+  parameters={[
+    {
+      name: "asChild",
+    },
+    {
+      name: "hideWhenSingleBranch",
+      type: "boolean",
+      default: "false",
+      description:
+        "Do not render the BranchPicker when there is only one branch at the current message.",
+    },
+  ]}
+/>
+
+### Number
+
+The current branch number.
+
+This primitive renders the raw number as a string.
+
+### Count
+
+The total number of branches.
+
+This primitive renders the raw number as a string.
+
+### Previous
+
+Navigates to the previous branch.
+
+This primitive renders a `<button>` element unless `asChild` is set.
+
+<ParametersTable
+  type="BranchPickerPrimitivePreviousProps"
+  parameters={[
+    {
+      name: "asChild",
+    },
+  ]}
+/>
+
+### Next
+
+Navigates to the next branch.
+
+This primitive renders a `<button>` element unless `asChild` is set.
+
+<ParametersTable
+  type="BranchPickerPrimitiveNextProps"
+  parameters={[
+    {
+      name: "asChild",
+    },
+  ]}
+/>