Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions openhands/usage/agent-canvas/conversations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

## Child Conversations

When an agent uses `launch_child_conversation`, Agent Canvas can launch a child conversation on a local or Cloud target. Local children can use either an isolated worktree or the parent's shared workspace. Cloud children use the repository and branch selected for the launch.

Check warning on line 10 in openhands/usage/agent-canvas/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/conversations.mdx#L10

Did you really mean 'worktree'?

The child remains linked to its parent, and its result is returned to the parent conversation. Agent Canvas validates the launch inputs before creating the child conversation.

Expand All @@ -15,7 +15,7 @@

Use the conversation list controls to manage automation runs and visible tags:

- Choose `All`, `Hide`, or `Only` to include, exclude, or show only automation-run conversations. You can further select individual automation names, including unnamed automations.

Check warning on line 18 in openhands/usage/agent-canvas/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/conversations.mdx#L18

Did you really mean 'automations'?
- Pinned conversations remain visible when automation-run filtering would otherwise hide them.
- Enable the `Tags` preference to show conversation tag chips. Tags are off by default; when there are more tags than fit, Agent Canvas shows a `+N` chip with the remaining count.

Expand All @@ -31,8 +31,33 @@

## Inline Markdown Artifact Previews

When an agent creates a Markdown file, Agent Canvas renders it inline as a height-limited rich preview with an internal scrollbar instead of showing only the raw file content. Select `View` to open the full file in the Files drawer.

Check warning on line 34 in openhands/usage/agent-canvas/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/conversations.mdx#L34

Did you really mean 'scrollbar'?

## Conversation Overview Panel

The conversation overview panel displays project context for the active conversation, including workspace information, git state, and loaded resources such as skills, MCP servers, and automations.

Check warning on line 38 in openhands/usage/agent-canvas/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/conversations.mdx#L38

Did you really mean 'automations'?

Toggle the overview using the info control in the conversation header. The panel peeks beside the chat area and closes when you open the Files drawer.

### Unified Commits Drawer

From the overview panel, open the **Commits** drawer to see a unified view of git activity:

- The commit list shows recent commits alongside any uncommitted changes
- A header git-actions control lets you send commit, pull, push, and pull-request prompts to the agent

The Commits tab combines the commit history with uncommitted changes in a single view, so you no longer need to switch between separate Diff and Commits surfaces.

### Files View

The **Files** tab is a focused file browser with open-file tabs and close controls. The file tree is resizable and persists its state across refreshes.

Check warning on line 53 in openhands/usage/agent-canvas/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/conversations.mdx#L53

Did you really mean 'resizable'?

Above the file tree, the active workspace path is displayed with a copy button. Hover the truncated path to see the full value in a tooltip, then click to copy it.

Check warning on line 55 in openhands/usage/agent-canvas/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/conversations.mdx#L55

Did you really mean 'tooltip'?

<Note>
The workspace path row is hidden when the conversation has no working directory.
</Note>

## Context Window Usage and Manual Compaction

Agent Canvas shows a context-window meter in the composer that visualizes how much of the model's available context is in use. The meter fills as the conversation grows.
Expand Down Expand Up @@ -159,7 +184,7 @@

## Archive a Conversation

Archiving a conversation hides it from the sidebar list without deleting it. The conversation's full history stays on the backend, and you can unarchive it at any time.

Check warning on line 187 in openhands/usage/agent-canvas/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/conversations.mdx#L187

Did you really mean 'unarchive'?

**To archive a conversation:**

Expand Down
2 changes: 1 addition & 1 deletion openhands/usage/agent-canvas/customize-and-settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ The `Settings` area currently includes the following sections:
| Section | Purpose |
|---------|---------|
| `Agent` | Agent Profile library and agent-specific capabilities |
| `LLM` | Provider, model, API key, and profile configuration |
| `LLM` | Provider, model, API key, profile configuration, and provider connections |
| `Condenser` | Context compression and summarization behavior |
| `Verification` | Approval, critic evaluation, and verification-related behavior |
| `Application` | UI-level preferences and app behavior |
Expand Down
17 changes: 17 additions & 0 deletions openhands/usage/agent-canvas/first-time-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
Agent Canvas uses the **Agent-Client Protocol (ACP)** to communicate with agents, which means you're not locked into a single provider.

- **OpenHands** (selected by default) — the general-purpose OpenHands agent, best for coding and exploration.
- **Claude Code** — Anthropic's Claude Code agent.

Check warning on line 15 in openhands/usage/agent-canvas/first-time-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/first-time-setup.mdx#L15

Did you really mean 'Anthropic's'?
- **Codex** — OpenAI's Codex agent.
- **Gemini CLI** — Google's Gemini CLI agent.

Expand Down Expand Up @@ -68,8 +68,25 @@
- **GitHub Repository Monitor** — watch a repository for `@OpenHands` mentions and respond automatically.
- **Slack Standup Digest** — summarize yesterday's Slack activity into an async standup note.

You can browse all pre-built automations from the `Automate` view at any time. See [Pre-built Automations](/openhands/usage/agent-canvas/prebuilt-automations) for the full list.

Check warning on line 71 in openhands/usage/agent-canvas/first-time-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/first-time-setup.mdx#L71

Did you really mean 'automations'?

## Getting Started Checklist

After completing the setup wizard, a **Getting Started** checklist appears in the sidebar. It guides you through the core first actions:

1. **Set up your LLM** — links to `Settings > LLM`
2. **Connect MCP servers** — links to `Customize > MCP`
3. **Start a conversation** — links to `Conversations`
4. **Explore automations** — links to `Automate`

Check warning on line 80 in openhands/usage/agent-canvas/first-time-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/first-time-setup.mdx#L80

Did you really mean 'automations'?
5. **Customize your agent** — links to `Customize`
6. **Review settings** — links to `Settings`

Each item links directly to the relevant page. The checklist tracks your progress and minimizes to stay out of the way. When all items are complete, the checklist auto-hides.

<Note>
Toggle the checklist from `Settings > Application` using the **Show getting started checklist** switch. The setting persists across sessions.
</Note>

## After Your First Session

Keep the terminal or Docker container that runs Agent Canvas active while you use the browser. When you are done, [stop Agent Canvas](/openhands/usage/agent-canvas/setup#stop-agent-canvas). Start it again with the same command when you return.
Expand Down
24 changes: 24 additions & 0 deletions openhands/usage/agent-canvas/llm-profiles.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@

### Local OpenAI-Compatible Endpoint

A local server can be LM Studio, Ollama, vLLM, SGLang, or another service that exposes an OpenAI-compatible API. In the **Advanced** tab, enter the provider, exact model ID, endpoint base URL, and the required API key or a placeholder value when the server does not require one.

Check warning on line 57 in openhands/usage/agent-canvas/llm-profiles.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/llm-profiles.mdx#L57

Did you really mean 'Ollama'?

Check warning on line 57 in openhands/usage/agent-canvas/llm-profiles.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/llm-profiles.mdx#L57

Did you really mean 'SGLang'?

The URL must be reachable from the **backend**, not only from your browser. For example, a backend in Docker cannot use `127.0.0.1` to reach a model server running on the host. Use the host address appropriate for that backend and confirm the endpoint's model inventory before saving.

Expand All @@ -64,7 +64,7 @@
- **Base URL**: `http://host.docker.internal:1234/v1`
- **API key**: `local-llm` or another placeholder value when the server does not require authentication

See [Local LLMs](/openhands/usage/llms/local-llms) for LM Studio, Ollama, and other local-server examples.

Check warning on line 67 in openhands/usage/agent-canvas/llm-profiles.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/llm-profiles.mdx#L67

Did you really mean 'Ollama'?

### LiteLLM Proxy

Expand All @@ -72,6 +72,30 @@

See [LiteLLM Proxy](/openhands/usage/llms/litellm-proxy) for the complete configuration.

## Provider Connections

<Note>
Provider Connections are available on **local agent-server backends only**. The panel is hidden when using an OpenHands Cloud backend.
</Note>

When you want multiple LLM profiles to share the same provider credentials, use **Provider Connections** to store an API key and optional base URL once and reference it across profiles. This avoids pasting the same key into every profile and lets you rotate credentials in one place.

### Create a Provider Connection

1. Open `Settings > LLM`.
2. In the **Provider Connections** panel, add a new connection.
3. Enter a name, the provider, the API key, and an optional base URL.

### Link a Profile to a Provider Connection

In the profile editor, use the **provider-connection selector** to link a profile to an existing connection. When a profile is linked, its inline API key and base URL fields are hidden — the profile uses the connection's credentials instead.

Linked profiles are grouped under their provider connection name in the profile list for readability.

### Broken Link Badge

If a provider connection is deleted while still referenced by a profile, the profile shows a **Broken link** badge. Re-link the profile to another connection or restore inline credentials to resolve it.

## Working with LLM Profiles

LLM profiles are useful when you want different model setups for different tasks, such as:
Expand Down Expand Up @@ -107,7 +131,7 @@
|---|---|---|
| Provider is not recognized | Provider selection and model prefix | Use the matching configuration path above. |
| Model format or identifier error | Exact model ID | Compare it with the provider or proxy model inventory. |
| Local server cannot be reached | Base URL from the backend | Check host, port, and container or network reachability. |

Check warning on line 134 in openhands/usage/agent-canvas/llm-profiles.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/llm-profiles.mdx#L134

Did you really mean 'reachability'?
| Authentication or permission error | Key type and backend scope | Re-enter the key or follow the provider guide. |
| Model cannot perform the task | Context and tool support | Choose a compatible model from the provider's recommendations. |

Expand Down
4 changes: 4 additions & 0 deletions openhands/usage/agent-canvas/prebuilt-automations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
description: Get started quickly with a pre-built automation for common workflows.
---

Agent Canvas ships with a set of pre-built automations for the most common agent workflows. Each one is a ready-to-use starting point — pick the one that fits your use case, connect it to the right backend, and you can have an automation running in minutes.

Check warning on line 6 in openhands/usage/agent-canvas/prebuilt-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/prebuilt-automations.mdx#L6

Did you really mean 'automations'?

## Available Pre-built Automations

Check warning on line 8 in openhands/usage/agent-canvas/prebuilt-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/prebuilt-automations.mdx#L8

Did you really mean 'Automations'?

| Automation | What It Does |
|------------|-------------|
Expand All @@ -21,30 +21,34 @@

In the `Automate` view, you can:

- Browse existing automations

Check warning on line 24 in openhands/usage/agent-canvas/prebuilt-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/prebuilt-automations.mdx#L24

Did you really mean 'automations'?
- Inspect automation configuration and activity
- Enable or disable automations

Check warning on line 26 in openhands/usage/agent-canvas/prebuilt-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/prebuilt-automations.mdx#L26

Did you really mean 'automations'?
- Edit an automation's LLM profile for future runs
- Work with recommended automation flows

## How Creation Flows Usually Start

The `Automations` view is mainly for browsing and managing automations that already exist.

Check warning on line 32 in openhands/usage/agent-canvas/prebuilt-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/prebuilt-automations.mdx#L32

Did you really mean 'automations'?

In practice, new automation setup starts in one of two ways:

- From a conversation, where you ask OpenHands to `create an automation` for you
- From a recommended automation flow in the `Automations` view

For recommended automations that support a direct form setup, Agent Canvas checks the active backend's capabilities and any prerequisites, then guides you through the required input fields, a review step, and creation. If direct form setup is unavailable, it offers a conversation-assisted setup instead. Review the proposed configuration before creating an automation.

Check warning on line 39 in openhands/usage/agent-canvas/prebuilt-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/prebuilt-automations.mdx#L39

Did you really mean 'automations'?

Check warning on line 39 in openhands/usage/agent-canvas/prebuilt-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/prebuilt-automations.mdx#L39

Did you really mean 'backend's'?

Some catalog entries ship a **script bundle** — a packaged set of files that install as a deterministic automation — rather than a prompt-based preset. Script-bundle entries run their own logic for tasks like polling, deduplication, and fixed API calls, using the agent only for the parts that genuinely require judgment. When a catalog entry supports a bundle install, the setup form handles packaging and upload automatically; you just fill in the required fields.

Check warning on line 41 in openhands/usage/agent-canvas/prebuilt-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/prebuilt-automations.mdx#L41

Did you really mean 'deduplication'?

Catalog entries that accept repositories can also collect multiple repositories in a single field, so one automation can monitor several repos at once.

Check warning on line 43 in openhands/usage/agent-canvas/prebuilt-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/prebuilt-automations.mdx#L43

Did you really mean 'repos'?

For a detailed walkthrough, see [Creating Automations](/openhands/usage/automations/creating-automations).

Check warning on line 45 in openhands/usage/agent-canvas/prebuilt-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/prebuilt-automations.mdx#L45

Did you really mean 'walkthrough'?

<Note>
Some recommended automations depend on integrations that cannot be auto-installed as MCP servers on this backend (for example, Jira's HTTP/OpenAPI-only integration). These appear on the recommendation card with a `Needs external setup` label. The `MCPs to connect` count only covers integrations the install flow can connect automatically. You must configure externally-hosted integrations yourself before the automation can use them.

Check warning on line 48 in openhands/usage/agent-canvas/prebuilt-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/prebuilt-automations.mdx#L48

Did you really mean 'automations'?

Check warning on line 48 in openhands/usage/agent-canvas/prebuilt-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/prebuilt-automations.mdx#L48

Did you really mean 'Jira's'?
</Note>

Automations run against the active backend. Use [Manage Backends](/openhands/usage/agent-canvas/backends) to see and switch which backend your automations run on.

Check warning on line 51 in openhands/usage/agent-canvas/prebuilt-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/prebuilt-automations.mdx#L51

Did you really mean 'Automations'?

Check warning on line 51 in openhands/usage/agent-canvas/prebuilt-automations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/agent-canvas/prebuilt-automations.mdx#L51

Did you really mean 'automations'?

## Edit an Automation's LLM Profile

Expand Down
4 changes: 4 additions & 0 deletions openhands/usage/settings/application-settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,10 @@ To override the defaults:
for commits and pull requests. OpenHands will remain as a co-author.
</Note>

## Getting Started Checklist

The sidebar shows a **Getting Started** checklist after first-run onboarding. Toggle `Show getting started checklist` in `Settings > Application` to hide or show it. The setting persists across sessions. See [First Time Setup](/openhands/usage/agent-canvas/first-time-setup#getting-started-checklist) for details.

## Sandbox Grouping Strategy

The `Sandbox Grouping Strategy` setting controls where OpenHands places new
Expand Down
Loading