- MCP Server ToolsUpdated
- Managed MCP with chat()Updated
- Manual MCPUpdated
- MCP Type GenerationUpdated
- MCP Client InputUpdated
- MCP Server Tools: AdvancedNew
- MCP EventsNew
- MCP AppsUpdated
- Serve Tools over HTTPUpdated
- Serve Resources and PromptsUpdated
- Ask for InputUpdated
- Draft Text from a ToolUpdated
- MCP Server TasksUpdated
- MCP Server AuthUpdated
- MCP Server SessionsUpdated
- MCP Server on stdioUpdated
Persistence (Advanced)
- GenerationsUpdated
- Realtime Voice ChatUpdated
- Text-to-SpeechUpdated
- TranscriptionUpdated
- Transcription: AdvancedNew
- Voice CreationUpdated
- Audio RecordingUpdated
- Audio GenerationUpdated
- Image GenerationUpdated
- Image Generation: AdvancedNew
- Video GenerationUpdated
- Video Generation: AdvancedNew
- Live GenerationUpdated
- World GenerationUpdated
- Generation HooksUpdated
- Build your first harnessUpdated
- Host optionsNew
- Send and show mediaUpdated
- Connect clientsUpdated
- Write a client in any languageNew
- Access and tenantsNew
- Run in the terminalUpdated
- Deploy a harnessUpdated
- Send inputs safelyUpdated
- Run a tool without a model
- Durable sessionsUpdated
- Run background work on workersNew
- List, rename, and fork sessionsUpdated
- Lifecycle and retentionNew
- Run side effects onceUpdated
- Wait for a personNew
- Build on the session logUpdated
- Control how a turn endsUpdated
- Store settings per threadUpdated
- Compact a long sessionUpdated
- Fork and reset a threadUpdated
- One log for a session treeUpdated
- Write a pluginUpdated
- Track usage and costUpdated
- Ask before risky tool callsUpdated
- Give your agent coding toolsUpdated
- Sandbox and extend the coding toolsUpdated
- Run the coding tools for many threadsNew
- Undo a turnUpdated
- Build a coding agentUpdated
- Delegate to coding agentsUpdated
- Switch between agent profilesUpdated
- Auth and connectorsUpdated
- Share a thread between peopleUpdated
- Connect model providersUpdated
- Build your own UIUpdated
- Code mode in a harnessUpdated
- Work until a goal is metUpdated
- Run agents from a harnessUpdated
- Hand off a conversationNew
- Add skillsUpdated
- Use MCP serversUpdated
- Give your agent a computerNew
- Use from any MCP clientUpdated
- Use a harness from an editor (ACP)Updated
- OverviewUpdated
- Quick StartUpdated
- ProvidersUpdated
- HarnessesUpdated
- Harness AuthUpdated
- WorkspaceUpdated
- ToolsUpdated
- PolicyUpdated
- Lifecycle & SnapshotsUpdated
- Portable SnapshotsUpdated
- Keep Files After ReloadUpdated
- Save a Named VersionUpdated
- Branch From a VersionUpdated
- Send a Frozen FileUpdated
- Let the Agent Save and ForkUpdated
- Pick Which Files to KeepUpdated
- What a Snapshot StoresUpdated
- Instance DurabilityUpdated
- Durable RunsUpdated
- EventsUpdated
Sandboxes (Advanced)
- Runtime ContextUpdated
- Bring Your Own KeyUpdated
- Keep Keys on the ServerUpdated
- Debug LoggingUpdated
- Multimodal ContentUpdated
- Files APIUpdated
- Per-Model Type SafetyUpdated
- Runtime Adapter SwitchingUpdated
- Tree-ShakingUpdated
- Extend AdapterUpdated
- Extend Adapter: AdvancedNew
- Typed Pre-Configured OptionsUpdated
- Test with a Fake ModelUpdated
- Prompt CachingUpdated
- Mid-Conversation ChangesUpdated
- Approval Flow ProcessingUpdated
Showing Code Mode in the UI
Stream Code Mode events to the client so the UI shows each sandbox step. The user then sees the run before the final answer.
Code Mode sends custom events while it runs. Catch them with onCustomEvent in useChat, and show the code, each tool call, and the result in the chat.
Quick setup#
You need the Code Mode route from the Code Mode quick setup. Then replace your chat component with this one:
import { useState } from "react";
import { parsePartialJSON } from "@tanstack/ai";
import { useChat, fetchServerSentEvents } from "@tanstack/ai-react";
interface CodeModeEvent {
eventType: string;
data: unknown;
}
function isRecord(value: unknown): value is Record<string, unknown> {
return typeof value === "object" && value !== null;
}
export function CodeModeChat() {
const [input, setInput] = useState("");
const [events, setEvents] = useState<Record<string, Array<CodeModeEvent>>>(
{},
);
const { messages, sendMessage, isLoading } = useChat({
connection: fetchServerSentEvents("/api/chat"),
threadId: "support-chat",
// Keep each event under the execute_typescript call that sent it.
onCustomEvent: (eventType, data, { toolCallId }) => {
if (!toolCallId) return;
setEvents((prev) => ({
...prev,
[toolCallId]: [...(prev[toolCallId] ?? []), { eventType, data }],
}));
},
});
return (
<>
{messages.map((message) => (
<div key={message.id}>
{message.parts.map((part, index) => {
if (part.type === "text") {
return <p key={index}>{part.content}</p>;
}
if (
part.type === "tool-call" &&
part.name === "execute_typescript"
) {
return (
<CodeExecutionPanel
key={part.id}
args={part.arguments}
output={part.output}
events={events[part.id] ?? []}
/>
);
}
return null;
})}
</div>
))}
<form
onSubmit={(event) => {
event.preventDefault();
if (input.trim() === "") return;
sendMessage(input);
setInput("");
}}
>
<input value={input} onChange={(event) => setInput(event.target.value)} />
<button type="submit" disabled={isLoading}>
Send
</button>
</form>
</>
);
}
function CodeExecutionPanel({
args,
output,
events,
}: {
args: string;
output: unknown;
events: Array<CodeModeEvent>;
}) {
// The arguments stream in as partial JSON, so the code shows while the model writes it.
const parsed: unknown = parsePartialJSON(args);
const code =
isRecord(parsed) && typeof parsed.typescriptCode === "string"
? parsed.typescriptCode
: "";
return (
<div>
<details open>
<summary>TypeScript code</summary>
<pre>
<code>{code}</code>
</pre>
</details>
<ul>
{events.map((event, index) => (
<li key={index}>{describeEvent(event)}</li>
))}
</ul>
<pre>{describeResult(output)}</pre>
</div>
);
}
function describeEvent({ eventType, data }: CodeModeEvent): string {
if (!isRecord(data)) return eventType;
switch (eventType) {
case "code_mode:execution_started":
return "Started";
case "code_mode:console":
return `[${String(data.level)}] ${String(data.message)}`;
case "code_mode:external_call":
return `Call ${String(data.function)}(${JSON.stringify(data.args)})`;
case "code_mode:external_result":
return `Done ${String(data.function)} in ${String(data.duration)} ms`;
case "code_mode:external_error":
return `Failed ${String(data.function)}: ${String(data.error)}`;
case "code_mode:execution_finished":
return `Finished in ${String(data.durationMs)} ms`;
default:
return eventType;
}
}
function describeResult(output: unknown): string {
if (output === undefined) return "Running...";
if (!isRecord(output)) return JSON.stringify(output, null, 2);
if (output.success === false) {
const message = isRecord(output.error) ? output.error.message : undefined;
return `Error: ${String(message ?? "unknown error")}`;
}
return JSON.stringify(output.result, null, 2);
}Send "Compare the weather in Tokyo, Paris, and New York City." The chat now shows the code that the model wrote, one line for each external_fetchWeather call, and the final result.
How it works#
- Code Mode sends custom events through the chat stream, next to the normal text and tool-call chunks.
- onCustomEvent gets three arguments: the event type, the payload, and a context with the toolCallId.
- The toolCallId is the id of the execute_typescript tool-call part. Use it to show each event under the right call.
- When the execution ends, part.output holds the result: success, result, logs, and error.
For the full list of events and their payloads, see Custom events.
Other frameworks#
onCustomEvent comes from ChatClient in @tanstack/ai-client, which every framework package uses. Pass it in the same way:
- React, Preact, Solid, Vue: useChat({ onCustomEvent }).
- Svelte: createChat({ onCustomEvent }).
- Angular: injectChat({ onCustomEvent }).
The callback has the same signature everywhere:
(eventType: string, data: unknown, context: { toolCallId?: string }) => void