The official TypeScript implementation of the Agent Client Protocol (ACP) — a standardized communication protocol between code editors and AI-powered coding agents.
Learn more at https://agentclientprotocol.com
npm install @agentclientprotocol/sdkWarning: ACP v2 is still a draft. Its wire protocol and this TypeScript API may change incompatibly in any SDK release. Use it only if you are prepared to track the draft as it evolves.
The stable package entry point remains ACP v1. ACP v2 requires an explicit experimental import:
import * as acp from "@agentclientprotocol/sdk/experimental/v2";Browse the experimental v2 TypeScript API reference and the draft ACP v2 protocol documentation for the current SDK and protocol designs.
In v2, the extensible unions (SessionUpdate, ContentBlock, and so on) also
accept variants this SDK does not know, such as ones added by a newer ACP
version. Only received values can be such an UnknownVariant, so a value you
build is checked field by field at any depth, and a custom variant needs a tag
that starts with _. Received values pass on unchanged, for example when an
agent echoes a prompt's content into its user message.
Start by reading the official ACP documentation to understand the core concepts and protocol specification.
The examples directory contains simple implementations of both Agents and Clients in TypeScript. These examples can be run from your terminal or from an ACP Client like Zed, making them great starting points for your own integration!
Browse the TypeScript library reference for detailed API documentation.
If you're building an Agent, start with agent({ name }), register handlers such as initialize(...), newSession(...), and prompt(...), then call connect(stream).
If you're building a Client, start with client({ name }), register client-side handlers such as requestPermission(...) and sessionUpdate(...), then run your agent workflow with connectWith(stream, async (ctx) => ...).
For a complete, production-ready implementation, check out the Gemini CLI Agent.
See the main repository for contribution guidelines.
By contributing, you agree that your contributions will be licensed under the Apache 2.0 License.