@assistant-ui/mcp-docs-server 0.1.30 → 0.1.32
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.docs/organized/code-examples/waterfall.md +8 -8
- package/.docs/organized/code-examples/with-a2a.md +10 -10
- package/.docs/organized/code-examples/with-ag-ui.md +12 -12
- package/.docs/organized/code-examples/with-ai-sdk-v6.md +14 -14
- package/.docs/organized/code-examples/with-artifacts.md +14 -14
- package/.docs/organized/code-examples/with-assistant-transport.md +11 -11
- package/.docs/organized/code-examples/with-browser-extension.md +345 -0
- package/.docs/organized/code-examples/with-chain-of-thought.md +129 -63
- package/.docs/organized/code-examples/with-cloud-standalone.md +13 -13
- package/.docs/organized/code-examples/with-cloud.md +13 -13
- package/.docs/organized/code-examples/with-custom-thread-list.md +65 -20
- package/.docs/organized/code-examples/with-elevenlabs-conversational.md +18 -17
- package/.docs/organized/code-examples/with-elevenlabs-scribe.md +18 -17
- package/.docs/organized/code-examples/with-expo.md +25 -25
- package/.docs/organized/code-examples/with-external-store.md +10 -10
- package/.docs/organized/code-examples/with-ffmpeg.md +14 -14
- package/.docs/organized/code-examples/with-generative-ui.md +211 -14
- package/.docs/organized/code-examples/with-google-adk.md +12 -12
- package/.docs/organized/code-examples/with-heat-graph.md +8 -8
- package/.docs/organized/code-examples/with-image-generation.md +454 -0
- package/.docs/organized/code-examples/with-interactables.md +14 -14
- package/.docs/organized/code-examples/with-langchain.md +12 -12
- package/.docs/organized/code-examples/with-langgraph.md +15 -12
- package/.docs/organized/code-examples/with-livekit.md +19 -18
- package/.docs/organized/code-examples/with-mcp.md +748 -0
- package/.docs/organized/code-examples/with-opencode.md +107 -62
- package/.docs/organized/code-examples/with-parent-id-grouping.md +12 -12
- package/.docs/organized/code-examples/with-react-hook-form.md +14 -14
- package/.docs/organized/code-examples/with-react-ink.md +4 -4
- package/.docs/organized/code-examples/with-react-router.md +16 -16
- package/.docs/organized/code-examples/with-resumable-stream.md +660 -0
- package/.docs/organized/code-examples/with-store.md +8 -8
- package/.docs/organized/code-examples/with-tanstack.md +14 -14
- package/.docs/organized/code-examples/with-tap-runtime.md +11 -10
- package/.docs/raw/docs/(docs)/cli.mdx +3 -1
- package/.docs/raw/docs/(docs)/copilots/assistant-frame.mdx +1 -0
- package/.docs/raw/docs/(docs)/copilots/make-assistant-tool-ui.mdx +10 -3
- package/.docs/raw/docs/(docs)/copilots/make-assistant-tool.mdx +8 -3
- package/.docs/raw/docs/(docs)/copilots/make-assistant-visible.mdx +1 -0
- package/.docs/raw/docs/(docs)/copilots/model-context.mdx +1 -0
- package/.docs/raw/docs/(docs)/copilots/motivation.mdx +1 -0
- package/.docs/raw/docs/(docs)/copilots/use-assistant-instructions.mdx +1 -0
- package/.docs/raw/docs/(docs)/devtools.mdx +1 -0
- package/.docs/raw/docs/(docs)/index.mdx +3 -2
- package/.docs/raw/docs/(docs)/installation.mdx +2 -1
- package/.docs/raw/docs/(docs)/rtl.mdx +1 -0
- package/.docs/raw/docs/(reference)/api-reference/adapters/attachments.mdx +36 -0
- package/.docs/raw/docs/(reference)/api-reference/adapters/feedback.mdx +20 -0
- package/.docs/raw/docs/(reference)/api-reference/adapters/index.mdx +34 -0
- package/.docs/raw/docs/(reference)/api-reference/adapters/model.mdx +44 -0
- package/.docs/raw/docs/(reference)/api-reference/adapters/persistence.mdx +55 -0
- package/.docs/raw/docs/(reference)/api-reference/adapters/runtime.mdx +20 -0
- package/.docs/raw/docs/(reference)/api-reference/adapters/suggestions.mdx +20 -0
- package/.docs/raw/docs/(reference)/api-reference/context-providers/assistant-runtime-provider.mdx +37 -8
- package/.docs/raw/docs/(reference)/api-reference/context-providers/index.mdx +22 -0
- package/.docs/raw/docs/(reference)/api-reference/context-providers/scoped-providers.mdx +64 -0
- package/.docs/raw/docs/(reference)/api-reference/external-store/index.mdx +22 -0
- package/.docs/raw/docs/(reference)/api-reference/external-store/message-conversion.mdx +52 -0
- package/.docs/raw/docs/(reference)/api-reference/external-store/runtime.mdx +36 -0
- package/.docs/raw/docs/(reference)/api-reference/hooks/composer-triggers.mdx +98 -0
- package/.docs/raw/docs/(reference)/api-reference/hooks/index.mdx +31 -0
- package/.docs/raw/docs/(reference)/api-reference/hooks/model-context.mdx +33 -0
- package/.docs/raw/docs/(reference)/api-reference/hooks/primitives.mdx +640 -0
- package/.docs/raw/docs/(reference)/api-reference/hooks/runtimes.mdx +28 -0
- package/.docs/raw/docs/(reference)/api-reference/hooks/state.mdx +94 -0
- package/.docs/raw/docs/(reference)/api-reference/hooks/utilities.mdx +464 -0
- package/.docs/raw/docs/(reference)/api-reference/integrations/cloud-ai-sdk.mdx +24 -0
- package/.docs/raw/docs/(reference)/api-reference/integrations/index.mdx +22 -0
- package/.docs/raw/docs/(reference)/api-reference/integrations/react-ai-sdk.mdx +79 -0
- package/.docs/raw/docs/(reference)/api-reference/model-context/context.mdx +52 -0
- package/.docs/raw/docs/(reference)/api-reference/model-context/index.mdx +22 -0
- package/.docs/raw/docs/(reference)/api-reference/model-context/registry.mdx +20 -0
- package/.docs/raw/docs/(reference)/api-reference/overview.mdx +125 -125
- package/.docs/raw/docs/(reference)/api-reference/primitives/action-bar-more.mdx +78 -221
- package/.docs/raw/docs/(reference)/api-reference/primitives/action-bar.mdx +127 -242
- package/.docs/raw/docs/(reference)/api-reference/primitives/assistant-if.mdx +46 -20
- package/.docs/raw/docs/(reference)/api-reference/primitives/assistant-modal.mdx +66 -87
- package/.docs/raw/docs/(reference)/api-reference/primitives/attachment.mdx +50 -58
- package/.docs/raw/docs/(reference)/api-reference/primitives/branch-picker.mdx +80 -48
- package/.docs/raw/docs/(reference)/api-reference/primitives/chain-of-thought.mdx +67 -0
- package/.docs/raw/docs/(reference)/api-reference/primitives/composer.mdx +323 -461
- package/.docs/raw/docs/(reference)/api-reference/primitives/error.mdx +36 -43
- package/.docs/raw/docs/(reference)/api-reference/primitives/index.mdx +70 -0
- package/.docs/raw/docs/(reference)/api-reference/primitives/message-part.mdx +63 -245
- package/.docs/raw/docs/(reference)/api-reference/primitives/message.mdx +182 -554
- package/.docs/raw/docs/(reference)/api-reference/primitives/queue-item.mdx +65 -0
- package/.docs/raw/docs/(reference)/api-reference/primitives/selection-toolbar.mdx +35 -22
- package/.docs/raw/docs/(reference)/api-reference/primitives/suggestion.mdx +57 -140
- package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list-item-more.mdx +70 -161
- package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list-item.mdx +84 -108
- package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list.mdx +82 -86
- package/.docs/raw/docs/(reference)/api-reference/primitives/thread.mdx +173 -314
- package/.docs/raw/docs/(reference)/api-reference/runtimes/assistant-runtime.mdx +9 -21
- package/.docs/raw/docs/(reference)/api-reference/runtimes/attachment-runtime.mdx +10 -21
- package/.docs/raw/docs/(reference)/api-reference/runtimes/composer-runtime.mdx +15 -70
- package/.docs/raw/docs/(reference)/api-reference/runtimes/index.mdx +43 -0
- package/.docs/raw/docs/(reference)/api-reference/runtimes/message-part-runtime.mdx +25 -28
- package/.docs/raw/docs/(reference)/api-reference/runtimes/message-runtime.mdx +11 -63
- package/.docs/raw/docs/(reference)/api-reference/runtimes/queue-state.mdx +20 -0
- package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-list-item-runtime.mdx +11 -48
- package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-list-runtime.mdx +10 -42
- package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-runtime.mdx +18 -30
- package/.docs/raw/docs/(reference)/api-reference/tools/component-tools.mdx +68 -0
- package/.docs/raw/docs/(reference)/api-reference/tools/index.mdx +39 -0
- package/.docs/raw/docs/(reference)/api-reference/tools/rendering.mdx +79 -0
- package/.docs/raw/docs/(reference)/api-reference/tools/status.mdx +42 -0
- package/.docs/raw/docs/(reference)/api-reference/tools/toolkits.mdx +92 -0
- package/.docs/raw/docs/(reference)/api-reference/transport/assistant-transport.mdx +48 -0
- package/.docs/raw/docs/(reference)/api-reference/transport/frame.mdx +62 -0
- package/.docs/raw/docs/(reference)/api-reference/transport/index.mdx +22 -0
- package/.docs/raw/docs/(reference)/api-reference/utilities/index.mdx +19 -0
- package/.docs/raw/docs/(reference)/api-reference/utilities/miscellaneous.mdx +131 -0
- package/.docs/raw/docs/(reference)/api-reference/voice/index.mdx +22 -0
- package/.docs/raw/docs/(reference)/api-reference/voice/session.mdx +54 -0
- package/.docs/raw/docs/(reference)/api-reference/voice/speech-dictation.mdx +36 -0
- package/.docs/raw/docs/cloud/ai-sdk-assistant-ui.mdx +230 -2
- package/.docs/raw/docs/cloud/ai-sdk.mdx +222 -4
- package/.docs/raw/docs/cloud/index.mdx +2 -2
- package/.docs/raw/docs/cloud/langgraph.mdx +274 -2
- package/.docs/raw/docs/{(docs)/guides → guides}/attachments.mdx +45 -40
- package/.docs/raw/docs/guides/branching.mdx +76 -0
- package/.docs/raw/docs/guides/chain-of-thought.mdx +166 -0
- package/.docs/raw/docs/{(docs)/guides → guides}/context-api.mdx +54 -26
- package/.docs/raw/docs/{(docs)/guides → guides}/dictation.mdx +3 -1
- package/.docs/raw/docs/guides/editing.mdx +102 -0
- package/.docs/raw/docs/guides/generative-ui.mdx +142 -0
- package/.docs/raw/docs/guides/image-generation.mdx +74 -0
- package/.docs/raw/docs/guides/index.mdx +103 -0
- package/.docs/raw/docs/{(docs)/guides → guides}/interactables.mdx +51 -2
- package/.docs/raw/docs/{(docs)/guides → guides}/latex.mdx +53 -10
- package/.docs/raw/docs/guides/mcp-apps.mdx +231 -0
- package/.docs/raw/docs/{(docs)/guides → guides}/mentions.mdx +63 -88
- package/.docs/raw/docs/{(docs)/guides → guides}/message-timing.mdx +45 -6
- package/.docs/raw/docs/{(docs)/guides → guides}/multi-agent.mdx +66 -6
- package/.docs/raw/docs/{(docs)/guides → guides}/quoting.mdx +11 -18
- package/.docs/raw/docs/guides/resumable-stream-deployment.mdx +212 -0
- package/.docs/raw/docs/guides/resumable-stream-stores.mdx +152 -0
- package/.docs/raw/docs/guides/resumable-streams.mdx +210 -0
- package/.docs/raw/docs/{(docs)/guides → guides}/slash-commands.mdx +104 -38
- package/.docs/raw/docs/guides/speech.mdx +156 -0
- package/.docs/raw/docs/{(docs)/guides → guides}/suggestions.mdx +91 -69
- package/.docs/raw/docs/{(docs)/guides → guides}/tool-ui.mdx +110 -38
- package/.docs/raw/docs/{(docs)/guides → guides}/tools.mdx +197 -40
- package/.docs/raw/docs/{(docs)/guides → guides}/voice.mdx +41 -2
- package/.docs/raw/docs/ink/adapters.mdx +37 -1
- package/.docs/raw/docs/ink/custom-backend.mdx +59 -8
- package/.docs/raw/docs/ink/index.mdx +11 -14
- package/.docs/raw/docs/ink/migration.mdx +1 -3
- package/.docs/raw/docs/ink/primitives.mdx +386 -9
- package/.docs/raw/docs/integrations/attachments/custom-adapter.mdx +520 -0
- package/.docs/raw/docs/integrations/auth/better-auth.mdx +191 -0
- package/.docs/raw/docs/integrations/auth/clerk.mdx +172 -0
- package/.docs/raw/docs/integrations/auth/next-auth.mdx +196 -0
- package/.docs/raw/docs/integrations/frameworks/ai-sdk.mdx +79 -0
- package/.docs/raw/docs/integrations/frameworks/cloudflare-agents/overview.mdx +282 -0
- package/.docs/raw/docs/integrations/frameworks/mastra/full-stack.mdx +188 -0
- package/.docs/raw/docs/integrations/frameworks/mastra/overview.mdx +57 -0
- package/.docs/raw/docs/integrations/frameworks/mastra/separate-server.mdx +201 -0
- package/.docs/raw/docs/integrations/gateways/index.mdx +162 -0
- package/.docs/raw/docs/integrations/index.mdx +185 -0
- package/.docs/raw/docs/integrations/observability/helicone.mdx +130 -0
- package/.docs/raw/docs/integrations/observability/langfuse.mdx +163 -0
- package/.docs/raw/docs/integrations/observability/langsmith.mdx +150 -0
- package/.docs/raw/docs/integrations/persistence/custom-adapter.mdx +712 -0
- package/.docs/raw/docs/integrations/tools/mcp.mdx +267 -0
- package/.docs/raw/docs/integrations/tools/react-mcp.mdx +337 -0
- package/.docs/raw/docs/migrations/v0-14.mdx +297 -0
- package/.docs/raw/docs/primitives/action-bar.mdx +1 -0
- package/.docs/raw/docs/primitives/assistant-modal.mdx +1 -0
- package/.docs/raw/docs/primitives/attachment.mdx +1 -0
- package/.docs/raw/docs/primitives/branch-picker.mdx +1 -0
- package/.docs/raw/docs/primitives/chain-of-thought.mdx +90 -85
- package/.docs/raw/docs/primitives/composer.mdx +55 -1
- package/.docs/raw/docs/primitives/error.mdx +1 -0
- package/.docs/raw/docs/primitives/index.mdx +4 -3
- package/.docs/raw/docs/primitives/message.mdx +68 -5
- package/.docs/raw/docs/primitives/selection-toolbar.mdx +1 -0
- package/.docs/raw/docs/primitives/suggestion.mdx +10 -0
- package/.docs/raw/docs/primitives/thread-list.mdx +39 -0
- package/.docs/raw/docs/primitives/thread.mdx +16 -13
- package/.docs/raw/docs/react-native/hooks.mdx +2 -2
- package/.docs/raw/docs/react-native/index.mdx +5 -7
- package/.docs/raw/docs/react-native/migration.mdx +1 -3
- package/.docs/raw/docs/runtimes/a2a/client-and-hooks.mdx +396 -0
- package/.docs/raw/docs/runtimes/a2a/overview.mdx +60 -0
- package/.docs/raw/docs/runtimes/a2a/quickstart.mdx +216 -0
- package/.docs/raw/docs/runtimes/ag-ui/overview.mdx +70 -0
- package/.docs/raw/docs/runtimes/ag-ui/quickstart.mdx +243 -0
- package/.docs/raw/docs/runtimes/ag-ui/runtime-options.mdx +154 -0
- package/.docs/raw/docs/runtimes/ai-sdk/overview.mdx +52 -0
- package/.docs/raw/docs/runtimes/ai-sdk/v4-legacy.mdx +73 -128
- package/.docs/raw/docs/runtimes/ai-sdk/v5-legacy.mdx +70 -64
- package/.docs/raw/docs/runtimes/ai-sdk/v6.mdx +337 -123
- package/.docs/raw/docs/runtimes/concepts/adapters.mdx +265 -0
- package/.docs/raw/docs/runtimes/concepts/architecture.mdx +125 -0
- package/.docs/raw/docs/runtimes/concepts/stability.mdx +67 -0
- package/.docs/raw/docs/runtimes/concepts/threads.mdx +428 -0
- package/.docs/raw/docs/runtimes/custom/assistant-transport.mdx +703 -0
- package/.docs/raw/docs/runtimes/custom/data-stream.mdx +348 -0
- package/.docs/raw/docs/runtimes/custom/external-store.mdx +261 -1236
- package/.docs/raw/docs/runtimes/custom/local-runtime.mdx +746 -0
- package/.docs/raw/docs/runtimes/custom/overview.mdx +71 -0
- package/.docs/raw/docs/runtimes/google-adk/api.mdx +256 -0
- package/.docs/raw/docs/runtimes/google-adk/hooks.mdx +717 -0
- package/.docs/raw/docs/runtimes/google-adk/overview.mdx +69 -0
- package/.docs/raw/docs/runtimes/google-adk/quickstart.mdx +229 -0
- package/.docs/raw/docs/runtimes/langchain.mdx +533 -0
- package/.docs/raw/docs/runtimes/langgraph/generative-ui.mdx +305 -0
- package/.docs/raw/docs/runtimes/langgraph/interrupts.mdx +104 -0
- package/.docs/raw/docs/runtimes/langgraph/overview.mdx +84 -0
- package/.docs/raw/docs/runtimes/langgraph/quickstart.mdx +496 -0
- package/.docs/raw/docs/runtimes/langgraph/streaming.mdx +127 -0
- package/.docs/raw/docs/runtimes/langgraph/threads.mdx +113 -0
- package/.docs/raw/docs/runtimes/langgraph/tutorial/introduction.mdx +3 -3
- package/.docs/raw/docs/runtimes/langgraph/tutorial/part-1.mdx +0 -23
- package/.docs/raw/docs/runtimes/langgraph/tutorial/part-2.mdx +1 -1
- package/.docs/raw/docs/runtimes/opencode/hooks.mdx +191 -0
- package/.docs/raw/docs/runtimes/opencode/overview.mdx +48 -0
- package/.docs/raw/docs/runtimes/opencode/quickstart.mdx +119 -0
- package/.docs/raw/docs/runtimes/pick-a-runtime.mdx +78 -203
- package/.docs/raw/docs/ui/accordion.mdx +1 -0
- package/.docs/raw/docs/ui/assistant-modal.mdx +1 -0
- package/.docs/raw/docs/ui/assistant-sidebar.mdx +1 -0
- package/.docs/raw/docs/ui/attachment.mdx +1 -0
- package/.docs/raw/docs/ui/badge.mdx +1 -0
- package/.docs/raw/docs/ui/composer-trigger-popover.mdx +12 -1
- package/.docs/raw/docs/ui/context-display.mdx +1 -0
- package/.docs/raw/docs/ui/diff-viewer.mdx +1 -0
- package/.docs/raw/docs/ui/directive-text.mdx +1 -0
- package/.docs/raw/docs/ui/file.mdx +1 -0
- package/.docs/raw/docs/ui/image.mdx +1 -0
- package/.docs/raw/docs/ui/markdown.mdx +2 -14
- package/.docs/raw/docs/ui/mcp-config.mdx +102 -0
- package/.docs/raw/docs/ui/mermaid.mdx +1 -0
- package/.docs/raw/docs/ui/message-timing.mdx +3 -2
- package/.docs/raw/docs/ui/model-selector.mdx +9 -8
- package/.docs/raw/docs/ui/part-grouping.mdx +325 -313
- package/.docs/raw/docs/ui/quote.mdx +1 -0
- package/.docs/raw/docs/ui/reasoning.mdx +66 -33
- package/.docs/raw/docs/ui/scrollbar.mdx +1 -0
- package/.docs/raw/docs/ui/select.mdx +1 -0
- package/.docs/raw/docs/ui/sources.mdx +18 -0
- package/.docs/raw/docs/ui/streamdown.mdx +35 -2
- package/.docs/raw/docs/ui/syntax-highlighting.mdx +1 -0
- package/.docs/raw/docs/ui/tabs.mdx +1 -0
- package/.docs/raw/docs/ui/thread-list.mdx +19 -2
- package/.docs/raw/docs/ui/thread.mdx +58 -3
- package/.docs/raw/docs/ui/tool-fallback.mdx +1 -0
- package/.docs/raw/docs/ui/tool-group.mdx +39 -11
- package/.docs/raw/docs/ui/voice.mdx +1 -0
- package/.docs/raw/docs/utilities/heat-graph.mdx +1 -0
- package/.docs/raw/docs/utilities/react-o11y.mdx +278 -0
- package/.docs/raw/docs/utilities/tw-shimmer.mdx +1 -0
- package/README.md +14 -72
- package/dist/constants.d.ts +12 -9
- package/dist/constants.d.ts.map +1 -1
- package/dist/constants.js +13 -9
- package/dist/constants.js.map +1 -1
- package/dist/index.d.ts +7 -3
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +25 -24
- package/dist/index.js.map +1 -1
- package/dist/prepare-docs/code-examples.d.ts +4 -1
- package/dist/prepare-docs/code-examples.d.ts.map +1 -1
- package/dist/prepare-docs/code-examples.js +109 -121
- package/dist/prepare-docs/code-examples.js.map +1 -1
- package/dist/prepare-docs/copy-raw.d.ts +4 -1
- package/dist/prepare-docs/copy-raw.d.ts.map +1 -1
- package/dist/prepare-docs/copy-raw.js +45 -42
- package/dist/prepare-docs/copy-raw.js.map +1 -1
- package/dist/prepare-docs/prepare.d.ts +1 -2
- package/dist/prepare-docs/prepare.js +17 -17
- package/dist/prepare-docs/prepare.js.map +1 -1
- package/dist/stdio.d.ts +1 -3
- package/dist/stdio.js +6 -3
- package/dist/stdio.js.map +1 -1
- package/dist/tools/docs.d.ts +20 -15
- package/dist/tools/docs.d.ts.map +1 -1
- package/dist/tools/docs.js +140 -161
- package/dist/tools/docs.js.map +1 -1
- package/dist/tools/examples.d.ts +20 -15
- package/dist/tools/examples.d.ts.map +1 -1
- package/dist/tools/examples.js +74 -86
- package/dist/tools/examples.js.map +1 -1
- package/dist/tools/tests/test-setup.d.ts +5 -2
- package/dist/tools/tests/test-setup.d.ts.map +1 -1
- package/dist/tools/tests/test-setup.js +21 -28
- package/dist/tools/tests/test-setup.js.map +1 -1
- package/dist/utils/logger.d.ts +8 -5
- package/dist/utils/logger.d.ts.map +1 -1
- package/dist/utils/logger.js +17 -17
- package/dist/utils/logger.js.map +1 -1
- package/dist/utils/mcp-format.d.ts +8 -5
- package/dist/utils/mcp-format.d.ts.map +1 -1
- package/dist/utils/mcp-format.js +9 -9
- package/dist/utils/mcp-format.js.map +1 -1
- package/dist/utils/mdx.d.ts +8 -6
- package/dist/utils/mdx.d.ts.map +1 -1
- package/dist/utils/mdx.js +22 -22
- package/dist/utils/mdx.js.map +1 -1
- package/dist/utils/paths.d.ts +9 -6
- package/dist/utils/paths.d.ts.map +1 -1
- package/dist/utils/paths.js +66 -76
- package/dist/utils/paths.js.map +1 -1
- package/dist/utils/security.d.ts +4 -1
- package/dist/utils/security.d.ts.map +1 -1
- package/dist/utils/security.js +19 -40
- package/dist/utils/security.js.map +1 -1
- package/package.json +6 -6
- package/src/tools/tests/path-traversal.test.ts +1 -1
- package/.docs/raw/docs/(docs)/guides/branching.mdx +0 -65
- package/.docs/raw/docs/(docs)/guides/chain-of-thought.mdx +0 -164
- package/.docs/raw/docs/(docs)/guides/editing.mdx +0 -66
- package/.docs/raw/docs/(docs)/guides/speech.mdx +0 -38
- package/.docs/raw/docs/(reference)/api-reference/context-providers/text-message-part-provider.mdx +0 -40
- package/.docs/raw/docs/(reference)/api-reference/integrations/react-data-stream.mdx +0 -260
- package/.docs/raw/docs/(reference)/api-reference/integrations/react-hook-form.mdx +0 -103
- package/.docs/raw/docs/(reference)/api-reference/integrations/vercel-ai-sdk.mdx +0 -254
- package/.docs/raw/docs/(reference)/migrations/v0-14.mdx +0 -159
- package/.docs/raw/docs/runtimes/a2a/index.mdx +0 -298
- package/.docs/raw/docs/runtimes/assistant-transport.mdx +0 -1033
- package/.docs/raw/docs/runtimes/custom/custom-thread-list.mdx +0 -314
- package/.docs/raw/docs/runtimes/custom/local.mdx +0 -1464
- package/.docs/raw/docs/runtimes/data-stream.mdx +0 -422
- package/.docs/raw/docs/runtimes/google-adk/index.mdx +0 -686
- package/.docs/raw/docs/runtimes/helicone.mdx +0 -61
- package/.docs/raw/docs/runtimes/langchain/comparison.mdx +0 -60
- package/.docs/raw/docs/runtimes/langchain/index.mdx +0 -210
- package/.docs/raw/docs/runtimes/langgraph/index.mdx +0 -699
- package/.docs/raw/docs/runtimes/langgraph/tutorial/index.mdx +0 -12
- package/.docs/raw/docs/runtimes/langserve.mdx +0 -116
- package/.docs/raw/docs/runtimes/mastra/full-stack-integration.mdx +0 -218
- package/.docs/raw/docs/runtimes/mastra/overview.mdx +0 -18
- package/.docs/raw/docs/runtimes/mastra/separate-server-integration.mdx +0 -217
- package/dist/prepare-docs/prepare.d.ts.map +0 -1
- package/dist/stdio.d.ts.map +0 -1
- /package/.docs/raw/docs/{(reference)/migrations → migrations}/deprecation-policy.mdx +0 -0
- /package/.docs/raw/docs/{(reference) → migrations}/react-compatibility.mdx +0 -0
- /package/.docs/raw/docs/{(reference)/migrations → migrations}/react-langgraph-v0-7.mdx +0 -0
- /package/.docs/raw/docs/{(reference)/migrations → migrations}/v0-11.mdx +0 -0
- /package/.docs/raw/docs/{(reference)/migrations → migrations}/v0-12.mdx +0 -0
|
@@ -64,29 +64,29 @@
|
|
|
64
64
|
"dependencies": {
|
|
65
65
|
"@assistant-ui/react": "workspace:*",
|
|
66
66
|
"@assistant-ui/react-markdown": "workspace:*",
|
|
67
|
-
"@tailwindcss/vite": "^4.
|
|
68
|
-
"@tanstack/react-router": "^1.
|
|
69
|
-
"@tanstack/react-start": "^1.
|
|
67
|
+
"@tailwindcss/vite": "^4.3.0",
|
|
68
|
+
"@tanstack/react-router": "^1.170.6",
|
|
69
|
+
"@tanstack/react-start": "^1.168.9",
|
|
70
70
|
"class-variance-authority": "^0.7.1",
|
|
71
71
|
"clsx": "^2.1.1",
|
|
72
|
-
"lucide-react": "^1.
|
|
72
|
+
"lucide-react": "^1.16.0",
|
|
73
73
|
"nitro": "^3.0.260311-beta",
|
|
74
|
-
"openai": "^6.
|
|
75
|
-
"react": "^19.2.
|
|
76
|
-
"react-dom": "^19.2.
|
|
74
|
+
"openai": "^6.38.0",
|
|
75
|
+
"react": "^19.2.6",
|
|
76
|
+
"react-dom": "^19.2.6",
|
|
77
77
|
"remark-gfm": "^4.0.1",
|
|
78
|
-
"tailwind-merge": "^3.
|
|
79
|
-
"tailwindcss": "^4.
|
|
78
|
+
"tailwind-merge": "^3.6.0",
|
|
79
|
+
"tailwindcss": "^4.3.0",
|
|
80
80
|
"vite-tsconfig-paths": "^6.1.1"
|
|
81
81
|
},
|
|
82
82
|
"devDependencies": {
|
|
83
83
|
"@assistant-ui/x-buildutils": "workspace:*",
|
|
84
|
-
"@types/node": "^25.
|
|
85
|
-
"@types/react": "^19.2.
|
|
84
|
+
"@types/node": "^25.9.1",
|
|
85
|
+
"@types/react": "^19.2.15",
|
|
86
86
|
"@types/react-dom": "^19.2.3",
|
|
87
|
-
"@vitejs/plugin-react": "^6.0.
|
|
87
|
+
"@vitejs/plugin-react": "^6.0.2",
|
|
88
88
|
"typescript": "^6.0.3",
|
|
89
|
-
"vite": "^8.0.
|
|
89
|
+
"vite": "^8.0.14"
|
|
90
90
|
}
|
|
91
91
|
}
|
|
92
92
|
|
|
@@ -458,7 +458,7 @@ export const chatStream = createServerFn({ method: "POST" })
|
|
|
458
458
|
});
|
|
459
459
|
|
|
460
460
|
const stream = await openai.chat.completions.create({
|
|
461
|
-
model: "gpt-
|
|
461
|
+
model: "gpt-5.4-nano",
|
|
462
462
|
messages: data.messages,
|
|
463
463
|
stream: true,
|
|
464
464
|
});
|
|
@@ -601,20 +601,20 @@ export default nextConfig;
|
|
|
601
601
|
"@assistant-ui/ui": "workspace:*",
|
|
602
602
|
"class-variance-authority": "^0.7.1",
|
|
603
603
|
"clsx": "^2.1.1",
|
|
604
|
-
"lucide-react": "^1.
|
|
605
|
-
"next": "^16.2.
|
|
606
|
-
"react": "^19.2.
|
|
607
|
-
"react-dom": "^19.2.
|
|
608
|
-
"tailwind-merge": "^3.
|
|
604
|
+
"lucide-react": "^1.16.0",
|
|
605
|
+
"next": "^16.2.6",
|
|
606
|
+
"react": "^19.2.6",
|
|
607
|
+
"react-dom": "^19.2.6",
|
|
608
|
+
"tailwind-merge": "^3.6.0"
|
|
609
609
|
},
|
|
610
610
|
"devDependencies": {
|
|
611
611
|
"@assistant-ui/x-buildutils": "workspace:*",
|
|
612
|
-
"@tailwindcss/postcss": "^4.
|
|
613
|
-
"@types/node": "^25.
|
|
614
|
-
"@types/react": "^19.2.
|
|
612
|
+
"@tailwindcss/postcss": "^4.3.0",
|
|
613
|
+
"@types/node": "^25.9.1",
|
|
614
|
+
"@types/react": "^19.2.15",
|
|
615
615
|
"@types/react-dom": "^19.2.3",
|
|
616
|
-
"postcss": "^8.5.
|
|
617
|
-
"tailwindcss": "^4.
|
|
616
|
+
"postcss": "^8.5.15",
|
|
617
|
+
"tailwindcss": "^4.3.0",
|
|
618
618
|
"tw-animate-css": "^1.4.0",
|
|
619
619
|
"typescript": "^6.0.3"
|
|
620
620
|
}
|
|
@@ -789,6 +789,7 @@ You can extend this example to:
|
|
|
789
789
|
"@/lib/utils": ["../../packages/ui/src/lib/utils"],
|
|
790
790
|
"@assistant-ui/ui/*": ["../../packages/ui/src/*"],
|
|
791
791
|
"@assistant-ui/*": ["../../packages/*/src"],
|
|
792
|
+
"@assistant-ui/core/*": ["../../packages/core/src/*"],
|
|
792
793
|
"@assistant-ui/react/*": ["../../packages/react/src/*"],
|
|
793
794
|
"@assistant-ui/tap": ["../../packages/tap/src"],
|
|
794
795
|
"@assistant-ui/tap/*": ["../../packages/tap/src/*"],
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: CLI
|
|
3
3
|
description: Scaffold projects, add components, and manage updates from the command line.
|
|
4
|
+
platforms: ["react"]
|
|
4
5
|
---
|
|
5
6
|
|
|
6
7
|
Use the `assistant-ui` CLI to quickly set up new projects and add components to existing ones.
|
|
@@ -68,8 +69,9 @@ Use `--example` to create a project from one of the monorepo examples with full
|
|
|
68
69
|
| `with-artifacts` | HTML artifact rendering with live preview | `npx assistant-ui create my-app -e with-artifacts` |
|
|
69
70
|
| `with-langgraph` | LangGraph agent with custom tools | `npx assistant-ui create my-app -e with-langgraph` |
|
|
70
71
|
| `with-cloud` | Assistant Cloud persistence | `npx assistant-ui create my-app -e with-cloud` |
|
|
71
|
-
| `with-ag-ui` | AG-UI protocol integration | `npx assistant-ui create my-app -e with-ag-ui` |
|
|
72
|
+
| `with-ag-ui` | [AG-UI protocol](/docs/runtimes/ag-ui) integration | `npx assistant-ui create my-app -e with-ag-ui` |
|
|
72
73
|
| `with-assistant-transport` | Custom backend via Assistant Transport | `npx assistant-ui create my-app -e with-assistant-transport` |
|
|
74
|
+
| `with-resumable-stream` | Resumable LLM stream that survives reload mid-response | `npx assistant-ui create my-app -e with-resumable-stream` |
|
|
73
75
|
| `with-chain-of-thought` | Chain-of-thought with JS execution | `npx assistant-ui create my-app -e with-chain-of-thought` |
|
|
74
76
|
| `with-external-store` | External message store | `npx assistant-ui create my-app -e with-external-store` |
|
|
75
77
|
| `with-custom-thread-list` | Custom thread list UI | `npx assistant-ui create my-app -e with-custom-thread-list` |
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Assistant Frame API
|
|
3
3
|
description: Share model context across iframe boundaries
|
|
4
|
+
platforms: ["react"]
|
|
4
5
|
---
|
|
5
6
|
|
|
6
7
|
The Assistant Frame API enables iframes to provide model context (tools and instructions) to a parent window's assistant. This is particularly useful for embedded applications, plugins, or sandboxed components that need to contribute capabilities to the main assistant.
|
|
@@ -1,11 +1,18 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: makeAssistantToolUI
|
|
3
3
|
description: Register custom UI components to render tool executions and their status.
|
|
4
|
+
platforms: ["react"]
|
|
4
5
|
---
|
|
5
6
|
|
|
6
|
-
<Callout type="
|
|
7
|
-
|
|
8
|
-
|
|
7
|
+
<Callout type="info">
|
|
8
|
+
Prefer pre-registering tool UIs via the [`Tools()` API](/docs/guides/tools)
|
|
9
|
+
(set `render` on the tool definition) or by mounting `makeAssistantToolUI`
|
|
10
|
+
near the root of your tree. A tool UI that is only registered while a
|
|
11
|
+
specific component is mounted will not appear when chat history is replayed
|
|
12
|
+
or during server-side rendering, since the registering component may not be
|
|
13
|
+
mounted at that point. Tool execution can still be registered dynamically
|
|
14
|
+
via [`makeAssistantTool`](/docs/copilots/make-assistant-tool); this caveat
|
|
15
|
+
applies specifically to the UI render function.
|
|
9
16
|
</Callout>
|
|
10
17
|
|
|
11
18
|
The `makeAssistantToolUI` utility is used to register a tool UI component with the Assistant.
|
|
@@ -1,11 +1,16 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: makeAssistantTool
|
|
3
3
|
description: Create React components that provide reusable tools to the assistant.
|
|
4
|
+
platforms: ["react"]
|
|
4
5
|
---
|
|
5
6
|
|
|
6
|
-
<Callout type="
|
|
7
|
-
|
|
8
|
-
|
|
7
|
+
<Callout type="info">
|
|
8
|
+
For most apps, the [`Tools()` API](/docs/guides/tools) is an easier starting
|
|
9
|
+
point: tool definitions live in a toolkit object rather than the component
|
|
10
|
+
tree. `makeAssistantTool` is fully supported and remains a good fit when a
|
|
11
|
+
tool's availability is tied to a component being mounted, for example a
|
|
12
|
+
product-specific tool that should only be exposed while that product's UI is
|
|
13
|
+
on screen (the [intelligent components](/docs/copilots/motivation) pattern).
|
|
9
14
|
</Callout>
|
|
10
15
|
|
|
11
16
|
`makeAssistantTool` creates a React component that provides a tool to the assistant. This is useful for defining reusable tools that can be composed into your application.
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: makeAssistantVisible
|
|
3
3
|
description: Make React components visible and interactive to assistants via higher-order component wrapping.
|
|
4
|
+
platforms: ["react"]
|
|
4
5
|
---
|
|
5
6
|
|
|
6
7
|
`makeAssistantVisible` is a higher-order component (HOC) that makes React components "visible" by the assistant, allowing it to understand and interact with the component's HTML structure.
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Model Context
|
|
3
3
|
description: Configure assistant behavior through system instructions, tools, and context providers.
|
|
4
|
+
platforms: ["react"]
|
|
4
5
|
---
|
|
5
6
|
|
|
6
7
|
Model Context is the foundation of intelligence in assistant-ui components. It provides configuration and capabilities to the assistant through a context provider system.
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Intelligent Components
|
|
3
3
|
description: Add intelligence to React components through readable interfaces and assistant tools.
|
|
4
|
+
platforms: ["react"]
|
|
4
5
|
---
|
|
5
6
|
|
|
6
7
|
React revolutionized web development with components that combine logic, structure, and style. Now, with assistant-ui, we're adding a fourth dimension: intelligence. Let's learn how to build smart components through a practical banking app example.
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: useAssistantInstructions
|
|
3
3
|
description: React hook for setting system instructions to guide assistant behavior.
|
|
4
|
+
platforms: ["react"]
|
|
4
5
|
---
|
|
5
6
|
|
|
6
7
|
`useAssistantInstructions` is a React hook that allows you to set system instructions for your assistant-ui components.
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
---
|
|
2
|
-
title:
|
|
3
|
-
description:
|
|
2
|
+
title: Documentation
|
|
3
|
+
description: Build production-grade AI chat experiences in React with assistant-ui — components, runtimes, and primitives for ChatGPT-style UIs, copilots, and agents.
|
|
4
|
+
platforms: ["react"]
|
|
4
5
|
---
|
|
5
6
|
|
|
6
7
|
import { PanelsTopLeft, Database, Terminal } from "lucide-react";
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Installation
|
|
3
3
|
description: Get assistant-ui running in 5 minutes with npm and your first chat component.
|
|
4
|
+
platforms: ["react"]
|
|
4
5
|
---
|
|
5
6
|
|
|
6
7
|
|
|
@@ -136,7 +137,7 @@ export const maxDuration = 30;
|
|
|
136
137
|
export async function POST(req: Request) {
|
|
137
138
|
const { messages, system, tools } = await req.json();
|
|
138
139
|
const result = streamText({
|
|
139
|
-
model: openai("gpt-
|
|
140
|
+
model: openai("gpt-5.4-nano"),
|
|
140
141
|
system,
|
|
141
142
|
messages: await convertToModelMessages(messages),
|
|
142
143
|
tools: frontendTools(tools),
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: RTL Support
|
|
3
3
|
description: Use assistant-ui with right-to-left languages like Arabic, Hebrew, and Persian.
|
|
4
|
+
platforms: ["react"]
|
|
4
5
|
---
|
|
5
6
|
|
|
6
7
|
Components shipped through `@assistant-ui/ui` (npm) and the shadcn registry (`npx shadcn@latest add https://r.assistant-ui.com/...`) use logical Tailwind classes (`ms-*`, `pe-*`, `text-start`, `end-*`, `border-s`, ...). They flip automatically under `dir="rtl"` and render byte-identically under `dir="ltr"` (the default) — there is nothing to opt out of.
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Attachment Adapters
|
|
3
|
+
description: Attachment adapters for uploading files, handling lifecycle events, and bringing app-owned content into assistant-ui composers and messages.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
import { AttachmentAdapter, CloudFileAttachmentAdapter, CompositeAttachmentAdapter, SimpleImageAttachmentAdapter, SimpleTextAttachmentAdapter } from "@/generated/typeDocs";
|
|
7
|
+
|
|
8
|
+
{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
|
|
9
|
+
{/* Do not edit manually. */}
|
|
10
|
+
|
|
11
|
+
{/* api-reference:start */}
|
|
12
|
+
{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
|
|
13
|
+
{/* Do not edit this block manually. */}
|
|
14
|
+
|
|
15
|
+
## API Reference
|
|
16
|
+
|
|
17
|
+
### AttachmentAdapter
|
|
18
|
+
|
|
19
|
+
<ParametersTable {...AttachmentAdapter} />
|
|
20
|
+
|
|
21
|
+
### CloudFileAttachmentAdapter
|
|
22
|
+
|
|
23
|
+
<ParametersTable {...CloudFileAttachmentAdapter} />
|
|
24
|
+
|
|
25
|
+
### CompositeAttachmentAdapter
|
|
26
|
+
|
|
27
|
+
<ParametersTable {...CompositeAttachmentAdapter} />
|
|
28
|
+
|
|
29
|
+
### SimpleImageAttachmentAdapter
|
|
30
|
+
|
|
31
|
+
<ParametersTable {...SimpleImageAttachmentAdapter} />
|
|
32
|
+
|
|
33
|
+
### SimpleTextAttachmentAdapter
|
|
34
|
+
|
|
35
|
+
<ParametersTable {...SimpleTextAttachmentAdapter} />
|
|
36
|
+
{/* api-reference:end */}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Feedback Adapter
|
|
3
|
+
description: Capture and respond to message feedback submitted through action primitives or runtime actions.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
import { FeedbackAdapter } from "@/generated/typeDocs";
|
|
7
|
+
|
|
8
|
+
{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
|
|
9
|
+
{/* Do not edit manually. */}
|
|
10
|
+
|
|
11
|
+
{/* api-reference:start */}
|
|
12
|
+
{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
|
|
13
|
+
{/* Do not edit this block manually. */}
|
|
14
|
+
|
|
15
|
+
## API Reference
|
|
16
|
+
|
|
17
|
+
### FeedbackAdapter
|
|
18
|
+
|
|
19
|
+
<ParametersTable {...FeedbackAdapter} />
|
|
20
|
+
{/* api-reference:end */}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Adapters API Reference
|
|
3
|
+
description: Adapter interfaces for connecting chat models, persistence, file attachments, feedback, and suggestions to assistant-ui React runtimes.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
|
|
7
|
+
{/* The page list is generated from exported APIs; edit only the manual prose slot. */}
|
|
8
|
+
|
|
9
|
+
{/* api-manual:start */}
|
|
10
|
+
Adapters define the boundaries between assistant-ui and the systems around it. Use them when you need custom model execution, attachment handling, persistence, feedback collection, or prompt suggestions.
|
|
11
|
+
{/* api-manual:end */}
|
|
12
|
+
|
|
13
|
+
## Pages
|
|
14
|
+
|
|
15
|
+
<Cards>
|
|
16
|
+
<Card title={"Attachment Adapters"} href={"/docs/api-reference/adapters/attachments"}>
|
|
17
|
+
{"Attachment adapters for uploading files, handling lifecycle events, and bringing app-owned content into assistant-ui composers and messages."}
|
|
18
|
+
</Card>
|
|
19
|
+
<Card title={"Feedback Adapter"} href={"/docs/api-reference/adapters/feedback"}>
|
|
20
|
+
{"Capture and respond to message feedback submitted through action primitives or runtime actions."}
|
|
21
|
+
</Card>
|
|
22
|
+
<Card title={"Model Adapters"} href={"/docs/api-reference/adapters/model"}>
|
|
23
|
+
{"Adapter interfaces for connecting chat models, streaming responses, and model execution to assistant-ui runtimes."}
|
|
24
|
+
</Card>
|
|
25
|
+
<Card title={"Persistence Adapters"} href={"/docs/api-reference/adapters/persistence"}>
|
|
26
|
+
{"Persistence adapters for saving assistant-ui message history, remote thread lists, and long-running chat sessions across browser reloads."}
|
|
27
|
+
</Card>
|
|
28
|
+
<Card title={"Runtime Adapter Context"} href={"/docs/api-reference/adapters/runtime"}>
|
|
29
|
+
{"Provide assistant-ui runtime adapters through React context for model, attachment, speech, and feedback behavior."}
|
|
30
|
+
</Card>
|
|
31
|
+
<Card title={"Suggestion Adapters"} href={"/docs/api-reference/adapters/suggestions"}>
|
|
32
|
+
{"Suggestion adapters for providing starter prompts, contextual actions, and guided composer options to assistant-ui runtimes."}
|
|
33
|
+
</Card>
|
|
34
|
+
</Cards>
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Model Adapters
|
|
3
|
+
description: Adapter interfaces for connecting chat models, streaming responses, and model execution to assistant-ui runtimes.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
import { ChatModelAdapter, ChatModelRunOptions, ChatModelRunResult, ChatModelRunUpdate, CreateResumeRunConfig, CreateStartRunConfig, LanguageModelConfig } from "@/generated/typeDocs";
|
|
7
|
+
|
|
8
|
+
{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
|
|
9
|
+
{/* Do not edit manually. */}
|
|
10
|
+
|
|
11
|
+
{/* api-reference:start */}
|
|
12
|
+
{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
|
|
13
|
+
{/* Do not edit this block manually. */}
|
|
14
|
+
|
|
15
|
+
## API Reference
|
|
16
|
+
|
|
17
|
+
### ChatModelAdapter
|
|
18
|
+
|
|
19
|
+
<ParametersTable {...ChatModelAdapter} />
|
|
20
|
+
|
|
21
|
+
### ChatModelRunOptions
|
|
22
|
+
|
|
23
|
+
<ParametersTable {...ChatModelRunOptions} />
|
|
24
|
+
|
|
25
|
+
### ChatModelRunResult
|
|
26
|
+
|
|
27
|
+
<ParametersTable {...ChatModelRunResult} />
|
|
28
|
+
|
|
29
|
+
### ChatModelRunUpdate
|
|
30
|
+
|
|
31
|
+
<ParametersTable {...ChatModelRunUpdate} />
|
|
32
|
+
|
|
33
|
+
### CreateResumeRunConfig
|
|
34
|
+
|
|
35
|
+
<ParametersTable {...CreateResumeRunConfig} />
|
|
36
|
+
|
|
37
|
+
### CreateStartRunConfig
|
|
38
|
+
|
|
39
|
+
<ParametersTable {...CreateStartRunConfig} />
|
|
40
|
+
|
|
41
|
+
### LanguageModelConfig
|
|
42
|
+
|
|
43
|
+
<ParametersTable {...LanguageModelConfig} />
|
|
44
|
+
{/* api-reference:end */}
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Persistence Adapters
|
|
3
|
+
description: Persistence adapters for saving assistant-ui message history, remote thread lists, and long-running chat sessions across browser reloads.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
import { GenericThreadHistoryAdapter, InMemoryThreadListAdapter, MessageFormatAdapter, RemoteThreadListAdapter, ThreadHistoryAdapter } from "@/generated/typeDocs";
|
|
7
|
+
|
|
8
|
+
{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
|
|
9
|
+
{/* Do not edit manually. */}
|
|
10
|
+
|
|
11
|
+
{/* api-reference:start */}
|
|
12
|
+
{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
|
|
13
|
+
{/* Do not edit this block manually. */}
|
|
14
|
+
|
|
15
|
+
## API Reference
|
|
16
|
+
|
|
17
|
+
### GenericThreadHistoryAdapter
|
|
18
|
+
|
|
19
|
+
<ParametersTable {...GenericThreadHistoryAdapter} />
|
|
20
|
+
|
|
21
|
+
### InMemoryThreadListAdapter
|
|
22
|
+
|
|
23
|
+
<ParametersTable {...InMemoryThreadListAdapter} />
|
|
24
|
+
|
|
25
|
+
### MessageFormatAdapter
|
|
26
|
+
|
|
27
|
+
<ParametersTable {...MessageFormatAdapter} />
|
|
28
|
+
|
|
29
|
+
### RemoteThreadListAdapter
|
|
30
|
+
|
|
31
|
+
{/* api-example:RemoteThreadListAdapter:start */}
|
|
32
|
+
```tsx
|
|
33
|
+
const runtime = useRemoteThreadListRuntime({
|
|
34
|
+
adapter: myRemoteThreadListAdapter,
|
|
35
|
+
runtimeHook: () => useLocalRuntime(chatModelAdapter),
|
|
36
|
+
});
|
|
37
|
+
```
|
|
38
|
+
{/* api-example:RemoteThreadListAdapter:end */}
|
|
39
|
+
|
|
40
|
+
<ParametersTable {...RemoteThreadListAdapter} />
|
|
41
|
+
|
|
42
|
+
### ThreadHistoryAdapter
|
|
43
|
+
|
|
44
|
+
{/* api-example:ThreadHistoryAdapter:start */}
|
|
45
|
+
```tsx
|
|
46
|
+
const runtime = useLocalRuntime(chatModelAdapter, {
|
|
47
|
+
adapters: {
|
|
48
|
+
history: myHistoryAdapter,
|
|
49
|
+
},
|
|
50
|
+
});
|
|
51
|
+
```
|
|
52
|
+
{/* api-example:ThreadHistoryAdapter:end */}
|
|
53
|
+
|
|
54
|
+
<ParametersTable {...ThreadHistoryAdapter} />
|
|
55
|
+
{/* api-reference:end */}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Runtime Adapter Context
|
|
3
|
+
description: Provide assistant-ui runtime adapters through React context for model, attachment, speech, and feedback behavior.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
import { RuntimeAdapters } from "@/generated/typeDocs";
|
|
7
|
+
|
|
8
|
+
{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
|
|
9
|
+
{/* Do not edit manually. */}
|
|
10
|
+
|
|
11
|
+
{/* api-reference:start */}
|
|
12
|
+
{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
|
|
13
|
+
{/* Do not edit this block manually. */}
|
|
14
|
+
|
|
15
|
+
## API Reference
|
|
16
|
+
|
|
17
|
+
### RuntimeAdapters
|
|
18
|
+
|
|
19
|
+
<ParametersTable {...RuntimeAdapters} />
|
|
20
|
+
{/* api-reference:end */}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Suggestion Adapters
|
|
3
|
+
description: Suggestion adapters for providing starter prompts, contextual actions, and guided composer options to assistant-ui runtimes.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
import { SuggestionAdapter } from "@/generated/typeDocs";
|
|
7
|
+
|
|
8
|
+
{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
|
|
9
|
+
{/* Do not edit manually. */}
|
|
10
|
+
|
|
11
|
+
{/* api-reference:start */}
|
|
12
|
+
{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
|
|
13
|
+
{/* Do not edit this block manually. */}
|
|
14
|
+
|
|
15
|
+
## API Reference
|
|
16
|
+
|
|
17
|
+
### SuggestionAdapter
|
|
18
|
+
|
|
19
|
+
<ParametersTable {...SuggestionAdapter} />
|
|
20
|
+
{/* api-reference:end */}
|
package/.docs/raw/docs/(reference)/api-reference/context-providers/assistant-runtime-provider.mdx
CHANGED
|
@@ -1,16 +1,22 @@
|
|
|
1
1
|
---
|
|
2
|
-
title:
|
|
3
|
-
description: Root provider that connects
|
|
2
|
+
title: AssistantRuntimeProvider
|
|
3
|
+
description: Root React provider that connects an assistant-ui runtime to primitives, hooks, threads, and composer state.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import { AssistantRuntimeProvider } from "@/generated/typeDocs";
|
|
6
|
+
import { AssistantRuntimeProvider, AuiProvider } from "@/generated/typeDocs";
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
|
|
9
|
+
{/* Do not edit manually. */}
|
|
9
10
|
|
|
10
|
-
|
|
11
|
+
{/* api-reference:start */}
|
|
12
|
+
{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
|
|
13
|
+
{/* Do not edit this block manually. */}
|
|
11
14
|
|
|
12
|
-
|
|
15
|
+
## API Reference
|
|
13
16
|
|
|
17
|
+
### AssistantRuntimeProvider
|
|
18
|
+
|
|
19
|
+
{/* api-example:AssistantRuntimeProvider:start */}
|
|
14
20
|
```tsx {1, 8, 10}
|
|
15
21
|
import { AssistantRuntimeProvider } from "@assistant-ui/react";
|
|
16
22
|
import { useChatRuntime, AssistantChatTransport } from "@assistant-ui/react-ai-sdk";
|
|
@@ -29,7 +35,30 @@ const MyApp = () => {
|
|
|
29
35
|
);
|
|
30
36
|
};
|
|
31
37
|
```
|
|
32
|
-
|
|
33
|
-
#### Properties
|
|
38
|
+
{/* api-example:AssistantRuntimeProvider:end */}
|
|
34
39
|
|
|
35
40
|
<ParametersTable {...AssistantRuntimeProvider} />
|
|
41
|
+
|
|
42
|
+
### AuiProvider
|
|
43
|
+
|
|
44
|
+
Supplies an `AssistantClient` to the React tree.
|
|
45
|
+
|
|
46
|
+
Place near the root of any subtree that uses [useAui](/docs/api-reference/hooks/state#useaui) or the
|
|
47
|
+
primitives built on it. Components rendered outside an `AuiProvider`
|
|
48
|
+
receive a default client whose scope accessors throw on use, so
|
|
49
|
+
missing-provider mistakes surface at the point of use.
|
|
50
|
+
|
|
51
|
+
When mounting a runtime built with one of the runtime hooks, use
|
|
52
|
+
[AssistantRuntimeProvider](/docs/api-reference/context-providers/assistant-runtime-provider#assistantruntimeprovider) — it installs an `AuiProvider`
|
|
53
|
+
internally — rather than wiring `AuiProvider` yourself.
|
|
54
|
+
|
|
55
|
+
```tsx
|
|
56
|
+
function ScopedAssistant({ children, scopes }) {
|
|
57
|
+
const aui = useAui(scopes);
|
|
58
|
+
|
|
59
|
+
return <AuiProvider value={aui}>{children}</AuiProvider>;
|
|
60
|
+
}
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
<ParametersTable {...AuiProvider} />
|
|
64
|
+
{/* api-reference:end */}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Context Providers API Reference
|
|
3
|
+
description: React context providers including AssistantRuntimeProvider that scope assistant-ui runtime, thread, message part, and attachment state for primitives, hooks, and custom chat components.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
|
|
7
|
+
{/* The page list is generated from exported APIs; edit only the manual prose slot. */}
|
|
8
|
+
|
|
9
|
+
{/* api-manual:start */}
|
|
10
|
+
Context providers define where assistant-ui primitives and hooks read their state. Most apps only need `AssistantRuntimeProvider`, while scoped providers support custom renderers, isolated message parts, and advanced composition.
|
|
11
|
+
{/* api-manual:end */}
|
|
12
|
+
|
|
13
|
+
## Pages
|
|
14
|
+
|
|
15
|
+
<Cards>
|
|
16
|
+
<Card title={"AssistantRuntimeProvider"} href={"/docs/api-reference/context-providers/assistant-runtime-provider"}>
|
|
17
|
+
{"Root React provider that connects an assistant-ui runtime to primitives, hooks, threads, and composer state."}
|
|
18
|
+
</Card>
|
|
19
|
+
<Card title={"Scoped Providers"} href={"/docs/api-reference/context-providers/scoped-providers"}>
|
|
20
|
+
{"Lower-level assistant-ui providers for custom renderers, scoped message parts, attachments, and advanced composition."}
|
|
21
|
+
</Card>
|
|
22
|
+
</Cards>
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Scoped Providers
|
|
3
|
+
description: Lower-level assistant-ui providers for custom renderers, scoped message parts, attachments, and advanced composition.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
import { ChainOfThoughtByIndicesProvider, ComposerAttachmentByIndexProvider, MessageAttachmentByIndexProvider, MessageByIndexProvider, MessageProvider, PartByIndexProvider, ReadonlyThreadProvider, RuntimeAdapterProvider, SuggestionByIndexProvider, TextMessagePartProvider, ThreadListItemByIndexProvider, ThreadListItemRuntimeProvider } from "@/generated/typeDocs";
|
|
7
|
+
|
|
8
|
+
{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
|
|
9
|
+
{/* Do not edit manually. */}
|
|
10
|
+
|
|
11
|
+
{/* api-reference:start */}
|
|
12
|
+
{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
|
|
13
|
+
{/* Do not edit this block manually. */}
|
|
14
|
+
|
|
15
|
+
## API Reference
|
|
16
|
+
|
|
17
|
+
### ChainOfThoughtByIndicesProvider
|
|
18
|
+
|
|
19
|
+
<ParametersTable {...ChainOfThoughtByIndicesProvider} />
|
|
20
|
+
|
|
21
|
+
### ComposerAttachmentByIndexProvider
|
|
22
|
+
|
|
23
|
+
<ParametersTable {...ComposerAttachmentByIndexProvider} />
|
|
24
|
+
|
|
25
|
+
### MessageAttachmentByIndexProvider
|
|
26
|
+
|
|
27
|
+
<ParametersTable {...MessageAttachmentByIndexProvider} />
|
|
28
|
+
|
|
29
|
+
### MessageByIndexProvider
|
|
30
|
+
|
|
31
|
+
<ParametersTable {...MessageByIndexProvider} />
|
|
32
|
+
|
|
33
|
+
### MessageProvider
|
|
34
|
+
|
|
35
|
+
<ParametersTable {...MessageProvider} />
|
|
36
|
+
|
|
37
|
+
### PartByIndexProvider
|
|
38
|
+
|
|
39
|
+
<ParametersTable {...PartByIndexProvider} />
|
|
40
|
+
|
|
41
|
+
### ReadonlyThreadProvider
|
|
42
|
+
|
|
43
|
+
<ParametersTable {...ReadonlyThreadProvider} />
|
|
44
|
+
|
|
45
|
+
### RuntimeAdapterProvider
|
|
46
|
+
|
|
47
|
+
<ParametersTable {...RuntimeAdapterProvider} />
|
|
48
|
+
|
|
49
|
+
### SuggestionByIndexProvider
|
|
50
|
+
|
|
51
|
+
<ParametersTable {...SuggestionByIndexProvider} />
|
|
52
|
+
|
|
53
|
+
### TextMessagePartProvider
|
|
54
|
+
|
|
55
|
+
<ParametersTable {...TextMessagePartProvider} />
|
|
56
|
+
|
|
57
|
+
### ThreadListItemByIndexProvider
|
|
58
|
+
|
|
59
|
+
<ParametersTable {...ThreadListItemByIndexProvider} />
|
|
60
|
+
|
|
61
|
+
### ThreadListItemRuntimeProvider
|
|
62
|
+
|
|
63
|
+
<ParametersTable {...ThreadListItemRuntimeProvider} />
|
|
64
|
+
{/* api-reference:end */}
|