Skip to content

Commit 364564d

Browse files
danilo-lealbenbrandt
danilo-leal
and
benbrandt
authored
docs: Make first section be "Get Started" and move the registry content there (#421)
* Restructure first section of docs and adjust content * Run pnpm format * Update script with new page location * Run pnpm format again * nonpermanent redirect --------- Co-authored-by: Ben Brandt <benjamin.j.brandt@gmail.com>
1 parent 473ceae commit 364564d

9 files changed

Lines changed: 139 additions & 134 deletions

File tree

‎docs/docs.json‎

Lines changed: 34 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,13 @@
5050
"tab": "Protocol",
5151
"pages": [
5252
{
53-
"group": "Overview",
53+
"group": "Get Started",
5454
"pages": [
55-
"overview/introduction",
56-
"overview/architecture",
57-
"overview/agents",
58-
"overview/clients"
55+
"get-started/introduction",
56+
"get-started/architecture",
57+
"get-started/agents",
58+
"get-started/clients",
59+
"get-started/registry"
5960
]
6061
},
6162
{
@@ -95,10 +96,6 @@
9596
"libraries/typescript",
9697
"libraries/community"
9798
]
98-
},
99-
{
100-
"group": "Registry",
101-
"pages": ["registry/index"]
10299
}
103100
]
104101
},
@@ -165,5 +162,32 @@
165162
},
166163
"contextual": {
167164
"options": ["copy", "view"]
168-
}
165+
},
166+
"redirects": [
167+
{
168+
"source": "/overview/introduction",
169+
"destination": "/get-started/introduction",
170+
"permanent": true
171+
},
172+
{
173+
"source": "/overview/architecture",
174+
"destination": "/get-started/architecture",
175+
"permanent": true
176+
},
177+
{
178+
"source": "/overview/agents",
179+
"destination": "/get-started/agents",
180+
"permanent": true
181+
},
182+
{
183+
"source": "/overview/clients",
184+
"destination": "/get-started/clients",
185+
"permanent": true
186+
},
187+
{
188+
"source": "/registry",
189+
"destination": "/get-started/registry",
190+
"permanent": false
191+
}
192+
]
169193
}

‎docs/get-started/_registry_agents.mdx‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
title: ACP Registry
3+
description: The easiest way to find and install ACP-compatible agents.
4+
---
5+
6+
<style>{`
7+
.agent-icon {
8+
width: 20px;
9+
height: 20px;
10+
color: currentColor;
11+
}
12+
`}</style>
13+
14+
## Overview
15+
16+
The ACP Registry is an easy way for developers to distribute their ACP-compatible agents to any client that speaks the protocol.
17+
18+
At the moment, this is a curated set of agents, including only the ones that [support authentication](/rfds/auth-methods).
19+
20+
Visit [the registry repository on GitHub](https://github.com/agentclientprotocol/registry) to learn more about it.
21+
22+
<Warning>
23+
The registry is under active development, so expect its format and contents to
24+
change.
25+
</Warning>
26+
27+
## Available Agents
28+
29+
$$AGENTS_CARDS$$
30+
31+
## Using the Registry
32+
33+
Clients can fetch the registry programmatically:
34+
35+
```bash
36+
curl https://cdn.agentclientprotocol.com/registry/v1/latest/registry.json
37+
```
38+
39+
The registry JSON contains all agent metadata including distribution information for automatic installation.
40+
41+
## Submit your Agent
42+
43+
To add your agent to the registry:
44+
45+
1. Fork the [registry repository on GitHub](https://github.com/agentclientprotocol/registry)
46+
2. Create a folder with your agent's ID (lowercase, hyphens allowed)
47+
3. Add an `agent.json` file following [the schema](https://github.com/agentclientprotocol/registry/blob/main/agent.schema.json)
48+
4. Optionally add an `icon.svg` (16x16 recommended)
49+
5. Submit a pull request
50+
51+
See the [contributing guide](https://github.com/agentclientprotocol/registry/blob/main/CONTRIBUTING.md) for details.

docs/overview/agents.mdx renamed to docs/get-started/agents.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Agents"
3-
description: "Agents implementing the Agent Client Protocol"
3+
description: "Agents implementing the Agent Client Protocol."
44
---
55

66
The following agents can be used with an ACP Client:

docs/overview/architecture.mdx renamed to docs/get-started/architecture.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Architecture"
3-
description: "Overview of the Agent Client Protocol architecture"
3+
description: "Overview of the Agent Client Protocol architecture."
44
---
55

66
The Agent Client Protocol defines a standard interface for communication between AI agents and client applications. The architecture is designed to be flexible, extensible, and platform-agnostic.

docs/overview/clients.mdx renamed to docs/get-started/clients.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Clients"
3-
description: "Clients implementing the Agent Client Protocol"
3+
description: "Clients implementing the Agent Client Protocol."
44
---
55

66
The following clients can be used with an ACP Agent:

docs/overview/introduction.mdx renamed to docs/get-started/introduction.mdx

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
title: "Introduction"
3-
description: "Get started with the Agent Client Protocol (ACP)"
3+
description: "Get started with the Agent Client Protocol."
44
---
55

6-
The Agent Client Protocol standardizes communication between code editors/IDEs and coding agents and is suitable for both local and remote scenarios.
6+
The Agent Client Protocol (ACP) standardizes communication between code editors/IDEs and coding agents and is suitable for both local and remote scenarios.
77

88
## Why ACP?
99

@@ -28,7 +28,11 @@ ACP is suitable for both local and remote scenarios:
2828
- **Local agents** run as sub-processes of the code editor, communicating via JSON-RPC over stdio.
2929
- **Remote agents** can be hosted in the cloud or on separate infrastructure, communicating over HTTP or WebSocket
3030

31-
> **Note:** Full support for remote agents is a work in progress. We are actively collaborating with agentic platforms to ensure the protocol addresses the specific requirements of cloud-hosted and remote deployment scenarios.
31+
<Info>
32+
Full support for remote agents is a work in progress. We are actively
33+
collaborating with agentic platforms to ensure the protocol addresses the
34+
specific requirements of cloud-hosted and remote deployment scenarios.
35+
</Info>
3236

3337
The protocol re-uses the JSON representations used in MCP where possible, but includes custom types for useful agentic coding UX elements, like displaying diffs.
3438

docs/registry/index.mdx renamed to docs/get-started/registry.mdx

Lines changed: 40 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Official ACP Registry
3-
description: Discover Agent Client Protocol agents
2+
title: ACP Registry
3+
description: The easiest way to find and install ACP-compatible agents.
44
---
55

66
<style>{`
@@ -11,13 +11,25 @@ description: Discover Agent Client Protocol agents
1111
}
1212
`}</style>
1313

14-
The ACP Agent Registry is a curated collection of agents implementing the Agent Client Protocol.
14+
## Overview
15+
16+
The ACP Registry is an easy way for developers to distribute their ACP-compatible agents to any client that speaks the protocol.
17+
18+
At the moment, this is a curated set of agents, including only the ones that [support authentication](/rfds/auth-methods).
19+
20+
Visit [the registry repository on GitHub](https://github.com/agentclientprotocol/registry) to learn more about it.
21+
22+
<Warning>
23+
The registry is under active development, so expect its format and contents to
24+
change.
25+
</Warning>
1526

1627
## Available Agents
1728

18-
<CardGroup cols={2}>
29+
<CardGroup cols={3}>
1930
<Card
2031
title="Auggie CLI"
32+
href="https://github.com/augmentcode/auggie-zed-extension"
2133
icon={
2234
<svg
2335
width="20"
@@ -39,16 +51,14 @@ The ACP Agent Registry is a curated collection of agents implementing the Agent
3951
/>
4052
</svg>
4153
}
42-
href="https://github.com/augmentcode/auggie-zed-extension"
4354
>
44-
Augment Code&#39;s powerful software agent, backed by industry-leading
45-
context engine
46-
<p>
55+
<p className="mt-2 text-xs">
4756
<code>0.14.0</code>
4857
</p>
4958
</Card>
5059
<Card
5160
title="Claude Code"
61+
href="https://github.com/zed-industries/claude-code-acp"
5262
icon={
5363
<svg
5464
width="20"
@@ -65,15 +75,14 @@ The ACP Agent Registry is a curated collection of agents implementing the Agent
6575
/>
6676
</svg>
6777
}
68-
href="https://github.com/zed-industries/claude-code-acp"
6978
>
70-
ACP wrapper for Anthropic&#39;s Claude
71-
<p>
79+
<p className="mt-2 text-xs">
7280
<code>0.13.2</code>
7381
</p>
7482
</Card>
7583
<Card
7684
title="Codex CLI"
85+
href="https://github.com/zed-industries/codex-acp"
7786
icon={
7887
<svg
7988
width="20"
@@ -90,10 +99,8 @@ The ACP Agent Registry is a curated collection of agents implementing the Agent
9099
/>
91100
</svg>
92101
}
93-
href="https://github.com/zed-industries/codex-acp"
94102
>
95-
ACP adapter for OpenAI&#39;s coding assistant
96-
<p>
103+
<p className="mt-2 text-xs">
97104
<code>0.9.0</code>
98105
</p>
99106
</Card>
@@ -117,13 +124,13 @@ The ACP Agent Registry is a curated collection of agents implementing the Agent
117124
</svg>
118125
}
119126
>
120-
Factory Droid - AI coding agent powered by Factory AI
121-
<p>
122-
<code>0.56.3</code>
127+
<p className="mt-2 text-xs">
128+
<code>0.52.0</code>
123129
</p>
124130
</Card>
125131
<Card
126132
title="Gemini CLI"
133+
href="https://github.com/google-gemini/gemini-cli"
127134
icon={
128135
<svg
129136
width="20"
@@ -140,15 +147,14 @@ The ACP Agent Registry is a curated collection of agents implementing the Agent
140147
/>
141148
</svg>
142149
}
143-
href="https://github.com/google-gemini/gemini-cli"
144150
>
145-
Google&#39;s official CLI for Gemini
146-
<p>
147-
<code>0.26.0</code>
151+
<p className="mt-2 text-xs">
152+
<code>0.25.2</code>
148153
</p>
149154
</Card>
150155
<Card
151156
title="GitHub Copilot"
157+
href="https://github.com/github/copilot-language-server-release"
152158
icon={
153159
<svg
154160
width="20"
@@ -176,15 +182,14 @@ The ACP Agent Registry is a curated collection of agents implementing the Agent
176182
/>
177183
</svg>
178184
}
179-
href="https://github.com/github/copilot-language-server-release"
180185
>
181-
GitHub&#39;s AI pair programmer
182-
<p>
186+
<p className="mt-2 text-xs">
183187
<code>1.417.0</code>
184188
</p>
185189
</Card>
186190
<Card
187191
title="Mistral Vibe"
192+
href="https://github.com/mistralai/mistral-vibe"
188193
icon={
189194
<svg
190195
width="20"
@@ -238,15 +243,14 @@ The ACP Agent Registry is a curated collection of agents implementing the Agent
238243
/>
239244
</svg>
240245
}
241-
href="https://github.com/mistralai/mistral-vibe"
242246
>
243-
Mistral&#39;s open-source coding assistant
244-
<p>
245-
<code>2.0.0</code>
247+
<p className="mt-2 text-xs">
248+
<code>1.3.5</code>
246249
</p>
247250
</Card>
248251
<Card
249252
title="OpenCode"
253+
href="https://github.com/sst/opencode"
250254
icon={
251255
<svg
252256
width="20"
@@ -266,15 +270,14 @@ The ACP Agent Registry is a curated collection of agents implementing the Agent
266270
/>
267271
</svg>
268272
}
269-
href="https://github.com/sst/opencode"
270273
>
271-
The open source coding agent
272-
<p>
273-
<code>1.1.39</code>
274+
<p className="mt-2 text-xs">
275+
<code>1.1.36</code>
274276
</p>
275277
</Card>
276278
<Card
277279
title="Qwen Code"
280+
href="https://github.com/QwenLM/qwen-code"
278281
icon={
279282
<svg
280283
width="20"
@@ -291,33 +294,13 @@ The ACP Agent Registry is a curated collection of agents implementing the Agent
291294
/>
292295
</svg>
293296
}
294-
href="https://github.com/QwenLM/qwen-code"
295297
>
296-
Alibaba&#39;s Qwen coding assistant
297-
<p>
298-
<code>0.8.1</code>
298+
<p className="mt-2 text-xs">
299+
<code>0.7.2</code>
299300
</p>
300301
</Card>
301302
</CardGroup>
302303

303-
<Warning>
304-
**Work in Progress**: This registry is under active development. Format and
305-
contents may change.
306-
</Warning>
307-
308-
<Note>
309-
This registry only includes agents that support
310-
[authentication](/rfds/auth-methods). Agents must implement auth flows to be
311-
listed here. Not all ACP-compatible agents are listed yet—as soon as they're
312-
ready, we'll be happy to add them.
313-
</Note>
314-
315-
<Info>
316-
The registry is hosted at
317-
[github.com/agentclientprotocol/registry](https://github.com/agentclientprotocol/registry).
318-
Visit the repository to contribute your own agent.
319-
</Info>
320-
321304
## Using the Registry
322305

323306
Clients can fetch the registry programmatically:
@@ -328,13 +311,13 @@ curl https://cdn.agentclientprotocol.com/registry/v1/latest/registry.json
328311

329312
The registry JSON contains all agent metadata including distribution information for automatic installation.
330313

331-
## Contributing
314+
## Submit your Agent
332315

333316
To add your agent to the registry:
334317

335-
1. Fork the [registry repository](https://github.com/agentclientprotocol/registry)
318+
1. Fork the [registry repository on GitHub](https://github.com/agentclientprotocol/registry)
336319
2. Create a folder with your agent's ID (lowercase, hyphens allowed)
337-
3. Add an `agent.json` file following the [schema](https://github.com/agentclientprotocol/registry/blob/main/agent.schema.json)
320+
3. Add an `agent.json` file following [the schema](https://github.com/agentclientprotocol/registry/blob/main/agent.schema.json)
338321
4. Optionally add an `icon.svg` (16x16 recommended)
339322
5. Submit a pull request
340323

0 commit comments

Comments
 (0)