Skip to main content

A Python implement of Agent Client Protocol (ACP, by Zed Industries)

Project description

Agent Client Protocol

Agent Client Protocol (Python)

Build ACP-compliant agents and clients in Python with generated schema models, asyncio transports, helper builders, and runnable demos.

Releases track the upstream ACP schema; contributions that tighten coverage or tooling are always welcome.

Install

pip install agent-client-protocol
# or
uv add agent-client-protocol

At a glance

  • Spec parity: Generated Pydantic models in acp.schema track every ACP release so payloads stay valid.
  • Runtime ergonomics: Async base classes, stdio JSON-RPC plumbing, and lifecycle helpers keep custom agents tiny.
  • Examples ready: Streaming, permissions, Gemini bridge, and duet demos live under examples/.
  • Helper builders: acp.helpers mirrors the Go/TS SDK APIs for content blocks, tool calls, and session updates.
  • Contrib utilities: Session accumulators, tool call trackers, and permission brokers share patterns from real deployments.

Who benefits

  • Agent authors who need typed models, helper builders, and event-stream ergonomics for ACP-compatible assistants.
  • Client integrators embedding ACP parties inside Python applications or wrapping existing CLIs via stdio.
  • Tooling teams experimenting with permission flows, streaming UX, or Gemini bridges without re-implementing transports. See real adopters like kimi-cli in the Use Cases list.

How to get started

  • Follow the Quickstart guide for installation, echo-agent validation, editor wiring (e.g. Zed), and programmatic launch recipes.
  • Browse the example gallery to see progressively richer integrations you can copy or extend.
  • Skim the docs hub for focused references on contrib helpers, releasing, and transport details.

Quick links

Need Link
Docs hub https://agentclientprotocol.github.io/python-sdk/
Quickstart https://agentclientprotocol.github.io/python-sdk/quickstart/
Use cases https://agentclientprotocol.github.io/python-sdk/use-cases/
Contrib helpers https://agentclientprotocol.github.io/python-sdk/contrib/
Releasing workflow https://agentclientprotocol.github.io/python-sdk/releasing/
Examples https://github.com/agentclientprotocol/python-sdk/tree/main/examples
Tests https://github.com/agentclientprotocol/python-sdk/tree/main/tests
PyPI https://pypi.org/project/agent-client-protocol/

Project layout

  • src/acp/: runtime package (agents, clients, transports, helpers, schema bindings, contrib utilities)
  • schema/: upstream JSON schema sources (regenerate via make gen-all)
  • docs/: MkDocs content backing the published documentation
  • examples/: runnable scripts covering stdio orchestration patterns
  • tests/: pytest suite with golden fixtures and optional Gemini coverage

Developer commands

  • make install provisions the uv virtualenv and installs pre-commit hooks.
  • make check runs Ruff formatting/linting, type analysis, dependency hygiene, and lock verification.
  • make test executes pytest (with doctests) inside the managed environment.
  • ACP_SCHEMA_VERSION=<ref> make gen-all refreshes protocol artifacts when the schema advances.

Keep docs and examples current whenever you ship public API or transport changes, and prefer Conventional Commits (feat:, fix:, etc.) when submitting patches.

Community & support

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

agent_client_protocol-0.7.0.tar.gz (64.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

agent_client_protocol-0.7.0-py3-none-any.whl (52.9 kB view details)

Uploaded Python 3

File details

Details for the file agent_client_protocol-0.7.0.tar.gz.

File metadata

File hashes

Hashes for agent_client_protocol-0.7.0.tar.gz
Algorithm Hash digest
SHA256 c66811bb804868c4e7728b18b67379bcb0335afba3b1c2ff0fcdfd0c48d93029
MD5 a0bb2fe684832be351f50e21ed7bd880
BLAKE2b-256 7d4de33e4e997de8fdc6c7154e59490a20c455cd46543b62dab768ae99317046

See more details on using hashes here.

File details

Details for the file agent_client_protocol-0.7.0-py3-none-any.whl.

File metadata

File hashes

Hashes for agent_client_protocol-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 71fce4088fe7faa85b30278aecd1d8d6012f03505ae2ee6e312f9e2ba4ea1f4e
MD5 6d74a4a6455f267643525bf1f18b56e6
BLAKE2b-256 4a02257ea400cfee72a48dabe04ef0a984c496c9687830cf7977b327979e8cd7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page