@assistant-ui/mcp-docs-server 0.2.1 → 0.2.2
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 +1 -1
- package/.docs/organized/code-examples/with-a2a.md +2 -2
- package/.docs/organized/code-examples/with-ag-ui.md +3 -3
- package/.docs/organized/code-examples/with-ai-sdk-v7.md +5 -5
- package/.docs/organized/code-examples/with-artifacts.md +5 -5
- package/.docs/organized/code-examples/with-assistant-transport.md +3 -3
- package/.docs/organized/code-examples/with-browser-extension.md +4 -4
- package/.docs/organized/code-examples/with-chain-of-thought.md +5 -5
- package/.docs/organized/code-examples/with-cloud-standalone.md +5 -5
- package/.docs/organized/code-examples/with-cloud.md +5 -5
- package/.docs/organized/code-examples/with-custom-thread-list.md +6 -6
- package/.docs/organized/code-examples/with-elevenlabs-conversational.md +7 -7
- package/.docs/organized/code-examples/with-elevenlabs-scribe.md +8 -8
- package/.docs/organized/code-examples/with-eve.md +3 -3
- package/.docs/organized/code-examples/with-expo.md +13 -19
- package/.docs/organized/code-examples/with-external-store.md +3 -3
- package/.docs/organized/code-examples/with-ffmpeg.md +5 -5
- package/.docs/organized/code-examples/with-generative-ui.md +259 -23
- package/.docs/organized/code-examples/with-google-adk.md +2 -2
- package/.docs/organized/code-examples/with-heat-graph.md +1 -1
- package/.docs/organized/code-examples/with-image-generation.md +4 -4
- package/.docs/organized/code-examples/with-interactables.md +5 -5
- package/.docs/organized/code-examples/with-langchain.md +7 -7
- package/.docs/organized/code-examples/with-langgraph.md +4 -4
- package/.docs/organized/code-examples/with-livekit.md +7 -7
- package/.docs/organized/code-examples/with-mcp.md +6 -6
- package/.docs/organized/code-examples/with-nuxt.md +500 -564
- package/.docs/organized/code-examples/with-opencode.md +2 -2
- package/.docs/organized/code-examples/with-openui.md +449 -0
- package/.docs/organized/code-examples/with-pi.md +2 -2
- package/.docs/organized/code-examples/with-react-hook-form.md +7 -7
- package/.docs/organized/code-examples/with-react-ink-web.md +4 -4
- package/.docs/organized/code-examples/with-react-ink.md +2 -2
- package/.docs/organized/code-examples/with-react-router.md +4 -4
- package/.docs/organized/code-examples/with-resumable-stream.md +7 -7
- package/.docs/organized/code-examples/with-store.md +1 -1
- package/.docs/organized/code-examples/with-svelte.md +415 -0
- package/.docs/organized/code-examples/with-sveltekit.md +1061 -0
- package/.docs/organized/code-examples/with-tanstack.md +5 -5
- package/.docs/organized/code-examples/with-tap-runtime.md +2 -2
- package/.docs/organized/code-examples/with-virtualized-thread.md +2 -2
- package/.docs/organized/code-examples/with-vue.md +1 -1
- package/.docs/raw/docs/(docs)/cli.mdx +6 -1
- package/.docs/raw/docs/(docs)/installation.mdx +2 -2
- package/.docs/raw/docs/(reference)/api-reference/generative-ui/slack.mdx +5 -1
- package/.docs/raw/docs/(reference)/api-reference/generative-ui/teams.mdx +9 -2
- package/.docs/raw/docs/(reference)/api-reference/hooks/primitives.mdx +2 -2
- package/.docs/raw/docs/(reference)/api-reference/integrations/eve.mdx +39 -1
- package/.docs/raw/docs/(reference)/api-reference/integrations/react-ai-sdk.mdx +29 -4
- package/.docs/raw/docs/(reference)/api-reference/tools/status.mdx +1 -1
- package/.docs/raw/docs/(reference)/api-reference/utilities/miscellaneous.mdx +29 -1
- package/.docs/raw/docs/(reference)/api-reference/voice/session.mdx +1 -1
- package/.docs/raw/docs/cloud/ai-sdk-assistant-ui.mdx +1 -1
- package/.docs/raw/docs/cloud/ai-sdk.mdx +2 -2
- package/.docs/raw/docs/cloud/index.mdx +1 -1
- package/.docs/raw/docs/guides/attachments.mdx +2 -2
- package/.docs/raw/docs/guides/context-api.mdx +15 -17
- package/.docs/raw/docs/guides/dictation.mdx +1 -1
- package/.docs/raw/docs/guides/mentions.mdx +2 -0
- package/.docs/raw/docs/guides/suggestions.mdx +6 -3
- package/.docs/raw/docs/ink/primitives.mdx +1 -1
- package/.docs/raw/docs/integrations/persistence/custom-adapter.mdx +146 -128
- package/.docs/raw/docs/migrations/v0-15.mdx +34 -0
- package/.docs/raw/docs/primitives/suggestion.mdx +3 -1
- package/.docs/raw/docs/primitives/thread.mdx +1 -1
- package/.docs/raw/docs/runtimes/ag-ui/runtime-options.mdx +35 -5
- package/.docs/raw/docs/runtimes/claude-managed-agents.mdx +118 -0
- package/.docs/raw/docs/runtimes/concepts/stability.mdx +2 -1
- package/.docs/raw/docs/runtimes/concepts/threads.mdx +68 -28
- package/.docs/raw/docs/runtimes/custom/assistant-transport.mdx +1 -1
- package/.docs/raw/docs/runtimes/custom/external-store.mdx +6 -2
- package/.docs/raw/docs/runtimes/langchain.mdx +1 -1
- package/.docs/raw/docs/runtimes/langgraph/streaming.mdx +4 -0
- package/.docs/raw/docs/runtimes/pick-a-runtime.mdx +8 -1
- package/.docs/raw/docs/tools/defining-tools.mdx +19 -0
- package/.docs/raw/docs/tools/generative-ui-primitive.mdx +180 -0
- package/.docs/raw/docs/tools/generative-ui-slack.mdx +167 -0
- package/.docs/raw/docs/tools/generative-ui-teams.mdx +160 -0
- package/.docs/raw/docs/tools/generative-ui.mdx +224 -211
- package/.docs/raw/docs/tools/index.mdx +2 -1
- package/.docs/raw/docs/tools/interactables.mdx +5 -4
- package/.docs/raw/docs/tools/openui.mdx +175 -0
- package/.docs/raw/docs/tools/tool-ui.mdx +1 -2
- package/.docs/raw/docs/tools/user-managed-mcp.mdx +5 -1
- package/.docs/raw/docs/ui/attachment.mdx +27 -0
- package/.docs/raw/docs/ui/file.mdx +1 -1
- package/.docs/raw/docs/ui/image.mdx +1 -1
- package/package.json +4 -4
- package/.docs/raw/docs/tools/interactables-legacy.mdx +0 -423
|
@@ -1902,7 +1902,7 @@ export default withAui(nextConfig);
|
|
|
1902
1902
|
"@pierre/diffs": "^1.3.5",
|
|
1903
1903
|
"class-variance-authority": "^0.7.1",
|
|
1904
1904
|
"clsx": "^2.1.1",
|
|
1905
|
-
"lucide-react": "^1.
|
|
1905
|
+
"lucide-react": "^1.31.0",
|
|
1906
1906
|
"next": "^16.3.0",
|
|
1907
1907
|
"react": "^19.2.8",
|
|
1908
1908
|
"react-dom": "^19.2.8",
|
|
@@ -1913,7 +1913,7 @@ export default withAui(nextConfig);
|
|
|
1913
1913
|
"@assistant-ui/next": "workspace:*",
|
|
1914
1914
|
"@assistant-ui/x-buildutils": "workspace:*",
|
|
1915
1915
|
"@tailwindcss/postcss": "^4.3.3",
|
|
1916
|
-
"@types/node": "^26.
|
|
1916
|
+
"@types/node": "^26.2.0",
|
|
1917
1917
|
"@types/react": "^19.2.18",
|
|
1918
1918
|
"@types/react-dom": "^19.2.4",
|
|
1919
1919
|
"postcss": "^8.5.26",
|
|
@@ -0,0 +1,449 @@
|
|
|
1
|
+
# Example: with-openui
|
|
2
|
+
|
|
3
|
+
## app/api/chat/route.ts
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { openai } from "@ai-sdk/openai";
|
|
7
|
+
import { frontendTools } from "@assistant-ui/react-ai-sdk";
|
|
8
|
+
import {
|
|
9
|
+
type JSONSchema7,
|
|
10
|
+
streamText,
|
|
11
|
+
convertToModelMessages,
|
|
12
|
+
type UIMessage,
|
|
13
|
+
createUIMessageStreamResponse,
|
|
14
|
+
toUIMessageStream,
|
|
15
|
+
} from "ai";
|
|
16
|
+
|
|
17
|
+
// Allow streaming responses up to 30 seconds
|
|
18
|
+
export const maxDuration = 30;
|
|
19
|
+
|
|
20
|
+
export async function POST(req: Request) {
|
|
21
|
+
const {
|
|
22
|
+
messages,
|
|
23
|
+
system,
|
|
24
|
+
tools,
|
|
25
|
+
}: {
|
|
26
|
+
messages: UIMessage[];
|
|
27
|
+
system?: string;
|
|
28
|
+
tools?: Record<string, { description?: string; parameters: JSONSchema7 }>;
|
|
29
|
+
} = await req.json();
|
|
30
|
+
|
|
31
|
+
const result = streamText({
|
|
32
|
+
model: openai("gpt-5.6-luna"),
|
|
33
|
+
messages: await convertToModelMessages(messages),
|
|
34
|
+
...(system ? { system } : {}),
|
|
35
|
+
tools: frontendTools(tools ?? {}),
|
|
36
|
+
});
|
|
37
|
+
|
|
38
|
+
return createUIMessageStreamResponse({
|
|
39
|
+
stream: toUIMessageStream({ stream: result.stream }),
|
|
40
|
+
});
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## app/globals.css
|
|
46
|
+
|
|
47
|
+
```css
|
|
48
|
+
@import "tailwindcss";
|
|
49
|
+
@import "tw-animate-css";
|
|
50
|
+
@import "@openuidev/react-ui/layered/styles/index.css";
|
|
51
|
+
|
|
52
|
+
@source "../../../packages/ui/src";
|
|
53
|
+
|
|
54
|
+
@custom-variant dark (&:is(.dark *));
|
|
55
|
+
|
|
56
|
+
@theme inline {
|
|
57
|
+
--radius-sm: calc(var(--radius) - 4px);
|
|
58
|
+
--radius-md: calc(var(--radius) - 2px);
|
|
59
|
+
--radius-lg: var(--radius);
|
|
60
|
+
--radius-xl: calc(var(--radius) + 4px);
|
|
61
|
+
--color-background: var(--background);
|
|
62
|
+
--color-foreground: var(--foreground);
|
|
63
|
+
--color-card: var(--card);
|
|
64
|
+
--color-card-foreground: var(--card-foreground);
|
|
65
|
+
--color-popover: var(--popover);
|
|
66
|
+
--color-popover-foreground: var(--popover-foreground);
|
|
67
|
+
--color-primary: var(--primary);
|
|
68
|
+
--color-primary-foreground: var(--primary-foreground);
|
|
69
|
+
--color-secondary: var(--secondary);
|
|
70
|
+
--color-secondary-foreground: var(--secondary-foreground);
|
|
71
|
+
--color-muted: var(--muted);
|
|
72
|
+
--color-muted-foreground: var(--muted-foreground);
|
|
73
|
+
--color-accent: var(--accent);
|
|
74
|
+
--color-accent-foreground: var(--accent-foreground);
|
|
75
|
+
--color-destructive: var(--destructive);
|
|
76
|
+
--color-border: var(--border);
|
|
77
|
+
--color-input: var(--input);
|
|
78
|
+
--color-ring: var(--ring);
|
|
79
|
+
--color-chart-1: var(--chart-1);
|
|
80
|
+
--color-chart-2: var(--chart-2);
|
|
81
|
+
--color-chart-3: var(--chart-3);
|
|
82
|
+
--color-chart-4: var(--chart-4);
|
|
83
|
+
--color-chart-5: var(--chart-5);
|
|
84
|
+
--color-sidebar: var(--sidebar);
|
|
85
|
+
--color-sidebar-foreground: var(--sidebar-foreground);
|
|
86
|
+
--color-sidebar-primary: var(--sidebar-primary);
|
|
87
|
+
--color-sidebar-primary-foreground: var(--sidebar-primary-foreground);
|
|
88
|
+
--color-sidebar-accent: var(--sidebar-accent);
|
|
89
|
+
--color-sidebar-accent-foreground: var(--sidebar-accent-foreground);
|
|
90
|
+
--color-sidebar-border: var(--sidebar-border);
|
|
91
|
+
--color-sidebar-ring: var(--sidebar-ring);
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
:root {
|
|
95
|
+
--radius: 0.625rem;
|
|
96
|
+
--background: oklch(1 0 0);
|
|
97
|
+
--foreground: oklch(0.141 0.005 285.823);
|
|
98
|
+
--card: oklch(1 0 0);
|
|
99
|
+
--card-foreground: oklch(0.141 0.005 285.823);
|
|
100
|
+
--popover: oklch(1 0 0);
|
|
101
|
+
--popover-foreground: oklch(0.141 0.005 285.823);
|
|
102
|
+
--primary: oklch(0.21 0.006 285.885);
|
|
103
|
+
--primary-foreground: oklch(0.985 0 0);
|
|
104
|
+
--secondary: oklch(0.967 0.001 286.375);
|
|
105
|
+
--secondary-foreground: oklch(0.21 0.006 285.885);
|
|
106
|
+
--muted: oklch(0.967 0.001 286.375);
|
|
107
|
+
--muted-foreground: oklch(0.552 0.016 285.938);
|
|
108
|
+
--accent: oklch(0.967 0.001 286.375);
|
|
109
|
+
--accent-foreground: oklch(0.21 0.006 285.885);
|
|
110
|
+
--destructive: oklch(0.577 0.245 27.325);
|
|
111
|
+
--border: oklch(0.92 0.004 286.32);
|
|
112
|
+
--input: oklch(0.92 0.004 286.32);
|
|
113
|
+
--ring: oklch(0.705 0.015 286.067);
|
|
114
|
+
--chart-1: oklch(0.646 0.222 41.116);
|
|
115
|
+
--chart-2: oklch(0.6 0.118 184.704);
|
|
116
|
+
--chart-3: oklch(0.398 0.07 227.392);
|
|
117
|
+
--chart-4: oklch(0.828 0.189 84.429);
|
|
118
|
+
--chart-5: oklch(0.769 0.188 70.08);
|
|
119
|
+
--sidebar: oklch(0.985 0 0);
|
|
120
|
+
--sidebar-foreground: oklch(0.141 0.005 285.823);
|
|
121
|
+
--sidebar-primary: oklch(0.21 0.006 285.885);
|
|
122
|
+
--sidebar-primary-foreground: oklch(0.985 0 0);
|
|
123
|
+
--sidebar-accent: oklch(0.967 0.001 286.375);
|
|
124
|
+
--sidebar-accent-foreground: oklch(0.21 0.006 285.885);
|
|
125
|
+
--sidebar-border: oklch(0.92 0.004 286.32);
|
|
126
|
+
--sidebar-ring: oklch(0.705 0.015 286.067);
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
.dark {
|
|
130
|
+
--background: oklch(0.141 0.005 285.823);
|
|
131
|
+
--foreground: oklch(0.985 0 0);
|
|
132
|
+
--card: oklch(0.21 0.006 285.885);
|
|
133
|
+
--card-foreground: oklch(0.985 0 0);
|
|
134
|
+
--popover: oklch(0.21 0.006 285.885);
|
|
135
|
+
--popover-foreground: oklch(0.985 0 0);
|
|
136
|
+
--primary: oklch(0.92 0.004 286.32);
|
|
137
|
+
--primary-foreground: oklch(0.21 0.006 285.885);
|
|
138
|
+
--secondary: oklch(0.274 0.006 286.033);
|
|
139
|
+
--secondary-foreground: oklch(0.985 0 0);
|
|
140
|
+
--muted: oklch(0.274 0.006 286.033);
|
|
141
|
+
--muted-foreground: oklch(0.705 0.015 286.067);
|
|
142
|
+
--accent: oklch(0.274 0.006 286.033);
|
|
143
|
+
--accent-foreground: oklch(0.985 0 0);
|
|
144
|
+
--destructive: oklch(0.704 0.191 22.216);
|
|
145
|
+
--border: oklch(1 0 0 / 10%);
|
|
146
|
+
--input: oklch(1 0 0 / 15%);
|
|
147
|
+
--ring: oklch(0.552 0.016 285.938);
|
|
148
|
+
--chart-1: oklch(0.488 0.243 264.376);
|
|
149
|
+
--chart-2: oklch(0.696 0.17 162.48);
|
|
150
|
+
--chart-3: oklch(0.769 0.188 70.08);
|
|
151
|
+
--chart-4: oklch(0.627 0.265 303.9);
|
|
152
|
+
--chart-5: oklch(0.645 0.246 16.439);
|
|
153
|
+
--sidebar: oklch(0.21 0.006 285.885);
|
|
154
|
+
--sidebar-foreground: oklch(0.985 0 0);
|
|
155
|
+
--sidebar-primary: oklch(0.488 0.243 264.376);
|
|
156
|
+
--sidebar-primary-foreground: oklch(0.985 0 0);
|
|
157
|
+
--sidebar-accent: oklch(0.274 0.006 286.033);
|
|
158
|
+
--sidebar-accent-foreground: oklch(0.985 0 0);
|
|
159
|
+
--sidebar-border: oklch(1 0 0 / 10%);
|
|
160
|
+
--sidebar-ring: oklch(0.552 0.016 285.938);
|
|
161
|
+
}
|
|
162
|
+
|
|
163
|
+
@layer base {
|
|
164
|
+
* {
|
|
165
|
+
@apply border-border outline-ring/50;
|
|
166
|
+
}
|
|
167
|
+
body {
|
|
168
|
+
@apply bg-background text-foreground;
|
|
169
|
+
}
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
## app/layout.tsx
|
|
175
|
+
|
|
176
|
+
```tsx
|
|
177
|
+
import type { Metadata } from "next";
|
|
178
|
+
import "./globals.css";
|
|
179
|
+
|
|
180
|
+
export const metadata: Metadata = {
|
|
181
|
+
title: "OpenUI Example",
|
|
182
|
+
description:
|
|
183
|
+
"Example using @assistant-ui/react with the OpenUI renderer via @openuidev/assistant-ui",
|
|
184
|
+
};
|
|
185
|
+
|
|
186
|
+
export default function RootLayout({
|
|
187
|
+
children,
|
|
188
|
+
}: Readonly<{
|
|
189
|
+
children: React.ReactNode;
|
|
190
|
+
}>) {
|
|
191
|
+
return (
|
|
192
|
+
<html lang="en">
|
|
193
|
+
<body className="h-dvh">{children}</body>
|
|
194
|
+
</html>
|
|
195
|
+
);
|
|
196
|
+
}
|
|
197
|
+
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
## app/page.tsx
|
|
201
|
+
|
|
202
|
+
```tsx
|
|
203
|
+
"use client";
|
|
204
|
+
|
|
205
|
+
import { Thread } from "@/components/assistant-ui/thread";
|
|
206
|
+
import {
|
|
207
|
+
AssistantRuntimeProvider,
|
|
208
|
+
AuiConfig,
|
|
209
|
+
Suggestions,
|
|
210
|
+
Tools,
|
|
211
|
+
} from "@assistant-ui/react";
|
|
212
|
+
import { useChatRuntime } from "@assistant-ui/react-ai-sdk";
|
|
213
|
+
import { OpenUIInstructions, openuiIntegration } from "@openuidev/assistant-ui";
|
|
214
|
+
import { shouldContinueAfterOpenUIPrompt } from "@openuidev/assistant-ui/ai-sdk";
|
|
215
|
+
|
|
216
|
+
export default function Home() {
|
|
217
|
+
const runtime = useChatRuntime({
|
|
218
|
+
sendAutomaticallyWhen: shouldContinueAfterOpenUIPrompt,
|
|
219
|
+
});
|
|
220
|
+
|
|
221
|
+
const config = AuiConfig({
|
|
222
|
+
tools: Tools({ toolkit: openuiIntegration.toolkit }),
|
|
223
|
+
suggestions: Suggestions([
|
|
224
|
+
{
|
|
225
|
+
title: "Trip summary",
|
|
226
|
+
label: "as a display-only card",
|
|
227
|
+
prompt:
|
|
228
|
+
"Show a trip summary for my Tokyo trip: flying March 14 to 21, staying at Park Hyatt Tokyo at $310 a night, total budget $4,200, with three confirmed activities: teamLab Planets, a Tsukiji food tour, and a Hakone day trip.",
|
|
229
|
+
},
|
|
230
|
+
{
|
|
231
|
+
title: "Pick a slot",
|
|
232
|
+
label: "with an interactive choice",
|
|
233
|
+
prompt:
|
|
234
|
+
"Ask me to pick a meeting slot from Tuesday 10:00, Wednesday 14:30, or Friday 09:15.",
|
|
235
|
+
},
|
|
236
|
+
{
|
|
237
|
+
title: "Registration form",
|
|
238
|
+
label: "collect structured input",
|
|
239
|
+
prompt:
|
|
240
|
+
"Collect my conference registration with a form: full name, email, company, and a t-shirt size choice of S, M, L, or XL.",
|
|
241
|
+
},
|
|
242
|
+
{
|
|
243
|
+
title: "Sprint metrics",
|
|
244
|
+
label: "summarized visually",
|
|
245
|
+
prompt:
|
|
246
|
+
"Summarize our sprint: 34 of 41 planned issues closed, velocity 62 points versus 55 last sprint, 3 escaped bugs, and a median cycle time of 2.4 days.",
|
|
247
|
+
},
|
|
248
|
+
]),
|
|
249
|
+
});
|
|
250
|
+
|
|
251
|
+
return (
|
|
252
|
+
<AssistantRuntimeProvider config={config} runtime={runtime}>
|
|
253
|
+
<OpenUIInstructions />
|
|
254
|
+
<div className="h-full">
|
|
255
|
+
<Thread />
|
|
256
|
+
</div>
|
|
257
|
+
</AssistantRuntimeProvider>
|
|
258
|
+
);
|
|
259
|
+
}
|
|
260
|
+
|
|
261
|
+
```
|
|
262
|
+
|
|
263
|
+
## components.json
|
|
264
|
+
|
|
265
|
+
```json
|
|
266
|
+
{
|
|
267
|
+
"$schema": "https://ui.shadcn.com/schema.json",
|
|
268
|
+
"style": "new-york",
|
|
269
|
+
"rsc": true,
|
|
270
|
+
"tsx": true,
|
|
271
|
+
"tailwind": {
|
|
272
|
+
"config": "",
|
|
273
|
+
"css": "app/globals.css",
|
|
274
|
+
"baseColor": "zinc",
|
|
275
|
+
"cssVariables": true,
|
|
276
|
+
"prefix": ""
|
|
277
|
+
},
|
|
278
|
+
"aliases": {
|
|
279
|
+
"components": "@/components",
|
|
280
|
+
"utils": "@/lib/utils",
|
|
281
|
+
"ui": "@/components/ui",
|
|
282
|
+
"lib": "@/lib",
|
|
283
|
+
"hooks": "@/hooks"
|
|
284
|
+
},
|
|
285
|
+
"iconLibrary": "lucide",
|
|
286
|
+
"registries": {
|
|
287
|
+
"@assistant-ui": "https://r.assistant-ui.com/{name}.json"
|
|
288
|
+
}
|
|
289
|
+
}
|
|
290
|
+
|
|
291
|
+
```
|
|
292
|
+
|
|
293
|
+
## next.config.js
|
|
294
|
+
|
|
295
|
+
```javascript
|
|
296
|
+
/** @type {import('next').NextConfig} */
|
|
297
|
+
const nextConfig = {
|
|
298
|
+
transpilePackages: ["@assistant-ui/react", "@assistant-ui/react-ai-sdk"],
|
|
299
|
+
};
|
|
300
|
+
|
|
301
|
+
export default nextConfig;
|
|
302
|
+
|
|
303
|
+
```
|
|
304
|
+
|
|
305
|
+
## package.json
|
|
306
|
+
|
|
307
|
+
```json
|
|
308
|
+
{
|
|
309
|
+
"name": "with-openui",
|
|
310
|
+
"version": "0.0.0",
|
|
311
|
+
"private": true,
|
|
312
|
+
"type": "module",
|
|
313
|
+
"scripts": {
|
|
314
|
+
"dev": "next dev",
|
|
315
|
+
"build": "next build",
|
|
316
|
+
"start": "next start"
|
|
317
|
+
},
|
|
318
|
+
"dependencies": {
|
|
319
|
+
"@ai-sdk/openai": "^4.0.40",
|
|
320
|
+
"@assistant-ui/react": "workspace:*",
|
|
321
|
+
"@assistant-ui/react-ai-sdk": "workspace:*",
|
|
322
|
+
"@assistant-ui/react-markdown": "workspace:*",
|
|
323
|
+
"@assistant-ui/ui": "workspace:*",
|
|
324
|
+
"@openuidev/assistant-ui": "^0.0.3",
|
|
325
|
+
"@openuidev/react-headless": "^0.9.8",
|
|
326
|
+
"@openuidev/react-lang": "^0.2.11",
|
|
327
|
+
"@openuidev/react-ui": "^0.13.6",
|
|
328
|
+
"ai": "^7.0.62",
|
|
329
|
+
"class-variance-authority": "^0.7.1",
|
|
330
|
+
"clsx": "^2.1.1",
|
|
331
|
+
"lucide-react": "^1.31.0",
|
|
332
|
+
"next": "^16.3.0",
|
|
333
|
+
"react": "^19.2.8",
|
|
334
|
+
"react-dom": "^19.2.8",
|
|
335
|
+
"tailwind-merge": "^3.6.0",
|
|
336
|
+
"zod": "^4.4.3",
|
|
337
|
+
"zustand": "^4.5.5"
|
|
338
|
+
},
|
|
339
|
+
"devDependencies": {
|
|
340
|
+
"@assistant-ui/x-buildutils": "workspace:*",
|
|
341
|
+
"@tailwindcss/postcss": "^4.3.3",
|
|
342
|
+
"@types/node": "^26.2.0",
|
|
343
|
+
"@types/react": "^19.2.18",
|
|
344
|
+
"@types/react-dom": "^19.2.4",
|
|
345
|
+
"postcss": "^8.5.26",
|
|
346
|
+
"tailwindcss": "^4.3.3",
|
|
347
|
+
"tw-animate-css": "^1.4.0",
|
|
348
|
+
"typescript": "^7.0.2"
|
|
349
|
+
}
|
|
350
|
+
}
|
|
351
|
+
|
|
352
|
+
```
|
|
353
|
+
|
|
354
|
+
## README.md
|
|
355
|
+
|
|
356
|
+
```markdown
|
|
357
|
+
# OpenUI Example
|
|
358
|
+
|
|
359
|
+
This example renders streaming [OpenUI Lang](https://www.openui.com) interfaces inside an assistant-ui conversation using [`@openuidev/assistant-ui`](https://www.npmjs.com/package/@openuidev/assistant-ui), the integration package published and maintained by OpenUI.
|
|
360
|
+
|
|
361
|
+
assistant-ui owns the chat shell, runtime, messages, streaming, and tool lifecycle. OpenUI renders the `ui` argument of two tool calls: `present_openui` for display-only interfaces and `prompt_openui` for forms and choices that wait for the user to submit.
|
|
362
|
+
|
|
363
|
+
## Quick Start
|
|
364
|
+
|
|
365
|
+
### Using CLI (Recommended)
|
|
366
|
+
|
|
367
|
+
```bash
|
|
368
|
+
npx assistant-ui@latest create my-app --example with-openui
|
|
369
|
+
cd my-app
|
|
370
|
+
```
|
|
371
|
+
|
|
372
|
+
### Environment Variables
|
|
373
|
+
|
|
374
|
+
Create `.env.local`:
|
|
375
|
+
|
|
376
|
+
```sh
|
|
377
|
+
OPENAI_API_KEY=your-api-key-here
|
|
378
|
+
```
|
|
379
|
+
|
|
380
|
+
### Run
|
|
381
|
+
|
|
382
|
+
```bash
|
|
383
|
+
pnpm install
|
|
384
|
+
pnpm dev
|
|
385
|
+
```
|
|
386
|
+
|
|
387
|
+
Open [http://localhost:3000](http://localhost:3000) to see the result.
|
|
388
|
+
|
|
389
|
+
### Run inside the monorepo
|
|
390
|
+
|
|
391
|
+
To develop against the workspace packages directly, clone the repository and build the packages the example imports before starting the dev server. Create `examples/with-openui/.env.local` with your `OPENAI_API_KEY` first.
|
|
392
|
+
|
|
393
|
+
```bash
|
|
394
|
+
git clone https://github.com/assistant-ui/assistant-ui.git
|
|
395
|
+
cd assistant-ui
|
|
396
|
+
pnpm install
|
|
397
|
+
pnpm exec turbo build --filter='with-openui^...'
|
|
398
|
+
pnpm -C examples/with-openui dev
|
|
399
|
+
```
|
|
400
|
+
|
|
401
|
+
## Key Features
|
|
402
|
+
|
|
403
|
+
- Registers `openuiIntegration.toolkit` so the model can call `present_openui` and `prompt_openui`
|
|
404
|
+
- Mounts `OpenUIInstructions` so the model learns the OpenUI component vocabulary through assistant instructions
|
|
405
|
+
- Uses `sendAutomaticallyWhen: shouldContinueAfterOpenUIPrompt` so a display-only call ends the turn while an interactive submission continues the conversation
|
|
406
|
+
- Forwards the instructions and both frontend tools to the backend through `AssistantChatTransport`, so the API route stays generic
|
|
407
|
+
- Loads the OpenUI layered stylesheet once in `app/globals.css`
|
|
408
|
+
|
|
409
|
+
## How it works
|
|
410
|
+
|
|
411
|
+
- `app/page.tsx` wires the runtime, toolkit, instructions, and suggestions
|
|
412
|
+
- `app/api/chat/route.ts` streams with the AI SDK and exposes the forwarded frontend tools with `frontendTools`
|
|
413
|
+
- Submitted form state is returned through `addResult` and hydrates again on replay
|
|
414
|
+
|
|
415
|
+
## Related Documentation
|
|
416
|
+
|
|
417
|
+
- [assistant-ui OpenUI guide](https://www.assistant-ui.com/docs/tools/openui)
|
|
418
|
+
- [OpenUI assistant-ui integration reference](https://www.openui.com/docs/api-reference/assistant-ui)
|
|
419
|
+
|
|
420
|
+
```
|
|
421
|
+
|
|
422
|
+
## tsconfig.json
|
|
423
|
+
|
|
424
|
+
```json
|
|
425
|
+
{
|
|
426
|
+
"extends": "@assistant-ui/x-buildutils/ts/next",
|
|
427
|
+
"compilerOptions": {
|
|
428
|
+
"paths": {
|
|
429
|
+
"@/*": ["./*"],
|
|
430
|
+
"@/components/assistant-ui/*": [
|
|
431
|
+
"../../packages/ui/src/components/assistant-ui/*"
|
|
432
|
+
],
|
|
433
|
+
"@/components/ui/*": [
|
|
434
|
+
"../../packages/ui/src/components/ui/base/*",
|
|
435
|
+
"../../packages/ui/src/components/ui/radix/*"
|
|
436
|
+
],
|
|
437
|
+
"@/components/ui/radix/*": [
|
|
438
|
+
"../../packages/ui/src/components/ui/radix/*"
|
|
439
|
+
],
|
|
440
|
+
"@/lib/utils": ["../../packages/ui/src/lib/utils"],
|
|
441
|
+
"@assistant-ui/ui/*": ["../../packages/ui/src/*"]
|
|
442
|
+
}
|
|
443
|
+
},
|
|
444
|
+
"include": ["**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
|
|
445
|
+
"exclude": ["node_modules"]
|
|
446
|
+
}
|
|
447
|
+
|
|
448
|
+
```
|
|
449
|
+
|
|
@@ -1964,7 +1964,7 @@ export default withAui(nextConfig);
|
|
|
1964
1964
|
"@earendil-works/pi-coding-agent": "^0.84.1",
|
|
1965
1965
|
"class-variance-authority": "^0.7.1",
|
|
1966
1966
|
"clsx": "^2.1.1",
|
|
1967
|
-
"lucide-react": "^1.
|
|
1967
|
+
"lucide-react": "^1.31.0",
|
|
1968
1968
|
"next": "^16.3.0",
|
|
1969
1969
|
"radix-ui": "^1.6.7",
|
|
1970
1970
|
"react": "^19.2.8",
|
|
@@ -1975,7 +1975,7 @@ export default withAui(nextConfig);
|
|
|
1975
1975
|
"@assistant-ui/next": "workspace:*",
|
|
1976
1976
|
"@assistant-ui/x-buildutils": "workspace:*",
|
|
1977
1977
|
"@tailwindcss/postcss": "^4.3.3",
|
|
1978
|
-
"@types/node": "^26.
|
|
1978
|
+
"@types/node": "^26.2.0",
|
|
1979
1979
|
"@types/react": "^19.2.18",
|
|
1980
1980
|
"@types/react-dom": "^19.2.4",
|
|
1981
1981
|
"postcss": "^8.5.26",
|
|
@@ -18,7 +18,7 @@ export async function POST(req: Request) {
|
|
|
18
18
|
const { messages, system, tools } = await req.json();
|
|
19
19
|
|
|
20
20
|
const result = streamText({
|
|
21
|
-
model: openai("gpt-5.
|
|
21
|
+
model: openai("gpt-5.6-luna"),
|
|
22
22
|
messages: await convertToModelMessages(messages),
|
|
23
23
|
system,
|
|
24
24
|
tools: {
|
|
@@ -617,27 +617,27 @@ export default withAui(nextConfig);
|
|
|
617
617
|
"start": "next start"
|
|
618
618
|
},
|
|
619
619
|
"dependencies": {
|
|
620
|
-
"@ai-sdk/openai": "^4.0.
|
|
620
|
+
"@ai-sdk/openai": "^4.0.40",
|
|
621
621
|
"@assistant-ui/react": "workspace:*",
|
|
622
622
|
"@assistant-ui/react-ai-sdk": "workspace:*",
|
|
623
623
|
"@assistant-ui/react-hook-form": "workspace:*",
|
|
624
624
|
"@assistant-ui/react-markdown": "workspace:*",
|
|
625
625
|
"@assistant-ui/ui": "workspace:*",
|
|
626
|
-
"ai": "^7.0.
|
|
626
|
+
"ai": "^7.0.62",
|
|
627
627
|
"class-variance-authority": "^0.7.1",
|
|
628
628
|
"clsx": "^2.1.1",
|
|
629
|
-
"lucide-react": "^1.
|
|
629
|
+
"lucide-react": "^1.31.0",
|
|
630
630
|
"next": "^16.3.0",
|
|
631
631
|
"react": "^19.2.8",
|
|
632
632
|
"react-dom": "^19.2.8",
|
|
633
|
-
"react-hook-form": "^7.
|
|
633
|
+
"react-hook-form": "^7.85.0",
|
|
634
634
|
"tailwind-merge": "^3.6.0"
|
|
635
635
|
},
|
|
636
636
|
"devDependencies": {
|
|
637
637
|
"@assistant-ui/next": "workspace:*",
|
|
638
638
|
"@assistant-ui/x-buildutils": "workspace:*",
|
|
639
639
|
"@tailwindcss/postcss": "^4.3.3",
|
|
640
|
-
"@types/node": "^26.
|
|
640
|
+
"@types/node": "^26.2.0",
|
|
641
641
|
"@types/react": "^19.2.18",
|
|
642
642
|
"@types/react-dom": "^19.2.4",
|
|
643
643
|
"postcss": "^8.5.26",
|
|
@@ -690,7 +690,7 @@ npm run dev
|
|
|
690
690
|
## Related Documentation
|
|
691
691
|
|
|
692
692
|
- [assistant-ui Documentation](https://www.assistant-ui.com/docs)
|
|
693
|
-
- [
|
|
693
|
+
- [Form-Filling AI Copilot Example](https://www.assistant-ui.com/examples/form-demo)
|
|
694
694
|
|
|
695
695
|
```
|
|
696
696
|
|
|
@@ -554,9 +554,9 @@ export default config;
|
|
|
554
554
|
"@assistant-ui/react-ai-sdk": "workspace:*",
|
|
555
555
|
"@assistant-ui/react-ink": "workspace:*",
|
|
556
556
|
"@assistant-ui/react-ink-markdown": "workspace:*",
|
|
557
|
-
"@wterm/dom": "^0.3.
|
|
558
|
-
"@wterm/react": "^0.3.
|
|
559
|
-
"ai": "^7.0.
|
|
557
|
+
"@wterm/dom": "^0.3.3",
|
|
558
|
+
"@wterm/react": "^0.3.3",
|
|
559
|
+
"ai": "^7.0.62",
|
|
560
560
|
"ink": "^7.1.1",
|
|
561
561
|
"ink-web": "^0.2.0",
|
|
562
562
|
"next": "^16.3.0",
|
|
@@ -566,7 +566,7 @@ export default config;
|
|
|
566
566
|
"scheduler": "^0.27.0"
|
|
567
567
|
},
|
|
568
568
|
"devDependencies": {
|
|
569
|
-
"@types/node": "^26.
|
|
569
|
+
"@types/node": "^26.2.0",
|
|
570
570
|
"@types/react": "^19.2.18",
|
|
571
571
|
"typescript": "^7.0.2"
|
|
572
572
|
}
|
|
@@ -520,7 +520,7 @@ export async function action({ request }: Route.ActionArgs) {
|
|
|
520
520
|
|
|
521
521
|
while (continueLoop) {
|
|
522
522
|
const response = await openai.chat.completions.create({
|
|
523
|
-
model: "gpt-5.
|
|
523
|
+
model: "gpt-5.6-luna",
|
|
524
524
|
messages: openaiMessages,
|
|
525
525
|
tools,
|
|
526
526
|
stream: true,
|
|
@@ -783,9 +783,9 @@ export default function Home() {
|
|
|
783
783
|
"@react-router/serve": "^8.3.0",
|
|
784
784
|
"class-variance-authority": "^0.7.1",
|
|
785
785
|
"clsx": "^2.1.1",
|
|
786
|
-
"eventsource-parser": "^
|
|
786
|
+
"eventsource-parser": "^4.0.0",
|
|
787
787
|
"isbot": "^5.2.1",
|
|
788
|
-
"lucide-react": "^1.
|
|
788
|
+
"lucide-react": "^1.31.0",
|
|
789
789
|
"openai": "^7.4.0",
|
|
790
790
|
"react": "^19.2.8",
|
|
791
791
|
"react-dom": "^19.2.8",
|
|
@@ -796,7 +796,7 @@ export default function Home() {
|
|
|
796
796
|
"devDependencies": {
|
|
797
797
|
"@react-router/dev": "^8.3.0",
|
|
798
798
|
"@tailwindcss/vite": "^4.3.3",
|
|
799
|
-
"@types/node": "^26.
|
|
799
|
+
"@types/node": "^26.2.0",
|
|
800
800
|
"@types/react": "^19.2.18",
|
|
801
801
|
"@types/react-dom": "^19.2.4",
|
|
802
802
|
"tailwindcss": "^4.3.3",
|
|
@@ -120,7 +120,7 @@ async function buildOpenAIBody({
|
|
|
120
120
|
}),
|
|
121
121
|
});
|
|
122
122
|
const result = streamText({
|
|
123
|
-
model: openai("gpt-5.
|
|
123
|
+
model: openai("gpt-5.6-luna"),
|
|
124
124
|
messages: await convertToModelMessages(messages),
|
|
125
125
|
...(system ? { system } : {}),
|
|
126
126
|
stopWhen: stepCountIs(10),
|
|
@@ -514,23 +514,23 @@ export default withAui(nextConfig);
|
|
|
514
514
|
"start": "next start"
|
|
515
515
|
},
|
|
516
516
|
"dependencies": {
|
|
517
|
-
"@ai-sdk/openai": "^4.0.
|
|
518
|
-
"@ai-sdk/react": "^4.0.
|
|
517
|
+
"@ai-sdk/openai": "^4.0.40",
|
|
518
|
+
"@ai-sdk/react": "^4.0.65",
|
|
519
519
|
"@assistant-ui/react": "workspace:*",
|
|
520
520
|
"@assistant-ui/react-ai-sdk": "workspace:*",
|
|
521
521
|
"@assistant-ui/react-markdown": "workspace:*",
|
|
522
522
|
"@assistant-ui/store": "workspace:*",
|
|
523
523
|
"@assistant-ui/tap": "workspace:*",
|
|
524
524
|
"@assistant-ui/ui": "workspace:*",
|
|
525
|
-
"ai": "^7.0.
|
|
525
|
+
"ai": "^7.0.62",
|
|
526
526
|
"assistant-stream": "workspace:*",
|
|
527
527
|
"class-variance-authority": "^0.7.1",
|
|
528
528
|
"clsx": "^2.1.1",
|
|
529
|
-
"lucide-react": "^1.
|
|
529
|
+
"lucide-react": "^1.31.0",
|
|
530
530
|
"next": "^16.3.0",
|
|
531
531
|
"react": "^19.2.8",
|
|
532
532
|
"react-dom": "^19.2.8",
|
|
533
|
-
"redis": "^6.2.
|
|
533
|
+
"redis": "^6.2.1",
|
|
534
534
|
"tailwind-merge": "^3.6.0",
|
|
535
535
|
"zod": "^4.4.3"
|
|
536
536
|
},
|
|
@@ -538,7 +538,7 @@ export default withAui(nextConfig);
|
|
|
538
538
|
"@assistant-ui/next": "workspace:*",
|
|
539
539
|
"@assistant-ui/x-buildutils": "workspace:*",
|
|
540
540
|
"@tailwindcss/postcss": "^4.3.3",
|
|
541
|
-
"@types/node": "^26.
|
|
541
|
+
"@types/node": "^26.2.0",
|
|
542
542
|
"@types/react": "^19.2.18",
|
|
543
543
|
"@types/react-dom": "^19.2.4",
|
|
544
544
|
"postcss": "^8.5.26",
|
|
@@ -509,7 +509,7 @@ export default withAui(nextConfig);
|
|
|
509
509
|
"@assistant-ui/next": "workspace:*",
|
|
510
510
|
"@assistant-ui/x-buildutils": "workspace:*",
|
|
511
511
|
"@tailwindcss/postcss": "^4.3.3",
|
|
512
|
-
"@types/node": "^26.
|
|
512
|
+
"@types/node": "^26.2.0",
|
|
513
513
|
"@types/react": "^19.2.18",
|
|
514
514
|
"@types/react-dom": "^19.2.4",
|
|
515
515
|
"postcss": "^8.5.26",
|