Skip to content

Commit 7b53849

Browse files
authored
docs: Update readme (#127)
1 parent 5569d8d commit 7b53849

1 file changed

Lines changed: 27 additions & 0 deletions

File tree

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,33 @@ The Agent Client Protocol (ACP) standardizes communication between _code editors
88

99
Learn more at [agentclientprotocol.com](https://agentclientprotocol.com/).
1010

11+
This repository is the official **Rust SDK** for ACP. It provides crates for building clients, agents, and proxies, plus a conductor that orchestrates chains of proxies between an editor and an agent so that behavior can be extended without modifying the agent itself.
12+
13+
## Crates
14+
15+
**Core SDK**
16+
17+
- [`agent-client-protocol`](./src/agent-client-protocol/) – Roles (Client, Agent, Proxy, Conductor), connection builders, handlers, and protocol types.
18+
- [`agent-client-protocol-tokio`](./src/agent-client-protocol-tokio/) – Tokio utilities for spawning agent processes and wiring stdio transports.
19+
- [`agent-client-protocol-rmcp`](./src/agent-client-protocol-rmcp/) – Integration with the [`rmcp`](https://docs.rs/rmcp) MCP SDK.
20+
- [`agent-client-protocol-derive`](./src/agent-client-protocol-derive/) – Derive macros used by the core crate.
21+
22+
**Proxy orchestration**
23+
24+
- [`agent-client-protocol-conductor`](./src/agent-client-protocol-conductor/) – Binary and library that manages chains of proxy components.
25+
- [`agent-client-protocol-trace-viewer`](./src/agent-client-protocol-trace-viewer/) – Interactive sequence-diagram viewer for conductor trace files.
26+
27+
**Patterns, examples, and testing**
28+
29+
- [`agent-client-protocol-cookbook`](./src/agent-client-protocol-cookbook/) – Practical patterns for clients, agents, and proxies, rendered as rustdoc.
30+
- [`agent-client-protocol-test`](./src/agent-client-protocol-test/) – Shared test utilities and fixtures.
31+
- [`yopo`](./src/yopo/) – "You Only Prompt Once", an example client.
32+
33+
## Documentation
34+
35+
- **API reference** for individual crates is on [docs.rs/agent-client-protocol](https://docs.rs/agent-client-protocol).
36+
- **Design and architecture documentation** lives in the mdbook at [agentclientprotocol.github.io/rust-sdk](https://agentclientprotocol.github.io/rust-sdk/). Source is in [`md/`](./md/).
37+
1138
## Integrations
1239

1340
- [Schema](./schema/schema.json)

0 commit comments

Comments
 (0)