Skip to content

Commit 26ab76d

Browse files
committed
fix: Update server and client transport descriptions in the README
1 parent f7cf1bf commit 26ab76d

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

README.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,16 +40,19 @@ The A2A Java SDK provides a Java server implementation of the [Agent2Agent (A2A)
4040
- [Add a class that creates an A2A Agent Card](#2-add-a-class-that-creates-an-a2a-agent-card)
4141
- [Add a class that creates an A2A Agent Executor](#3-add-a-class-that-creates-an-a2a-agent-executor)
4242

43-
### 1. Add the A2A Java SDK Server Maven dependency to your project
43+
### 1. Add an A2A Java SDK Reference Server dependency to your project
4444

45-
Adding a dependency on an A2A Java SDK Server will provide access to the core classes that make up the A2A specification
46-
and allow you to run your agentic Java application as an A2A server agent.
45+
Adding a dependency on an A2A Java SDK Reference Server will provide access to the core classes
46+
that make up the A2A specification and allow you to run your agentic Java application as an A2A server agent.
4747

48-
The A2A Java SDK provides a [reference A2A server implementation](reference-impl/README.md) based on [Quarkus](https://quarkus.io) for use with our tests and examples. However, the project is designed in such a way that it is trivial to integrate with various Java runtimes.
48+
The A2A Java SDK provides [reference A2A server implementations](reference) based on [Quarkus](https://quarkus.io) for use with our tests and examples. However, the project is designed in such a way that it is trivial to integrate with various Java runtimes.
4949

5050
[Server Integrations](#server-integrations) contains a list of community contributed integrations of the server with various runtimes. You might be able to use one of these for your target runtime, or you can use them as inspiration to create your own.
5151

52-
To use the reference implementation with the JSONRPC protocol add the following dependency to your project:
52+
#### Server Transports
53+
The A2A Java SDK Reference Server implementations support a couple transports: JSON-RPC 2.0 and gRPC.
54+
55+
To use the reference implementation with the JSON-RPC protocol, add the following dependency to your project:
5356

5457
> *⚠️ The `io.github.a2asdk` `groupId` below is temporary and will likely change for future releases.*
5558
@@ -62,7 +65,7 @@ To use the reference implementation with the JSONRPC protocol add the following
6265
</dependency>
6366
```
6467

65-
To use the reference implementation with the gRPC protocol add the following dependency to your project:
68+
To use the reference implementation with the gRPC protocol, add the following dependency to your project:
6669

6770
> *⚠️ The `io.github.a2asdk` `groupId` below is temporary and will likely change for future releases.*
6871
@@ -75,6 +78,11 @@ To use the reference implementation with the gRPC protocol add the following dep
7578
</dependency>
7679
```
7780

81+
Note that you can add more than one of the above dependencies to your project depending on the transports
82+
you'd like to support.
83+
84+
Support for the HTTP+JSON/REST transport will be coming soon.
85+
7886
### 2. Add a class that creates an A2A Agent Card
7987

8088
```java
@@ -233,7 +241,7 @@ that you can use to create your A2A `Client`.
233241
</dependency>
234242
```
235243

236-
### 2. Add dependencies on the A2A Java SDK Client Transport(s) you'd like to use
244+
### 2. Add one or more dependencies on the A2A Java SDK Client Transport(s) you'd like to use
237245

238246
You need to add a dependency on at least one of the following client transport modules:
239247

@@ -569,7 +577,8 @@ The following list contains community contributed integrations with various Java
569577

570578
To contribute an integration, please see [CONTRIBUTING_INTEGRATIONS.md](CONTRIBUTING_INTEGRATIONS.md).
571579

572-
* [reference-impl/README.md](reference-impl/README.md) - Reference implementation, based on Quarkus.
580+
* [reference/jsonrpc/README.md](reference/jsonrpc/README.md) - JSON-RPC 2.0 Reference implementation, based on Quarkus.
581+
* [reference/grpc/README.md](reference/grpc/README.md) - gRPC Reference implementation, based on Quarkus.
573582
* https://github.com/wildfly-extras/a2a-java-sdk-server-jakarta - This integration is based on Jakarta EE, and should work in all runtimes supporting the [Jakarta EE Web Profile](https://jakarta.ee/specifications/webprofile/).
574583

575584

0 commit comments

Comments
 (0)