@assistant-ui/mcp-docs-server 0.1.1

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

@@ -0,0 +1,204 @@
+---
+title: ComposerPrimitive
+---
+
+The user interface to add new messages or edit existing ones.
+
+import { Callout } from "fumadocs-ui/components/callout";
+
+import { ParametersTable, KeyboardTable } from "@/components/docs";
+import { Code } from "@radix-ui/themes";
+
+<Callout>
+  **Dual Use!** A Composer placed directly inside a `Thread` will compose new
+  messages. A Composer placed inside a `Message` will edit that message.
+</Callout>
+
+## Anatomy
+
+```tsx
+import { ComposerPrimitive } from "@assistant-ui/react";
+
+// creating a new message
+const Composer = () => (
+  <ComposerPrimitive.Root>
+    <ComposerPrimitive.Attachments />
+    <ComposerPrimitive.AddAttachment />
+    <ComposerPrimitive.Input />
+    <ComposerPrimitive.Send />
+  </ComposerPrimitive.Root>
+);
+
+// editing an existing message
+const EditComposer = () => (
+  <ComposerPrimitive.Root>
+    <ComposerPrimitive.Input />
+    <ComposerPrimitive.Send />
+    <ComposerPrimitive.Cancel />
+  </ComposerPrimitive.Root>
+);
+```
+
+## API Reference
+
+### Root
+
+Containts all parts of the composer.
+
+This primitive renders a `<form>` element unless `asChild` is set.
+
+<ParametersTable
+  type="ComposerRootProps"
+  parameters={[
+    {
+      name: "asChild",
+    },
+  ]}
+/>
+
+### Input
+
+The text input field for the user to type a new message.
+
+This primitive renders a `<textarea>` element unless `asChild` is set.
+
+<ParametersTable
+  type="ComposerPrimitiveInputProps"
+  parameters={[
+    {
+      name: "asChild",
+    },
+  ]}
+/>
+
+#### Keyboard Shortcuts
+
+<KeyboardTable
+  data={[
+    {
+      keys: ["Enter"],
+      description: "Sends the message.",
+    },
+    {
+      keys: ["Escape"],
+      description: "Sends a cancel action.",
+    },
+  ]}
+/>
+
+### Send
+
+The button to send the message.
+
+This primitive renders a `<button>` element unless `asChild` is set.
+
+<ParametersTable
+  type="ComposerPrimitiveSendProps"
+  parameters={[
+    {
+      name: "asChild",
+    },
+    {
+      name: "multiple",
+      type: "boolean | undefined",
+      description: "Allow selecting multiple attachments at the same time.",
+      default: "true",
+    },
+  ]}
+/>
+
+### Cancel
+
+Sends a cancel action.
+
+In edit composers, this action exits the edit mode.  
+In thread composers, this action stops the current run.
+
+This primitive renders a `<button>` element unless `asChild` is set.
+
+<ParametersTable
+  type="ComposerPrimitiveCancelProps"
+  parameters={[
+    {
+      name: "asChild",
+    },
+  ]}
+/>
+
+### Attachments
+
+Renders attachments. This primitive renders a separate component for each attachment.
+
+<ParametersTable
+  type="ComposerPrimitiveAttachmentsProps"
+  parameters={[
+    {
+      name: "components",
+      type: "ComposerAttachmentsComponents",
+      description: "The component to render for each attachment.",
+      children: [
+        {
+          type: "ComposerPrimitiveAttachmentsProps['components']",
+          parameters: [
+            {
+              name: "Image",
+              type: "ComponentType",
+              description: "The component to render for each image attachment.",
+            },
+            {
+              name: "Document",
+              type: "ComponentType",
+              description:
+                "The component to render for each document attachment.",
+            },
+            {
+              name: "File",
+              type: "ComponentType",
+              description: "The component to render for each file attachment.",
+            },
+            {
+              name: "Fallback",
+              type: "ComponentType",
+              description: "The component to render for each attachment type.",
+            },
+          ],
+        },
+      ],
+    },
+  ]}
+/>
+
+### AddAttachment
+
+Renders a button to add an attachment.
+
+This primitive renders a `<button>` element unless `asChild` is set.
+
+<ParametersTable
+  type="ComposerPrimitiveAddAttachmentProps"
+  parameters={[
+    {
+      name: "asChild",
+    },
+  ]}
+/>
+
+### If
+
+Renders children if a condition is met.
+
+<ParametersTable
+  type="UseComposerIfProps"
+  parameters={[
+    {
+      name: "editing",
+      required: false,
+      type: "boolean | undefined",
+      description: "Render children if the message is being edited.",
+    },
+  ]}
+/>
+
+```tsx
+<Composer.If editing>{/* rendered if message is being edited */}</Composer.If>
+```

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

@@ -0,0 +1,173 @@
+---
+title: ContentPartPrimitive
+description: A part of a message's content. Content parts may be text, image, tool call or UI elements.
+---
+
+import { ParametersTable } from "@/components/docs";
+import {
+  ContentPartRuntime,
+  TextContentPartState,
+  AudioContentPartState,
+  ToolCallContentPartState,
+} from "@/generated/typeDocs";
+
+Each message can have any number of content parts.  
+Content parts are usually one of text, reasoning, audio or tool-call.
+
+## Content Part Types
+
+### Text
+
+Standard text content, used for both user and assistant messages.
+
+### Reasoning
+
+Exposes the assistant's reasoning process, showing how it arrived at its responses. This is typically used only in assistant messages.
+
+### Audio
+
+Audio content that can be played back.
+
+### Tool Call
+
+Interactive elements that represent tool operations.
+
+## Anatomy
+
+```tsx
+import { ContentPartPrimitive } from "@assistant-ui/react";
+
+const TextContentPart = () => {
+  return <ContentPartPrimitive.Text />;
+};
+```
+
+## Primitives
+
+### Plain Text
+
+```tsx
+import { ContentPartPrimitive } from "@assistant/react";
+
+<ContentPartPrimitive.Text />;
+```
+
+### Markdown Text
+
+Renders the message's text as Markdown.
+
+```tsx
+import { MarkdownTextPrimitive } from "@assistant-ui/react-markdown";
+
+<MarkdownTextPrimitive />;
+```
+
+### Audio
+
+Coming soon.
+
+### InProgress
+
+Renders children only if the content part is in progress.
+
+```tsx
+import { ContentPartPrimitive } from "@assistant/react";
+
+<ContentPartPrimitive.InProgress>
+  <LoadingIndicator />
+</ContentPartPrimitive.InProgress>;
+```
+
+### Tool UI
+
+You can map tool calls to UI components. We provide a few utility functions to make this easier, such as `makeAssistantToolUI`.
+
+```tsx
+const MyWeatherToolUI = makeAssistantToolUI({
+  toolName: "get_weather",
+  render: function MyWeatherToolUI({ args, result }) {
+    return (
+      <div className="mb-4 flex flex-col items-center">
+        <pre className="whitespace-pre-wrap break-all text-center">
+          get_weather({JSON.stringify(args)})
+        </pre>
+        {"result" in result && (
+          <pre className="whitespace-pre-wrap break-all text-center">
+            {JSON.stringify(result.result)}
+          </pre>
+        )}
+      </div>
+    );
+  },
+});
+```
+
+## Context Provider
+
+Content part context is provided by `MessagePrimitive.Content` or `TextContentPartProvider`
+
+### MessagePrimitive.Content
+
+```tsx
+import { MessagePrimitive } from "@assistant/react";
+
+<MessagePrimitive.Content
+  components={{
+    Text: MyText,
+    Reasoning: MyReasoning,
+    Audio: MyAudio,
+    tools: {
+      by_name: {
+        get_weather: MyWeatherToolUI,
+      },
+      Fallback: MyFallbackToolUI,
+    },
+  }}
+/>;
+```
+
+### TextContentPartProvider
+
+This is a helper context provider to allow you to reuse the content part components outside a message content part.
+
+```tsx
+import { TextContentPartProvider } from "@assistant-ui/react";
+
+<TextContentPartProvider text="Hello world" isRunning={false}>
+  <ContentPart.Text />
+</TextContentPartProvider>;
+```
+
+## Runtime API
+
+### `useContentPartRuntime`
+
+```tsx
+import { useContentPartRuntime } from "@assistant-ui/react";
+
+const contentPartRuntime = useContentPartRuntime();
+```
+
+<ParametersTable {...ContentPartRuntime} />
+
+### `useContentPart`
+
+```tsx
+import { useContentPart } from "@assistant-ui/react";
+
+const contentPart = useContentPart();
+```
+
+<ParametersTable {...TextContentPartState} />
+<ParametersTable {...AudioContentPartState} />
+<ParametersTable {...ToolCallContentPartState} />
+
+### `useContentPartText`
+
+```tsx
+import { useContentPartText } from "@assistant-ui/react";
+
+const contentPartText = useContentPartText();
+```
+
+<ParametersTable {...TextContentPartState} />

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

@@ -0,0 +1,70 @@
+---
+title: ErrorPrimitive
+---
+
+A component for displaying error messages in the UI.
+
+import { ParametersTable } from "@/components/docs";
+
+## Anatomy
+
+```tsx
+import { ErrorPrimitive } from "@assistant-ui/react";
+
+const ErrorDisplay = () => (
+  <ErrorPrimitive.Root>
+    <ErrorPrimitive.Message />
+  </ErrorPrimitive.Root>
+);
+```
+
+## API Reference
+
+### Root
+
+Contains all parts of the error display. Renders a `<div>` element with `role="alert"`.
+
+<ParametersTable
+  type="ErrorPrimitiveRootProps"
+  parameters={[
+    {
+      name: "asChild",
+      type: "boolean",
+      description: "Change the component to the HTML tag or custom component of the only child.",
+    },
+  ]}
+/>
+
+### Message
+
+Displays the error message. By default, it shows the error from the message context if available, or you can provide custom content.
+
+<ParametersTable
+  type="ErrorPrimitiveMessageProps"
+  parameters={[
+    {
+      name: "children",
+      type: "ReactNode",
+      description: "Optional custom content to display instead of the default error message.",
+    },
+  ]}
+/>
+
+## Usage
+
+The ErrorPrimitive is typically used within a MessagePrimitive.Error component to display error states in messages:
+
+```tsx
+import { MessagePrimitive, ErrorPrimitive } from "@assistant-ui/react";
+
+const MessageWithError = () => (
+  <MessagePrimitive.Root>
+    <MessagePrimitive.Content />
+    <MessagePrimitive.Error>
+      <ErrorPrimitive.Root>
+        <ErrorPrimitive.Message />
+      </ErrorPrimitive.Root>
+    </MessagePrimitive.Error>
+  </MessagePrimitive.Root>
+);
+```

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

@@ -0,0 +1,181 @@
+---
+title: MessagePrimitive
+---
+
+A single message in a conversation. Messages may consist of multiple parts.
+
+import { ParametersTable } from "@/components/docs";
+
+## Anatomy
+
+```tsx
+import { MessagePrimitive } from "@assistant-ui/react";
+
+const UserMessage = () => (
+  <MessagePrimitive.Root>
+    User: <MessagePrimitive.Content />
+    <BranchPicker />
+    <ActionBar />
+  </MessagePrimitive.Root>
+);
+
+const AssistantMessage = () => (
+  <MessagePrimitive.Root>
+    Assistant: <MessagePrimitive.Content />
+    <BranchPicker />
+    <ActionBar />
+  </MessagePrimitive.Root>
+);
+```
+
+## API Reference
+
+### Root
+
+Containts all parts of the message.
+
+This primitive renders a `<div>` element unless `asChild` is set.
+
+<ParametersTable
+  type="MessagePrimitiveRootProps"
+  parameters={[
+    {
+      name: "asChild",
+    },
+  ]}
+/>
+
+### Content
+
+The content of the message. This renders a separate component for each content part of the message.
+
+<ParametersTable
+  type="MessagePrimitiveContentProps"
+  parameters={[
+    {
+      name: "components",
+      required: false,
+      type: "ContentPartComponents",
+      description: "The components to render for each content part.",
+      children: [
+        {
+          type: "ContentPartComponents",
+          parameters: [
+            {
+              name: "Text",
+              type: "TextContentPartComponent",
+              description:
+                "The component to render for each text content part.",
+            },
+            {
+              name: "Image",
+              type: "ImageContentPartComponent",
+              description:
+                "The component to render for each image content part.",
+            },
+            {
+              name: "Source",
+              type: "SourceContentPartComponent",
+              description:
+                "The component to render for each source content part.",
+            },
+            {
+              name: "File",
+              type: "FileContentPartComponent",
+              description:
+                "The component to render for each file content part.",
+            },
+            {
+              name: "Unstable_Audio",
+              type: "Unstable_AudioContentPartComponent",
+              description:
+                "The component to render for each audio content part.",
+            },
+            {
+              name: "tools",
+              type: "object",
+              description:
+                "The component to render for each tool call content part.",
+              children: [
+                {
+                  parameters: [
+                    {
+                      name: "by_name",
+                      type: "Record<string, ToolCallContentPartComponent>",
+                      description:
+                        "The components to render for each tool call content part.",
+                    },
+                    {
+                      name: "Fallback",
+                      type: "ToolCallContentPartComponent",
+                      description:
+                        "The fallback component to render for tool call content parts.",
+                    },
+                  ],
+                },
+              ],
+            },
+          ],
+        },
+      ],
+    },
+  ]}
+/>
+
+### If
+
+Renders children if a condition is met.
+
+<ParametersTable
+  type="UseMessageIfProps"
+  parameters={[
+    {
+      name: "user",
+      type: "boolean | undefined",
+      description: "Render children if the message is from the user.",
+    },
+    {
+      name: "assistant",
+      type: "boolean | undefined",
+      description: "Render children if the message is from the assistant.",
+    },
+    {
+      name: "hasBranches",
+      type: "boolean | undefined",
+      description: "Render children if the message has branches.",
+    },
+    {
+      name: "copied",
+      type: "boolean | undefined",
+      description: "Render children if the message is copied.",
+    },
+    {
+      name: "lastOrHover",
+      type: "boolean | undefined",
+      description:
+        "Render children if the message is the last or hovered over.",
+    },
+  ]}
+/>
+
+```tsx
+<Message.If user>
+  {/* rendered if message is from the user */}
+</Message.If>
+<Message.If assistant>
+  {/* rendered if message is from the assistant */}
+</Message.If>
+```
+
+### Error
+
+Renders children only if the message has an error status.
+
+```tsx
+<MessagePrimitive.Error>
+  {/* rendered if the message has an error status */}
+  <ErrorPrimitive.Root>
+    <ErrorPrimitive.Message />
+  </ErrorPrimitive.Root>
+</MessagePrimitive.Error>
+```