Skip to content
/ a2a4j Public

A2A4J is a comprehensive Java implementation of the Agent2Agent Protocol, including server, client, examples, and starters.

License

Notifications You must be signed in to change notification settings

a2ap/a2a4j

Repository files navigation

A2A4J - Agent2Agent Protocol for Java

Maven Central License Java Version

πŸ“– δΈ­ζ–‡ζ–‡ζ‘£

Agent2Agent (A2A) providing an open standard for communication and interoperability between independent AI agent systems.

A2A4J A2A4J is a comprehensive Java implementation of the Agent2Agent (A2A) Protocol, including server, client, examples, and starters. Built on Reactor for reactive programming support, A2A4J enables agents to discover each other's capabilities, collaborate on tasks, and securely exchange information without needing access to each other's internal state.

πŸš€ Features

  • βœ… Complete A2A Protocol Support - Full implementation of the Agent2Agent specification
  • βœ… JSON-RPC 2.0 Communication - Standards-based request/response messaging
  • βœ… Server-Sent Events Streaming - Real-time task updates and streaming responses
  • βœ… Task Lifecycle Management - Comprehensive task state management and monitoring
  • βœ… Spring Boot Integration - Easy integration with Spring Boot applications
  • βœ… Reactive Programming Support - Built on Reactor for scalable, non-blocking operations
  • βœ… Multiple Content Types - Support for text, files, and structured data exchange
  • βšͺ️ Agent Card Discovery - Dynamic capability discovery mechanism
  • βšͺ️ Push Notification Configuration - Asynchronous task updates via webhooks
  • βšͺ️ Enterprise Security - Authentication and authorization support

πŸ“‹ Prerequisites

  • Java 17+ - Required for running the application
  • Maven 3.6+ - Build tool

πŸ—οΈ Project Structure

a2a4j/
β”œβ”€β”€ a2a4j-bom/                     # A2A4J dependency management
β”œβ”€β”€ a2a4j-core/                    # Core A2A protocol implementation
β”œβ”€β”€ a2a4j-spring-boot-starter/     # Spring Boot auto-configuration
β”‚   β”œβ”€β”€ a2a4j-server-spring-boot-starter/   # Server-side starter
β”‚   └── a2a4j-client-spring-boot-starter/   # Client-side starter
β”œβ”€β”€ a2a4j-samples/                 # Example implementations
β”‚   └── server-hello-world/        # Hello World server example
β”‚   └── client-hello-world/        # Hello World client example
β”œβ”€β”€ specification/                 # A2A protocol specification
β”œβ”€β”€ tools/                        # Development tools and configuration

πŸš€ Quick Start

1. Use A2Aj Build Agent

Integrate A2A4j SDK

If you’re building on the SpringBoot framework, it is recommended to use a2a4j-server-spring-boot-starter.

<dependency>
    <groupId>io.github.a2ap</groupId>
    <artifactId>a2a4j-server-spring-boot-starter</artifactId>
    <version>0.0.1</version>
</dependency>

For other frameworks, it is recommended to use a2a4j-core.

<dependency>
    <groupId>io.github.a2ap</groupId>
    <artifactId>a2a4j-core</artifactId>
    <version>0.0.1</version>
</dependency>

Expose an External Endpoint

@RestController
public class MyA2AController {

    @Autowired
    private A2AServer a2aServer;
    @Autowired
    private final Dispatcher a2aDispatch;

    @GetMapping(".well-known/agent.json")
    public ResponseEntity<AgentCard> getAgentCard() {
        AgentCard card = a2aServer.getSelfAgentCard();
        return ResponseEntity.ok(card);
    }

    @PostMapping(value = "/a2a/server", produces = MediaType.APPLICATION_JSON_VALUE)
    public ResponseEntity<JSONRPCResponse> handleA2ARequestTask(@RequestBody JSONRPCRequest request) {
        return ResponseEntity.ok(a2aDispatch.dispatch(request));
    }

    @PostMapping(value = "/a2a/server", produces = MediaType.TEXT_EVENT_STREAM_VALUE)
    public Flux<ServerSentEvent<JSONRPCResponse>> handleA2ARequestTaskSubscribe(@RequestBody JSONRPCRequest request) {
        return a2aDispatch.dispatchStream(request).map(event -> ServerSentEvent.<JSONRPCResponse>builder()
                .data(event).event("task-update").build());
    }
}

Implementing the AgentExecutor Interface for Agent Task Execution

@Component
public class MyAgentExecutor implements AgentExecutor {

    @Override
    public Mono<Void> execute(RequestContext context, EventQueue eventQueue) {
        // your agent logic code
        TaskStatusUpdateEvent completedEvent = TaskStatusUpdateEvent.builder()
                .taskId(taskId)
                .contextId(contextId)
                .status(TaskStatus.builder()
                        .state(TaskState.COMPLETED)
                        .timestamp(String.valueOf(Instant.now().toEpochMilli()))
                        .message(createAgentMessage("Task completed successfully! Hi you."))
                        .build())
                .isFinal(true)
                .metadata(Map.of(
                        "executionTime", "3000ms",
                        "artifactsGenerated", 4,
                        "success", true))
                .build();

        eventQueue.enqueueEvent(completedEvent);
        return Mono.empty();
    }
}

Done

That’s it β€” these are the main steps. For detailed implementation, please refer to our Agent Demo example.

2. Test Run Agent Example

Run the Server Hello World

git clone https://github.com/a2ap/a2a4j.git

cd a2a4j

mvn clean install

cd a2a4j-samples/server-hello-world

mvn spring-boot:run

The server will start at http://localhost:8089.

Get Agent Card

curl http://localhost:8089/.well-known/agent.json

Send a Message

curl -X POST http://localhost:8089/a2a/server \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "method": "message/send",
    "params": {
      "message": {
        "role": "user",
        "parts": [
          {
            "kind": "text",
            "text": "Hello, A2A!"
          }
        ],
        "messageId": "9229e770-767c-417b-a0b0-f0741243c589"
      }
    },
    "id": "1"
  }'

Stream Messages

curl -X POST http://localhost:8089/a2a/server \
  -H "Content-Type: application/json" \
  -H "Accept: text/event-stream" \
  -d '{
    "jsonrpc": "2.0",
    "method": "message/stream",
    "params": {
      "message": {
        "role": "user",
        "parts": [
          {
            "kind": "text",
            "text": "Hello, streaming A2A!"
          }
        ],
        "messageId": "9229e770-767c-417b-a0b0-f0741243c589"
      }
    },
    "id": "1"
  }'

πŸ“š Core Modules

A2A4J Core (a2a4j-core)

The core module provides the fundamental A2A protocol implementation:

  • Models: Data structures for Agent Cards, Tasks, Messages, and Artifacts
  • Server: Server-side A2A protocol implementation
  • Client: Client-side A2A protocol implementation
  • JSON-RPC: JSON-RPC 2.0 request/response handling
  • Exception Handling: Comprehensive error management

πŸ“– View Core Documentation

Spring Boot Starters

Server Starter (a2a4j-server-spring-boot-starter)

Auto-configuration for A2A servers with Spring Boot, providing:

  • Automatic endpoint configuration
  • Agent Card publishing
  • Task management
  • SSE streaming support

Client Starter (a2a4j-client-spring-boot-starter)

Auto-configuration for A2A clients with Spring Boot, providing:

  • Agent discovery
  • HTTP client configuration
  • Reactive client support

Examples (a2a4j-samples)

Complete working examples demonstrating A2A4J usage:

πŸ“Š JSON-RPC Methods

Core Methods

  • message/send - Send a message and create a task
  • message/stream - Send a message with streaming updates

Task Management

  • tasks/get - Get task status and details
  • tasks/cancel - Cancel a running task
  • tasks/resubscribe - Resubscribe to task updates

Push Notifications

  • tasks/pushNotificationConfig/set - Configure push notifications
  • tasks/pushNotificationConfig/get - Get notification configuration

πŸ“– Documentation

🀝 Contributing

We welcome contributions! Please see our Contributing Guidelines for details.

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/my-feature
  3. Commit your changes: git commit -am 'Add new feature'
  4. Push to the branch: git push origin feature/my-feature
  5. Submit a Pull Request

πŸ“„ License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

🌟 Support

πŸ”— Refer Projects


Built with ❀️ by the A2AP Community

About

A2A4J is a comprehensive Java implementation of the Agent2Agent Protocol, including server, client, examples, and starters.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Contributors 8