Skip to content

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

Updated mintlify pages (#170)

qaifi-tfaf151bd08467
diff --git a/docs/images/agent-composer-with-library.png b/docs/images/agent-composer-with-library.png
new file mode 100644
index 000000000..f970240fc
Binary files /dev/null and b/docs/images/agent-composer-with-library.png differ
diff --git a/docs/images/agent-composer.png b/docs/images/agent-composer.png
new file mode 100644
index 000000000..144a16e08
Binary files /dev/null and b/docs/images/agent-composer.png differ
diff --git a/docs/images/agent-library-with-composer.png b/docs/images/agent-library-with-composer.png
new file mode 100644
index 000000000..e69de29bb
diff --git a/docs/images/agent-library.png b/docs/images/agent-library.png
new file mode 100644
index 000000000..6249f515c
Binary files /dev/null and b/docs/images/agent-library.png differ
diff --git a/docs/images/single-agent.png b/docs/images/single-agent.png
new file mode 100644
index 000000000..e69de29bb
diff --git a/docs/ui-sdk/get-started/quickstart.mdx b/docs/ui-sdk/get-started/quickstart.mdx
index a98825a27..ebaa82759 100644
--- a/docs/ui-sdk/get-started/quickstart.mdx
+++ b/docs/ui-sdk/get-started/quickstart.mdx
@@ -31,34 +31,13 @@ Typed for hosts adopting the harness adapter.
<TrueforgeUI
server={{
type: "trueforge",
- apiKey: {{API_KEY}},
+ baseUrl: 'http://localhost:8790'
}}
- layout="sidebar"
/>
```
## Rendered UI
<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/landing-screen.png)
-</Frame>
-
-## Where to go next
-
-<CardGroup cols={2}>
- <Card title="Pick a layout" icon="table-columns" href="/ui-sdk/guides/layouts">
- Sidebar, drawer, dock, widget, or a layout you write yourself.
- </Card>
-
- <Card title="Match your brand" icon="palette" href="/ui-sdk/guides/theming">
- Presets, semantic tokens, logo, and dark mode.
- </Card>
-
- <Card title="Swap components" icon="puzzle-piece" href="/ui-sdk/guides/slot-overrides">
- Replace any built-in component via `overrides`.
- </Card>
-
- <Card title="Server contract" icon="server" href="/ui-sdk/concepts/server-contract">
- Every interface a backend must satisfy.
- </Card>
-</CardGroup>
\ No newline at end of file
+ ![The TrueforgeUI component rendering an agent chat with an agent-steps panel and a streamed response](/images/agent-composer-with-library.png)
+</Frame>
\ No newline at end of file
diff --git a/docs/ui-sdk/guides/agent-modes.mdx b/docs/ui-sdk/guides/agent-modes.mdx
index dc3edd5bf..a9cdfdb30 100644
--- a/docs/ui-sdk/guides/agent-modes.mdx
+++ b/docs/ui-sdk/guides/agent-modes.mdx
@@ -3,7 +3,7 @@ title: "Agent modes"
description: "Choose between a fixed agent, a library, a composer, or both."
---
-`agentConfig` decides which agent-selection affordances the shell exposes.
+This can be configured by using the `agentConfig` object.
```ts
type AgentConfig =
@@ -20,62 +20,54 @@ The default is `{ mode: "AgentLibraryWithComposer" }`.
| `SingleAgent` | — | — | yes |
| `AgentLibrary` | yes | — | no |
| `AgentComposer` | — | yes | yes |
-| `AgentLibraryWithComposer` | yes | yes | yes |
+| `AgentLibraryWithComposer (Default)` | yes | yes | yes |
+
+## Single Agent
+
+Pins the UI to one named agent. All selection controls are hidden and the user cannot switch agents or open the composer.
+
+<Frame>
+ ![Single Agent](/images/single-agent.png "Single Agent")
+</Frame>
<AccordionGroup>
<Accordion title="SingleAgent">
- Pins the UI to one named agent. All selection controls are hidden and the user cannot
- switch agents or open the composer.
+ Pins the UI to one named agent. All selection controls are hidden and the user cannot switch agents or open the composer.
</Accordion>
+
<Accordion title="AgentLibrary">
- Users pick from agents your `searchAgents` implementation returns, but cannot author a
- new one. Note that "new chat" is disabled in this mode only.
+ Users pick from agents your `searchAgents` implementation returns, but cannot author a new one. Note that "new chat" is disabled in this mode only.
<Frame caption="The Agents Library: users pick from the agents your `searchAgents` returns.">
- <img src="/images/agent-registry.png" alt="The Agents Library dialog listing saved agents to choose from" />
+ ![The Agents Library dialog listing saved agents to choose from](/images/agent-registry.png)
</Frame>
</Accordion>
+
<Accordion title="AgentComposer">
- Users assemble an ad-hoc agent — model, skills, MCP servers — without browsing a
- library, and can save it back to the library.
+ Users assemble an ad-hoc agent — model, skills, MCP servers — without browsing a library, and can save it back to the library.
<Frame caption="Composing an agent — pick a model, add connectors and skills, then save it to the library.">
<div style={{ position: "relative", boxSizing: "content-box", width: "100%", aspectRatio: "1.46", padding: "40px 0" }}>
- <iframe
- src="https://app.supademo.com/embed/cmsk13xio00k81p0j1wj6amj6?embed_v=2&utm_source=embed"
- loading="lazy"
- title="Compose an agent in TrueForge"
- allow="clipboard-write"
- allowFullScreen
- style={{ position: "absolute", top: 0, left: 0, width: "100%", height: "100%", border: 0 }}
- />
- </div>
+ <iframe src="https://app.supademo.com/embed/cmsk13xio00k81p0j1wj6amj6?embed_v=2&utm_source=embed" loading="lazy" title="Compose an agent in TrueForge" allow="clipboard-write" allowFullScreen style={{ position: "absolute", top: 0, left: 0, width: "100%", height: "100%", border: 0 }} />
+</div>
</Frame>
</Accordion>
+
<Accordion title="AgentLibraryWithComposer">
Both surfaces, and the default. Users can pick an existing agent or author a new one.
</Accordion>
</AccordionGroup>
-
## 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
- path deliberately preserves the spec already bound to the draft. The new value is picked up
- when a **new chat** starts. To apply it immediately, remount the component with a new `key`.
- It is ignored entirely in `SingleAgent` mode.
+ `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 path deliberately preserves the spec already bound to the draft. The new value is picked up when a **new chat** starts. To apply it immediately, remount the component with a new `key`. It is ignored entirely in `SingleAgent` mode.
</Warning>
<Warning>
- Always pass an explicit `defaultAgentSpec` in composer modes. Omitting it falls back to
- `{ model: { name: "openai-main/gpt-4.1" } }`, and requests fail if your backend does not
- expose a model under that exact name.
+ Always pass an explicit `defaultAgentSpec` in composer modes. Omitting it falls back to `{ model: { name: "openai-main/gpt-4.1" } }`, and requests fail if your backend does not expose a model under that exact name.
</Warning>
## Settings
-The settings panel appears only when your server exposes a `catalog`. Without one it is
-silently absent — there is no error, so an unexpectedly missing settings button usually means
-the catalog is not attached. Note that `useCatalogServer()` throws when there is no catalog;
-use `useOptionalCatalogServer()` in code that must tolerate its absence.
+The settings panel appears only when your server exposes a `catalog`. Without one it is silently absent — there is no error, so an unexpectedly missing settings button usually means the catalog is not attached. Note that `useCatalogServer()` throws when there is no catalog; use `useOptionalCatalogServer()` in code that must tolerate its absence.
\ No newline at end of file