The open-source agent harness - the runtime layer that turns an LLM into a working agent.
docs: new web-research quickstart example + refreshed screenshots (#263)
shubhamagarwal-createf5ca6a599c5f
diff --git a/README.md b/README.mdindex 773ed69a0..be726d18f 100644--- a/README.md+++ b/README.md@@ -106,25 +106,33 @@ See the [chart README](charts/trueforge/README.md) (including [`configs.oidc`](c## Build your first agent-Full walkthrough: [Quickstart](https://trueforge.dev/quickstart).+Full walkthrough: [Quickstart](https://trueforge.dev/quickstart). The example below builds a **web research briefer** — it searches the web, fans out to parallel subagents, and renders an interactive brief.-1. **Setup models** - **Settings → Models**, pick a catalog provider, paste your API key.+1. **Add a model provider** - **Settings → Models**, pick a provider, paste your API key.-2. **Setup connectors & skills** (optional) - **Settings → Connectors** / **Skills**. Skills need a sandbox.+2. **Connect a web-search tool** - **Settings → Connectors**, connect **Exa** (no auth). Then under **Settings → Skills**, enable **web-artifacts-builder** (skills run in a sandbox).- + -3. **Setup sandbox** (optional) - **Settings → Sandbox providers**. Daytona is the only provider supported today.+3. **Add a sandbox** - **Settings → Sandbox providers**, configure **Daytona** (the provider supported today).- + -4. **Create an agent** - pick a model, attach connectors/skills, write instructions, then **Save as agent**.+4. **Compose and run** - pick a model, enable Exa and web-artifacts-builder, then send a prompt:- + > Research the current state of open-source vector databases. Compare Qdrant, Weaviate, and Milvus on performance, features, and licensing, then write a one-page brief with sources.-5. **Find it in the Agent Library** - open **Agents Library**, then **Try** or **Edit**. In hosted mode with login enabled, agents created by anyone are visible to everyone - see [Agent Library](https://trueforge.dev/agent-library).+ The agent searches with Exa, delegates to parallel subagents, and renders an interactive brief.++ ++5. **Save as an agent** - click **Save Agent** and name it `web-research-brief`.++ ++6. **Find it in the Agent Library** - open **Agents Library**, then **Try** or **Edit**. In hosted mode with login enabled, agents created by anyone are visible to everyone - see [Agent Library](https://trueforge.dev/agent-library).diff --git a/docs/images/quickstart-agents-library.png b/docs/images/quickstart-agents-library.pngindex 353f9cf1c..be33b11aa 100644Binary files a/docs/images/quickstart-agents-library.png and b/docs/images/quickstart-agents-library.png differdiff --git a/docs/images/quickstart-chat-result.png b/docs/images/quickstart-chat-result.pngindex 9af8f276c..5eddcecfd 100644Binary files a/docs/images/quickstart-chat-result.png and b/docs/images/quickstart-chat-result.png differdiff --git a/docs/images/quickstart-compose-capabilities.png b/docs/images/quickstart-compose-capabilities.pngnew file mode 100644index 000000000..0e7f84204Binary files /dev/null and b/docs/images/quickstart-compose-capabilities.png differdiff --git a/docs/images/quickstart-compose-connectors.png b/docs/images/quickstart-compose-connectors.pngnew file mode 100644index 000000000..4b0baece8Binary files /dev/null and b/docs/images/quickstart-compose-connectors.png differdiff --git a/docs/images/quickstart-compose-skills.png b/docs/images/quickstart-compose-skills.pngnew file mode 100644index 000000000..92244a950Binary files /dev/null and b/docs/images/quickstart-compose-skills.png differdiff --git a/docs/images/quickstart-connectors.png b/docs/images/quickstart-connectors.pngindex 074c21b37..8abd5378d 100644Binary files a/docs/images/quickstart-connectors.png and b/docs/images/quickstart-connectors.png differdiff --git a/docs/images/quickstart-model-configure.png b/docs/images/quickstart-model-configure.pngnew file mode 100644index 000000000..4dc21a74fBinary files /dev/null and b/docs/images/quickstart-model-configure.png differdiff --git a/docs/images/quickstart-models.png b/docs/images/quickstart-models.pngindex 694778a4f..daa4cdc6e 100644Binary files a/docs/images/quickstart-models.png and b/docs/images/quickstart-models.png differdiff --git a/docs/images/quickstart-sandbox-configure.png b/docs/images/quickstart-sandbox-configure.pngnew file mode 100644index 000000000..a609a7b6bBinary files /dev/null and b/docs/images/quickstart-sandbox-configure.png differdiff --git a/docs/images/quickstart-sandbox-connected.png b/docs/images/quickstart-sandbox-connected.pngnew file mode 100644index 000000000..0f7b714f6Binary files /dev/null and b/docs/images/quickstart-sandbox-connected.png differdiff --git a/docs/images/quickstart-sandbox.png b/docs/images/quickstart-sandbox.pngdeleted file mode 100644index 20aff3a7b..000000000Binary files a/docs/images/quickstart-sandbox.png and /dev/null differdiff --git a/docs/images/quickstart-save-agent.png b/docs/images/quickstart-save-agent.pngindex 5f0823093..cb0d6c5cd 100644Binary files a/docs/images/quickstart-save-agent.png and b/docs/images/quickstart-save-agent.png differdiff --git a/docs/images/quickstart-skill-1.png b/docs/images/quickstart-skill-1.pngdeleted file mode 100644index 0a285633a..000000000Binary files a/docs/images/quickstart-skill-1.png and /dev/null differdiff --git a/docs/images/quickstart-skill.png b/docs/images/quickstart-skill.pngnew file mode 100644index 000000000..fe75eb7e4Binary files /dev/null and b/docs/images/quickstart-skill.png differdiff --git a/docs/quickstart.mdx b/docs/quickstart.mdxindex f47db4b9e..617345a11 100644--- a/docs/quickstart.mdx+++ b/docs/quickstart.mdx@@ -64,89 +64,104 @@ TrueForge runs in [two modes](/introduction#two-ways-to-run-it): **local mode**## Build your first agent-With TrueForge open in your browser, this walkthrough takes you from an empty workspace to a saved, reusable agent. The example builds a **GitHub repo explainer** — an agent that turns any public repo into a one-page PDF brief.+With TrueForge open in your browser, this walkthrough takes you from an empty workspace to a saved, reusable agent. The example builds a **web research briefer** — an agent that searches the web, fans out to parallel subagents, and turns its findings into an interactive one-page brief.<Steps><Step title="Add a model provider">- Open **Settings → Models**, pick a provider from the catalog, and paste your API key. Its models become available immediately.-- <Frame>- <img src="/images/quickstart-models.png" alt="Settings → Models with the OpenAI provider expanded, showing an API key field and a Create button" />- </Frame>+ Open **Settings → Models**, find a provider in the catalog, and click **Configure**. Paste your API key in **Configure Provider Details** and click **Create** — the provider's models become available immediately.++ <Columns cols={2}>+ <Frame caption="Pick a provider from the catalog.">+ + </Frame>+ <Frame caption="Paste an API key and click Create.">+ + </Frame>+ </Columns></Step>- <Step title="Connect a tool">- Open **Settings → Connectors** and add a [Model Context Protocol (MCP)](/mcp-servers) server — this is how your agent reaches external tools and data. TrueForge ships a catalog you can connect in one click (some use OAuth, some an API key, some need no auth), and you can register your own server by URL with **Add MCP Server**.+ <Step title="Connect a web-search tool">+ Open **Settings → Connectors** and add a [Model Context Protocol (MCP)](/mcp-servers) server — this is how your agent reaches external tools and data. TrueForge ships a catalog you can connect in one click; each entry shows its auth type (OAuth, an API key, or none), and you can register your own server by URL with **Add MCP Server**.- For this walkthrough, connect **DeepWiki** — it needs no authentication and lets the agent read and answer questions about any public GitHub repo. Find it in the catalog and click **Connect**.+ For this walkthrough, connect **Exa** — a web-search server that needs no authentication. Find it in the catalog and click **Connect**; it moves to **Configured**.<Frame>- <img src="/images/quickstart-connectors.png" alt="Settings → Connectors with DeepWiki connected, above a catalog of more MCP servers" />+ </Frame></Step><Step title="Add a skill">Open **Settings → Skills**. A [skill](/skills) is a git-backed `SKILL.md` instruction pack the agent loads on demand. Enable one from the built-in list, or click **Import from GitHub** to add a skill from any public repository.- For this walkthrough, import the **pdf** skill so the agent can turn its findings into a PDF. Click **Import from GitHub** and fill in:+ For this walkthrough, enable **web-artifacts-builder** from the built-in list — it lets the agent turn its findings into a self-contained, interactive web page. Click **Enable**; it moves to **Enabled**.- - **Name** — `pdf`- - **Description** — `Use this skill whenever the user wants to do anything with PDF files`- - **Repository URL** — `https://github.com/anthropics/skills`- - **Path** — `skills/pdf`- - **Ref** — `main`-- Click **Import**; the skill moves to **Selected**.-- <Frame caption="Import from GitHub — point TrueForge at a SKILL.md in any public repo.">- <img src="/images/quickstart-skill-1.png" alt="The Import from GitHub dialog filled in for the pdf skill" />+ <Frame>+ </Frame></Step>- <Step title="Add a sandbox provider (optional)">- A [sandbox](/sandbox) lets the agent run code, work with files, and use skills. TrueForge supports [Daytona](https://www.daytona.io) today. It's a one-time setup:+ <Step title="Add a sandbox provider">+ A [sandbox](/sandbox) lets the agent run code, work with files, and use skills — so it's required for the skill you just enabled. TrueForge supports [Daytona](https://www.daytona.io) today. It's a one-time setup:1. **Create a Daytona API key** with permission to write and delete snapshots and write sandboxes.- 2. **Add the provider** under **Settings → Sandbox providers** — choose Daytona and enter your API key.+ 2. Open **Settings → Sandbox providers**, choose **Daytona**, click **Configure**, paste your API key, and click **Save**.- <Frame>- <img src="/images/quickstart-sandbox.png" alt="The Configure Daytona dialog: snapshot name, API key, and a collapsed Advanced settings section" />- </Frame>+ <Columns cols={2}>+ <Frame caption="Paste your Daytona API key.">+ + </Frame>+ <Frame caption="Connected and ready.">+ + </Frame>+ </Columns>See the [Sandbox guide](/sandbox) for provider setup details.</Step><Step title="Compose an agent and start chatting">- Back in the chat, assemble the agent for this conversation, then send your first message.-- 1. **Pick a model** from the selector in the composer.- 2. Open the **+** menu → **Connectors** and enable the MCP server you connected.- 3. In the same menu → **Skills**, enable your skill.- 4. **Send your first message.**-- For example, paste this to try the GitHub repo explainer:+ Back in the chat, assemble the agent for this conversation. Pick a model from the selector in the composer, then open the **Tools** menu and set three things:++ - **Connectors** — enable **Exa**.+ - **Skills** — enable **web-artifacts-builder**.+ - **Capabilities** — leave **Dynamic sub-agents** on (it's the default). This lets the agent research each item in parallel instead of one at a time.++ <Columns cols={3}>+ <Frame caption="Connectors">+ + </Frame>+ <Frame caption="Skills">+ + </Frame>+ <Frame caption="Capabilities">+ + </Frame>+ </Columns>++ Then send your first message. For example:```text- Use DeepWiki to explain the truefoundry/models repository — what it does, its architecture, and how to get started. Then use the pdf skill to save a one-page brief as a PDF.+ Research the current state of open-source vector databases. Compare Qdrant, Weaviate, and Milvus on performance, features, and licensing, then write a one-page brief with sources.```- <Frame caption="The agent runs — here it used the connector, the sandbox, and the pdf skill to generate a one-page brief.">- <img src="/images/quickstart-chat-result.png" alt="A completed chat where the agent generated a one-page PDF brief, with one connector and one skill active" />+ The agent searches with Exa, delegates each database to a parallel subagent, and uses **web-artifacts-builder** in the sandbox to render an interactive brief.++ <Frame caption="The result — an interactive brief the agent built from its web research: a comparison, feature chips, and a strengths chart.">+ </Frame></Step><Step title="Save it as an agent">- Happy with the setup? Click **Save as agent**, enter a name and system instructions, and click **Save** — this captures the model, connectors, skills, and prompt together as a reusable agent. For this example:+ Happy with the setup? Click **Save Agent**, then in **Save agent** give it a name and instructions and click **Save changes** — this captures the model, connectors, skills, and prompt together as a reusable agent. For this example:- - **Name** — `github-repo-explainer`- - **System instructions** —+ - **Name** — `web-research-brief`+ - **Instructions** —```text- You are a GitHub repo explainer. Given a public repository, use DeepWiki to understand what it does and how it's structured, then produce a clear one-page PDF brief covering its purpose, architecture, and how to run it.+ You are a web research assistant. Given a topic or question, use Exa to search the web and pull content from the most relevant, recent sources. When the request compares several items, research each one in parallel, then synthesize the findings into a clear one-page brief.```<Frame>- <img src="/images/quickstart-save-agent.png" alt="The Save as agent dialog with a name and system instructions" />+ </Frame></Step>@@ -154,7 +169,7 @@ With TrueForge open in your browser, this walkthrough takes you from an empty woOpen **Agents Library** from the sidebar. Your saved agent is there — click **Try** to start a fresh chat with the same setup, or **Edit** to tweak it. See [Agent Library](/agent-library) for shared-visibility notes in hosted mode.<Frame>- <img src="/images/quickstart-agents-library.png" alt="The Agents Library listing the saved github-repo-explainer agent with Edit and Try actions" />+ </Frame></Step></Steps>