Skip to content

Commit 8f2e177

Browse files
authored
Merge pull request #1928 from gtardif/more_docs_rename
More docs rename (in / docs), fix remaining `docker agent serve a2a/acp/mcp`
2 parents d016736 + 8fc3a4f commit 8f2e177

10 files changed

Lines changed: 25 additions & 25 deletions

File tree

docs/TODO.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## New Pages
44

5-
- [x] **Go SDK** — Not documented anywhere. The `examples/golibrary/` directory shows how to use cagent as a Go library. Needs a dedicated page. *(Completed: pages/guides/go-sdk.html)*
5+
- [x] **Go SDK** — Not documented anywhere. The `examples/golibrary/` directory shows how to use Docker Agent as a Go library. Needs a dedicated page. *(Completed: pages/guides/go-sdk.html)*
66
- [x] **Hooks**`hooks` agent config (`pre_tool_use`, `post_tool_use`, `session_start`, `session_end`, `on_user_input`) is a significant feature with no documentation page. Covers running shell commands at various agent lifecycle points. *(Completed: pages/configuration/hooks.html)*
77
- [x] **Permissions** — Top-level `permissions` config with `allow`/`deny` glob patterns for tool call approval. Mentioned briefly in TUI page but has no dedicated reference. *(Completed: pages/configuration/permissions.html)*
88
- [x] **Sandbox Mode** — Shell tool `sandbox` config runs commands in Docker containers. Includes `image` and `paths` (bind mounts with `:ro` support). Not documented. *(Completed: pages/configuration/sandbox.html)*

docs/_config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
title: cagent
1+
title: Docker Agent
22
description: Build, run, and share powerful AI agents with a declarative YAML config, rich tool ecosystem, and multi-agent orchestration — by Docker.
33
url: "https://docker.github.io"
44
baseurl: "/cagent"

docs/_includes/header.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- Header -->
22
<header class="header" role="banner">
33
<div class="header-inner">
4-
<a href="{{ '/' | relative_url }}" class="header-logo" aria-label="cagent docs home">
4+
<a href="{{ '/' | relative_url }}" class="header-logo" aria-label="docker agent docs home">
55
<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true">
66
<rect x="3" y="11" width="18" height="10" rx="2"/>
77
<circle cx="9" cy="16" r="1.5" fill="currentColor"/>
@@ -10,7 +10,7 @@
1010
<path d="M5 11V9"/>
1111
<path d="M19 11V9"/>
1212
</svg>
13-
<span>cagent <span style="font-weight:400;color:var(--text-muted);font-size:0.85rem;">docs</span></span>
13+
<span>Docker Agent <span style="font-weight:400;color:var(--text-muted);font-size:0.85rem;">docs</span></span>
1414
</a>
1515

1616
<div class="header-actions">
@@ -23,7 +23,7 @@
2323
<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" aria-hidden="true"><path d="M21 12.79A9 9 0 1 1 11.21 3 7 7 0 0 0 21 12.79z"/></svg>
2424
</button>
2525

26-
<a href="https://github.com/docker/cagent" target="_blank" rel="noopener" class="github-link" title="GitHub" aria-label="View cagent on GitHub">
26+
<a href="https://github.com/docker/cagent" target="_blank" rel="noopener" class="github-link" title="GitHub" aria-label="View Docker Agent on GitHub">
2727
<svg viewBox="0 0 24 24" fill="currentColor" aria-hidden="true"><path d="M12 0C5.37 0 0 5.37 0 12c0 5.31 3.435 9.795 8.205 11.385.6.105.825-.255.825-.57 0-.285-.015-1.23-.015-2.235-3.015.555-3.795-.735-4.035-1.41-.135-.345-.72-1.41-1.23-1.695-.42-.225-1.02-.78-.015-.795.945-.015 1.62.87 1.845 1.23 1.08 1.815 2.805 1.305 3.495.99.105-.78.42-1.305.765-1.605-2.67-.3-5.46-1.335-5.46-5.925 0-1.305.465-2.385 1.23-3.225-.12-.3-.54-1.53.12-3.18 0 0 1.005-.315 3.3 1.23.96-.27 1.98-.405 3-.405s2.04.135 3 .405c2.295-1.56 3.3-1.23 3.3-1.23.66 1.65.24 2.88.12 3.18.765.84 1.23 1.905 1.23 3.225 0 4.605-2.805 5.625-5.475 5.925.435.375.81 1.095.81 2.22 0 1.605-.015 2.895-.015 3.3 0 .315.225.69.825.57A12.02 12.02 0 0 0 24 12c0-6.63-5.37-12-12-12z"/></svg>
2828
</a>
2929
</div>

docs/_layouts/default.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
<head>
44
<meta charset="UTF-8">
55
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6-
<title>{% if page.title %}{{ page.title }} – cagent docs{% else %}cagent – Documentation{% endif %}</title>
6+
<title>{% if page.title %}{{ page.title }} – Docker Agent docs{% else %}Docker Agent – Documentation{% endif %}</title>
77
<meta name="description" content="{{ page.description | default: site.description }}">
88

9-
<meta property="og:title" content="{% if page.title %}{{ page.title }} – cagent docs{% else %}cagent – Documentation{% endif %}">
9+
<meta property="og:title" content="{% if page.title %}{{ page.title }} – Docker Agent docs{% else %}Docker Agent – Documentation{% endif %}">
1010
<meta property="og:description" content="{{ page.description | default: site.description }}">
1111
<meta property="og:type" content="{% if page.url == '/' %}website{% else %}article{% endif %}">
1212
<meta property="og:url" content="{{ page.url | absolute_url }}">

docs/configuration/overview/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ docker-agent validates your configuration at startup:
165165

166166
## JSON Schema
167167

168-
For editor autocompletion and validation, use the [cagent JSON Schema](https://github.com/docker/cagent/blob/main/agent-schema.json). Add this to the top of your YAML file:
168+
For editor autocompletion and validation, use the [Docker Agent JSON Schema](https://github.com/docker/cagent/blob/main/agent-schema.json). Add this to the top of your YAML file:
169169

170170
```bash
171171
# yaml-language-server: $schema=https://raw.githubusercontent.com/docker/docker-agent/main/agent-schema.json

docs/features/a2a/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ _Expose docker-agent agents via Google's Agent-to-Agent (A2A) protocol for inter
1010

1111
## Overview
1212

13-
The `docker agent serve a2a` command starts an A2A server that exposes your agents using the [A2A protocol](https://google.github.io/A2A/). This enables communication between cagent and other agent frameworks that support A2A.
13+
The `docker agent serve a2a` command starts an A2A server that exposes your agents using the [A2A protocol](https://google.github.io/A2A/). This enables communication between Docker Agent and other agent frameworks that support A2A.
1414

1515
<div class="callout callout-warning">
1616
<div class="callout-title">⚠️ Early support

docs/features/acp/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,16 @@ ACP is built on the [ACP Go SDK](https://github.com/coder/acp-go-sdk) and provid
2525

2626
```bash
2727
# Start ACP server on stdio
28-
$ docker agent acp ./agent.yaml
28+
$ docker agent serve acp ./agent.yaml
2929

3030
# With a multi-agent team config
31-
$ docker agent acp ./team.yaml
31+
$ docker agent serve acp ./team.yaml
3232

3333
# From the agent catalog
34-
$ docker agent acp agentcatalog/pirate
34+
$ docker agent serve acp agentcatalog/pirate
3535

3636
# With a custom session database
37-
$ docker agent acp ./agent.yaml --session-db ./my-sessions.db
37+
$ docker agent serve acp ./agent.yaml --session-db ./my-sessions.db
3838
```
3939

4040
## How It Works

docs/features/cli/index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -102,12 +102,12 @@ $ docker agent api ociReference --pull-interval 10 # auto-refresh
102102
Expose agents as MCP tools for use in Claude Desktop, Claude Code, or other MCP clients.
103103

104104
```bash
105-
$ docker agent mcp [config] [flags]
105+
$ docker agent serve mcp [config] [flags]
106106

107107
# Examples
108-
$ docker agent mcp agent.yaml
109-
$ docker agent mcp agent.yaml --working-dir /path/to/project
110-
$ docker agent mcp agentcatalog/coder
108+
$ docker agent serve mcp agent.yaml
109+
$ docker agent serve mcp agent.yaml --working-dir /path/to/project
110+
$ docker agent serve mcp agentcatalog/coder
111111
```
112112

113113
See [MCP Mode](/features/mcp-mode/) for detailed setup.
@@ -214,9 +214,9 @@ Run an alias with: docker agent run <alias>
214214
<div class="callout callout-tip">
215215
<div class="callout-title">💡 Set a default agent
216216
</div>
217-
<p>Create a <code>default</code> alias to customize what <code>cagent</code> starts with no arguments:</p>
218-
<pre><code>$ cagent alias add default /my/default/agent.yaml</code></pre>
219-
<p>Then simply run <code>cagent</code> — it will launch that agent automatically.</p>
217+
<p>Create a <code>default</code> alias to customize what <code>docker agent</code> starts with no arguments:</p>
218+
<pre><code>$ docker agent alias add default /my/default/agent.yaml</code></pre>
219+
<p>Then simply run <code>docker agent</code> — it will launch that agent automatically.</p>
220220

221221
</div>
222222

docs/features/mcp-mode/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@ The `docker agent serve mcp` command makes your agents available to any applicat
2828

2929
```bash
3030
# Expose a local config
31-
$ docker agent mcp ./agent.yaml
31+
$ docker agent serve mcp ./agent.yaml
3232

3333
# Expose from a registry
34-
$ docker agent mcp agentcatalog/pirate
34+
$ docker agent serve mcp agentcatalog/pirate
3535

3636
# Set the working directory
37-
$ docker agent mcp ./agent.yaml --working-dir /path/to/project
37+
$ docker agent serve mcp ./agent.yaml --working-dir /path/to/project
3838
```
3939

4040
## Using with Claude Desktop
@@ -73,7 +73,7 @@ Restart Claude Desktop after updating the configuration.
7373
$ claude mcp add --transport stdio myagent \
7474
--env OPENAI_API_KEY=$OPENAI_API_KEY \
7575
--env ANTHROPIC_API_KEY=$ANTHROPIC_API_KEY \
76-
-- docker agent mcp agentcatalog/pirate --working-dir $(pwd)
76+
-- docker agent serve mcp agentcatalog/pirate --working-dir $(pwd)
7777
```
7878

7979
## Multi-Agent in MCP Mode

docs/features/remote-mcp/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ _Connect docker-agent to cloud services via remote MCP servers with built-in OAu
1010

1111
## Overview
1212

13-
cagent supports connecting to remote MCP servers over **SSE** (Server-Sent Events) and **Streamable HTTP** transports. Many popular services offer MCP endpoints with OAuth — docker-agent handles the authentication flow automatically.
13+
Docker Agent supports connecting to remote MCP servers over **SSE** (Server-Sent Events) and **Streamable HTTP** transports. Many popular services offer MCP endpoints with OAuth — docker-agent handles the authentication flow automatically.
1414

1515
```yaml
1616
toolsets:

0 commit comments

Comments
 (0)