@assistant-ui/mcp-docs-server 0.1.18 → 0.1.19

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.
Files changed (132) hide show
  1. package/.docs/organized/code-examples/with-ag-ui.md +375 -85
  2. package/.docs/organized/code-examples/{with-ai-sdk-v5.md → with-ai-sdk-v6.md} +386 -94
  3. package/.docs/organized/code-examples/with-assistant-transport.md +374 -84
  4. package/.docs/organized/code-examples/with-cloud.md +405 -100
  5. package/.docs/organized/code-examples/with-custom-thread-list.md +412 -105
  6. package/.docs/organized/code-examples/with-elevenlabs-scribe.md +2241 -0
  7. package/.docs/organized/code-examples/with-external-store.md +374 -83
  8. package/.docs/organized/code-examples/with-ffmpeg.md +377 -87
  9. package/.docs/organized/code-examples/with-langgraph.md +403 -98
  10. package/.docs/organized/code-examples/with-parent-id-grouping.md +374 -83
  11. package/.docs/organized/code-examples/with-react-hook-form.md +379 -89
  12. package/.docs/organized/code-examples/with-react-router.md +2167 -0
  13. package/.docs/organized/code-examples/with-store.md +5 -5
  14. package/.docs/organized/code-examples/with-tanstack.md +10 -10
  15. package/.docs/raw/blog/2025-01-31-changelog/index.mdx +0 -2
  16. package/.docs/raw/docs/{about-assistantui.mdx → (docs)/about-assistantui.mdx} +2 -1
  17. package/.docs/raw/docs/{architecture.mdx → (docs)/architecture.mdx} +3 -2
  18. package/.docs/raw/docs/{cli.mdx → (docs)/cli.mdx} +1 -19
  19. package/.docs/raw/docs/{copilots → (docs)/copilots}/make-assistant-readable.mdx +1 -0
  20. package/.docs/raw/docs/{copilots → (docs)/copilots}/make-assistant-tool-ui.mdx +2 -1
  21. package/.docs/raw/docs/{copilots → (docs)/copilots}/make-assistant-tool.mdx +2 -1
  22. package/.docs/raw/docs/{copilots → (docs)/copilots}/model-context.mdx +1 -0
  23. package/.docs/raw/docs/{copilots → (docs)/copilots}/motivation.mdx +1 -0
  24. package/.docs/raw/docs/{copilots → (docs)/copilots}/use-assistant-instructions.mdx +1 -0
  25. package/.docs/raw/docs/{devtools.mdx → (docs)/devtools.mdx} +4 -4
  26. package/.docs/raw/docs/{guides/Attachments.mdx → (docs)/guides/attachments.mdx} +4 -5
  27. package/.docs/raw/docs/{guides/Branching.mdx → (docs)/guides/branching.mdx} +2 -1
  28. package/.docs/raw/docs/{guides → (docs)/guides}/context-api.mdx +1 -0
  29. package/.docs/raw/docs/(docs)/guides/dictation.mdx +370 -0
  30. package/.docs/raw/docs/{guides/Editing.mdx → (docs)/guides/editing.mdx} +1 -0
  31. package/.docs/raw/docs/{guides/Latex.mdx → (docs)/guides/latex.mdx} +1 -2
  32. package/.docs/raw/docs/{guides/Speech.mdx → (docs)/guides/speech.mdx} +9 -10
  33. package/.docs/raw/docs/{guides/ToolUI.mdx → (docs)/guides/tool-ui.mdx} +15 -14
  34. package/.docs/raw/docs/{guides/Tools.mdx → (docs)/guides/tools.mdx} +10 -7
  35. package/.docs/raw/docs/{getting-started.mdx → (docs)/index.mdx} +17 -22
  36. package/.docs/raw/docs/{mcp-docs-server.mdx → (docs)/mcp-docs-server.mdx} +1 -2
  37. package/.docs/raw/docs/{api-reference/context-providers/AssistantRuntimeProvider.mdx → (reference)/api-reference/context-providers/assistant-runtime-provider.mdx} +2 -1
  38. package/.docs/raw/docs/{api-reference/context-providers/TextMessagePartProvider.mdx → (reference)/api-reference/context-providers/text-message-part-provider.mdx} +2 -1
  39. package/.docs/raw/docs/{api-reference → (reference)/api-reference}/integrations/react-data-stream.mdx +2 -1
  40. package/.docs/raw/docs/{api-reference → (reference)/api-reference}/integrations/react-hook-form.mdx +2 -1
  41. package/.docs/raw/docs/{api-reference → (reference)/api-reference}/integrations/vercel-ai-sdk.mdx +2 -2
  42. package/.docs/raw/docs/{api-reference → (reference)/api-reference}/overview.mdx +1 -1
  43. package/.docs/raw/docs/(reference)/api-reference/primitives/action-bar-more.mdx +327 -0
  44. package/.docs/raw/docs/{api-reference/primitives/ActionBar.mdx → (reference)/api-reference/primitives/action-bar.mdx} +3 -1
  45. package/.docs/raw/docs/{api-reference/primitives/AssistantIf.mdx → (reference)/api-reference/primitives/assistant-if.mdx} +2 -2
  46. package/.docs/raw/docs/{api-reference/primitives/AssistantModal.mdx → (reference)/api-reference/primitives/assistant-modal.mdx} +3 -1
  47. package/.docs/raw/docs/{api-reference/primitives/Attachment.mdx → (reference)/api-reference/primitives/attachment.mdx} +3 -2
  48. package/.docs/raw/docs/{api-reference/primitives/BranchPicker.mdx → (reference)/api-reference/primitives/branch-picker.mdx} +2 -1
  49. package/.docs/raw/docs/{api-reference/primitives/Composer.mdx → (reference)/api-reference/primitives/composer.mdx} +101 -2
  50. package/.docs/raw/docs/{api-reference → (reference)/api-reference}/primitives/composition.mdx +1 -0
  51. package/.docs/raw/docs/{api-reference/primitives/Error.mdx → (reference)/api-reference/primitives/error.mdx} +2 -1
  52. package/.docs/raw/docs/{api-reference/primitives/MessagePart.mdx → (reference)/api-reference/primitives/message-part.mdx} +2 -2
  53. package/.docs/raw/docs/{api-reference/primitives/Message.mdx → (reference)/api-reference/primitives/message.mdx} +2 -1
  54. package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list-item-more.mdx +221 -0
  55. package/.docs/raw/docs/{api-reference/primitives/ThreadListItem.mdx → (reference)/api-reference/primitives/thread-list-item.mdx} +2 -1
  56. package/.docs/raw/docs/{api-reference/primitives/ThreadList.mdx → (reference)/api-reference/primitives/thread-list.mdx} +2 -1
  57. package/.docs/raw/docs/{api-reference/primitives/Thread.mdx → (reference)/api-reference/primitives/thread.mdx} +2 -1
  58. package/.docs/raw/docs/{api-reference/runtimes/AssistantRuntime.mdx → (reference)/api-reference/runtimes/assistant-runtime.mdx} +2 -1
  59. package/.docs/raw/docs/{api-reference/runtimes/AttachmentRuntime.mdx → (reference)/api-reference/runtimes/attachment-runtime.mdx} +3 -2
  60. package/.docs/raw/docs/{api-reference/runtimes/ComposerRuntime.mdx → (reference)/api-reference/runtimes/composer-runtime.mdx} +2 -1
  61. package/.docs/raw/docs/{api-reference/runtimes/MessagePartRuntime.mdx → (reference)/api-reference/runtimes/message-part-runtime.mdx} +3 -2
  62. package/.docs/raw/docs/{api-reference/runtimes/MessageRuntime.mdx → (reference)/api-reference/runtimes/message-runtime.mdx} +3 -2
  63. package/.docs/raw/docs/{api-reference/runtimes/ThreadListItemRuntime.mdx → (reference)/api-reference/runtimes/thread-list-item-runtime.mdx} +2 -1
  64. package/.docs/raw/docs/{api-reference/runtimes/ThreadListRuntime.mdx → (reference)/api-reference/runtimes/thread-list-runtime.mdx} +2 -1
  65. package/.docs/raw/docs/{api-reference/runtimes/ThreadRuntime.mdx → (reference)/api-reference/runtimes/thread-runtime.mdx} +3 -5
  66. package/.docs/raw/docs/{legacy/styled/AssistantModal.mdx → (reference)/legacy/styled/assistant-modal.mdx} +2 -3
  67. package/.docs/raw/docs/{legacy/styled/Decomposition.mdx → (reference)/legacy/styled/decomposition.mdx} +1 -0
  68. package/.docs/raw/docs/{legacy/styled/Markdown.mdx → (reference)/legacy/styled/markdown.mdx} +2 -4
  69. package/.docs/raw/docs/{legacy/styled/Scrollbar.mdx → (reference)/legacy/styled/scrollbar.mdx} +2 -1
  70. package/.docs/raw/docs/{legacy/styled/ThreadWidth.mdx → (reference)/legacy/styled/thread-width.mdx} +1 -0
  71. package/.docs/raw/docs/{legacy/styled/Thread.mdx → (reference)/legacy/styled/thread.mdx} +2 -3
  72. package/.docs/raw/docs/{migrations → (reference)/migrations}/deprecation-policy.mdx +1 -0
  73. package/.docs/raw/docs/{migrations → (reference)/migrations}/react-langgraph-v0-7.mdx +1 -2
  74. package/.docs/raw/docs/{migrations → (reference)/migrations}/v0-11.mdx +1 -0
  75. package/.docs/raw/docs/{migrations → (reference)/migrations}/v0-12.mdx +1 -0
  76. package/.docs/raw/docs/{react-compatibility.mdx → (reference)/react-compatibility.mdx} +2 -3
  77. package/.docs/raw/docs/cloud/authorization.mdx +1 -0
  78. package/.docs/raw/docs/cloud/overview.mdx +1 -0
  79. package/.docs/raw/docs/cloud/persistence/ai-sdk.mdx +2 -3
  80. package/.docs/raw/docs/cloud/persistence/langgraph.mdx +5 -7
  81. package/.docs/raw/docs/runtimes/ai-sdk/use-chat.mdx +9 -8
  82. package/.docs/raw/docs/runtimes/ai-sdk/v4-legacy.mdx +2 -3
  83. package/.docs/raw/docs/runtimes/assistant-transport.mdx +7 -6
  84. package/.docs/raw/docs/runtimes/custom/custom-thread-list.mdx +2 -3
  85. package/.docs/raw/docs/runtimes/custom/external-store.mdx +6 -8
  86. package/.docs/raw/docs/runtimes/custom/local.mdx +12 -8
  87. package/.docs/raw/docs/runtimes/data-stream.mdx +32 -4
  88. package/.docs/raw/docs/runtimes/helicone.mdx +1 -0
  89. package/.docs/raw/docs/runtimes/langgraph/index.mdx +3 -3
  90. package/.docs/raw/docs/runtimes/langgraph/tutorial/index.mdx +1 -0
  91. package/.docs/raw/docs/runtimes/langgraph/tutorial/introduction.mdx +1 -0
  92. package/.docs/raw/docs/runtimes/langgraph/tutorial/part-1.mdx +1 -0
  93. package/.docs/raw/docs/runtimes/langgraph/tutorial/part-2.mdx +1 -0
  94. package/.docs/raw/docs/runtimes/langgraph/tutorial/part-3.mdx +2 -1
  95. package/.docs/raw/docs/runtimes/langserve.mdx +2 -2
  96. package/.docs/raw/docs/runtimes/mastra/full-stack-integration.mdx +4 -5
  97. package/.docs/raw/docs/runtimes/mastra/overview.mdx +1 -0
  98. package/.docs/raw/docs/runtimes/mastra/separate-server-integration.mdx +3 -4
  99. package/.docs/raw/docs/runtimes/pick-a-runtime.mdx +2 -4
  100. package/.docs/raw/docs/ui/assistant-modal.mdx +163 -0
  101. package/.docs/raw/docs/ui/assistant-sidebar.mdx +90 -0
  102. package/.docs/raw/docs/ui/attachment.mdx +227 -0
  103. package/.docs/raw/docs/ui/{Markdown.mdx → markdown.mdx} +11 -6
  104. package/.docs/raw/docs/ui/{Mermaid.mdx → mermaid.mdx} +12 -5
  105. package/.docs/raw/docs/ui/{PartGrouping.mdx → part-grouping.mdx} +4 -6
  106. package/.docs/raw/docs/ui/reasoning.mdx +148 -0
  107. package/.docs/raw/docs/ui/{Scrollbar.mdx → scrollbar.mdx} +9 -1
  108. package/.docs/raw/docs/ui/sources.mdx +87 -0
  109. package/.docs/raw/docs/ui/{SyntaxHighlighting.mdx → syntax-highlighting.mdx} +9 -5
  110. package/.docs/raw/docs/ui/thread-list.mdx +275 -0
  111. package/.docs/raw/docs/ui/{Thread.mdx → thread.mdx} +5 -6
  112. package/.docs/raw/docs/ui/tool-fallback.mdx +112 -0
  113. package/.docs/raw/docs/ui/tool-group.mdx +214 -0
  114. package/dist/tools/docs.js +1 -1
  115. package/dist/tools/examples.js +1 -1
  116. package/dist/tools/examples.js.map +1 -1
  117. package/package.json +5 -5
  118. package/src/tools/docs.ts +1 -1
  119. package/src/tools/examples.ts +1 -1
  120. package/src/tools/tests/docs.test.ts +18 -16
  121. package/src/tools/tests/examples.test.ts +5 -5
  122. package/src/tools/tests/path-traversal.test.ts +3 -3
  123. package/src/utils/tests/security.test.ts +3 -3
  124. package/.docs/raw/docs/index.mdx +0 -7
  125. package/.docs/raw/docs/ui/AssistantModal.mdx +0 -45
  126. package/.docs/raw/docs/ui/AssistantSidebar.mdx +0 -41
  127. package/.docs/raw/docs/ui/Attachment.mdx +0 -84
  128. package/.docs/raw/docs/ui/Reasoning.mdx +0 -152
  129. package/.docs/raw/docs/ui/ThreadList.mdx +0 -90
  130. package/.docs/raw/docs/ui/ToolFallback.mdx +0 -63
  131. package/.docs/raw/docs/ui/ToolGroup.mdx +0 -96
  132. /package/.docs/raw/docs/{copilots → (docs)/copilots}/assistant-frame.mdx +0 -0
@@ -485,15 +485,15 @@ export default nextConfig;
485
485
  "dependencies": {
486
486
  "@assistant-ui/store": "workspace:*",
487
487
  "@assistant-ui/tap": "workspace:*",
488
- "next": "16.1.0",
489
- "react": "19.2.3",
490
- "react-dom": "19.2.3"
488
+ "next": "^16.1.4",
489
+ "react": "^19.2.3",
490
+ "react-dom": "^19.2.3"
491
491
  },
492
492
  "devDependencies": {
493
493
  "@assistant-ui/x-buildutils": "workspace:*",
494
494
  "@tailwindcss/postcss": "^4.1.18",
495
- "@types/node": "^25.0.3",
496
- "@types/react": "^19.2.7",
495
+ "@types/node": "^25.0.9",
496
+ "@types/react": "^19.2.9",
497
497
  "@types/react-dom": "^19.2.3",
498
498
  "postcss": "^8.5.6",
499
499
  "tailwindcss": "^4.1.18",
@@ -4,7 +4,7 @@
4
4
 
5
5
  ```json
6
6
  {
7
- "projectName": "assistant-ui-with-tanstack",
7
+ "projectName": "with-tanstack",
8
8
  "mode": "file-router",
9
9
  "typescript": true,
10
10
  "tailwind": true,
@@ -37,28 +37,28 @@
37
37
  "@radix-ui/react-slot": "^1.2.4",
38
38
  "@radix-ui/react-tooltip": "^1.2.8",
39
39
  "@tailwindcss/vite": "^4.1.18",
40
- "@tanstack/react-router": "^1.141.8",
41
- "@tanstack/react-start": "^1.142.1",
40
+ "@tanstack/react-router": "^1.153.2",
41
+ "@tanstack/react-start": "^1.154.0",
42
42
  "class-variance-authority": "^0.7.1",
43
43
  "clsx": "^2.1.1",
44
44
  "lucide-react": "^0.562.0",
45
45
  "nitro": "^3.0.1-alpha.1",
46
- "openai": "^6.15.0",
47
- "react": "19.2.3",
48
- "react-dom": "19.2.3",
46
+ "openai": "^6.16.0",
47
+ "react": "^19.2.3",
48
+ "react-dom": "^19.2.3",
49
49
  "remark-gfm": "^4.0.1",
50
50
  "tailwind-merge": "^3.4.0",
51
51
  "tailwindcss": "^4.1.18",
52
- "vite-tsconfig-paths": "^6.0.3"
52
+ "vite-tsconfig-paths": "^6.0.4"
53
53
  },
54
54
  "devDependencies": {
55
55
  "@assistant-ui/x-buildutils": "workspace:*",
56
- "@types/node": "^25.0.3",
57
- "@types/react": "^19.2.7",
56
+ "@types/node": "^25.0.9",
57
+ "@types/react": "^19.2.9",
58
58
  "@types/react-dom": "^19.2.3",
59
59
  "@vitejs/plugin-react": "^5.1.2",
60
60
  "typescript": "^5.9.3",
61
- "vite": "^7.3.0"
61
+ "vite": "^7.3.1"
62
62
  }
63
63
  }
64
64
 
@@ -5,8 +5,6 @@ author: Simon Farshid
5
5
  date: 2025-01-31T12:00:00
6
6
  ---
7
7
 
8
- import { Callout } from "fumadocs-ui/components/callout";
9
-
10
8
  <Callout emoji="🎉">
11
9
  This is the first edition of our changelog. We post these updates on a monthly
12
10
  basis. If you want more frequent updates about our new features, join our
@@ -1,5 +1,6 @@
1
1
  ---
2
2
  title: "About assistant-ui"
3
+ description: Why assistant-ui? Composable primitives, runtime agnostic, and production-ready.
3
4
  ---
4
5
 
5
6
  import { Sparkles, PanelsTopLeft, Database, Terminal } from "lucide-react";
@@ -38,7 +39,7 @@ assistant-ui helps you create beautiful, enterprise-grade AI chat interfaces in
38
39
  </Cards>
39
40
 
40
41
  <Callout title="Want to try it out?">
41
- [Get Started in 30 Seconds](/docs/getting-started).
42
+ [Get Started in 30 Seconds](/docs).
42
43
  </Callout>
43
44
 
44
45
  ## AI Accessible Documentation
@@ -1,12 +1,13 @@
1
1
  ---
2
2
  title: "Architecture"
3
+ description: How components, runtimes, and cloud services fit together.
3
4
  ---
4
5
 
5
6
  import { Sparkles, PanelsTopLeft, Database, Terminal } from "lucide-react";
6
7
 
7
8
  ## assistant-ui is built on these main pillars:
8
9
 
9
- <div className="grid grid-cols-1 md:grid-cols-3 gap-4 my-8">
10
+ <div className="grid grid-cols-1 md:grid-cols-3 gap-4">
10
11
  <Card title='1. Frontend components'>
11
12
  Shadcn UI chat components with built-in state management
12
13
  </Card>
@@ -23,7 +24,7 @@ import { Sparkles, PanelsTopLeft, Database, Terminal } from "lucide-react";
23
24
 
24
25
 
25
26
  ### 1. Frontend components
26
- Stylized and functional chat components built on top of Shadcn components that have context state management provided by the assistantUI runtime provider. These pre-built React components come with intelligent state management. [View our components](/docs/ui/Thread)
27
+ Stylized and functional chat components built on top of Shadcn components that have context state management provided by the assistantUI runtime provider. These pre-built React components come with intelligent state management. [View our components](/docs/ui/thread)
27
28
 
28
29
  ### 2. Runtime
29
30
  A React state management context for assistant chat. The runtime handles data conversions between the local state and calls to backends and LLMs. We offer different runtime solutions that work with various frameworks like Vercel AI SDK, LangGraph, LangChain, Helicone, local runtime, and an ExternalStore when you need full control of the frontend message state. [You can view the runtimes we support](/docs/runtimes/pick-a-runtime)
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: CLI
3
- description: Use the assistant-ui CLI to add components and dependencies to your project.
3
+ description: Scaffold projects, add components, and manage updates from the command line.
4
4
  ---
5
5
 
6
6
  Use the `assistant-ui` CLI to quickly set up new projects and add components to existing ones.
@@ -37,8 +37,6 @@ Options:
37
37
  -h, --help display help for command
38
38
  ```
39
39
 
40
- ---
41
-
42
40
  ## create
43
41
 
44
42
  Use the `create` command to scaffold a new Next.js project with assistant-ui pre-configured.
@@ -94,8 +92,6 @@ Options:
94
92
  -h, --help display help for command
95
93
  ```
96
94
 
97
- ---
98
-
99
95
  ## add
100
96
 
101
97
  Use the `add` command to add individual components to your project.
@@ -143,8 +139,6 @@ Options:
143
139
  -h, --help display help for command
144
140
  ```
145
141
 
146
- ---
147
-
148
142
  ## update
149
143
 
150
144
  Use the `update` command to update all `@assistant-ui/*` packages to their latest versions.
@@ -181,8 +175,6 @@ Options:
181
175
  -h, --help display help for command
182
176
  ```
183
177
 
184
- ---
185
-
186
178
  ## upgrade
187
179
 
188
180
  Use the `upgrade` command to automatically migrate your codebase when there are breaking changes.
@@ -228,8 +220,6 @@ Options:
228
220
  -h, --help display help for command
229
221
  ```
230
222
 
231
- ---
232
-
233
223
  ## codemod
234
224
 
235
225
  Use the `codemod` command to run a specific codemod transformation.
@@ -272,8 +262,6 @@ Options:
272
262
  -h, --help display help for command
273
263
  ```
274
264
 
275
- ---
276
-
277
265
  ## Common Workflows
278
266
 
279
267
  ### Starting a new project
@@ -328,8 +316,6 @@ npx assistant-ui@latest codemod v0-11/content-part-to-message-part ./src
328
316
  npx assistant-ui@latest update
329
317
  ```
330
318
 
331
- ---
332
-
333
319
  ## Component Registry
334
320
 
335
321
  The CLI pulls components from our public registry at [r.assistant-ui.com](https://r.assistant-ui.com).
@@ -342,8 +328,6 @@ Each component includes:
342
328
 
343
329
  Components are added directly to your project's source code, giving you full control to customize them.
344
330
 
345
- ---
346
-
347
331
  ## Troubleshooting
348
332
 
349
333
  ### Command not found
@@ -384,8 +368,6 @@ Use the `--overwrite` flag to replace existing components:
384
368
  npx assistant-ui@latest add thread --overwrite
385
369
  ```
386
370
 
387
- ---
388
-
389
371
  ## Configuration
390
372
 
391
373
  The CLI respects your project's configuration:
@@ -1,5 +1,6 @@
1
1
  ---
2
2
  title: makeAssistantVisible
3
+ description: Make React components visible and interactive to assistants via higher-order component wrapping.
3
4
  ---
4
5
 
5
6
  `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,8 +1,9 @@
1
1
  ---
2
2
  title: makeAssistantToolUI
3
+ description: Register custom UI components to render tool executions and their status.
3
4
  ---
4
5
 
5
- import { ParametersTable } from "@/components/docs";
6
+ import { ParametersTable } from "@/components/docs/tables/ParametersTable";
6
7
 
7
8
  The `makeAssistantToolUI` utility is used to register a tool UI component with the Assistant.
8
9
 
@@ -1,8 +1,9 @@
1
1
  ---
2
2
  title: makeAssistantTool
3
+ description: Create React components that provide reusable tools to the assistant.
3
4
  ---
4
5
 
5
- import { ParametersTable } from "@/components/docs";
6
+ import { ParametersTable } from "@/components/docs/tables/ParametersTable";
6
7
 
7
8
  `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.
8
9
 
@@ -1,5 +1,6 @@
1
1
  ---
2
2
  title: Model Context
3
+ description: Configure assistant behavior through system instructions, tools, and context providers.
3
4
  ---
4
5
 
5
6
  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,5 +1,6 @@
1
1
  ---
2
2
  title: Intelligent Components
3
+ description: Add intelligence to React components through readable interfaces and assistant tools.
3
4
  ---
4
5
 
5
6
  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,5 +1,6 @@
1
1
  ---
2
2
  title: useAssistantInstructions
3
+ description: React hook for setting system instructions to guide assistant behavior.
3
4
  ---
4
5
 
5
6
  `useAssistantInstructions` is a React hook that allows you to set system instructions for your assistant-ui components.
@@ -1,13 +1,13 @@
1
1
  ---
2
2
  title: DevTools
3
+ description: Inspect runtime state, context, and events in the browser.
3
4
  ---
4
5
 
5
- import { Step, Steps } from "fumadocs-ui/components/steps";
6
- import { InstallCommand } from "@/components/docs/install-command";
6
+ import { InstallCommand } from "@/components/docs/fumadocs/install/install-command";
7
7
 
8
8
  Hey, the assistant-ui DevTools allows you to debug the assistant-ui state and context, and events without resorting to `console.log`. It's an easy way to see how data flows to the assistant-ui's runtime layer.
9
9
 
10
- ![Screenshot of the DevTools UI showing logs and state panels](../../../../.github/assets/devtoolsui.png)
10
+ ![Screenshot of the DevTools UI showing logs and state panels](../../../../../.github/assets/devtoolsui.png)
11
11
 
12
12
  ## Setup
13
13
 
@@ -44,7 +44,7 @@ export function AssistantApp() {
44
44
 
45
45
  That's it! In development builds you should now see the DevTools in the lower-right corner of your site.
46
46
 
47
- ![DevTools floating modal anchored in the lower-right corner of a page](../../../../.github/assets/devtoolsmodal.png)
47
+ ![DevTools floating modal anchored in the lower-right corner of a page](../../../../../.github/assets/devtoolsmodal.png)
48
48
 
49
49
  </Step>
50
50
  </Steps>
@@ -1,11 +1,10 @@
1
1
  ---
2
2
  title: Attachments
3
+ description: Let users attach files, images, and documents to messages.
3
4
  ---
4
5
 
5
- import { AttachmentSample } from "@/components/samples/attachment-sample";
6
- import { Steps, Step } from "fumadocs-ui/components/steps";
7
- import { Callout } from "fumadocs-ui/components/callout";
8
- import { InstallCommand } from "@/components/docs/install-command";
6
+ import { AttachmentSample } from "@/components/docs/samples/attachment";
7
+ import { InstallCommand } from "@/components/docs/fumadocs/install/install-command";
9
8
 
10
9
  Enable users to attach files to their messages, enhancing conversations with images, documents, and other content.
11
10
 
@@ -530,5 +529,5 @@ Attachments work with all assistant-ui runtimes:
530
529
 
531
530
  ## Resources
532
531
 
533
- - [Attachment UI Components](/docs/ui/Attachment) - UI implementation details
532
+ - [Attachment UI Components](/docs/ui/attachment) - UI implementation details
534
533
  - [API Reference](/docs/api-reference) - Detailed type definitions
@@ -1,8 +1,9 @@
1
1
  ---
2
2
  title: Message Branching
3
+ description: Navigate between different conversation branches when editing or reloading messages.
3
4
  ---
4
5
 
5
- import { BranchingSample } from "@/components/samples/branching-sample";
6
+ import { BranchingSample } from "@/components/docs/samples/branching";
6
7
 
7
8
  Switch between different conversation branches.
8
9
 
@@ -1,5 +1,6 @@
1
1
  ---
2
2
  title: Context API
3
+ description: Read and update assistant state to build custom components.
3
4
  ---
4
5
 
5
6
  The Context API provides direct access to assistant-ui's state management system, enabling you to build custom components that integrate seamlessly with the assistant runtime.