Skip to content

docs: add registry page with auto-sync from CDN #397

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
ignatov merged 1 commit into from
Jan 25, 2026
+629 −0
Merged

docs: add registry page with auto-sync from CDN #397

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
72 changes: 72 additions & 0 deletions .github/workflows/sync-registry.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
name: Sync Registry Docs

on:
# Allow manual trigger
workflow_dispatch:

# Run hourly to pick up registry changes
schedule:
- cron: "15 * * * *" # Every hour at :15

permissions:
contents: write
pull-requests: write

jobs:
sync:
name: Sync Registry Documentation
runs-on: ubuntu-latest
timeout-minutes: 5

steps:
- uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4

- name: Set up Python
uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5
with:
python-version: "3.11"

- name: Set up Node.js
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
with:
node-version: latest
cache: "npm"

- name: Install dependencies
run: npm ci

- name: Generate registry docs
run: python scripts/generate_registry_docs.py

- name: Format generated files
run: npx prettier --write docs/registry/

- name: Check for changes
id: changes
run: |
if git diff --quiet docs/registry/index.mdx; then
echo "changed=false" >> $GITHUB_OUTPUT
else
echo "changed=true" >> $GITHUB_OUTPUT
fi

- name: Create Pull Request
id: cpr
if: steps.changes.outputs.changed == 'true'
uses: peter-evans/create-pull-request@c5a7806660adbe173f04e3e038b0ccdcd758773c # v6
with:
commit-message: "docs: update registry agents"
title: "docs: update registry agents"
body: |
This PR updates the registry documentation with the latest agents from the ACP Registry CDN.

Auto-generated by the sync-registry workflow.
branch: auto/sync-registry
delete-branch: true
labels: documentation

- name: Enable auto-merge
if: steps.cpr.outputs.pull-request-number
run: gh pr merge --squash --auto "${{ steps.cpr.outputs.pull-request-number }}"
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
4 changes: 4 additions & 0 deletions docs/docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,10 @@
"libraries/typescript",
"libraries/community"
]
},
{
"group": "Registry",
"pages": ["registry/index"]
}
]
},
Expand Down
58 changes: 58 additions & 0 deletions docs/registry/_agents.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
title: Official ACP Registry
description: Discover Agent Client Protocol agents
---

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

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

## Available Agents

$$AGENTS_CARDS$$

<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:

```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.
Loading