@assistant-ui/mcp-docs-server 0.1.1

package/.docs/raw/blog/2024-07-29-hello/index.mdx

@@ -0,0 +1,65 @@
+---
+title: Hello, assistant-ui
+description: assistant-ui is an open-source AI chat component for React.
+author: Simon Farshid
+date: 2024-07-29T12:00:00
+---
+
+import Image from "next/image";
+import { TestimonialContainer } from "@/components/testimonials/TestimonialContainer";
+import { BLOG_TESTIMONIALS } from "@/components/testimonials/testimonials";
+import npmDownloads from "./npm-downloads.png";
+import assistantUi from "./assistant-ui-screenshot.png";
+
+After spending the last two years building Gen-AI prototypes and products, I realized that all software will soon have a natural language interface. OpenAI's ChatGPT sets the quality bar high and I wanted to have a similar UX in my own apps. No solution on the market came anywhere close, so I built assistant-ui.
+
+assistant-ui is an open-source, embeddable, customizable AI chat component for React web apps. You can use it to build GPT wrappers, in-app copilots, or agentic systems. It supports rich content (markdown, code highlighting, charts, tables), generative UI, message editing, ..., across all the major model providers.
+
+<Image
+  src={assistantUi}
+  alt="screenshot of assistant-ui"
+  width={398}
+  height={498}
+  className="mx-auto rounded-xl border drop-shadow"
+/>
+
+Earlier last month, I released the project to the world. The feedback from early adopters has been overwhelmingly positive:
+
+<div className="not-prose mx-auto max-w-md">
+  <TestimonialContainer testimonials={BLOG_TESTIMONIALS} />
+</div>
+
+It didn't take long for developers to start building with assistant-ui. Here are some of my favorite products from the community:
+
+- [Helicone](https://helicone.ai/) - open-source LLM observability platform
+- [screenpipe](https://screenpi.pe/) - AI to remember everything you see, say or hear
+- [myresume.guru](http://myresume.guru) - AI resume optimizer to land your dream job
+- [Entelligence](https://entelligence.ai/) - AI mentor for software engineers
+
+With 250+ stars on [GitHub](https://github.com/assistant-ui/assistant-ui) and over 1k [npm](https://www.npmjs.com/package/@assistant-ui/react) weekly downloads, we got a vibrant growing community of developers who care about the user experience.
+
+<Image
+  src={npmDownloads}
+  alt="graph showing 1355 weekly npm downloads"
+  width={381}
+  height={94}
+  className="mx-auto dark:hue-rotate-180 dark:invert"
+/>
+
+I want to thank the following contributors who got the project to where it is today:
+
+- [@m13v](https://github.com/m13v) for contributing two examples and several how-to videos
+- [@okisdev](https://github.com/okisdev) for multiple bugfixes
+- [@Rajaniraiyn](https://github.com/Rajaniraiyn) for improving streaming support for REST APIs
+- @ccbkai for integrating Chrome's `window.ai` with assistant-ui
+- [@stingfeng](https://github.com/stingfeng/dify-extensions) for building a [Dify](https://dify.ai) integration
+- [@Ephibbs](https://github.com/Ephibbs/flowtoken) for building a Perplexity-style text streaming library ([Demo](https://assistant-ui-flowtoken-demo.vercel.app/))
+- … and so many others
+
+assistant-ui builds on top of [Radix UI](https://www.radix-ui.com/), [Tailwind](https://tailwindcss.com/), [shadcn/ui](https://ui.shadcn.com/), [Vercel AI SDK](https://sdk.vercel.ai/docs/introduction) and other amazing open-source projects.
+
+Over the coming month, I'll be rolling out multimodal support, so you can use your voice and upload images. There's so much more in the pipeline that I can't wait to unveil!
+
+Today, several companies like [Helicone (YC W23)](https://x.com/justinstorre/status/1816849882612904156) are using assistant-ui to power a core part of their product. If your company wants to do the same, please [get in touch](https://cal.com/simon-farshid/assistant-ui).
+
+If you're building conversational AI, join us on [Discord](https://discord.gg/S9dwgCNEFs). If you're technical and want to shape how we interact with AIs of the future, [send me an email](mailto:simon@assistant-ui.com).

package/.docs/raw/blog/2024-09-11/index.mdx

@@ -0,0 +1,10 @@
+---
+title: Build conversational AI agents with LangGraph and assistant-ui
+description: Announcing our collaboration with LangChain
+author: Harrison Chase
+date: 2024-09-11T12:00:00
+---
+
+import { Redirect } from "./redirect";
+
+<Redirect />

package/.docs/raw/blog/2024-12-15/index.mdx

@@ -0,0 +1,10 @@
+---
+title: Announcing github-assistant
+description: github-assistant answers questions about your GitHub repositories.
+author: Amir Zohrenejad
+date: 2024-12-15T12:00:00
+---
+
+import { Redirect } from "./redirect";
+
+<Redirect />

package/.docs/raw/blog/2025-01-31-changelog/index.mdx

@@ -0,0 +1,129 @@
+---
+title: January 2025 Changelog
+description: shadcn/ui, Thread Management, Improvements to AI SDK and LangGraph support
+author: Simon Farshid
+date: 2025-01-31T12:00:00
+---
+
+import { Callout } from "fumadocs-ui/components/callout";
+
+<Callout emoji="🎉">
+  This is the first edition of our changelog. We post these updates on a monthly
+  basis. If you want more frequent updates about our new features, join our
+  Discord where we have a `#changelog` channel that is updated on a daily basis.
+</Callout>
+
+## Summary
+
+In January, we shipped 36 new versions of our package `@assistant-ui/react`. We also crossed 10k weekly downloads on npm for the first time. 🎉
+
+## shadcn/ui CLI support
+
+You can now install all components using the shadcn CLI, e.g.
+
+```sh
+npx shadcn@latest add "https://r.assistant-ui.com/thread"
+```
+
+We began a migration towards distributing our components as unstyled primitives and using the shadcn CLI to drop styles in your project.
+
+## 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 ease the migration, we added a migration codemod:
+
+```sh
+npx assistant-ui upgrade
+```
+
+This will update your codebase to use the new package. This new package remains supported, however, based on the learnings from existing users, we recommend all new projects to use our shadcn/ui CLI instead.
+
+## Customizing the max-width of the Thread
+
+You can now customize the max-width of the thread via `--aui-thread-max-width` CSS variable.
+
+## Thread Management
+
+One of our main focus areas in this month was on the new Thread Management API. The new ThreadList API is available under `runtime.threads`. It allows you to create, switch to, rename, archive, and delete threads.
+
+We shipped a `<ThreadList />` component which gives the user the UI to manage their threads.
+
+We also shipped a few hooks `useThreadListItem()`, `useThreadListItemRuntime()`, `useRemoteThreadListRuntime()` and `useCloudThreadListRuntime()`.
+
+## Assistant Cloud
+
+We rolled out the new Assistant Cloud service to early users. This is a managed service for persistence, chat history, and thread management.
+Our runtimes are being upgraded to support Assistant Cloud natively by letting you pass a `cloud` object to the runtime hook.
+
+Keep an eye out for the public announcement of Assistant Cloud in a few days.
+
+## Improvements to our LangGraph Integration
+
+- We now have full support for LangGraph's `interrupt()`/`Command` API. You can check out the new example repository [here](https://github.com/assistant-ui/assistant-ui-langgraph-interrupt).
+- We now also support starting LangGraph runs without a user message (based on button input or other events).
+- Cancellation of runs is now supported via an `abortSignal` being passed to the LangGraph runtime adapter.
+
+## Improvements to our AI SDK Integration
+
+We now give you access to annotations and data packets in the assistant message:
+
+```tsx
+type AssistantMessage = {
+  metadata: {
+    unstable_annotations: [...],
+    unstable_data: [...],
+  }
+}
+```
+
+## AI SDK recommended for new projects
+
+For new projects, we recommend using the AI SDK integration. Previously, we recommended our custom SDK called `useEdgeRuntime`.  
+With our improved AI SDK integration, we believe it is time to recommend AI SDK for new projects, giving you access to the AI SDK ecosystem.
+
+The edge runtime remains maintained and supported for existing projects.
+
+## Misc
+
+- **Refactors & API Enhancements**:
+
+  - Renamed `ModelConfig` to `ModelContext`.
+  - Moved `switchToThread / switchToNewThread` under `runtime.threads`.
+  - Deprecated `UIContentPart`.
+  - `ToolCallContentPart.args` is now a `JSONObject`.
+  - `MessagePrimitive.tools.Override` introduced.
+  - Added `AppendMessage.sourceId` to provide better tracking.
+  - Reverse order of threads in `useRemoteThreadListRuntime` for better visibility.
+  - Added `threads.getById` and `threads.main` APIs.
+  - Introduced `AssistantCloudThreadHistoryAdapter` to handle cloud-based thread history.
+  - Auto-injection of history adapter in the local runtime.
+  - Tool call `id` + `args` are now optional in `ThreadMessageLike`.
+  - Added `ThreadListPrimitive.Root`.
+  - `ComposerRuntime.clearAttachments` API added.
+  - Improved input support for IME keyboards (e.g., Chinese, Japanese, Korean).
+  - Moved repository to a new GitHub organization (`assistant-ui/assistant-ui`).
+
+- **External Store & Data Handling**:
+
+  - Enhanced `ExternalStoreAdapter` to support metadata and attachments.
+  - Renamed `getExternalStoreMessage` to `getExternalStoreMessages`.
+  - Tool call `args` streaming support in our Python SDK.
+
+- **User Interface & Styling**:
+
+  - Styled UI assistant message footer.
+  - Improved attachment filename handling to prevent overflow.
+  - Renamed CSS class to `aui-thread-welcome-suggestions`.
+
+- **Performance Optimizations**:
+
+  - Memoized `MessageRepository.getMessages()` for better efficiency.
+  - Marked `ChatAdapter` types as readonly.
+
+- **Bug Fixes**:
+
+  - Fixed event subscription issues in thread lists.
+  - Fixed import errors in React server environments.
+  - Prevented excessive classes being included via TailwindCSS.
+  - Fixed AI SDK annotation packet errors.

package/.docs/raw/docs/about-assistantui.mdx

@@ -0,0 +1,44 @@
+---
+title: "About assistant-ui"
+---
+
+import { Sparkles, PanelsTopLeft, Database, Terminal } from "lucide-react";
+
+assistant-ui helps you create beautiful, enterprise-grade AI chat interfaces in minutes. Whether you're building a chatGPT clone, a customer support chatbot, an AI assistant, or a complex multi agent application, assistant-ui provides the frontend primative components and state management layers to focus on what makes your application unique.
+
+## Key Features
+
+<Cards>
+
+    <Card icon={<PanelsTopLeft className="text-purple-300" />} title='Instant Chat UI'>
+
+    Pre-built beautiful, customizable chat interfaces out of the box. Easy to quickly iterate on your idea.
+
+    </Card>
+
+    <Card icon={<PanelsTopLeft className="text-blue-300" />} title='Chat State Management'>
+
+    Powerful state management for chat interactions, optimized for streaming responses and efficient rendering.
+
+    </Card>
+
+    <Card icon={<Database className="text-green-300" />} title='High Performance'>
+
+    Optimized for speed and efficiency with minimal bundle size, ensuring your AI chat interfaces remain responsive.
+
+    </Card>
+
+    <Card icon={<Terminal className="text-orange-300" />} title='Framework Agnostic'>
+
+    Easily integrate with any backend system, whether using Vercel AI SDK, direct LLM connections, or custom solutions.
+     Works with any React-based framework.
+
+    </Card>
+
+</Cards>
+
+<Callout title="Want to try it out?">
+  [Get Started in 30 Seconds](/docs/getting-started).
+</Callout>
+
+

package/.docs/raw/docs/api-reference/context-providers/AssistantRuntimeProvider.mdx

@@ -0,0 +1,30 @@
+---
+title: <AssistantRuntimeProvider />
+---
+
+import { ParametersTable } from "@/components/docs";
+import { AssistantRuntimeProvider } from "@/generated/typeDocs";
+
+The `AssistantRuntimeProvider` provides data and APIs used by assistant-ui components.
+
+Almost all components in assistant-ui require an `AssistantRuntimeProvider` around them to function properly.
+
+You must either wrap your app in an `AssistantRuntimeProvider` or pass a `runtime` to the `<Thread />` component instead.
+
+```tsx {1, 8, 10}
+import { AssistantRuntimeProvider } from "@assistant-ui/react";
+
+const MyApp = () => {
+  const runtime = useChatRuntime({ api: "/api/chat" });
+
+  return (
+    <AssistantRuntimeProvider runtime={runtime}>
+      {/* your app */}
+    </AssistantRuntimeProvider>
+  );
+};
+```
+
+#### Properties
+
+<ParametersTable {...AssistantRuntimeProvider} />

package/.docs/raw/docs/api-reference/context-providers/TextContentPartProvider.mdx

@@ -0,0 +1,26 @@
+---
+title: <TextContentPartProvider />
+---
+
+import { ParametersTable } from "@/components/docs";
+import { AssistantRuntimeProvider } from "@/generated/typeDocs";
+
+The `TextContentPartProvider` provides data and APIs for `TextContentPart` components.
+
+This is useful if you want to reuse the same `Text` component outside of a message text, e.g. with the `@assistant-ui/react-markdown` package.
+
+```tsx {1, 8, 10}
+import { AssistantRuntimeProvider } from "@assistant-ui/react";
+
+const MyApp = () => {
+  return (
+    <TextContentPartProvider text={"Hello!"}>
+      <MyMarkdownText />
+    </AssistantRuntimeProvider>
+  );
+};
+```
+
+#### Properties
+
+<ParametersTable {...AssistantRuntimeProvider} />

package/.docs/raw/docs/api-reference/integrations/react-hook-form.mdx

@@ -0,0 +1,103 @@
+---
+title: "@assistant-ui/react-hook-form"
+---
+
+A React Hook Form integration for @assistant-ui.
+
+import { ParametersTable } from "@/components/docs";
+
+## API Reference
+
+### `useAssistantForm`
+
+Drop-in replacement hook for `useForm` that adds support for `@assistant-ui/react`.
+
+```diff
+- import { useForm } from "react-hook-form";
++ import { useAssistantForm } from "@assistant-ui/react-hook-form";
+
+- useForm({
++ useAssistantForm({
+    ...
+  });
+```
+
+#### Properties
+
+<ParametersTable
+  type="UseAssistantFormProps"
+  parameters={[
+    {
+      name: "assistant",
+      type: "object",
+      optional: true,
+      description: "Configuration for useAssistantForm",
+      children: [
+        {
+          parameters: [
+            {
+              name: "tools",
+              type: "object",
+              description: "Tools configuration for useAssistantForm",
+              children: [
+                {
+                  parameters: [
+                    {
+                      name: "set_form_field",
+                      type: "object",
+                      description: "Configuration for the set_form_field tool",
+                      children: [
+                        {
+                          parameters: [
+                            {
+                              name: "render",
+                              type: "ToolCallContentPartComponent<{ name: string; value: string; }, {}>",
+                              description:
+                                "The component to render when set_form_field is called.",
+                            },
+                          ],
+                        },
+                      ],
+                    },
+                    {
+                      name: "submit_form",
+                      type: "object",
+                      description: "Configuration for the submit_form tool",
+                      children: [
+                        {
+                          parameters: [
+                            {
+                              name: "render",
+                              type: "ToolCallContentPartComponent<{}, {}>",
+                              description:
+                                "The component to render when submit_form is called.",
+                            },
+                          ],
+                        },
+                      ],
+                    },
+                  ],
+                },
+              ],
+            },
+          ],
+        },
+      ],
+    },
+  ]}
+/>
+
+### `formTools`
+
+The set of tools to use with `useAssistantForm`, useful for runtimes that do not support client-side tool definitions (i.e. Vercel AI SDK).
+
+```tsx {1, 5-7}
+import { formTools } from "@assistant-ui/react-hook-form";
+
+const result = streamText({
+  ...
+  tools: {
+    ...formTools,
+  }
+});
+```

package/.docs/raw/docs/api-reference/integrations/vercel-ai-sdk.mdx

@@ -0,0 +1,145 @@
+---
+title: "@assistant-ui/react-ai-sdk"
+---
+
+Vercel AI SDK integration for assistant-ui.
+
+import { ParametersTable } from "@/components/docs";
+
+## API Reference
+
+### `useVercelUseChatRuntime`
+
+Convert Vercel AI SDK chat helpers into a `AssistantRuntime`.
+
+```tsx
+import { useVercelUseChatRuntime } from "@assistant-ui/react-ai-sdk";
+
+const MyRuntimeProvider = ({ children }: { children: React.ReactNode }) => {
+  const chat = useChat();
+  const runtime = useVercelUseChatRuntime(chat);
+
+  return (
+    <AssistantRuntimeProvider runtime={runtime}>
+      {children}
+    </AssistantRuntimeProvider>
+  );
+};
+```
+
+<ParametersTable
+  parameters={[
+    {
+      name: "chat",
+      type: "ReturnType<typeof useChat>",
+      description: "The UseChatHelpers from @ai-sdk/react.",
+    },
+  ]}
+/>
+
+### `useVercelUseAssistantRuntime`
+
+Convert Vercel AI SDK assistant helpers into a `AssistantRuntime`.
+
+```tsx
+import { useVercelUseAssistantRuntime } from "@assistant-ui/react-ai-sdk";
+
+const MyRuntimeProvider = ({ children }: { children: React.ReactNode }) => {
+  const assistant = useAssistant();
+  const runtime = useVercelUseAssistantRuntime(assistant);
+
+  return (
+    <AssistantRuntimeProvider runtime={runtime}>
+      {children}
+    </AssistantRuntimeProvider>
+  );
+};
+```
+
+<ParametersTable
+  parameters={[
+    {
+      name: "assistant",
+      type: "ReturnType<typeof useAssistant>",
+      description: "The UseAssistantHelpers from @ai-sdk/react.",
+    },
+  ]}
+/>
+
+### `useVercelRSCRuntime`
+
+Convert Vercel RSC runtime into a `AssistantRuntime`.
+
+```tsx
+import { useVercelRSCRuntime } from "@assistant-ui/react-ai-sdk";
+
+const MyRuntimeProvider = ({ children }: { children: React.ReactNode }) => {
+  const [messages, setMessages] = useUIState<typeof AI>();
+
+  const onNew = async (m: AppendMessage) => {
+    if (m.content[0]?.type !== "text")
+      throw new Error("Only text messages are supported");
+
+    const input = m.content[0].text;
+    setMessages((currentConversation) => [
+      ...currentConversation,
+      { id: nanoid(), role: "user", display: input },
+    ]);
+
+    const message = await continueConversation(input);
+
+    setMessages((currentConversation) => [...currentConversation, message]);
+  };
+
+  const runtime = useVercelRSCRuntime({ messages, onNew });
+
+  return (
+    <AssistantRuntimeProvider runtime={runtime}>
+      {children}
+    </AssistantRuntimeProvider>
+  );
+};
+```
+
+<ParametersTable
+  parameters={[
+    {
+      name: "adapter",
+      type: "VercelRSCAdapter<TMessage>",
+      description: "The Vercel RSC adapter to use.",
+      children: [
+        {
+          type: "VercelRSCAdapter<TMessage>",
+          parameters: [
+            {
+              name: "messages",
+              type: "readonly ThreadMessage[]",
+              description: "The messages in the thread.",
+            },
+            {
+              name: "onNew",
+              type: "(message: AppendMessage) => Promise<void>",
+              description: "A function to append a message to the thread.",
+            },
+            {
+              name: "onEdit",
+              type: "(message: AppendMessage) => Promise<void>",
+              description: "A function to edit a message.",
+            },
+            {
+              name: "onReload",
+              type: "(parentId: string | null) => Promise<void>",
+              description: "A function to reload a message.",
+            },
+            {
+              name: "convertMessage",
+              type: "(message: TMessage) => VercelRSCMessage",
+              description:
+                "A function to convert messages to the VercelRSCMessage format. Only required if your message objects are not already compatible with Vercel RSC.",
+            },
+          ],
+        },
+      ],
+    },
+  ]}
+/>