Skip to content

The open-source agent harness - the runtime layer that turns an LLM into a working agent.

UI sdk changes (#135)

qaifi-tf27f28cd2280c
diff --git a/docs/docs.json b/docs/docs.json
index 75f2f875a..0414b9c66 100644
--- a/docs/docs.json
+++ b/docs/docs.json
@@ -80,20 +80,24 @@
"groups": [
{
"group": "Get started",
- "pages": ["ui-sdk/index", "ui-sdk/get-started/installation", "ui-sdk/get-started/quickstart"]
- },
- {
- "group": "Concepts",
- "pages": ["ui-sdk/concepts/architecture", "ui-sdk/concepts/agent-modes", "ui-sdk/concepts/server-contract"]
+ "pages": ["ui-sdk/index", "ui-sdk/get-started/quickstart"]
},
{
"group": "Guides",
"pages": [
"ui-sdk/guides/layouts",
"ui-sdk/guides/theming",
+ "ui-sdk/guides/agent-modes",
"ui-sdk/guides/slot-overrides",
- "ui-sdk/guides/custom-server",
"ui-sdk/guides/mcp-oauth",
+ {
+ "group": "Setup Custom Server",
+ "pages": [
+ "ui-sdk/setup-different-servers/server-contract",
+ "ui-sdk/setup-different-servers/custom-server",
+ "ui-sdk/setup-different-servers/connect-with-truefoundry"
+ ]
+ },
"ui-sdk/guides/troubleshooting"
]
},
diff --git a/docs/images/landing-screen.png b/docs/images/landing-screen.png
new file mode 100644
index 000000000..8b3342c1a
Binary files /dev/null and b/docs/images/landing-screen.png differ
diff --git a/docs/ui-sdk/get-started/quickstart.mdx b/docs/ui-sdk/get-started/quickstart.mdx
index 0c62d9018..df1c3ece3 100644
--- a/docs/ui-sdk/get-started/quickstart.mdx
+++ b/docs/ui-sdk/get-started/quickstart.mdx
@@ -37,9 +37,10 @@ Typed for hosts adopting the harness adapter.
```
<Frame caption="What `TrueforgeUI` renders — a full agent chat with streaming, history, and tool calls.">
- ![The TrueforgeUI component rendering an agent chat with an agent-steps panel and a streamed response](/images/getting-started-chat.png)
+ ![The TrueforgeUI component rendering an agent chat with an agent-steps panel and a streamed response](/images/landing-screen.png)
</Frame>
+
## Troubleshooting
<AccordionGroup>
diff --git a/docs/ui-sdk/concepts/agent-modes.mdx b/docs/ui-sdk/guides/agent-modes.mdx
similarity index 100%
rename from docs/ui-sdk/concepts/agent-modes.mdx
rename to docs/ui-sdk/guides/agent-modes.mdx
index 8b583a6d2..dc3edd5bf 100644
--- a/docs/ui-sdk/concepts/agent-modes.mdx
+++ b/docs/ui-sdk/guides/agent-modes.mdx
@@ -57,8 +57,8 @@ The default is `{ mode: "AgentLibraryWithComposer" }`.
</Accordion>
</AccordionGroup>
-## Gotchas
+## Gotchas
<Warning>
`defaultAgentSpec` seeds a new draft rather than binding to the current one. Changing it does
not alter the conversation on screen, and it does not apply on **clear chat** either — that
diff --git a/docs/ui-sdk/index.mdx b/docs/ui-sdk/index.mdx
index 7abdb8613..482d9836d 100644
--- a/docs/ui-sdk/index.mdx
+++ b/docs/ui-sdk/index.mdx
@@ -5,38 +5,21 @@ description: "A themeable React SDK for building AI agent chat applications."
`@truefoundry/trueforge-ui` provides a production-ready agent chat experience as a single, reusable React component that can be integrated into an existing application.
-Features:
+Key Features:
-- Chat - Streaming responses, Session history, Tool calls and approval workflows, File attachments
-- Agents - Agent library with compose new agent option, Sub-agents
-- Reasoning traces
-- Model, MCP, Skill and Sandbox connector
-- Configurable server - TrueForge, TrueFoundry or fully custom
+- **Agent Modes** - Chat with a single agent, browse an agent library, or allow users to create and compose new agents.
+- **Chat** - Supports streaming responses, session history, tool calls with approval workflows, and file attachments.
+- **Themes** - Includes built-in themes for Claude, ChatGPT, Gemini, and TrueFoundry, with support for creating custom themes.
+- **Layouts** - Supports full-screen layouts with a sidebar or drawer, as well as embedded layouts with side-docked or floating widgets.
+- **Integration Settings** - Configure models, MCP servers, skills, and sandbox environments.
+- **Server Configuration** - Choose between TrueForge, a fully custom server, or TrueFoundry.
-The component is built on assistant-ui and follows shadcn/ui conventions. This allows you to customize the branding, layout, and individual UI components while retaining full control over the application’s look and feel
+<br />
<Frame caption="A TrueForge UI chat session — streaming response, agent steps, and tool calls.">
![The TrueForge UI SDK rendering an agent chat with an expandable agent-steps panel and a streamed response](/images/hero.png)
</Frame>
-<CardGroup cols={2}>
- <Card title="Installation" icon="download" href="/ui-sdk/get-started/installation">
- Install the package, wire up the stylesheet, and satisfy the peer dependencies.
- </Card>
-
- <Card title="Quickstart" icon="rocket" href="/ui-sdk/get-started/quickstart">
- A working chat UI in about fifteen lines of JSX.
- </Card>
-
- <Card title="Architecture" icon="layer-group" href="/ui-sdk/concepts/architecture">
- How atoms, containers, layouts, and slots fit together.
- </Card>
-
- <Card title="API reference" icon="code" href="/ui-sdk/reference/trueforge-ui">
- Every export, prop, and type.
- </Card>
-</CardGroup>
-
## Interactive Controls & Code Examples
The hosted webapp provides an interactive interface for exploring and configuring all available controls and properties.
diff --git a/docs/ui-sdk/guides/setup-different-servers/connect-with-true-foundry.mdx b/docs/ui-sdk/setup-different-servers/connect-with-truefoundry.mdx
similarity index 100%
rename from docs/ui-sdk/guides/setup-different-servers/connect-with-true-foundry.mdx
rename to docs/ui-sdk/setup-different-servers/connect-with-truefoundry.mdx