@assistant-ui/mcp-docs-server 0.2.3 → 0.3.0

package/.docs/raw/docs/migrations/deprecation-policy.mdx

@@ -1,42 +0,0 @@
----
-title: Deprecation Policy
-description: Stability guarantees and deprecation timelines for assistant-ui features.
----
-
-assistant-ui is committed to providing a stable API, so you can spend your time building amazing things on top of it.
-
-Rarely, we need to deprecate a feature we've already shipped, because it is causing performance, usability, or security issues.
-In such cases, we will communicate the intent to unship as soon as possible by marking the feature as `@deprecated` and publishing a notice in the documentation.
-
-Deprecations and breaking changes primarily affect new features released. The longer an API has been in the library, the less likely it is to be deprecated.
-For features that have long existed in the library, we will provide a longer deprecation notice period (as described below).
-
-Below is a list of features considered stable and those considered experimental.
-
-## Experimental Features
-
-These features may be removed at any time without notice.
-
-- Anything marked as `unstable_`, `experimental_`, or `internal`
-- The `RuntimeCore` API (considered internal)
-
-## Beta Features
-
-A deprecation of these features will undergo a short (<1) month deprecation notice period.
-
-- TailwindCSS Plugins (e.g. `tw-shimmer`, `tw-glass`)
-- Context API
-- Runtime API
-- Message types
-- Styled UI components
-- Primitive Hooks (e.g. useBranchPickerNext)
-- Attachment APIs
-- shadcn/ui styles
-
-## Stable Features
-
-A deprecation of these features will undergo a long (>3 month) deprecation notice period.
-
-The following features are considered stable:
-
-- Primitives (except for `AttachmentPrimitive`)

package/.docs/raw/docs/migrations/index.mdx

@@ -1,50 +0,0 @@
----
-title: Migration Guides
-description: Upgrade assistant-ui versions and migrate deprecated APIs and integrations.
----
-
-Use these guides when upgrading assistant-ui or moving from APIs that have been deprecated or replaced.
-
-## Version upgrades
-
-<Cards>
-  <Card title="Migration to v0.14" href="/docs/migrations/v0-14">
-    Replace APIs removed after v0.11 and v0.12, and migrate primitive
-    `components` props to children render functions.
-  </Card>
-  <Card title="Migration to v0.12" href="/docs/migrations/v0-12">
-    Move from individual context hooks to the unified state API.
-  </Card>
-  <Card title="Migration to v0.11" href="/docs/migrations/v0-11">
-    Update code affected by the `ContentPart` to `MessagePart` rename.
-  </Card>
-</Cards>
-
-## APIs and integrations
-
-<Cards>
-  <Card title="Migrating Tools to Toolkits" href="/docs/migrations/toolkit-tools">
-    Move legacy tool and tool UI registrations to the toolkit API.
-  </Card>
-  <Card
-    title="Migrating to react-langgraph v0.7"
-    href="/docs/migrations/react-langgraph-v0-7"
-  >
-    Upgrade to the simplified LangGraph integration API.
-  </Card>
-  <Card
-    title="Using old React versions"
-    href="/docs/migrations/react-compatibility"
-  >
-    Review compatibility notes for React 18 and React 19.
-  </Card>
-</Cards>
-
-## Stability
-
-<Cards>
-  <Card title="Deprecation Policy" href="/docs/migrations/deprecation-policy">
-    Review stability guarantees and deprecation timelines for assistant-ui
-    features.
-  </Card>
-</Cards>

package/.docs/raw/docs/migrations/react-compatibility.mdx

@@ -1,74 +0,0 @@
----
-title: Using old React versions
-description: Compatibility notes for React 18 and 19.
----
-
-
-<Callout type="warning" title="React 18 Required">
-  assistant-ui requires React 18 or React 19. React 17 and React 16 are not
-  supported. If you need help with an upgrade, join our
-  [Discord](https://discord.gg/S9dwgCNEFs).
-</Callout>
-
-This guide provides instructions for configuring assistant-ui to work with React 18.
-
-## React 18
-
-If you're using React 18, you need to update the shadcn/ui components to work with `forwardRef`. Specifically, you need to modify the Button component.
-
-### Updating the Button Component
-
-Navigate to your button component file (typically `/components/ui/button.tsx`) and wrap the Button component with `forwardRef`:
-
-```tsx
-// Before
-function Button({
-  className,
-  variant,
-  size,
-  asChild = false,
-  ...props
-}: React.ComponentProps<"button"> &
-  VariantProps<typeof buttonVariants> & {
-    asChild?: boolean;
-  }) {
-  const Comp = asChild ? Slot : "button";
-
-  return (
-    <Comp
-      data-slot="button"
-      className={cn(buttonVariants({ variant, size, className }))}
-      {...props}
-    />
-  );
-}
-
-// After
-const Button = React.forwardRef<
-  HTMLButtonElement,
-  React.ComponentProps<"button"> &
-    VariantProps<typeof buttonVariants> & {
-      asChild?: boolean;
-    }
->(({ className, variant, size, asChild = false, ...props }, ref) => {
-  const Comp = asChild ? Slot : "button";
-
-  return (
-    <Comp
-      data-slot="button"
-      className={cn(buttonVariants({ variant, size, className }))}
-      ref={ref}
-      {...props}
-    />
-  );
-});
-Button.displayName = "Button";
-```
-
-## Additional Resources
-
-If you encounter any issues with React compatibility, please:
-
-1. Check that all required dependencies are installed
-2. Ensure your component modifications are correctly implemented
-3. Join our [Discord](https://discord.gg/S9dwgCNEFs) community for direct support

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

@@ -1,328 +0,0 @@
----
-title: Migrating to react-langgraph v0.7
-description: Guide to upgrading to the simplified LangGraph integration API.
----
-
-
-## Overview
-
-This guide helps you migrate from the previous LangGraph integration pattern to the new simplified API introduced in `@assistant-ui/react-langgraph` v0.7. The new API consolidates thread management directly into `useLangGraphRuntime`, eliminating the need for separate runtime hooks and manual thread state management.
-
-## Key Changes
-
-### 1. Simplified Thread Management
-
-The `useLangGraphRuntime` hook now directly handles thread lifecycle:
-- No more `useRemoteThreadListRuntime` wrapper
-- No more separate runtime hook functions
-- Thread management is built into the core runtime
-
-### 2. New `initialize` Parameter
-
-The `stream` function now receives an `initialize` parameter that handles thread creation and loading automatically.
-
-### 3. Direct Cloud Integration
-
-Cloud persistence can now be configured directly in `useLangGraphRuntime` with the `cloud` parameter.
-
-## Migration Steps
-
-<Steps>
-
-<Step>
-
-### Update Your Runtime Implementation
-
-#### Before (Old Pattern)
-
-```tsx
-import {
-  useCloudThreadListRuntime,
-  useThreadListItemRuntime,
-} from "@assistant-ui/react";
-import { useLangGraphRuntime } from "@assistant-ui/react-langgraph";
-
-const useMyLangGraphRuntime = () => {
-  const threadListItemRuntime = useThreadListItemRuntime();
-
-  const runtime = useLangGraphRuntime({
-    stream: async function* (messages) {
-      const { externalId } = await threadListItemRuntime.initialize();
-      if (!externalId) throw new Error("Thread not found");
-
-      return sendMessage({
-        threadId: externalId,
-        messages,
-      });
-    },
-    onSwitchToThread: async (externalId) => {
-      const state = await getThreadState(externalId);
-      return {
-        messages: state.values.messages,
-      };
-    },
-  });
-
-  return runtime;
-};
-
-// In your component:
-const runtime = useCloudThreadListRuntime({
-  cloud,
-  runtimeHook: useMyLangGraphRuntime,
-  create: async () => {
-    const { thread_id } = await createThread();
-    return { externalId: thread_id };
-  },
-});
-```
-
-#### After (New Pattern)
-
-```tsx
-import { useLangGraphRuntime } from "@assistant-ui/react-langgraph";
-
-// Directly in your component:
-const runtime = useLangGraphRuntime({
-  cloud, // Optional: for cloud persistence
-  stream: async function* (messages, { initialize }) {
-    const { externalId } = await initialize();
-    if (!externalId) throw new Error("Thread not found");
-
-    return sendMessage({
-      threadId: externalId,
-      messages,
-    });
-  },
-  create: async () => {
-    const { thread_id } = await createThread();
-    return { externalId: thread_id };
-  },
-  load: async (externalId) => {
-    const state = await getThreadState(externalId);
-    return {
-      messages: state.values.messages,
-    };
-  },
-});
-```
-
-</Step>
-
-<Step>
-
-### Update Import Statements
-
-Remove unused imports:
-
-```diff
-- import {
--   useCloudThreadListRuntime,
--   useThreadListItemRuntime,
-- } from "@assistant-ui/react";
-+ import { AssistantCloud } from "@assistant-ui/react";
-```
-
-</Step>
-
-<Step>
-
-### Simplify Component Structure
-
-You no longer need a separate runtime hook function. Everything can be defined directly in your component or provider:
-
-```tsx
-export function MyRuntimeProvider({ children }) {
-  const cloud = useMemo(
-    () => new AssistantCloud({
-      baseUrl: process.env.NEXT_PUBLIC_ASSISTANT_BASE_URL,
-      anonymous: true,
-    }),
-    []
-  );
-
-  const runtime = useLangGraphRuntime({
-    cloud,
-    // All configuration inline
-    stream: async function* (messages, { initialize }) {
-      // Your stream implementation
-    },
-    create: async () => {
-      // Your create implementation
-    },
-    load: async (externalId) => {
-      // Your load implementation
-    },
-  });
-
-  return (
-    <AssistantRuntimeProvider runtime={runtime}>
-      {children}
-    </AssistantRuntimeProvider>
-  );
-}
-```
-
-</Step>
-
-<Step>
-
-### Update Method Names
-
-Rename methods to match the new API:
-
-- `onSwitchToThread` → `load`
-- `onSwitchToNewThread` → handled automatically via `create`
-- Thread ID management is now automatic
-
-</Step>
-
-</Steps>
-
-## API Reference Changes
-
-### Old API
-
-```typescript
-type OldLangGraphRuntimeOptions = {
-  threadId?: string;
-  stream: (messages: Message[]) => AsyncGenerator;
-  onSwitchToNewThread?: () => Promise<void>;
-  onSwitchToThread?: (threadId: string) => Promise<ThreadState>;
-};
-```
-
-### New API
-
-```typescript
-type NewLangGraphRuntimeOptions = {
-  cloud?: AssistantCloud;
-  stream: (
-    messages: Message[],
-    config: {
-      abortSignal: AbortSignal;
-      initialize: () => Promise<{
-        remoteId: string;
-        externalId: string | undefined;
-      }>;
-      command?: { resume: string };
-      runConfig?: unknown;
-      checkpointId?: string;
-    }
-  ) => AsyncGenerator;
-  create?: () => Promise<{ externalId: string }>;
-  load?: (threadId: string) => Promise<ThreadState>;
-  delete?: (threadId: string) => Promise<void>;
-};
-```
-
-## Benefits of the New API
-
-1. **Simpler Setup**: No need for multiple runtime hooks and wrappers
-2. **Cleaner Code**: All configuration in one place
-3. **Better Type Safety**: More explicit types for thread management
-4. **Automatic Thread Handling**: The runtime manages thread lifecycle internally
-5. **Optional Cloud Integration**: Add cloud persistence with a single parameter
-
-## Common Migration Issues
-
-<Callout type="warning">
-  **Breaking Change**: The `threadId` and `onSwitchToNewThread` parameters are no longer supported. Use the new `create` and `load` methods instead.
-</Callout>
-
-### Issue: `threadListItemRuntime` is not defined
-
-**Solution**: Remove references to `useThreadListItemRuntime()`. Use the `initialize` parameter in the stream function instead.
-
-### Issue: Thread switching doesn't work
-
-**Solution**: Ensure you've implemented both `create` and `load` functions. The runtime needs both to manage thread lifecycle.
-
-### Issue: Cloud persistence not working
-
-**Solution**: Pass the `AssistantCloud` instance directly to `useLangGraphRuntime` via the `cloud` parameter.
-
-## Example: Complete Migration
-
-Here's a complete before and after example for a typical LangGraph integration:
-
-### Before
-
-```tsx title="runtime-provider.tsx"
-import {
-  AssistantCloud,
-  AssistantRuntimeProvider,
-  useCloudThreadListRuntime,
-  useThreadListItemRuntime,
-} from "@assistant-ui/react";
-import { useLangGraphRuntime } from "@assistant-ui/react-langgraph";
-
-const useMyRuntime = () => {
-  const threadListItemRuntime = useThreadListItemRuntime();
-
-  return useLangGraphRuntime({
-    stream: async function* (messages) {
-      const { externalId } = await threadListItemRuntime.initialize();
-      // ... implementation
-    },
-    onSwitchToThread: async (externalId) => {
-      // ... implementation
-    },
-  });
-};
-
-export function Provider({ children }) {
-  const cloud = new AssistantCloud({ /* config */ });
-
-  const runtime = useCloudThreadListRuntime({
-    cloud,
-    runtimeHook: useMyRuntime,
-    create: async () => { /* ... */ },
-  });
-
-  return (
-    <AssistantRuntimeProvider runtime={runtime}>
-      {children}
-    </AssistantRuntimeProvider>
-  );
-}
-```
-
-### After
-
-```tsx title="runtime-provider.tsx"
-import {
-  AssistantCloud,
-  AssistantRuntimeProvider,
-} from "@assistant-ui/react";
-import { useLangGraphRuntime } from "@assistant-ui/react-langgraph";
-
-export function Provider({ children }) {
-  const cloud = new AssistantCloud({ /* config */ });
-
-  const runtime = useLangGraphRuntime({
-    cloud,
-    stream: async function* (messages, { initialize }) {
-      const { externalId } = await initialize();
-      // ... implementation
-    },
-    create: async () => { /* ... */ },
-    load: async (externalId) => {
-      // ... implementation (formerly onSwitchToThread)
-    },
-  });
-
-  return (
-    <AssistantRuntimeProvider runtime={runtime}>
-      {children}
-    </AssistantRuntimeProvider>
-  );
-}
-```
-
-## Need Help?
-
-If you encounter issues during migration:
-1. Check the updated [LangGraph documentation](/docs/runtimes/langgraph/overview)
-2. Review the [example implementation](https://github.com/assistant-ui/assistant-ui/tree/main/examples/with-langgraph)
-3. Report issues on [GitHub](https://github.com/assistant-ui/assistant-ui/issues)