diff --git a/docs/docs.json b/docs/docs.json index 4c2db7e3..f86e80a1 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -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" ] }, { @@ -95,10 +96,6 @@ "libraries/typescript", "libraries/community" ] - }, - { - "group": "Registry", - "pages": ["registry/index"] } ] }, @@ -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 + } + ] } diff --git a/docs/get-started/_registry_agents.mdx b/docs/get-started/_registry_agents.mdx new file mode 100644 index 00000000..bc013168 --- /dev/null +++ b/docs/get-started/_registry_agents.mdx @@ -0,0 +1,51 @@ +--- +title: ACP Registry +description: The easiest way to find and install ACP-compatible agents. +--- + + + +## 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. + + + The registry is under active development, so expect its format and contents to + change. + + +## 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. diff --git a/docs/overview/agents.mdx b/docs/get-started/agents.mdx similarity index 96% rename from docs/overview/agents.mdx rename to docs/get-started/agents.mdx index 1d0ee587..4da4ce25 100644 --- a/docs/overview/agents.mdx +++ b/docs/get-started/agents.mdx @@ -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: diff --git a/docs/overview/architecture.mdx b/docs/get-started/architecture.mdx similarity index 99% rename from docs/overview/architecture.mdx rename to docs/get-started/architecture.mdx index c9459171..87966308 100644 --- a/docs/overview/architecture.mdx +++ b/docs/get-started/architecture.mdx @@ -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. diff --git a/docs/overview/clients.mdx b/docs/get-started/clients.mdx similarity index 95% rename from docs/overview/clients.mdx rename to docs/get-started/clients.mdx index 48998d32..3cb649b6 100644 --- a/docs/overview/clients.mdx +++ b/docs/get-started/clients.mdx @@ -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: diff --git a/docs/overview/introduction.mdx b/docs/get-started/introduction.mdx similarity index 80% rename from docs/overview/introduction.mdx rename to docs/get-started/introduction.mdx index 379a0469..e5890c2b 100644 --- a/docs/overview/introduction.mdx +++ b/docs/get-started/introduction.mdx @@ -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? @@ -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. + + 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. + 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. diff --git a/docs/registry/index.mdx b/docs/get-started/registry.mdx similarity index 92% rename from docs/registry/index.mdx rename to docs/get-started/registry.mdx index 3b7d11fc..98276492 100644 --- a/docs/registry/index.mdx +++ b/docs/get-started/registry.mdx @@ -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. --- -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. + + + The registry is under active development, so expect its format and contents to + change. + ## Available Agents - + } - href="https://github.com/augmentcode/auggie-zed-extension" > - Augment Code's powerful software agent, backed by industry-leading - context engine -

+

0.14.0

} - href="https://github.com/zed-industries/claude-code-acp" > - ACP wrapper for Anthropic's Claude -

+

0.13.2

} - href="https://github.com/zed-industries/codex-acp" > - ACP adapter for OpenAI's coding assistant -

+

0.9.0

@@ -117,13 +124,13 @@ The ACP Agent Registry is a curated collection of agents implementing the Agent } > - Factory Droid - AI coding agent powered by Factory AI -

- 0.56.3 +

+ 0.52.0

} - href="https://github.com/google-gemini/gemini-cli" > - Google's official CLI for Gemini -

- 0.26.0 +

+ 0.25.2

} - href="https://github.com/github/copilot-language-server-release" > - GitHub's AI pair programmer -

+

1.417.0

} - href="https://github.com/mistralai/mistral-vibe" > - Mistral's open-source coding assistant -

- 2.0.0 +

+ 1.3.5

} - href="https://github.com/sst/opencode" > - The open source coding agent -

- 1.1.39 +

+ 1.1.36

} - href="https://github.com/QwenLM/qwen-code" > - Alibaba's Qwen coding assistant -

- 0.8.1 +

+ 0.7.2

- - **Work in Progress**: This registry is under active development. Format and - contents may change. - - - - 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. - - - - The registry is hosted at - [github.com/agentclientprotocol/registry](https://github.com/agentclientprotocol/registry). - Visit the repository to contribute your own agent. - - ## Using the Registry Clients can fetch the registry programmatically: @@ -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 diff --git a/docs/registry/_agents.mdx b/docs/registry/_agents.mdx deleted file mode 100644 index c6d08151..00000000 --- a/docs/registry/_agents.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: Official ACP Registry -description: Discover Agent Client Protocol agents ---- - - - -The ACP Agent Registry is a curated collection of agents implementing the Agent Client Protocol. - -## Available Agents - -$$AGENTS_CARDS$$ - - - **Work in Progress**: This registry is under active development. Format and - contents may change. - - - - 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. - - - - The registry is hosted at - [github.com/agentclientprotocol/registry](https://github.com/agentclientprotocol/registry). - Visit the repository to contribute your own agent. - - -## 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. - -## Contributing - -To add your agent to the registry: - -1. Fork the [registry repository](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. diff --git a/scripts/generate_registry_docs.py b/scripts/generate_registry_docs.py index 4f6a1950..bae1eca8 100755 --- a/scripts/generate_registry_docs.py +++ b/scripts/generate_registry_docs.py @@ -11,6 +11,7 @@ Environment variables: REGISTRY_URL: Override the default CDN URL (optional) """ + from __future__ import annotations import json @@ -27,8 +28,8 @@ ROOT = Path(__file__).resolve().parents[1] DOCS_DIR = ROOT / "docs" -TEMPLATE_PATH = DOCS_DIR / "registry" / "_agents.mdx" -OUTPUT_PATH = DOCS_DIR / "registry" / "index.mdx" +TEMPLATE_PATH = DOCS_DIR / "get-started" / "_registry_agents.mdx" +OUTPUT_PATH = DOCS_DIR / "get-started" / "registry.mdx" PLACEHOLDER = "$$AGENTS_CARDS$$" # SVG attribute mappings for JSX compatibility @@ -118,7 +119,7 @@ def _render_agent_cards(agents: list[dict]) -> str: # Sort agents by name agents = sorted(agents, key=lambda a: a.get("name", "").lower()) - lines: list[str] = [""] + lines: list[str] = [""] for agent in agents: agent_id = agent.get("id", "-")