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.9.0.tar.gz (71.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.9.0-py3-none-any.whl (56.9 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for agent_client_protocol-0.9.0.tar.gz
Algorithm Hash digest
SHA256 f744c48ab9af0f0b4452e5ab5498d61bcab97c26dbe7d6feec5fd36de49be30b
MD5 6a40f8a71e6d7d95741ebb86a4c7fe90
BLAKE2b-256 eb133b893421369767e7043cc115d6ef0df417c298b84563be3a12df0416158d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for agent_client_protocol-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 06911500b51d8cb69112544e2be01fc5e7db39ef88fecbc3848c5c6f194798ee
MD5 f1b83b75f444f37bc34299ba45d3b101
BLAKE2b-256 8fedc284543c08aa443a4ef2c8bd120be51da8433dd174c01749b5d87c333f22

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