Skip to content

docs: Make first section be "Get Started" and move the registry content there #421

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
benbrandt merged 5 commits into from
Jan 28, 2026
Merged

docs: Make first section be "Get Started" and move the registry content there #421

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
63b1fe5
Restructure first section of docs and adjust content
danilo-leal Jan 28, 2026
e2f9a6a
Run pnpm format
danilo-leal Jan 28, 2026
a515f30
Update script with new page location
danilo-leal Jan 28, 2026
323133f
Run pnpm format again
danilo-leal Jan 28, 2026
a5b0593
nonpermanent redirect
benbrandt Jan 28, 2026
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
44 changes: 34 additions & 10 deletions docs/docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,13 @@
"tab": "Protocol",
"pages": [
{
"group": "Overview",
"group": "Get Started",
"pages": [
"overview/introduction",
"overview/architecture",
"overview/agents",
"overview/clients"
"get-started/introduction",
"get-started/architecture",
"get-started/agents",
"get-started/clients",
"get-started/registry"
]
},
{
Expand Down Expand Up @@ -95,10 +96,6 @@
"libraries/typescript",
"libraries/community"
]
},
{
"group": "Registry",
"pages": ["registry/index"]
}
]
},
Expand Down Expand Up @@ -165,5 +162,32 @@
},
"contextual": {
"options": ["copy", "view"]
}
},
"redirects": [
{
"source": "/overview/introduction",
"destination": "/get-started/introduction",
"permanent": true
},
{
"source": "/overview/architecture",
"destination": "/get-started/architecture",
"permanent": true
},
{
"source": "/overview/agents",
"destination": "/get-started/agents",
"permanent": true
},
{
"source": "/overview/clients",
"destination": "/get-started/clients",
"permanent": true
},
{
"source": "/registry",
"destination": "/get-started/registry",
"permanent": false
}
]
}
51 changes: 51 additions & 0 deletions docs/get-started/_registry_agents.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
title: ACP Registry
description: The easiest way to find and install ACP-compatible agents.
---

<style>{`
.agent-icon {
width: 20px;
height: 20px;
color: currentColor;
}
`}</style>

## Overview

The ACP Registry is an easy way for developers to distribute their ACP-compatible agents to any client that speaks the protocol.

At the moment, this is a curated set of agents, including only the ones that [support authentication](/rfds/auth-methods).

Visit [the registry repository on GitHub](https://github.com/agentclientprotocol/registry) to learn more about it.

<Warning>
The registry is under active development, so expect its format and contents to
change.
</Warning>

## Available Agents

$$AGENTS_CARDS$$

## Using the Registry

Clients can fetch the registry programmatically:

```bash
curl https://cdn.agentclientprotocol.com/registry/v1/latest/registry.json
```

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

## Submit your Agent

To add your agent to the registry:

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

See the [contributing guide](https://github.com/agentclientprotocol/registry/blob/main/CONTRIBUTING.md) for details.
2 changes: 1 addition & 1 deletion docs/overview/agents.mdx → docs/get-started/agents.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Agents"
description: "Agents implementing the Agent Client Protocol"
description: "Agents implementing the Agent Client Protocol."
---

The following agents can be used with an ACP Client:
Expand Down
2 changes: 1 addition & 1 deletion docs/overview/architecture.mdx → docs/get-started/architecture.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Architecture"
description: "Overview of the Agent Client Protocol architecture"
description: "Overview of the Agent Client Protocol architecture."
---

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.
Expand Down
2 changes: 1 addition & 1 deletion docs/overview/clients.mdx → docs/get-started/clients.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Clients"
description: "Clients implementing the Agent Client Protocol"
description: "Clients implementing the Agent Client Protocol."
---

The following clients can be used with an ACP Agent:
Expand Down
10 changes: 7 additions & 3 deletions docs/overview/introduction.mdx → docs/get-started/introduction.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: "Introduction"
description: "Get started with the Agent Client Protocol (ACP)"
description: "Get started with the Agent Client Protocol."
---

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

## Why ACP?

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

> **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.
<Info>
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.
</Info>

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.

Expand Down
97 changes: 40 additions & 57 deletions docs/registry/index.mdx → docs/get-started/registry.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Official ACP Registry
description: Discover Agent Client Protocol agents
title: ACP Registry
description: The easiest way to find and install ACP-compatible agents.
---

<style>{`
Expand All @@ -11,13 +11,25 @@ description: Discover Agent Client Protocol agents
}
`}</style>

The ACP Agent Registry is a curated collection of agents implementing the Agent Client Protocol.
## Overview

The ACP Registry is an easy way for developers to distribute their ACP-compatible agents to any client that speaks the protocol.

At the moment, this is a curated set of agents, including only the ones that [support authentication](/rfds/auth-methods).

Visit [the registry repository on GitHub](https://github.com/agentclientprotocol/registry) to learn more about it.

<Warning>
The registry is under active development, so expect its format and contents to
change.
</Warning>

## Available Agents

<CardGroup cols={2}>
<CardGroup cols={3}>
<Card
title="Auggie CLI"
href="https://github.com/augmentcode/auggie-zed-extension"
icon={
<svg
width="20"
Expand All @@ -39,16 +51,14 @@ The ACP Agent Registry is a curated collection of agents implementing the Agent
/>
</svg>
}
href="https://github.com/augmentcode/auggie-zed-extension"
>
Augment Code&#39;s powerful software agent, backed by industry-leading
context engine
<p>
<p className="mt-2 text-xs">
<code>0.14.0</code>
</p>
</Card>
<Card
title="Claude Code"
href="https://github.com/zed-industries/claude-code-acp"
icon={
<svg
width="20"
Expand All @@ -65,15 +75,14 @@ The ACP Agent Registry is a curated collection of agents implementing the Agent
/>
</svg>
}
href="https://github.com/zed-industries/claude-code-acp"
>
ACP wrapper for Anthropic&#39;s Claude
<p>
<p className="mt-2 text-xs">
<code>0.13.2</code>
</p>
</Card>
<Card
title="Codex CLI"
href="https://github.com/zed-industries/codex-acp"
icon={
<svg
width="20"
Expand All @@ -90,10 +99,8 @@ The ACP Agent Registry is a curated collection of agents implementing the Agent
/>
</svg>
}
href="https://github.com/zed-industries/codex-acp"
>
ACP adapter for OpenAI&#39;s coding assistant
<p>
<p className="mt-2 text-xs">
<code>0.9.0</code>
</p>
</Card>
Expand All @@ -117,13 +124,13 @@ The ACP Agent Registry is a curated collection of agents implementing the Agent
</svg>
}
>
Factory Droid - AI coding agent powered by Factory AI
<p>
<code>0.56.3</code>
<p className="mt-2 text-xs">
<code>0.52.0</code>
</p>
</Card>
<Card
title="Gemini CLI"
href="https://github.com/google-gemini/gemini-cli"
icon={
<svg
width="20"
Expand All @@ -140,15 +147,14 @@ The ACP Agent Registry is a curated collection of agents implementing the Agent
/>
</svg>
}
href="https://github.com/google-gemini/gemini-cli"
>
Google&#39;s official CLI for Gemini
<p>
<code>0.26.0</code>
<p className="mt-2 text-xs">
<code>0.25.2</code>
</p>
</Card>
<Card
title="GitHub Copilot"
href="https://github.com/github/copilot-language-server-release"
icon={
<svg
width="20"
Expand Down Expand Up @@ -176,15 +182,14 @@ The ACP Agent Registry is a curated collection of agents implementing the Agent
/>
</svg>
}
href="https://github.com/github/copilot-language-server-release"
>
GitHub&#39;s AI pair programmer
<p>
<p className="mt-2 text-xs">
<code>1.417.0</code>
</p>
</Card>
<Card
title="Mistral Vibe"
href="https://github.com/mistralai/mistral-vibe"
icon={
<svg
width="20"
Expand Down Expand Up @@ -238,15 +243,14 @@ The ACP Agent Registry is a curated collection of agents implementing the Agent
/>
</svg>
}
href="https://github.com/mistralai/mistral-vibe"
>
Mistral&#39;s open-source coding assistant
<p>
<code>2.0.0</code>
<p className="mt-2 text-xs">
<code>1.3.5</code>
</p>
</Card>
<Card
title="OpenCode"
href="https://github.com/sst/opencode"
icon={
<svg
width="20"
Expand All @@ -266,15 +270,14 @@ The ACP Agent Registry is a curated collection of agents implementing the Agent
/>
</svg>
}
href="https://github.com/sst/opencode"
>
The open source coding agent
<p>
<code>1.1.39</code>
<p className="mt-2 text-xs">
<code>1.1.36</code>
</p>
</Card>
<Card
title="Qwen Code"
href="https://github.com/QwenLM/qwen-code"
icon={
<svg
width="20"
Expand All @@ -291,33 +294,13 @@ The ACP Agent Registry is a curated collection of agents implementing the Agent
/>
</svg>
}
href="https://github.com/QwenLM/qwen-code"
>
Alibaba&#39;s Qwen coding assistant
<p>
<code>0.8.1</code>
<p className="mt-2 text-xs">
<code>0.7.2</code>
</p>
</Card>
</CardGroup>

<Warning>
**Work in Progress**: This registry is under active development. Format and
contents may change.
</Warning>

<Note>
This registry only includes agents that support
[authentication](/rfds/auth-methods). Agents must implement auth flows to be
listed here. Not all ACP-compatible agents are listed yet—as soon as they're
ready, we'll be happy to add them.
</Note>

<Info>
The registry is hosted at
[github.com/agentclientprotocol/registry](https://github.com/agentclientprotocol/registry).
Visit the repository to contribute your own agent.
</Info>

## Using the Registry

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

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

## Contributing
## Submit your Agent

To add your agent to the registry:

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

Expand Down
Loading