52 Commits

Author SHA1 Message Date
Sam Betts
66df070988
docs: Add custom protocol bindings documentation (#1619)
## Summary

- Adds `docs/topics/custom-protocol-bindings.md`, a dedicated page
documenting custom protocol bindings as a concept distinct from
extensions; covers declaration in the Agent Card, specification
requirements, key areas to address (data type mappings, service
parameters, error mapping, streaming, authentication), and
interoperability testing
- Adds `docs/topics/extension-and-binding-governance.md`, merging the
governance content previously in `extensions.md` with the equivalent
custom protocol binding governance; deduplicates the tiers section into
a single section with a naming table; notes that SDKs SHOULD implement
official custom protocol bindings vs MAY for extensions
- Adds spec section 5.8 defining URI-based custom binding identification
as a SHOULD requirement and updates the section 12.7 Agent Card example
accordingly
- Replaces the verbose inline governance sections in `extensions.md` and
`custom-protocol-bindings.md` with short summaries linking to the new
governance page
- Adds Custom Protocol Bindings and Extension & Binding Governance to
the mkdocs.yml nav

---------

Signed-off-by: Sam Betts <1769706+Tehsmash@users.noreply.github.com>
Co-authored-by: Holt Skinner <13262395+holtskinner@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
2026-04-07 13:31:18 +02:00
Ritsuki Yamada
727168fe1f
docs(spec): Add HTTP caching guidance for Agent Card endpoints (#1479)
Closes #1478. Related to #306.

The specification provides caching guidance for Extended Agent Cards
(Sections 3.1.11 and 13.3) but has no equivalent guidance for public
Agent Cards. This creates a gap for SDK and framework implementers —
none of the five official SDKs currently implement Agent Card caching,
and framework implementers have noted the lack of protocol-level
guidance (google/adk-python#3297).

This PR adds SHOULD-level HTTP caching guidance, following the precedent
of OpenID Connect Discovery 1.0 (same `.well-known` URI pattern).

**Changes:**

- **`docs/specification.md`**: Add Section 8.6 "Caching" with normative
guidance on `Cache-Control`, `ETag`, and conditional requests. Placed
after Section 8.5 (Sample Agent Card) to avoid renumbering existing
sections and breaking anchor links.
- **`docs/topics/agent-discovery.md`**: Add "Caching Considerations"
section with practical guidance for implementers.

---------

Co-authored-by: Darrel <darrmi@microsoft.com>
2026-03-12 16:24:35 +00:00
Vinay Ramesh
e2eb7d2b4b
docs: Extension governance (#1488)
Brings extension governance from issue #1406 into A2A documentation spec

Closes #1406

---------

Co-authored-by: Luca Muscariello <muscariello@ieee.org>
Co-authored-by: Kuba Herczyński <herczyn@google.com>
Co-authored-by: Sam Betts <1769706+Tehsmash@users.noreply.github.com>
2026-03-11 13:44:49 +01:00
Holt Skinner
4890b77d6f
docs: Fix embedded version of AgentExtension in extensions (#1550) 2026-02-26 13:14:05 -06:00
Gijs Walraven
629190aea9
docs: wrap Task in result.task in life-of-a-task examples (#1492)
## Issue

Closes #1368 — Clarify whether JSON-RPC result should wrap Task/Message
objects

## Problem

Both response examples in `docs/topics/life-of-a-task.md` returned Task
fields directly inside `result`:

```json
"result": {
  "id": "task-boat-gen-123",
  "status": { ... },
  "artifacts": [ ... ]
}
```

The v1.0 specification defines `SendMessageResponse` as:

```
oneof response {
  Task task = 1;
  Message message = 2;
}
```

This means the result **must** contain either a `"task"` or `"message"`
wrapper key, not direct Task fields.

## Fix

Both response examples now correctly wrap the Task:

```json
"result": {
  "task": {
    "id": "task-boat-gen-123",
    "status": { ... },
    "artifacts": [ ... ]
  }
}
```

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Gijs Walraven <gijs.walraven@delaware.pro>
Co-authored-by: Holt Skinner <13262395+holtskinner@users.noreply.github.com>
2026-02-18 16:13:47 +00:00
Gijs Walraven
8bf133addc
docs: use correct v1.0 method name "SendMessage" in life-of-a-task example (#1491)
## Summary

The follow-up scenario example in \`docs/topics/life-of-a-task.md\` used
\`"message.send"\` (dot notation) for the first request, while the
second request in the same example correctly used \`"SendMessage"\`
(v1.0 PascalCase). This made the file internally inconsistent and showed
a method name that doesn't exist in any version of the protocol.

## Change

\`\`\`diff
- "method": "message.send",
+ "method": "SendMessage",
\`\`\`

**File:** \`docs/topics/life-of-a-task.md\`

## Related

- Closes #1493
- Related to #1367 (method name inconsistencies across documentation)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Gijs Walraven <gijs.walraven@delaware.pro>
Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-02-18 10:12:17 -06:00
Gijs Walraven
7245512250
docs: correct Part discriminator values and remove stale v0.3.x type names (#1490)
## Summary

Fixes documentation inconsistencies related to Part discriminator field
values, identified in #1365.

## Changes

### `docs/specification.md` — Appendix A.2.1

- **Legacy Part `kind` values**: corrected from PascalCase (`"kind":
"TextPart"`, `"kind": "FilePart"`, `"kind": "DataPart"`) to lowercase
(`"kind": "text"`, `"kind": "file"`, `"kind": "data"`), consistent with
what `whats-new-v1.md` documents as the v0.3.0 format
- **Legacy FilePart structure**: added the missing nested `file` object
wrapper
- **Legacy streaming event `kind` values**: corrected from PascalCase
(`TaskStatusUpdateEvent`, `TaskArtifactUpdateEvent`) to camelCase
(`taskStatusUpdate`, `taskArtifactUpdate`)
- **Current `DataPart` migration target**: removed incorrect
double-wrapping (`{ "data": { "data": {...} } }` → `{ "data": {...},
"mediaType": "application/json" }`)
- **Current streaming event member names**: aligned with
`whats-new-v1.md` (`taskStatusUpdate` / `taskArtifactUpdate`)

### `docs/topics/key-concepts.md`

- Updated Part description to use v1.0 terminology, removing references
to the removed `TextPart`, `FilePart`, and `DataPart` types

### `docs/tutorials/python/8-next-steps.md`

- Replaced reference to removed `DataPart` type with v1.0 Part field
names

### `CONTRIBUTING.md`

- Added **Documentation Guidelines** section with correct v1.0 Part
examples (member-presence pattern) and guidance on the correct v0.3.x
lowercase `kind` discriminator values for migration docs

## Related

- Closes #1365
- External community site fix:
https://github.com/sing1ee/a2a-directory/pull/12

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Gijs Walraven <gijs.walraven@delaware.pro>
2026-02-18 10:11:37 -06:00
Holt Skinner
c24b1151d1
docs(spec): Update inconsistencies in documentation for 1.0 Spec (#1466)
In the future, we should probably explore refactoring the docs set to
avoid these becoming out of sync going forward

This pull request updates the project documentation to align with the
v1.0 Agent2Agent (A2A) Protocol Specification defined in
specification/a2a.proto. It ensures that all conceptual guides,
summaries, and tutorials reflect the current normative definitions,
  RPC method names, and wire formats.

  Summary of Changes


1. RPC Method Naming Updates
Standardized all method references to use the v1.0 PascalCase naming
convention:

   * `message/send` → `SendMessage`
   * `message/stream` → `SendStreamingMessage`
   * `tasks/get` → `GetTask`
   * `tasks/list` → `ListTasks`
   * `tasks/cancel` → `CancelTask`
* `tasks/pushNotificationConfig/set` →
`CreateTaskPushNotificationConfig`
   * `tasks/resubscribe` → `SubscribeToTask`
   * `agent/getAuthenticatedExtendedCard` → `GetExtendedAgentCard`

2. JSON Example & Wire Format Corrections
Updated examples across all "Topic" files and the Python Quickstart to
match v1.0 breaking changes:
* Removed `kind` discriminators: Examples for Message, Task, Part, and
StreamResponse now use member-based polymorphism (e.g.,
     {"text": "..."} instead of {"kind": "text", "text": "..."}).
* Enum Standardization: Changed role and state enums from
kebab-case/lowercase to SCREAMING_SNAKE_CASE with type prefixes (e.g.,
     `"ROLE_USER"`, `"TASK_STATE_COMPLETED"`).
* Response Wrapping: Updated examples to reflect that `SendMessage` and
`SendStreamingMessage` return a unified response object where
     the message or task is nested within the result.

  3. LLM Context (`docs/llms.txt`)
* Completely refreshed the protocol summary and RPC method list to
ensure LLM-based tools (like Gemini CLI) have an accurate
     representation of the v1.0 API surface and error codes.

  4. Link & Anchor Maintenance
* Updated internal documentation links and spans to point to the correct
sections in the specification.md (e.g., correcting the
     anchor for GetExtendedAgentCard).

  Why this is needed
The v1.0 release introduced significant structural improvements for
ProtoJSON compliance and architectural consistency. Documentation
examples were previously showing v0.3.0 patterns which would cause
integration errors for developers using the latest SDKs.
2026-02-10 11:45:49 -06:00
Luca Muscariello
b86d8bb2ed
docs: clean up documentation build chain and fix broken links (#1400)
- Move a2a.proto to specification/ root
- Update build scripts and macros to support new proto location
- Fix broken internal links and anchor references in specification.md
- Update .gitignore to properly exclude generated SDK docs
- Configure Sphinx to suppress external SDK warnings
- Fix MkDocs redirects and Python SDK toctree structure

---------

Signed-off-by: Luca Muscariello <muscariello@ieee.org>
2026-01-29 21:00:02 +01:00
Didier Durand
f6129cafa1
docs: fix some typos in various files. (#1198)
Hi,
As per title, fixing typos in various files: see commit diffs for
details
Cheers
Didier

---------

Co-authored-by: Holt Skinner <13262395+holtskinner@users.noreply.github.com>
2026-01-29 11:03:42 -06:00
madankumarpichamuthu
4dd980f6ff
fix(spec)!: Standardize spelling of "canceled" to use American Spelling throughout (#1283)
Fixes inconsistent spelling of cancel-related terms across the
specification and documentation. The proto definition uses
TASK_STATE_CANCELLED (double 'l'), but various documentation files were
using single 'l' spelling.

Changes:
- cancelled → canceled
- cancellable → cancelable
- `TaskNotCancellableError` → `TaskNotCancelableError`

Files modified:
- docs/specification.md
- docs/llms.txt
- docs/topics/life-of-a-task.md

All documentation now consistently uses single 'l' to match the proto
definition and JSON naming conventions.

Fixes #1270

Release-As: 1.0.0

---------

Signed-off-by: Luca Muscariello <muscariello@ieee.org>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Luca Muscariello <muscariello@ieee.org>
Co-authored-by: Darrel <darrmi@microsoft.com>
Co-authored-by: Holt Skinner <13262395+holtskinner@users.noreply.github.com>
2026-01-29 09:51:18 -06:00
Darrel
3e6c7db907
fix(spec): Fix/1251 clarify authentication scheme (#1256)
Fixes #1251

---------

Co-authored-by: Luca Muscariello <muscariello@ieee.org>
2026-01-27 09:39:39 -08:00
madankumarpichamuthu
5b101cce0f
refactor(spec)!: Remove redundant final field from TaskStatusUpdateEvent (#1308)
Terminal states (COMPLETED, FAILED, CANCELLED, REJECTED) already
indicate task completion, making the final field redundant. This creates
consistency across streaming, polling, and push notification
communication patterns.

Changes:
- Removed final field (field 4) from TaskStatusUpdateEvent in proto
- Updated examples to remove final: true references
- Clarified that streams close upon terminal states
- Added migration guidance in Appendix A.2.2

Fixes #1232

---------

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Darrel <darrmi@microsoft.com>
Co-authored-by: Holt Skinner <13262395+holtskinner@users.noreply.github.com>
Co-authored-by: Luca Muscariello <muscariello@ieee.org>
2026-01-27 09:07:50 -08:00
madankumarpichamuthu
d14f410711
fix: Restore CreateTaskPushNotificationConfig method naming (#1402)
Bypassing tech-writing review as it is a simple rename and the majority of the changes are in the specification.  Changes to conceptual docs are just for aligning names.

Restores the intentional rename from "Set" to "Create" for push
notification configuration methods that was lost during refactoring.
When the protocol was updated to support multiple Push Notification
Configurations, the method was changed from "Set" (which implies
replacing a single config) to "Create" (which implies creating a new
instance among many).

Changes across all documentation and proto files:
- specification/grpc/a2a.proto: Renamed RPC method and request message
- docs/specification.md: Updated all references, section titles, and
method tables
- docs/topics/streaming-and-async.md: Updated links and text
- docs/llms.txt: Updated method reference

Fixes #1394

---------

Co-authored-by: madankumarpichamuthu <madankumarpichamuthu@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Darrel <darrmi@microsoft.com>
2026-01-25 11:42:23 -05:00
Didier Durand
cc8e67ebea
docs: fixing some typos in various files (#1310)
Hi,
Giving a second read to the repo, I found these additional typos: see
commit diffs.
Didier

---------

Co-authored-by: Holt Skinner <13262395+holtskinner@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
2026-01-08 08:55:51 -08:00
Andrew Wickham
c56ea72d5b
docs: Update A2A-Extensions header to align with current standard (#1248)
Replace the `X-A2A-Extensions` header with `A2A-Extensions` to align
with rfc6648.

Fixes #1238
2025-12-05 13:01:13 -06:00
madankumarpichamuthu
c42ef44805
docs: Remove deprecated kind discriminators from Life of a Task example (#1224)
Removes usage of deprecated 'kind' discriminators from the Life of a
Task documentation to align with v1.0 specification changes.

Changes:
- Removed 'kind' field from Part objects (4 occurrences) - deprecated in
v1.0 per spec section A.2.1
- Removed invalid 'kind' field from Task objects (2 occurrences) - never
part of Task specification
- Updated Part field names: mimeType → mediaType, bytes → fileWithBytes

The specification (section A.2.1) states that v1.0 removed the 'kind'
discriminator for Part types and streaming events, using JSON member
names as discriminators instead. Task objects never had a 'kind' field
in the proto definition.

Fixes #1220
2025-12-05 18:57:32 +00:00
madankumarpichamuthu
8704c88a72
docs: Clarify push notification payload format in topics documentation (#1223)
Fixes inconsistency between topics and specification documentation
regarding push notification payloads. The topics documentation
previously stated the payload was not strictly defined, while the
specification explicitly defines it as StreamResponse format.

- Updated docs/topics/streaming-and-async.md to specify StreamResponse
format
- Added references to specification sections for detailed structure
- Aligns with specification.md sections 3.1.7 and 4.3.3

Fixes #1216
2025-12-05 12:15:20 -06:00
Martin Harrigan
d8dd640d2b
docs: fix conflicting description of artifact name (#1153)
The heading says the artifact name is updated but the following text and
JSON shows that it remains the same.
2025-11-21 17:21:39 +00:00
Darrel
b078419954
docs(spec): Large refactor of specification to separate application protocol definition from mapping to transports. (#1160)
Related to #1151 

Fixes https://github.com/a2aproject/A2A/issues/998
Fixes https://github.com/a2aproject/A2A/issues/1091
Fixes https://github.com/a2aproject/A2A/issues/1072
Fixes https://github.com/a2aproject/A2A/issues/1058
Fixes https://github.com/a2aproject/A2A/issues/975
Fixes https://github.com/a2aproject/A2A/issues/1105
Fixes https://github.com/a2aproject/A2A/issues/989
Fixes https://github.com/a2aproject/A2A/issues/1189
Fixes https://github.com/a2aproject/A2A/issues/1187
Fixes https://github.com/a2aproject/A2A/issues/1177
Fixes https://github.com/a2aproject/A2A/issues/1180
Fixes https://github.com/a2aproject/A2A/issues/1172



In order to more effectively describe the A2A protocol in a consistent
way across different protocols, this PR refactors the specification to
describe the application protocol in a transport agnostic way, and then
have separate sections that describe how each of the transports map to
the abstract application protocol. To see a preview of what it looks
like you can go here
https://purple-moss-0838db51e.3.azurestaticapps.net/specification/

The goal of the TSC is to use the changes in this PR as the baseline for
a v1.0 Release Candidate. This will give SDK maintainers an stable
document to validate the changes in the specification through
implementations before v1.0 release.

There are many pending feature requests for the A2A specifications that
the TSC are supportive of. However, getting a stable, consistent,
unambiguous, multi-protocol specification is necessary before additional
features can be added safely.

## Document Restructuring 

- [A2A
Operations](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#3-a2a-protocol-operations)
are described independent of wire protocol
- [Protocol Data
Model](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#4-protocol-data-model)
is described using protobuf as source of truth. All other serializations
are derived from that.
- Protocol bindings (formerly described as transports) are now described
in their own sections
-
[JSON-RPC](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#9-json-rpc-protocol-binding)
-
[gRPC](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#10-grpc-protocol-binding)
-
[HTTP](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#11-httpjsonrest-protocol-binding)
- [Operation Parameters
](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#32-operation-parameter-objects)
describe structures reused across different operations
- [Operation
Semantics](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#33-operation-semantics)
describe common behavior patterns across operations

## New Sections

- [Requirements
Language](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#21-requirements-language)
- [Capability
Validation](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#334-capability-validation)
- [Abstract description of error
handling](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#332-error-handling)
- [Abstract description of
"headers"](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#325-headers)
-
[Extensions](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#46-extensions)
-
[Versioning](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#36-versioning)
- [Custom Binding
Guidelines](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#12-custom-binding-guidelines)
- [JSON Field Naming
Conventions](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#54-json-field-naming-convention)
- [Data Type
Conventions](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#55-data-type-conventions)
- [Security
Considerations](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#77-security-considerations)
- [Agent Card
Signing](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#84-agent-card-signing)
- [IANA
Considerations](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#13-iana-considerations)

## Protocol Clarifications

- Defining order for events returned from [Stream
Message](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#312-stream-message)
- [JSON
Examples](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#416-filepart)
provided for protobuf definitions of data model objects that previously
used discriminators
- Clarification of returned errors where multiple are applicable. e.g.
[Cancel
Task](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#315-cancel-task)
- Defined returned events and usage scenarios for
[Resubscribe](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#316-resubscribe-to-task)
- Defined protocol binding for errors using protocol native capabilities
for all bindings
-
[JSON-RPC](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#94-error-handling)
-
[gRPC](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#104-error-handling)
-
[HTTP](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#115-error-handling)
  
## Artifact Generation

The scripts have been changed to enable a2a.json to be generated from
the a2a.proto so that a2a.proto and specification.md are the only
normative source. Additional work is required to align the generated
a2a.json with the original one.

Release-As: 1.0

---------

Signed-off-by: Luca Muscariello <muscariello@ieee.org>
Signed-off-by: Luca Muscariello <lumuscar@cisco.com>
Co-authored-by: Luca Muscariello <muscariello@ieee.org>
Co-authored-by: Holt Skinner <13262395+holtskinner@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Sam Betts <1769706+Tehsmash@users.noreply.github.com>
2025-11-20 14:52:09 -05:00
yuri
f7aed0247f
docs: Replace filename metadata label with name to align with FileBase prop… (#1166)
## Problem
**The "filename” metadata label** in key-concept.md does not quite align
with FileBase property. As indicated in the specification.md, name,
mineType or bytes labels are part of the FilePart metadatas, instead of
using filename label.

<img width="950" height="557" alt="image"
src="https://github.com/user-attachments/assets/de687e31-e184-4036-a35b-763649bae682"
/>


## Solution
Replace “filename” metadata label with “name” label to align with
FileBase property.


## Changes
Modify A2A\docs\topics\key-concepts.md and **replace “filename” metadata
label with “name” label** to better align with FileBase property from
specification.

## Testing
✅ Documentation builds successfully with mkdocs
✅ Markdown linting passes
✅ All internal anchor links verified
✅ No broken cross-references

## Issue
Fixes #1167
2025-10-21 09:29:28 -05:00
abiramit5
51fac35bf6
docs: Add List of Extensions (#1136)
Fixes #1137
2025-10-10 13:05:34 -05:00
abiramit5
70d5cd6f93
docs: update the table of contents and actor/stack images (#1080)
Replaced the images and restructured the TOC.

Closes https://github.com/a2aproject/A2A/issues/1070

---------

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Holt Skinner <holtskinner@google.com>
2025-09-18 16:21:50 +00:00
abiramit5
d38f19b35d
docs: update docs and table of contents (#1056)
# Description

Closes #1048  🦕

---------

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Holt Skinner <holtskinner@google.com>
2025-09-10 18:30:45 +00:00
abiramit5
16a8e0eeac
docs: Updated the content in A2A docs topics (#965)
Co-authored-by: Holt Skinner <13262395+holtskinner@users.noreply.github.com>
Co-authored-by: Holt Skinner <holtskinner@google.com>
2025-09-05 11:05:43 -05:00
Sun Yuhan
55989487f4
fix: Fix typo forseeable -> foreseeable (#971)
# Description

fix typo `forseeable` -> `foreseeable`

- [ ✅ ] 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 #972 🦕

Signed-off-by: Sun Yuhan <sunyuhan1998@users.noreply.github.com>
Co-authored-by: Sun Yuhan <sunyuhan1998@users.noreply.github.com>
2025-08-12 14:14:13 +01:00
Richard Rance
6dcfcae350
docs: fix links on documentation site (#960)
There are a few links in the spec doc that are clearly meant to link to
the github repo as the files they link to are outside the docs folder.
This fixes them so they work on the generated site hosted at
https://a2a-protocol.org/

Ideally we would use relative links so that when reading the markdown
file in your IDE the links take you to the corresponding file within the
repo. I tried setting up a redirect in mkdocs.yml but the locally
running website kept downloading the file from github instead of
navigating to it. There is probably some plugin that will make this work
however for now I would like to simply fix the docs on the website.
2025-08-07 16:06:33 +01:00
Holt Skinner
0858ddb884
refactor!: Change Well-Known URI for Agent Card hosting from agent.json to agent-card.json (#841)
Based on feedback from IANA in
https://github.com/protocol-registries/well-known-uris/issues/66

Release-As: 0.3.0
2025-07-29 19:45:00 +01:00
Israel Ekpo
074a3dd06b
docs: Update Docs to Clarify that Task Id Must Be Generated By the A2A Server (#926)
Fixes #925  🦕

---------

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
2025-07-28 17:03:25 +01:00
Holt Skinner
ab412fe553
docs: Move Roadmap out of Topics to be more visible (#886)
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
2025-07-18 16:34:45 +01:00
Michael Vakoc
1c2ccbb18c
docs: Adding roadmap to /topics (#882)
Adding roadmap to the public docs site

---------

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
2025-07-17 22:27:25 +00:00
kthota-g
6f1d17ba80
fix: Type fix and doc clarification (#877)
Release-As: 0.2.6

---------

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>
2025-07-17 17:10:05 +01:00
Maryam Ziyad
6ff9d5de9e
docs: fix a typo (#851) 2025-07-09 10:50:24 -04:00
swapydapy
aeef6566e8
docs: fix task doc (#848)
Fixes #836
2025-07-08 15:01:50 -04:00
Holt Skinner
754c2cc48d
docs: Add Mermaid Diagram for A2A Request Lifecycle (#827)
<img width="663" alt="Screenshot 2025-07-02 at 2 32 33 PM"
src="https://github.com/user-attachments/assets/81e84e40-77a7-4ce5-b31c-dd81e823056b"
/>
2025-07-02 14:44:11 -05:00
kibitzing
6971b62ecb
docs: improperly closed parenthesis in Task state description (#790)
This pull request fixes a small typo in the Task state description. 🦕
An extra closing parenthesis was placed incorrectly:

Before:
...until it is in a interrupted state ()input-required or
auth-required)...

After:
...until it is in an interrupted state (input-required or
auth-required)...

This change improves clarity and corrects the formatting of the
sentence.
2025-06-26 13:44:36 +02:00
Holt Skinner
08132ac5c7
docs: Repo Link Updates (#780) 2025-06-23 21:34:48 +02:00
swapydapy
ebc4157ca8
docs!: update spec & doc topic with non-restartable tasks (#770) 2025-06-20 17:48:25 +00:00
Mike Smith
94a3a00282
docs: First pass at extensions documentation (#750)
# Description

My initial attempt at documenting extensions. I believe there's more
I'll want to write on this, and there's a lot of room for
diagrams/pretty pictures/code samples/content linking. But I figured I'd
get it started so we have something to share and get feedback early.

---------

Co-authored-by: Holt Skinner <holtskinner@google.com>
Co-authored-by: Holt Skinner <13262395+holtskinner@users.noreply.github.com>
2025-06-14 19:22:30 +00:00
Dino Chiesa
185187d66a
docs: replace the use of authentication with security (#731)
In https://github.com/google-a2a/A2A/pull/359, the Agent Card got an
update to replace authentication with security. This doc change in
enterprise-ready.md just reflects that change.
2025-06-06 09:17:08 -05:00
Mike Smith
70f1e2b0c6
feat: Add protocol support for extensions (#716)
# 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>
2025-06-04 10:17:37 -06:00
Holt Skinner
6b07c3764b docs: Fix formatting 2025-06-03 13:08:48 -05:00
Holt Skinner
7bcfc04811
ci: Update Linter to include all directories (#714) 2025-06-03 10:44:32 -05:00
MUTHU K BOMMIAH
7ec8027b5f
docs: replace all references to 'MIME type' with 'Media Type' in code (#713) 2025-06-03 14:38:58 +00:00
Holt Skinner
729988a3f5
refactor: Remove Samples/Demo/test directories and change references to google/A2A (#668) 2025-05-27 16:31:32 -05:00
kthota-g
bafba773a2
chore: Doc updates for 0.2.1 (#598)
# 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/google/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> 🦕
2025-05-19 21:42:44 -07:00
Holt Skinner
c09716e0fe
docs(refactor): Refactoring of Documentation (#453)
- Structuring of Information Architecture
- Combine `specification/*.md` files into a single `specification.md` in
RFC format.
  - Combine `documentation.md` into `index.md`
  - Rename `push-notifications.md` into `streaming-and-async.md`
  - Create `topics/key-concepts.md` and `topics/what-is-a2a.md`
- Remove duplicated content between README/index files.
- Hide Python Tutorial from Nav until SDK is released.
2025-05-09 12:50:37 -05:00
alan blount
59d63dc7f5
fix: many broken links (#413)
Use mkdocs style relative paths to file.md.
Fix several old paths.
Add redirects to mkdocs.
Replace HTML prev/next links with markdown.
Format markdown.
2025-05-05 15:23:17 -05:00
Kristopher Overholt
b5fecbe317
feat: Rework documentation, reorganize pages (Stage 2/3) (#365)
# 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/google/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)

Fixes https://github.com/google/A2A/issues/348.

This PR is for docs rework stage 2 of 3. See
https://github.com/google/A2A/issues/347 for full context.

Screenshot at this point:

![Screenshot 2025-05-01 at 4 12
05 PM](https://github.com/user-attachments/assets/c081c8b3-24ee-4164-91f1-a17bceff7e28)
2025-05-01 16:15:18 -05:00
Kristopher Overholt
2f9aa7edd4
feat: Initial commit of A2A docs source and mkdocs site (#350)
Fixes #346.

This PR is for docs rework stage 1 of 3. See #347 for full context.

Screenshot at this point:

![Screenshot 2025-04-30 at 12 55
15 PM](https://github.com/user-attachments/assets/3771ab84-77b9-4b55-82bc-3d38386e55f7)

---------

Co-authored-by: Holt Skinner <holtskinner@google.com>
2025-05-01 11:05:18 -05:00