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

package/.docs/raw/docs/(reference)/api-reference/transport/frame.mdx

@@ -1,62 +0,0 @@
----
-title: Assistant Frame
-description: Frame bridge APIs and serialized message types for embedding assistant-ui runtimes in external contexts.
----
-
-import { AssistantFrameHost, AssistantFrameProvider, FrameMessage, SerializedModelContext, SerializedTool, useAssistantFrameHost } from "@/generated/typeDocs";
-
-{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
-{/* Do not edit manually. */}
-
-{/* api-reference:start */}
-{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
-{/* Do not edit this block manually. */}
-
-## API Reference
-
-### AssistantFrameHost
-
-<ParametersTable {...AssistantFrameHost} />
-
-### AssistantFrameProvider
-
-<ParametersTable {...AssistantFrameProvider} />
-
-### FRAME_MESSAGE_CHANNEL
-
-```ts
-const FRAME_MESSAGE_CHANNEL: "assistant-ui-frame";
-```
-
-### FrameMessage
-
-<ParametersTable {...FrameMessage} />
-
-### SerializedModelContext
-
-<ParametersTable {...SerializedModelContext} />
-
-### SerializedTool
-
-<ParametersTable {...SerializedTool} />
-
-### useAssistantFrameHost
-
-React hook that manages the lifecycle of an AssistantFrameHost and its binding to the current AssistantRuntime.
-
-Usage example:
-```typescript
-function MyComponent() {
-  const iframeRef = useRef<HTMLIFrameElement>(null);
-
-  useAssistantFrameHost({
-    iframeRef,
-    targetOrigin: "https://trusted-domain.com",
-  });
-
-  return <iframe ref={iframeRef} src="..." />;
-}
-```
-
-<ParametersTable {...useAssistantFrameHost} />
-{/* api-reference:end */}

package/.docs/raw/docs/(reference)/api-reference/transport/index.mdx

@@ -1,22 +0,0 @@
----
-title: Transport API Reference
-description: Transport commands, frame messages, and protocol types for synchronizing assistant-ui runtimes across process or iframe boundaries.
----
-
-{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
-{/* The page list is generated from exported APIs; edit only the manual prose slot. */}
-
-{/* api-manual:start */}
-Transport APIs are for runtimes that cross a network, worker, iframe, or other execution boundary. They document the command and frame contracts that keep assistant-ui state synchronized with an external process.
-{/* api-manual:end */}
-
-## Pages
-
-<Cards>
-  <Card title={"Assistant Transport"} href={"/docs/api-reference/transport/assistant-transport"}>
-    {"Command, protocol, and transport types for connecting assistant-ui runtimes across execution boundaries."}
-  </Card>
-  <Card title={"Assistant Frame"} href={"/docs/api-reference/transport/frame"}>
-    {"Frame bridge APIs and serialized message types for embedding assistant-ui runtimes in external contexts."}
-  </Card>
-</Cards>

package/.docs/raw/docs/(reference)/api-reference/utilities/index.mdx

@@ -1,19 +0,0 @@
----
-title: Utilities API Reference
-description: Utility exports for custom rendering, composition, and advanced assistant-ui behavior that does not fit a larger API family.
----
-
-{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
-{/* The page list is generated from exported APIs; edit only the manual prose slot. */}
-
-{/* api-manual:start */}
-Utilities collect small public exports that are useful when building custom assistant-ui components but do not belong to a larger feature area. Start here when you recognize an export name but not its surrounding API family.
-{/* api-manual:end */}
-
-## Pages
-
-<Cards>
-  <Card title={"Utilities"} href={"/docs/api-reference/utilities/miscellaneous"}>
-    {"Miscellaneous @assistant-ui/react utilities for custom rendering, composition, and advanced assistant UI behavior."}
-  </Card>
-</Cards>

package/.docs/raw/docs/(reference)/api-reference/utilities/miscellaneous.mdx

@@ -1,152 +0,0 @@
----
-title: Utilities
-description: Miscellaneous @assistant-ui/react utilities for custom rendering, composition, and advanced assistant UI behavior.
----
-
-import { AssistantCloud, AuiConfig, ChainOfThoughtClient, DevToolsHooks, InMemoryThreadList, MessageNotSentError, RemoteThreadList, SingleThreadList, Suggestions, useSmooth } from "@/generated/typeDocs";
-
-{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
-{/* Do not edit manually. */}
-
-{/* api-reference:start */}
-{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
-{/* Do not edit this block manually. */}
-
-## API Reference
-
-### AssistantCloud
-
-<ParametersTable {...AssistantCloud} />
-
-### AuiConfig
-
-Builds a config for [AuiProvider](/docs/api-reference/context-providers/assistant-runtime-provider#auiprovider); the `config` prop only accepts
-configs built with this helper.
-
-A config is plain data: it can be hoisted to module scope, created inline
-per render, or memoized — the provider never relies on config identity.
-
-```tsx
-const aui = useAui();
-const config = AuiConfig({
-  message: Derived({
-    source: "thread",
-    query: { index: 0 },
-    get: (aui) => aui.thread.message({ index: 0 }),
-  }),
-});
-
-<AuiProvider extends={aui} config={config}>{children}</AuiProvider>;
-```
-
-<ParametersTable {...AuiConfig} />
-
-### ChainOfThoughtClient
-
-<ParametersTable {...ChainOfThoughtClient} />
-
-### createMessageQueue
-
-```ts
-const createMessageQueue: (driver: MessageQueueDriver) => MessageQueueController;
-```
-
-### DevToolsHooks
-
-<ParametersTable {...DevToolsHooks} />
-
-### InMemoryThreadList
-
-<ParametersTable {...InMemoryThreadList} />
-
-### isMessageNotSentError
-
-```ts
-const isMessageNotSentError: (error: unknown) => error is MessageNotSentError;
-```
-
-### MessageNotSentError
-
-Rejection reason for a send that never reached the backend, so nothing ran
-and nothing is recoverable from the thread. A runtime adapter throws it from
-`onNew` to hand the message back to the thread composer, which restores the
-draft it cleared at dispatch time when nothing has claimed the composer
-since. An edit composer closes at dispatch, so a rejected edit is not
-restored.
-
-<ParametersTable {...MessageNotSentError} />
-
-### RemoteThreadList
-
-`AuiConfig` `threads` entry backed by a `RemoteThreadListAdapter`. Thread
-bodies are born from the `thread` factory inside the client tree, so any
-`AssistantClient` host can run a remote or cloud list. Per-thread history
-and attachments come from `unstable_useAdapters`. `useRemoteThreadListRuntime`
-uses the same hook when `unstable_Provider` is omitted. Key the factory
-with `withKey` so history reloads when the visible thread changes.
-
-<ParametersTable {...RemoteThreadList} />
-
-### SingleThreadList
-
-<ParametersTable {...SingleThreadList} />
-
-### Suggestions
-
-<ParametersTable {...Suggestions} />
-
-### unstable_defaultDirectiveFormatter
-
-Default directive formatter using the `:type[label]{name=id}` syntax.
-
-When `id` equals `label`, the `{name=…}` attribute is omitted for brevity.
-
-```ts
-const unstable_defaultDirectiveFormatter: Unstable_DirectiveFormatter;
-```
-
-### useSmooth
-
-Animates streamed message part text with a typewriter-style reveal.
-
-Takes the current part state and a `smooth` argument: `false` disables,
-`true` uses the default rate, and a SmoothOptions object tunes
-the reveal. Returns the part state with `text` replaced by the revealed
-prefix and `status` reporting `running` until the reveal catches up.
-If the source settles before any character has been revealed, the text
-is committed immediately so a missed animation frame cannot leave an
-empty bubble.
-
-The reveal auto-disables under `prefers-reduced-motion: reduce`,
-committing the full text immediately; this takes precedence over an
-explicit `smooth={true}`.
-
-```tsx
-const { text, status } = useSmooth(useMessagePartText(), {
-  drainMs: 500,
-  maxCharsPerFrame: 30,
-});
-```
-
-<ParametersTable {...useSmooth} />
-
-### fromThreadMessageLike
-
-<Callout type="tip">
-<strong>Experimental.</strong> This API is experimental and may change without notice.
-</Callout>
-
-```ts
-const fromThreadMessageLike: (like: ThreadMessageLike, fallbackId: string, fallbackStatus: MessageStatus) => ThreadMessage;
-```
-
-### generateId
-
-<Callout type="tip">
-<strong>Experimental.</strong> This API is experimental and may change without notice.
-</Callout>
-
-```ts
-const generateId: (size?: number) => string;
-```
-{/* api-reference:end */}

package/.docs/raw/docs/(reference)/api-reference/voice/index.mdx

@@ -1,22 +0,0 @@
----
-title: Voice API Reference
-description: Realtime voice, speech synthesis, and dictation contracts for wiring spoken assistant flows into React chat UIs.
----
-
-{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
-{/* The page list is generated from exported APIs; edit only the manual prose slot. */}
-
-{/* api-manual:start */}
-Voice APIs cover the state and adapters needed for spoken assistant experiences. Use this section when connecting realtime voice sessions, speech synthesis controls, or dictation input to an assistant-ui runtime.
-{/* api-manual:end */}
-
-## Pages
-
-<Cards>
-  <Card title={"Voice Sessions"} href={"/docs/api-reference/voice/session"}>
-    {"Create and control realtime assistant-ui voice sessions, state, controls, and helpers."}
-  </Card>
-  <Card title={"Speech and Dictation"} href={"/docs/api-reference/voice/speech-dictation"}>
-    {"Connect speech synthesis and dictation adapters to assistant-ui voice and composer workflows."}
-  </Card>
-</Cards>

package/.docs/raw/docs/(reference)/api-reference/voice/session.mdx

@@ -1,54 +0,0 @@
----
-title: Voice Sessions
-description: Create and control realtime assistant-ui voice sessions, state, controls, and helpers.
----
-
-import { RealtimeVoiceAdapter, VoiceSessionControls, VoiceSessionHelpers, VoiceSessionState, createVoiceSession } from "@/generated/typeDocs";
-
-{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
-{/* Do not edit manually. */}
-
-{/* api-reference:start */}
-{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
-{/* Do not edit this block manually. */}
-
-## API Reference
-
-### createVoiceSession
-
-<ParametersTable {...createVoiceSession} />
-
-### RealtimeVoiceAdapter
-
-<ParametersTable {...RealtimeVoiceAdapter} />
-
-### useVoiceControls
-
-```ts
-const useVoiceControls: () => { connect: () => void; disconnect: () => void; mute: () => void; unmute: () => void; };
-```
-
-### useVoiceState
-
-```ts
-const useVoiceState: () => VoiceSessionState | undefined;
-```
-
-### useVoiceVolume
-
-```ts
-const useVoiceVolume: () => number;
-```
-
-### VoiceSessionControls
-
-<ParametersTable {...VoiceSessionControls} />
-
-### VoiceSessionHelpers
-
-<ParametersTable {...VoiceSessionHelpers} />
-
-### VoiceSessionState
-
-<ParametersTable {...VoiceSessionState} />
-{/* api-reference:end */}

package/.docs/raw/docs/(reference)/api-reference/voice/speech-dictation.mdx

@@ -1,36 +0,0 @@
----
-title: Speech and Dictation
-description: Connect speech synthesis and dictation adapters to assistant-ui voice and composer workflows.
----
-
-import { DictationAdapter, DictationState, SpeechSynthesisAdapter, WebSpeechDictationAdapter, WebSpeechSynthesisAdapter } from "@/generated/typeDocs";
-
-{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
-{/* Do not edit manually. */}
-
-{/* api-reference:start */}
-{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
-{/* Do not edit this block manually. */}
-
-## API Reference
-
-### DictationAdapter
-
-<ParametersTable {...DictationAdapter} />
-
-### DictationState
-
-<ParametersTable {...DictationState} />
-
-### SpeechSynthesisAdapter
-
-<ParametersTable {...SpeechSynthesisAdapter} />
-
-### WebSpeechDictationAdapter
-
-<ParametersTable {...WebSpeechDictationAdapter} />
-
-### WebSpeechSynthesisAdapter
-
-<ParametersTable {...WebSpeechSynthesisAdapter} />
-{/* api-reference:end */}