The ListTasksRequest message includes a google.protobuf.Struct metadata
field, which cannot be represented as simple URL query parameter
required by HTTP GET requests. This causes service config generation to
fail with `http: map field 'google.protobuf.Struct.fields' referred to
by message 'a2a.v1.ListTasksRequest`.
Since it's unclear whether metadata will be useful for ListTasks, I
propose to remove it at least for now to fix the specification.
Fixes#1236🦕
---------
Co-authored-by: Darrel <darrmi@microsoft.com>
In the currently published specification the data model definitions
include a proto snippet and then have a list of fields under the
snippet. This creates duplicated information. To prevent this
duplication while maintaining an easy to read presentation of the
abstract data models, this PR uses a Python macro to convert the proto
into a markdown table.
Also took the opportunity to do an editorial pass on the comments in the
a2a.proto before the field descriptions were removed from the
specification.md. Some of this content came from the types.ts file that
often had information that was not in a2a.proto.
A preview of the changes can be seen here
https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#41-core-objects
# Proto to Markdown Table Conversion
The macro system provides two main functions (`proto_to_table` and
`proto_enum_to_table`) that convert Protocol Buffer definitions into
formatted markdown tables:
1. **Locates Definitions**: Reads the `.proto` file and uses region
markers (`--8<-- [start:Name]` and `--8<-- [end:Name]`) to extract
specific message or enum definitions.
2. **Parses Structure**: Analyzes the proto content to separate three
sections:
- **Description**: Comments appearing before the message/enum
declaration
- **Fields/Values**: The actual field or enum value definitions with
their inline comments
- **Notes**: Comments appearing after the closing brace
3. **Extracts Field Details**: For each field, it captures:
- Field name (converted from snake_case to camelCase, or using
`json_name` annotation)
- Type (mapped to readable formats like "string", "array of integer",
"map of string")
- Required status (based on `REQUIRED` annotation or `optional` keyword)
- Description (from preceding comment lines)
4. **Generates Output**: Assembles the markdown output with:
- Description text at the top
- A formatted table with columns for Field/Type/Required/Description (or
Value/Description for enums)
- Special notes for `oneof` groups
- Additional notes from comments after the definition
The conversion automatically handles multi-line field definitions, map
types, repeated fields, and filters out protolint directives and region
markers from the output.
---------
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Add missing fields to align gRPC specification with JSON specification:
- Add reference_task_ids field to Message to support cross-task context
references, matching the referenceTaskIds field in JSON spec
- Add state_transition_history capability flag to AgentCapabilities to
indicate support for task state transition history tracking
These changes ensure feature parity between gRPC and JSON-RPC
implementations of the A2A protocol. Both additions are optional fields
and maintain backward compatibility with existing implementations.
Fixes#1139Closes#1139
This PR resolves an inconsistency in the Message object property names
between the two transport protocols:
**Issue:**
- JSON-RPC (TypeScript): Used `parts: Part[]` for the array of content
parts
- gRPC (Protocol Buffers): Used `repeated Part content = 5;` for the
same field
**Solution:**
Updated the gRPC protocol buffer definition in
`specification/grpc/a2a.proto` to use `parts` instead of `content`,
aligning it with the JSON-RPC naming convention:
```proto
// Before
repeated Part content = 5;
// After
repeated Part parts = 5;
```
Also updated the associated comment to reflect the change from "Content
is the container..." to "Parts is the container...".
**Impact:**
- Ensures consistent property naming across both transport protocols
- Eliminates potential confusion for developers working with different
transports
- Maintains backward compatibility while improving developer experience
- No changes needed to existing JSON schema or TypeScript definitions
The fix is minimal and surgical, changing only the field name in the
gRPC definition to match the established JSON-RPC convention.
Fixes#1083.
<!-- START COPILOT CODING AGENT TIPS -->
---
đź’ˇ You can make Copilot smarter by setting up custom instructions,
customizing its development environment and configuring Model Context
Protocol (MCP) servers. Learn more [Copilot coding agent
tips](https://gh.io/copilot-coding-agent-tips) in the docs.
---------
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: darrelmiller <447694+darrelmiller@users.noreply.github.com>
Co-authored-by: Holt Skinner <13262395+holtskinner@users.noreply.github.com>
Co-authored-by: Darrel <darrmi@microsoft.com>
# Description
Thank you for opening a Pull Request!
Before submitting your PR, there are a few things you can do to make
sure it goes smoothly:
- [x] Follow the [`CONTRIBUTING`
Guide](https://github.com/a2aproject/A2A/blob/main/CONTRIBUTING.md).
- [x] Make your Pull Request title in the
<https://www.conventionalcommits.org/> specification.
- [x] Ensure the tests and linter pass (Run `nox -s format` from the
repository root to format)
- [x] Appropriate docs were updated (if necessary)
- [x] Fix existing linting errors (I guess they were already on the main
upstream)
Fixes#761🦕
---------
Signed-off-by: Eden Reich <eden.reich@gmail.com>
Co-authored-by: Holt Skinner <holtskinner@google.com>
Co-authored-by: Holt Skinner <13262395+holtskinner@users.noreply.github.com>
Co-authored-by: Darrel <darrmi@microsoft.com>
Co-authored-by: Amye Scavarda Perrin <amye@amye.org>
## Summary
- Adds missing `metadata` field to the `Part` message in the gRPC
specification
- Fixes inconsistency between TypeScript/JSON and gRPC protocol
definitions
- Prevents data loss during Python ↔ gRPC conversions
## Problem
The `Part` message in `specification/grpc/a2a.proto` was missing the
`metadata` field that exists in the TypeScript and Python
specifications. This caused important metadata (like ADK function
call/response types) to be lost during conversions between Python and
gRPC representations.
## Solution
Added `google.protobuf.Struct metadata = 4;` to the `Part` message,
following the same pattern used by other proto messages in the
specification (Task, Message, Artifact, etc.).
Fixes#1005
Co-authored-by: Holt Skinner <13262395+holtskinner@users.noreply.github.com>
Reverts a2aproject/A2A#996
Fixes#1002
GetTaskRequest in the REST protocol is a GET. GET does not have request
body, and all fields in GET should be serializable to a query param.
metadata when being a struct cannot be serialized to query param, and
this is causing failure during API discovery doc generation `http: map
field 'google.protobuf.Struct.fields' referred to by message
'a2a.v1.GetTaskRequest' cannot be mapped as an HTTP parameter.`
# Description
According to the specification for `0.3.0` there is an optional icon url
in AgentCard, however this is not present in the provided protobuf spec.
~I didn't know which tag is preferred for this field, so I incremented
the highest tag found.~
Gemini helped notify me about the Next Tag comment.
Fixes#987🦕
We can push this when we release 0.3.0
Release-As: 0.3.0
---------
Co-authored-by: a2a-bot <a2a-bot@google.com>
Co-authored-by: Holt Skinner <13262395+holtskinner@users.noreply.github.com>
# Description
This PR makes changes to our security representations in AgentCards:
1. Adds a new MutualTLSSecurityScheme type for indicating mTLS
connection requirements. This matches the same field in the OpenAPI
specification v3.1. This type is pretty lacking: there is no way to
indicate any requirements on the certificate that is presented by the
client. I expect we'll want to extend this in the future (for example,
we may want to allow an agent to indicate that a SPIFFE certificate must
be presented). For now, users are advised to put requirements in the
description field.
2. Adds a field for specifying a URL for OAuth2 provider metadata. This
is planned for OpenAPI Specification v3.2, which has not yet been
released. This allows clients to fetch additional information about the
OAuth provider, such as to discover if they support Dynamic Client
Registration.
3. Allows AgentSkills to specify a `security` field. This allows agents
to indicate security requirements for leveraging a particular skill.
I also clarified the usage and expectations for the `security` field in
the base AgentCard.
This change is marked backwards incompatible due to the addition of the
MutualTLSSecurityScheme, which adds a new type to an exhaustive enum
(the security scheme `anyOf`).
Release-As: 0.3.0
---------
Co-authored-by: Holt Skinner <13262395+holtskinner@users.noreply.github.com>
Co-authored-by: Holt Skinner <holtskinner@google.com>
# Description
Thank you for opening a Pull Request!
Before submitting your PR, there are a few things you can do to make
sure it goes smoothly:
- [ ] Follow the [`CONTRIBUTING`
Guide](https://github.com/a2aproject/A2A/blob/main/CONTRIBUTING.md).
- [ ] Make your Pull Request title in the
<https://www.conventionalcommits.org/> specification.
- [ ] Ensure the tests and linter pass (Run `nox -s format` from the
repository root to format)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
---------
Co-authored-by: a2a-bot <a2a-bot@google.com>
# Description
This change adds support for a new JSON-RPC method
`agent/getAuthenticatedExtendedCard` for fetching authenticated extended
card.
This is only applicable if `AgentCard.supportsAuthenticatedExtendedCard`
bit is set to `true` that allows fetching authenticated context specific
agent card.
In the previous versions, the extended card was served via
`{AgentCard.url}/../agent/authenticatedExtendedCard` endpoint. This
endpoint is being removed in favor of the JSON-RPC method. This endpoint
will be deprecated in the SDKs and will be removed in a future release.
Release-As: 0.3.0
---------
Co-authored-by: a2a-bot <a2a-bot@google.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Holt Skinner <13262395+holtskinner@users.noreply.github.com>
# Description
This introduces a `signatures` field on the AgentCard that contains JWS
formatted signatures. See issue #916 and discussion #199 for further
details, including how signatures are constructed and verified.
Fixes#916🦕
Adds Enum of supported Transports to Specification, with extensibility
for proprietary protocols.
Adds URL formatting requirement for `AgentInterface.url` and
`AgentCard.url`
Co-authored-by: Stefano Maestri <stefano.maestri@javalinux.it>
Prevents usage of "Magic Strings" in SDKs, which supports better
adherence to the recommended path for Agent Cards.
NOTE: This path might also need to be changed based on feedback in
https://github.com/protocol-registries/well-known-uris/issues/66 so
having a global constant would make this adjustment easier.
Fixes#816🦕
This PR does a few cleanups to `buf.yaml`:
- Upgrades `buf.yaml` to
[`v2`](https://buf.build/blog/buf-cli-next-generation), which is what is
generally used going forward, and matches the `buf.gen.yaml` version. In
this case, virtually no changes.
- Adds lint exceptions for those lint rules that do not pass `buf lint`.
This now ensures that `buf lint` passes.
- Updates a few comments in `buf.yaml` for clarification.
- Updates the `README.md` to use `buf lint` instead of `buf build`. Note
that `buf build` is implicitly run via `buf lint`.
- Removes the instruction about checking for breaking changes, as
there's no mechanism for this set up yet. Happy to contribute a PR to
make this simple if this would be desirable.
- Removes the instruction to modify `buf.yaml`. `buf.yaml` should
generally never need modification.
---------
Signed-off-by: bufdev <bufdev-github@buf.build>
- **Replaced `@example` with `@TJS-examples`**: All JSDoc `@example`
tags have been converted to `@TJS-examples`, used
by`typescript-json-schema` to generate example values.
- **Completed Union Types**: The `JSONRPCResponse` union type was
incomplete. Added the missing `ListTaskPushNotificationConfigResponse`
and `DeleteTaskPushNotificationConfigResponse` types to make it
consistent with the defined request types.
# Description
Thank you for opening a Pull Request!
Before submitting your PR, there are a few things you can do to make
sure it goes smoothly:
- [ ] Follow the [`CONTRIBUTING`
Guide](https://github.com/a2aproject/A2A/blob/main/CONTRIBUTING.md).
- [ ] Make your Pull Request title in the
<https://www.conventionalcommits.org/> specification.
- [ ] Ensure the tests and linter pass (Run `nox -s format` from the
repository root to format)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
Add missing `@TJS-examples` annotations to `AgentProvider` and
`AgentExtension` interfaces to improve TypeScript developer experience.
Examples use Google ecosystem references (ai.google.dev, OAuth 2.0) and
follow existing JSDoc patterns in the codebase.
First contribution to open source ❤️
The Python SDK expects a value for `additionalInterfaces` if this is not
optional. New versions would be a breaking change.
Unit test output
```
ERROR tests/client/test_client.py - pydantic_core._pydantic_core.ValidationError: 1 validation error for AgentCard
additionalInterfaces
Field required [type=missing, input_value={'name': 'Hello World Age... tags=['hello world'])]}, input_type=dict]
```
---------
Co-authored-by: a2a-bot <a2a-bot@google.com>
This is designed to be backward compatible. Existing cards will work and
be correct with this update. New fields are added to the agent card and
default interpretation for these are provided to be backward compatible
---------
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: a2a-bot <a2a-bot@google.com>
Co-authored-by: Holt Skinner <holtskinner@google.com>
Co-authored-by: tomsun28 <tomsun28@outlook.com>
Co-authored-by: Mike Smith <mikeas@google.com>
Co-authored-by: Holt Skinner <13262395+holtskinner@users.noreply.github.com>
Co-authored-by: kthota-g <kcthota@google.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
- Support for list pushNotificationConfig for task
- Support for delete pushNotificationConfig
- Get pushNotificationConfig by id or by task
- update protos to use PushNotificationConfig
---------
Co-authored-by: a2a-bot <a2a-bot@google.com>
# Description
This updates the protocol to support Extensions. Extension profiles are
documents that describe modifications or additions to the core A2A
profile. AgentCards can declare supported extensions via
`capabilities.extensions`. This declaration can include additional
information via `capabilities.extensions.params`. Clients can use this
as a basis for extension negotiation: if a client supports an extension
that the server supports, the client can then follow the protocol
defined by the extension. This can include, but is not specifically
limited to:
1. Requiring specific structure of messages, such as following a
specific schema for a DataPart.
2. Providing additional information in request/response Message and
Artifact objects via their `metadata` field.
3. Exposing additional methods beyond the core A2A protocol methods.
Messages and Artifacts can now include an indication of which extensions
are present in their content. I do not yet know if extension indications
are necessary on other data structures (such as `MessageSendParams` or
`TaskStatus`). I'd say extension indications are not strictly necessary
at all: it's possible to infer that an extension was followed by
inspecting the message content itself (are the metadata fields you
expect present, does the DataPart follow the schema you expect, etc).
However, they are useful for validation and simplifying extension
implementation logic: "you said you followed this extension, so I'll
validate fields are present and then perform my processing".
Fixes#585
---------
Co-authored-by: Holt Skinner <13262395+holtskinner@users.noreply.github.com>