Skip to main content

A2UI Agent SDK

Project description

A2UI Agent implementation

The agent_sdks/python/src/a2ui directory contains the Python implementation of the A2UI agent SDK.

Core Components

The following directories contain the base protocol logic, parsing, and schema operations directly under src/a2ui/:

Schema Management (src/a2ui/schema)

  • manager.py: The A2uiSchemaManager handles loading specification schemas, managing catalogs, and generating system prompts for LLMs.
  • validator.py: Implements A2uiValidator for validating A2UI messages against JSON schemas and protocol rules.
  • catalog.py: Defines A2uiCatalog and CatalogConfig for handling component libraries.

Parser (src/a2ui/parser)

  • parser.py: Implementation of parse_response for synchronous parsing.
  • streaming.py: Incremental streaming parsers with automatic JSON healing and validation.
  • payload_fixer.py: Utilities to automatically correct common LLM output issues in A2UI payloads.

Basic Catalog (src/a2ui/basic_catalog)

  • provider.py: Implementation of BasicCatalog for handling the basic A2UI components.

A2A (src/a2ui/a2a)

  • extension.py: Utilities for managing the A2UI extension URI and activation logic.
  • parts.py: Utilities for creating A2A Parts with A2UI data and helpers for response parsing.

ADK Extensions (src/a2ui/adk)

Support for the Agent Development Kit (ADK) and A2A protocol.

  • send_a2ui_to_client_toolset.py: Implementation of SendA2uiToClientToolset to enable agents to send UI to clients via tool calls.

Running tests

  1. Navigate to the directory:

    cd agent_sdks/python
    
  2. Run the tests

    uv run pytest
    

Building the SDK

To build the SDK, run the following command from the agent_sdks/python directory:

uv build .

Formatting code

To format the code, run the following command from the agent_sdks/python directory:

uv run pyink .

Releasing the SDK

To release a new version of the SDK, follow these steps:

  1. Update the version in src/a2ui/version.py.

  2. Run the release script from the agent_sdks/python directory:

    ./release.sh
    

The script will build the package, upload it to the Artifact Registry, and trigger the release pipeline.

Tracking the release

  1. Check the release status through Sponge: go/spng2?q=PROJECT%3Aa2ui%2Fpypi
  2. You will see logs for the jobs involved in your release. A successful release is confirmed when the final job, named "publisher", completes successfully.

Disclaimer

Important: The sample code provided is for demonstration purposes and illustrates the mechanics of A2UI and the Agent-to-Agent (A2A) protocol. When building production applications, it is critical to treat any agent operating outside of your direct control as a potentially untrusted entity.

All operational data received from an external agent—including its AgentCard, messages, artifacts, and task statuses—should be handled as untrusted input. For example, a malicious agent could provide crafted data in its fields (e.g., name, skills.description) that, if used without sanitization to construct prompts for a Large Language Model (LLM), could expose your application to prompt injection attacks.

Similarly, any UI definition or data stream received must be treated as untrusted. Malicious agents could attempt to spoof legitimate interfaces to deceive users (phishing), inject malicious scripts via property values (XSS), or generate excessive layout complexity to degrade client performance (DoS). If your application supports optional embedded content (such as iframes or web views), additional care must be taken to prevent exposure to malicious external sites.

Developer Responsibility: Failure to properly validate data and strictly sandbox rendered content can introduce severe vulnerabilities. Developers are responsible for implementing appropriate security measures—such as input sanitization, Content Security Policies (CSP), strict isolation for optional embedded content, and secure credential handling—to protect their systems and users.

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

a2ui_agent_sdk-0.2.3.tar.gz (279.8 kB view details)

Uploaded Source

Built Distribution

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

a2ui_agent_sdk-0.2.3-py3-none-any.whl (85.8 kB view details)

Uploaded Python 3

File details

Details for the file a2ui_agent_sdk-0.2.3.tar.gz.

File metadata

  • Download URL: a2ui_agent_sdk-0.2.3.tar.gz
  • Upload date:
  • Size: 279.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.11.2

File hashes

Hashes for a2ui_agent_sdk-0.2.3.tar.gz
Algorithm Hash digest
SHA256 54b8649b187c231c25519dca4de7b3be754b3dadba8169b65c2585183ececbae
MD5 8494a7ee3b57297604f6e9a2764263a9
BLAKE2b-256 982338153e2277bfadc5f3acbd56d3a063a347bc631ae0607c1f43d456ac8f17

See more details on using hashes here.

Provenance

The following attestation bundles were made for a2ui_agent_sdk-0.2.3.tar.gz:

Publisher: a2ui-py@oss-exit-gate-prod.iam.gserviceaccount.com

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.
  • Statement: Publication detail:
    • Token Issuer: https://accounts.google.com
    • Service Account: a2ui-py@oss-exit-gate-prod.iam.gserviceaccount.com

File details

Details for the file a2ui_agent_sdk-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: a2ui_agent_sdk-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 85.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.11.2

File hashes

Hashes for a2ui_agent_sdk-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 472d7d8c0f7e8dab85285e9f72a007a609fb4bd4bd12e096f22094066384df79
MD5 c4886e573a305e048253a9fa87721f0f
BLAKE2b-256 5361dd7dcef66dc93676a0c44dd8ad6ccc9a4160492e5ee670c4f4831c53c7a4

See more details on using hashes here.

Provenance

The following attestation bundles were made for a2ui_agent_sdk-0.2.3-py3-none-any.whl:

Publisher: a2ui-py@oss-exit-gate-prod.iam.gserviceaccount.com

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.
  • Statement: Publication detail:
    • Token Issuer: https://accounts.google.com
    • Service Account: a2ui-py@oss-exit-gate-prod.iam.gserviceaccount.com

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