Skip to main content

Codex A2A runtime adapter

Project description

codex-a2a

Expose Codex through A2A.

codex-a2a adds an A2A runtime layer to the local Codex runtime, with auth, streaming, session continuity, interrupt handling, a built-in outbound A2A client, and a clear deployment boundary.

What This Is

  • An A2A adapter service for the local Codex runtime, with inbound runtime exposure plus outbound peer calling.
  • It supports both roles in one process: serving as an A2A Server and hosting an embedded A2A Client for a2a_call and CLI-driven peer calls.

Architecture

flowchart TD
    External["A2A Clients / a2a-client-hub / Gateways"]

    subgraph Adapter["codex-a2a Runtime"]
        Ingress["Inbound A2A Surface\nHTTP+JSON + JSON-RPC"]
        Codex["Codex Runtime / Executor"]
        Outbound["Embedded A2A Client\nCLI call + a2a_call"]
    end

    subgraph Peers["Peer A2A Services"]
        PeerA2A["Peer A2A Agent"]
        PeerRuntime["Peer Runtime"]
        PeerA2A --> PeerRuntime
    end

    External -->|message/send,\nmessage:stream| Ingress
    Ingress -->|task execution| Codex
    Codex -->|stream events / tool results| Ingress
    Codex -->|a2a_call tool| Outbound
    Outbound -->|message/send,\nmessage:stream| PeerA2A
    PeerA2A -->|task / stream result| Outbound

Quick Start

Install the released CLI with uv tool:

uv tool install codex-a2a

Upgrade later with:

uv tool upgrade codex-a2a

Install an exact release with:

uv tool install "codex-a2a==<version>"

Before starting the runtime:

  • Install and verify the local codex CLI itself.
  • Configure Codex with a working provider/model setup and any required credentials.
  • codex-a2a does not provision Codex providers, login state, or API keys for you.
  • Startup fails fast if the local codex runtime is missing or cannot initialize.

Self-start the released CLI against a workspace root:

A2A_BEARER_TOKEN="$(python -c 'import secrets; print(secrets.token_hex(24))')" \
A2A_HOST=127.0.0.1 \
A2A_PORT=8000 \
A2A_PUBLIC_URL=http://127.0.0.1:8000 \
A2A_DATABASE_URL=sqlite+aiosqlite:///./codex-a2a.db \
CODEX_WORKSPACE_ROOT=/abs/path/to/workspace \
codex-a2a

Agent Card: http://127.0.0.1:8000/.well-known/agent-card.json

Authenticated extended card:

  • JSON-RPC: agent/getAuthenticatedExtendedCard
  • HTTP: GET /v1/card

Outbound peer auth is configured with A2A_CLIENT_BEARER_TOKEN or A2A_CLIENT_BASIC_AUTH; see the Usage Guide for the complete client-side matrix.

Highlights

  • A2A HTTP+JSON endpoints such as /v1/message:send and /v1/message:stream
  • A2A JSON-RPC support on POST /
  • Embedded client access through codex-a2a call
  • Autonomous outbound peer calls through the a2a_call tool
  • SSE streaming with normalized text, reasoning, and tool_call blocks
  • Session continuity and session query extensions
  • Interrupt lifecycle mapping and callback validation
  • Transport selection, Agent Card discovery, timeout control, and bearer/basic auth for outbound A2A calls
  • Payload logging controls, secret-handling guardrails, and released-CLI startup / source-based runtime paths

Boundaries

Portable vs Private Surface:

  • Treat the core A2A send / stream / task methods plus Agent Card discovery as the portable baseline.
  • Treat codex.* methods and metadata.codex.directory as the Codex-specific control plane for Codex-aware clients.
  • Treat one deployed instance as a single-tenant trust boundary, not a hardened multi-tenant runtime.

The normative compatibility split and deployment model live in Compatibility Guide and Security Policy.

When To Use It

Use this project when:

  • you want to keep Codex as the runtime
  • you need A2A transports and Agent Card discovery
  • you want a thin service boundary instead of building your own adapter
  • you want inbound serving and outbound peer access in one deployable unit

Look elsewhere if:

  • you need hard multi-tenant isolation inside one shared runtime
  • you want this project to manage your process supervisor or host bootstrap
  • you want a general client integration layer rather than a runtime adapter

Recommended Client Side

If you want a broader application-facing client integration layer, prefer a2a-client-hub.

It is a better place for higher-level client concerns such as A2A consumption, upstream adapter normalization, and application-facing integration, while codex-a2a stays focused on the runtime boundary around Codex plus embedded peer calling.

Further Reading

  • Usage Guide Runtime configuration, outbound access, transport usage, and client examples.
  • Extension Specifications Stable extension URI/spec index plus public-vs-extended card disclosure rules.
  • Architecture Guide System structure, boundaries, and request flow.
  • Compatibility Guide Supported Python/runtime surface, extension stability, and ecosystem-facing compatibility expectations.
  • Security Policy Threat model, deployment caveats, and vulnerability disclosure guidance.

Development

For contributor workflow, validation, release handling, and helper scripts, see Contributing Guide and Scripts Reference. Use that workflow to create a PR from the working branch and merge into main after human review.

License

Apache License 2.0. See LICENSE.

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

codex_a2a-0.5.2.tar.gz (285.9 kB view details)

Uploaded Source

Built Distribution

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

codex_a2a-0.5.2-py3-none-any.whl (149.8 kB view details)

Uploaded Python 3

File details

Details for the file codex_a2a-0.5.2.tar.gz.

File metadata

  • Download URL: codex_a2a-0.5.2.tar.gz
  • Upload date:
  • Size: 285.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for codex_a2a-0.5.2.tar.gz
Algorithm Hash digest
SHA256 0b368125c661accb95530b690c9ee0d3692e41903ce0333bbba974301aa0e76c
MD5 725b7aa0a532908305dcb6755153a018
BLAKE2b-256 5c6edfa37a8827f7a24f0fed36cd94ff119dbd9a9f486c18b0190c736aeabff6

See more details on using hashes here.

Provenance

The following attestation bundles were made for codex_a2a-0.5.2.tar.gz:

Publisher: publish.yml on liujuanjuan1984/codex-a2a

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file codex_a2a-0.5.2-py3-none-any.whl.

File metadata

  • Download URL: codex_a2a-0.5.2-py3-none-any.whl
  • Upload date:
  • Size: 149.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for codex_a2a-0.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4503166a7613714be95494baf5d3be77f66d355b69bb7fa29a12a137d9918a47
MD5 04d578fa467ff50c1aa6f34c9fb739ae
BLAKE2b-256 eea61b3225da1326642bcdf49573c73285d1d9a94ff1d2c5303b8325ddf49773

See more details on using hashes here.

Provenance

The following attestation bundles were made for codex_a2a-0.5.2-py3-none-any.whl:

Publisher: publish.yml on liujuanjuan1984/codex-a2a

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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