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.8.1.tar.gz (68.9 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.8.1-py3-none-any.whl (54.5 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for agent_client_protocol-0.8.1.tar.gz
Algorithm Hash digest
SHA256 1bbf15663bf51f64942597f638e32a6284c5da918055d9672d3510e965143dbd
MD5 32a5ec5cbede91c3f55a9e6530604e3f
BLAKE2b-256 1b7b7cdac86db388809d9e3bc58cac88cc7dfa49b7615b98fab304a828cd7f8a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for agent_client_protocol-0.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9421a11fd435b4831660272d169c3812d553bb7247049c138c3ca127e4b8af8e
MD5 a1b726c4b5107386980d80722f788744
BLAKE2b-256 4bf3219eeca0ad4a20843d4b9eaac5532f87018b9d25730a62a16f54f6c52d1a

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