Skip to content

fix(proto): correct gRPC URL example in AgentInterface#1997

Open
Tehsmash wants to merge 3 commits into
mainfrom
fix/1388-grpc-agent-interface-url-example
Open

fix(proto): correct gRPC URL example in AgentInterface#1997
Tehsmash wants to merge 3 commits into
mainfrom
fix/1388-grpc-agent-interface-url-example

Conversation

@Tehsmash

Copy link
Copy Markdown
Contributor

Summary

Fixes the incorrect gRPC URL example in the AgentInterface message of a2a.proto.

Problem: The example showed "https://grpc.example.com/a2a" for a gRPC interface, but gRPC URLs do not use an https:// scheme or a path. The correct format is hostname:port.

Fix:

  • Updated the example URL from "https://grpc.example.com/a2a" to "grpc.example.com:443"
  • Clarified the field comment to note that the HTTPS URL requirement applies to HTTP-based transports only, while gRPC uses hostname:port format

Fixes #1388

@Tehsmash
Tehsmash requested a review from a team as a code owner June 26, 2026 11:34

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the documentation for the AgentInterface message in specification/a2a.proto to clarify the expected format of the url field for both HTTP-based and gRPC transports. The review feedback suggests refining the terminology from "URL" to "URL or address" when referring to gRPC endpoints to ensure technical accuracy, as gRPC addresses in the format "hostname:port" lack a scheme.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread specification/a2a.proto
Comment on lines +337 to +339
// The URL where this interface is available. For HTTP-based transports, must be a valid absolute
// HTTPS URL in production. For gRPC, the URL should be in the format "hostname:port".
// Example: "https://api.example.com/a2a/v1", "grpc.example.com:443"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

low

Since hostname:port is an address/endpoint rather than a URL (as it lacks a scheme), referring to it as 'the URL' for gRPC is technically inaccurate. It would be clearer to refer to it as 'the address' or 'the URL or address' to accommodate both HTTP and gRPC transports.

Suggested change
// The URL where this interface is available. For HTTP-based transports, must be a valid absolute
// HTTPS URL in production. For gRPC, the URL should be in the format "hostname:port".
// Example: "https://api.example.com/a2a/v1", "grpc.example.com:443"
// The URL or address where this interface is available. For HTTP-based transports, must be a valid absolute
// HTTPS URL in production. For gRPC, the address should be in the format "hostname:port".
// Example: "https://api.example.com/a2a/v1", "grpc.example.com:443"

The previous example used "https://grpc.example.com/a2a" which is
incorrect for gRPC — gRPC URLs use "hostname:port" format without
a scheme or path. Also updated the field comment to clarify that the
HTTPS URL requirement applies to HTTP-based transports only.

Fixes #1388

Signed-off-by: Sam Betts <1769706+Tehsmash@users.noreply.github.com>
@Tehsmash
Tehsmash force-pushed the fix/1388-grpc-agent-interface-url-example branch from bcd1c02 to 8653eda Compare June 26, 2026 11:36
@Tehsmash Tehsmash changed the title fix(spec): correct gRPC URL example in AgentInterface fix(proto): correct gRPC URL example in AgentInterface Jun 26, 2026
@chopmob-cloud

Copy link
Copy Markdown

Verified this fix independently while tracing the same example. The reference SDK confirms the corrected format: a2a-go's gRPC transport passes AgentInterface.url straight into grpc.NewClient(iface.URL, ...) (a2agrpc/v1/client.go), and a gRPC dial target is host:port, so the current https://grpc.example.com/a2a example would fail as written while grpc.example.com:443 works. Scoping the HTTPS wording to HTTP-based transports is the right accompanying clarification. Hope this helps it land.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug]: Wrong example of AgentInferface URL for gRpc

3 participants