Skip to content

Commit 7d5c645

Browse files
rachaelrenkoz-agent
andcommitted
Refine Oz web app agent docs
Co-Authored-By: Oz <oz-agent@warp.dev>
1 parent b2e5060 commit 7d5c645

2 files changed

Lines changed: 36 additions & 43 deletions

File tree

60.2 KB
Loading

src/content/docs/agent-platform/cloud-agents/oz-web-app.mdx

Lines changed: 36 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Watch this short demo to create an environment and run an agent using the Oz web
1919

2020
## Quick reference
2121

22-
<table><thead><tr><th width="150">Page</th><th width="120">Path</th><th>What you can do</th></tr></thead><tbody><tr><td><strong>Dashboard</strong></td><td><code>/dashboard</code></td><td>Quick actions, suggested agents, recent agents, and featured reads</td></tr><tr><td><strong>Runs</strong></td><td><code>/runs</code></td><td>View all runs, filter by status/source/creator, start new runs, inspect transcripts</td></tr><tr><td><strong>Agents</strong></td><td><code>/agents</code></td><td>Browse skills from your environments, manage agent identities, dispatch skills as agents</td></tr><tr><td><strong>Schedules</strong></td><td><code>/schedules</code></td><td>Create scheduled agents, pause/enable schedules, view run history</td></tr><tr><td><strong>Environments</strong></td><td><code>/environments</code></td><td>Create and manage environments with repos, Docker images, and setup commands</td></tr><tr><td><strong>Secrets</strong></td><td><code>/secrets</code></td><td>Create and manage Warp-managed secrets for cloud agent runs</td></tr><tr><td><strong>Integrations</strong></td><td><code>/integrations</code></td><td>Connect Slack and Linear to trigger agents from external tools</td></tr></tbody></table>
22+
<table><thead><tr><th width="150">Page</th><th width="120">Path</th><th>What you can do</th></tr></thead><tbody><tr><td><strong>Dashboard</strong></td><td><code>/dashboard</code></td><td>Quick actions, suggested agents, recent agents, and featured reads</td></tr><tr><td><strong>Runs</strong></td><td><code>/runs</code></td><td>View all runs, filter by status/source/creator, start new runs, inspect transcripts</td></tr><tr><td><strong>Agents</strong></td><td><code>/agents</code></td><td>Browse agents from your environments, view suggested agents, create agents, and start runs</td></tr><tr><td><strong>Schedules</strong></td><td><code>/schedules</code></td><td>Create scheduled agents, pause/enable schedules, view run history</td></tr><tr><td><strong>Environments</strong></td><td><code>/environments</code></td><td>Create and manage environments with repos, Docker images, and setup commands</td></tr><tr><td><strong>Secrets</strong></td><td><code>/secrets</code></td><td>Create and manage Warp-managed secrets for cloud agent runs</td></tr><tr><td><strong>Integrations</strong></td><td><code>/integrations</code></td><td>Connect Slack and Linear to trigger agents from external tools</td></tr></tbody></table>
2323

2424
<figure>
2525
![The Oz web app's management view.](../../../../assets/agent-platform/oz-web-app-runs-view.png)
@@ -63,15 +63,15 @@ The **Dashboard** page (`/dashboard`) is your starting point for common actions
6363
Four action cards at the top let you immediately:
6464

6565
* **New run** — Start a cloud agent run
66-
* **New agent** — Create a new skill
66+
* **New agent** — Create a new agent
6767
* **New schedule** — Set up a scheduled agent
6868
* **New environment** — Configure a new execution environment
6969

7070
Each action opens a guided side pane without leaving the Dashboard.
7171

7272
### Suggested agents
7373

74-
A curated list of pre-built skills from Warp's public [oz-skills repository](https://github.com/warpdotdev/oz-skills). Click **Run** on any suggested agent to start a run with that skill.
74+
A curated list of pre-built agents based on skills from Warp's public [oz-skills repository](https://github.com/warpdotdev/oz-skills). Click **Run** on any suggested agent to start a run from that configuration.
7575

7676
### Recent agents
7777

@@ -109,80 +109,74 @@ You can also search by title, prompt, or skill name, and add advanced filters fo
109109
Click **New run** in the header to start a cloud agent.
110110
:::
111111

112-
1. **Select an agent (optional)** — Choose a skill to use as the base instructions, or select "Quick run" to run without a skill
112+
1. **Select an agent (optional)** — Choose **Quick run** to run as yourself, or choose a saved agent identity from the **Agent** dropdown.
113113
2. **Select an environment** — Choose which environment the agent runs in
114114
3. **Add a prompt** — Provide context and instructions for this specific run
115115

116-
The skill provides base instructions; your prompt adds context for this particular execution.
116+
The **Agent** dropdown lets you choose **Quick run** or a saved agent identity before you start the run. **Quick run** runs as your own user. Your prompt adds context for this particular execution.
117117

118118
---
119119

120120
## Agents
121121

122-
The **Agents** page (`/agents`) covers two related but distinct concepts:
122+
The **Agents** page (`/agents`) is where you browse, create, and run agents. Agents are reusable cloud agent configurations that can include a prompt, skills, harness, model, environment, and secrets.
123123

124-
* **Skills** - Reusable instruction sets stored in repositories that an agent can execute. Browse skills available from your environments, plus suggested skills from Warp's public [oz-skills repository](https://github.com/warpdotdev/oz-skills).
125-
* **Agent identities** - Team-scoped bot accounts that own and execute runs. The same page is where teams create and manage agent identities, attach descriptions and secrets to them, and bind API keys to a specific identity.
124+
Skills are reusable instruction sets stored in repositories. You can attach existing skills to an agent through the **Skills** field.
126125

127-
For the full reference on agent identities, including plan limits, the REST endpoints, and how to run as a specific identity, see [Agent identities](/agent-platform/cloud-agents/agents/).
126+
### Agent details
128127

129-
### Skill details
128+
Each agent displays:
130129

131-
Each skill displays:
132-
133-
<table><thead><tr><th width="150">Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>Name</strong></td><td>The skill's identifier</td></tr><tr><td><strong>Description</strong></td><td>What the skill does</td></tr><tr><td><strong>Environments</strong></td><td>Which environments have access to this skill</td></tr></tbody></table>
130+
<table><thead><tr><th width="150">Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>Name</strong></td><td>The agent's identifier</td></tr><tr><td><strong>Description</strong></td><td>What the agent does</td></tr><tr><td><strong>Environment</strong></td><td>Which environment the agent runs in</td></tr></tbody></table>
134131

135132
<figure>
136133
![The Agents page in the Oz web app.](../../../../assets/agent-platform/oz-web-app-agents.png)
137134
<figcaption>The Agents page in the Oz web app.</figcaption>
138135
</figure>
139136

140-
Filter by environment or switch to the **Suggested** tab to see pre-built skills for common workflows like code review, dependency updates, and documentation sync.
137+
Filter by environment or switch to the **Suggested** tab to see pre-built agents for common workflows like code review, dependency updates, and documentation sync.
141138

142-
### Running a skill as an agent
139+
### Running an agent
143140

144-
Click any skill to view its details, then click **Run** to start an agent with that skill. You can also click **New run** from the header to start a run with optional skill selection.
141+
Click any agent to view its details, then click **Run** to start a run from that saved configuration. You can also click **New run** from the header to start a run with optional agent selection.
145142

146143
:::note
147144
For more details on how skills work with cloud agents, see [Skills as Agents](/agent-platform/cloud-agents/skills-as-agents/).
148145
:::
149146

150-
### Creating new skills
147+
### Creating a new agent
148+
149+
Click **New agent** to open the side pane. The guided flow helps you define a cloud agent and choose its default configuration.
151150

152-
Click **New skill** to create a new skill. The guided flow helps you define the skill's instructions, which are then available for future runs.
151+
1. **Name** (required) — Enter a short, descriptive identifier for the agent, such as `featureFlagRemover`.
152+
2. **Description** (optional) — Describe what the agent does.
153+
3. **Prompt** (optional) — Add instructions the agent uses by default.
154+
4. **Skills** (optional) — Attach one or more existing skills.
155+
5. **Harness** — Choose the execution harness the agent uses.
156+
6. **Model** — Choose the primary model the agent uses.
157+
7. **Environment** — Choose the team-scoped environment where the agent runs.
158+
8. **Secrets** (optional) — Attach any secrets the agent needs at run time.
159+
160+
Click **Create agent** to save the agent. The agent appears on the Agents page and is available for future runs.
153161

154162
<figure>
155-
![Creating a new agent skill in the Oz web app.](../../../../assets/agent-platform/oz-web-app-new-agent.png)
156-
<figcaption>Creating a new skill in the Oz web app.</figcaption>
163+
![Creating a new agent in the Oz web app.](../../../../assets/agent-platform/oz-web-app-new-agent.png)
164+
<figcaption>Creating a new agent in the Oz web app.</figcaption>
157165
</figure>
158166

159167
### Agent identities
160168

161-
Agent identities are managed from the same Agents page. From the agent-identities view, you can:
162-
163-
* **Create an agent identity** - Give it a name, an optional description, a default model and harness, and the secrets and skills runs as that identity should receive.
164-
* **Edit an existing identity** - Update its description, attached secrets, attached skills, or default configuration.
165-
* **Delete an identity** - Soft-deletes the identity and atomically deletes every API key bound to it. The default agent identity cannot be deleted.
169+
An [agent identity](/agent-platform/cloud-agents/agents/) is a team-scoped identity that can own and execute cloud agent runs. In the Oz web app, agent identities appear as saved agent options in the **Agent** dropdown for new runs and schedules. Skills provide reusable instructions; agent identities define the saved identity you select for a run.
166170

167171
When you start a new run or schedule from the web app, the form's **Agent** dropdown lets you pick which agent identity should execute the run. **Quick run** is the default option and runs as your own user. See [Agent identities](/agent-platform/cloud-agents/agents/) for the full reference.
168172

169-
#### Creating an agent identity
170-
171-
Click **New agent** to open the **New agent** side pane. The pane is split into collapsible sections; only the name is required. Walk through the fields in order:
173+
From the Agents page or the API, you can:
172174

173-
1. **Name** (required) — A short, scriptable identifier for the identity, such as `featureFlagRemover` or `deploy-bot`.
174-
2. **Description** (optional) — A summary teammates see when picking the identity in run pickers.
175-
3. **Prompt** (optional) — Additional instructions appended to every run started as this identity.
176-
4. **Skills** — Use the multi-select to attach one or more skill specs the identity comes preloaded with.
177-
5. **Base harness** — Choose the execution harness for this identity's runs: Oz (the default) or a supported third-party CLI agent.
178-
6. **Base model** — When the chosen harness uses Warp's model picker, select the primary model the identity uses. You can leave this empty to fall back to the team default.
179-
7. **Harness auth secret** — When the chosen harness needs its own authentication (for example, a third-party CLI agent), pick the Warp-managed secret to authenticate with. Can be overridden per run.
180-
8. **Secrets** — Open the **Secrets** section and select the [Warp-managed secrets](/agent-platform/cloud-agents/secrets/) this identity should receive at run time.
181-
9. **Memory stores** — Attach the memory stores this identity should read from or write to.
182-
183-
Click **Create agent** to save. The new identity appears on the Agents page and is immediately available in run and schedule pickers. To edit an existing identity later, click it in the list, then click **Edit**.
175+
* **Create an agent identity** - Give it a name and optional description, then attach Warp-managed secrets and skills for runs started as that identity.
176+
* **Edit an existing identity** - Update its description, attached secrets, or attached skills.
177+
* **Delete an identity** - Soft-deletes the identity and atomically deletes every API key bound to it. The default agent identity cannot be deleted.
184178

185-
For the conceptual modelplan limits, the REST endpoints, and how API keys are bound to an identity — see [Agent identities](/agent-platform/cloud-agents/agents/).
179+
For the conceptual model, plan limits, REST endpoints, and API key binding behavior, see [Agent identities](/agent-platform/cloud-agents/agents/).
186180

187181
---
188182

@@ -194,7 +188,7 @@ The **Schedules** page (`/schedules`) lets you create and manage scheduled agent
194188

195189
Each schedule displays:
196190

197-
<table><thead><tr><th width="150">Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>Name</strong></td><td>A descriptive name for the scheduled task</td></tr><tr><td><strong>Frequency</strong></td><td>Human-readable description of the cron schedule (e.g., "Every Monday at 10am")</td></tr><tr><td><strong>Next run</strong></td><td>When the schedule will next execute</td></tr><tr><td><strong>Environment</strong></td><td>Which environment the scheduled agent runs in</td></tr><tr><td><strong>Agent</strong></td><td>Which skill the schedule uses (if any)</td></tr><tr><td><strong>Status</strong></td><td>Whether the schedule is active or paused</td></tr></tbody></table>
191+
<table><thead><tr><th width="150">Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>Name</strong></td><td>A descriptive name for the scheduled task</td></tr><tr><td><strong>Frequency</strong></td><td>Human-readable description of the cron schedule (e.g., "Every Monday at 10am")</td></tr><tr><td><strong>Next run</strong></td><td>When the schedule will next execute</td></tr><tr><td><strong>Environment</strong></td><td>Which environment the scheduled agent runs in</td></tr><tr><td><strong>Agent</strong></td><td>Which saved agent the schedule uses (if any)</td></tr><tr><td><strong>Status</strong></td><td>Whether the schedule is active or paused</td></tr></tbody></table>
198192

199193
<figure>
200194
![The Schedules page in the Oz web app.](../../../../assets/agent-platform/oz-web-app-schedules.png)
@@ -212,7 +206,7 @@ Click **New schedule** in the header to create a scheduled agent.
212206
1. **Name** — Give the schedule a descriptive name
213207
2. **Frequency** — Set the cron schedule (with presets for common patterns)
214208
3. **Environment** — Select the environment to run in
215-
4. **Agent (optional)** — Choose a skill to use
209+
4. **Agent (optional)** — Choose a saved agent to use
216210
5. **Prompt** — Define what the agent should do each time it runs
217211

218212
---
@@ -311,7 +305,6 @@ Open a parent run from the Runs page. When the run has children, the detail pane
311305

312306
* [Cloud Agents Overview](/agent-platform/cloud-agents/overview/) — Learn about cloud agents and when to use them
313307
* [Multi-agent orchestration](/agent-platform/cloud-agents/orchestration/) — Parent/child model and common orchestration patterns
314-
* [Agent identities](/agent-platform/cloud-agents/agents/) — Team-scoped bot accounts that own and execute runs
315308
* [Skills as Agents](/agent-platform/cloud-agents/skills-as-agents/) — Run agents based on reusable skill definitions
316309
* [Scheduled Agents](/agent-platform/cloud-agents/triggers/scheduled-agents/) — Run agents automatically on a cron schedule
317310
* [Environments](/agent-platform/cloud-agents/environments/) — Configure runtime context for cloud agents

0 commit comments

Comments
 (0)