A2ui Implement New Sdks For Client Language
Developmenta2ui-implement-new-sdks-for-client-languageA2ui Implement New Sdks For Client Language is an Agent Skill for development published in the a2ui-project/a2ui repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Step-by-step phased instructions for building new A2UI Core SDKs, Framework Adapters, and Inference SDKs from scratch in any client language.
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/a2ui-project/a2ui/blob/HEAD/.agents/skills/a2ui-implement-new-sdks-for-client-language/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/a2ui-implement-new-sdks-for-client-language, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
A2UI SDK Implementation Guide (Phased Execution)
This skill provides expert instructions and sequences for AI agents or contributors tasked with implementing A2UI Core SDKs, Framework Adapters, or Agent/Inference SDKs in a new programming language or UI framework.
1. Core State SDK Phases
If you are building a new Core SDK (e.g., in Rust, Swift, Go, or C++), you must follow this sequence of phases:
Phase 1: Context & Schemas Ingestion
Thoroughly review:
blueprints/modules/a2ui_core.blueprint.md(for state and message structures).specification/v1_0/json/common_types.json(dynamic binding schemas).specification/v1_0/json/server_to_client.json(message envelopes).specification/v1_0/catalogs/basic/catalog.json(target components catalog).
Phase 2: Technical Architecture Planning
Create a detailed, local architectural proposal detailing:
- Dependencies: Which Schema library and Observable/Reactive library will you use? Note that the reactive library must support both discrete event subscription and stateful, signal-like data streams (e.g., BehaviorSubject/Signal).
- Component APIs: How will you define the
ComponentApiinterface in this language? - Binding Strategy: How will you structure the abstract Core Binder Layer?
- STOP and obtain human reviewer approval on this plan before writing code.
Phase 3: Core Model Layer
Implement the framework-agnostic data and processor layers:
- Observables & Signals: Implement multi-cast reactive streams with clear unsubscribe mechanism to prevent leaks.
- Protocol Structures: Create strictly-typed native classes/structs representing
A2uiMessageenvelopes and client capabilities with serialization/deserialization. - DataModel & JSON Pointers: Implement relative/absolute path resolution, auto-vivification (auto-typing intermediate segments), and bubble/cascade path change notifications.
- Core State Models: Implement
ComponentModel,SurfaceComponentsModel,SurfaceModel, andSurfaceGroupModel. - Context Mapping: Implement
DataContextandComponentContext. - MessageProcessor: Ingest incoming messages and mutate the state models. Generate
inlineCatalogsclient capabilities. - Verification: Write comprehensive unit tests for pointer cascading, JSON deserialization/validation, and message dispatching.
Phase 4: Foundational Basic Catalog Support
Bootstrap support for the Basic Catalog:
- Foundational Components: Define the pure API schemas and Binders for:
Text,Row,Column,Button, andTextField. - Foundational Functions: Implement
formatStringto interpret${expression}syntaxes, supporting recursive token evaluations and reactive coercion. - Verification: Ensure properties update reactively when underlying data paths emit notifications.
Phase 5: Complete Basic Catalog Support
- Full Components & Binders: Define core binders for all other components in
basic/catalog.json. - Full Functions: Implement remaining basic mathematical, logical, and array operations.
- Validation: Ensure strict type coercion rules are satisfied and memory disposals work flawlessly.
2. Framework Adapter SDK Phases
If you are building a new UI Framework Adapter / Renderer (e.g., in Flutter/Dart, SwiftUI, Jetpack Compose, Vue, or Svelte), follow this sequence:
Phase 1: Ingestion & Core Integration
Review:
blueprints/modules/a2ui_framework_adapter.blueprint.md(View and rendering architecture).specification/v1_0/docs/basic_catalog_implementation_guide.md(spacing, alignment, and typography specifications).
Phase 2: Architectural Plan
Draft a plan specifying:
- Component Registry: How components are dynamically resolved and instantiated.
- Surface Widget: How the root canvas mounts and recurses through the layout tree starting at
root. - Observer/State Bridge: Which Strategy (Direct, Predefined Binders, or Automated wrappers) will connect core signals to native views.
- STOP and obtain human reviewer approval on this plan.
Phase 3: Adapter & Lifecycle Layer
- Implement
ComponentImplementationbase traits/classes. - Implement the framework-native
Surfaceentrypoint widget. - Implement subscription management: lazy-subscribing only on mount, handling path stability updates, and strictly calling
dispose()on unmount.
Phase 4: Bootstrapping Basic Catalog Rendering
- Build native visual elements for:
Text,Row,Column,Button, andTextField. - Bundle these elements into the first framework catalog adapter.
- Verify reactive layout properties dynamically.
Phase 5: Gallery Application Milestone
Build the Gallery App as a testing playground with:
- Left Column: Sample navigation.
- Center Column: Surface preview, JSON message stream, and step-by-step interactive message stepper.
- Right Column: Live data model inspect pane and action logger.
- Load the 5 foundational verification examples:
00_simple-text.json,00_row-layout.json,00_complex-layout.json,00_interactive-button.json, and00_simple-login-form.json. - STOP and obtain human reviewer approval of the UI and visual rendering performance.
Phase 6: Full Catalog Support
- Implement all remaining widgets (e.g. Card, Image, List, etc.) and validation traits like
Checkable. - Update the Gallery App to support all official examples in
specification/v1_0/catalogs/basic/examples/. - Run visual parity and event action tests to verify correctness.