39 Commits

Author SHA1 Message Date
Iva Sokolaj
ae6a562d5d
docs: rename "Stream Message" to "Send Streaming Message" and replace legacy method names (#1784)
## Summary
Standardizes the operation names used throughout the spec and Python
tutorials so they match the canonical A2A operation names (`Send
Message` / `Send Streaming Message`) instead of the older JSON-RPC-style
identifiers (`message/send`, `message/stream`) or the inconsistent short
form `Stream Message`.
## Changes
- **`docs/specification.md`**
  - Architecture diagram: `Stream Message` → `Send Streaming Message`.
  - Section 3.1.3 (Get Task): `message/send` → `Send Message`.
  - Event delivery section: `Stream Message` → `Send Streaming Message`.
- Multi-protocol functionality table: `Stream message` → `Send Streaming
Message`.
- **`docs/tutorials/python/4-agent-executor.md`**: `message/send` /
`message/stream` → `Send Message` / `Send Streaming Message`.
- **`docs/tutorials/python/6-interact-with-server.md`**: same rename in
the `test_client.py` description.
- **`docs/tutorials/python/7-streaming-and-multiturn.md`**:
`message/send` → `Send Message` in the `CurrencyAgentExecutor`
walkthrough.
## Why
The docs previously mixed three different names for the same operations
(`message/stream`, `Stream Message`, `SendStreamingMessage`), which was
confusing for readers cross-referencing the spec, tutorials, and SDK.
This change picks one human-readable form per operation and uses it
consistently in prose, while leaving the code-level identifiers
(`SendMessage`, `SendStreamingMessage`, `POST /message:stream`, etc.)
untouched in the protocol-binding tables.
2026-04-23 13:54:31 +02:00
Iva Sokolaj
434d1fecbb
docs: use 127.0.0.1 in tutorial as in the referenced sample (#1783)
## Description
Follow-up cleanup to the Python helloworld tutorial to use the address
that the samples actually bind to.
## Changes
- **Host address**: Update tutorial references from
`http://localhost:9999/` to `http://127.0.0.1:9999/` so the docs match
the URL printed by the helloworld sample's Agent Card.
- Updated in `docs/tutorials/python/3-agent-skills-and-card.md` and
`docs/tutorials/python/6-interact-with-server.md`.
2026-04-23 12:27:17 +02:00
Iva Sokolaj
c5104cec72
docs: update Python helloworld tutorial for a2a-sdk v1.0 (#1775)
# Description
Update the Python tutorial to be compliant with the newly released A2A
SDK v1.0.

`Helloworld sample` referenced in the Python tutorial was updated to use
the new `v1.0.1`: [PR
527](https://github.com/a2aproject/a2a-samples/pull/527)
2026-04-23 11:23:52 +02:00
Iva Sokolaj
b9f03d4c96
docs: update code snippet markers to match refactored sample identifiers (#1732)
Fixes:
https://a2a-protocol.org/latest/tutorials/python/6-interact-with-server/#understanding-the-client-code

Sample update: #508
2026-04-09 09:55:38 +02:00
Iva Sokolaj
32a7d3a0bd
docs: update python tutorial for a2a-sdk v1.0.0-alpha.0 (#1678)
Issue: #1679

# Description

[a2a-samples/python](https://github.com/a2aproject/a2a-samples/tree/main/samples/python)
is being updated to use the new `v1.0`:
[samples-#462](https://github.com/a2aproject/a2a-samples/issues/462). We
are looking to merge [update helloworld sample to
v1.0-alpha](https://github.com/a2aproject/a2a-samples/pull/474) and
consequently need to update python tutorial in A2A as it references the
`helloworld sample`.

# Key Changes
- **Agent Skills & Card** (3-agent-skills-and-card.md): Updated the docs
to match the new AgentCard schema. Replaced the legacy `url` property
with `icon_url`, documented the new `supported_interfaces` field for
protocol bindings, and added mentions of the extended_agent_card
capability.
- **HelloWorldAgentExecutor logic** (4-agent-executor.md): Rewrote the
walkthrough for the execute method to reflect the modern event-driven
approach and to make the difference between non-streaming and streaming
more clear. It now explicitly describes enqueueing Task,
TaskStatusUpdateEvent (with `TASK_STATE_WORKING`),
TaskArtifactUpdateEvent, and TaskStatusUpdateEvent (with
`TASK_STATE_COMPLETED`) instead of single string messages.
- **Server Setup** (5-start-server.md): Replaced `0.0.0.0` with
`127.0.0.1` in the host binding tutorial and log examples to enforce
safer local testing defaults.
- **Client Interaction** (6-interact-with-server.md): 
- Replaced MessageSendParams dictionaries with native protobuf
`Message/Part/Role` construction.
- Replaced direct A2ACardResolver instantiation with the new
`ClientFactory` approach.
- Unified the documentation around `send_message` (which now handles
streams dynamically based on `config` and agent capabilities) and
updated expected log outputs.
2026-03-26 13:50:49 +01: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
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
yuri
61d1e3a6f9
docs: Readme files accuracy fix (#1186)
## Problem
There are a couple of readme file with spelling, capitalization fixes to
align with rest of documents.


## Solution
“a2a specification” -> “A2A specification”.
“Helloworld” -> “Hello World”.


## Changes
docs/topics/a2a-and-mcp.md
docs/tutorials/python/4-agent-executor.md
docs/tutorials/python/7-streaming-and-multiturn.md
specification/grpc/README.md

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

## Issue
Fixes #1185

---------

Signed-off-by: Yuri Zhao <yu.zhao5@huawei.com>
2025-11-21 10:19:44 -06:00
Farah Juma
202aa069e6
fix: Update the Java tutorials and descriptions (#1181)
Updating the Java section for the Tutorials page to list the current
samples.

Fixes https://github.com/a2aproject/A2A/issues/1182
2025-10-29 10:43:03 -07:00
abiramit5
0ab97ffa96
docs: Update tutorials/index.md to make tables for Tutorials (#1065)
# Description

Closes #1064

---------

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-12 10:04:18 -05:00
Holt Skinner
1c1d72056c
docs: Restructure TOC under Topics (#1060)
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
2025-09-11 12:42:32 -05:00
Holt Skinner
598b6d3d0d
docs: Fix Broken Links (#1044)
Fixes #1043 🦕
2025-09-08 10:39:56 -05: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
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
Holt Skinner
08132ac5c7
docs: Repo Link Updates (#780) 2025-06-23 21:34:48 +02:00
Jack Wotherspoon
bf5e809c62
chore(docs): update minimum Python version in tutorial (#724)
Python A2A SDK now supports Python 3.10+

Tutorial still says 3.13+, updating to be more inclusive.
2025-06-04 10:22:31 -05:00
Alexi Canales
6808acbbb8
docs: update next steps documentation (#722) 2025-06-04 09:29:41 -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
Stojan Gasic Brieva
266d1adadc
docs(langgraph): clarify location of __main__.py and test_client.py in app/ (#712)
The files __main__.py and test_client.py are located in
a2a-samples/samples/python/agents/langgraph/app/, not in the root
directory a2a-samples/samples/python/agents/langgraph/.
2025-06-03 14:37:03 +00:00
Akshay Kokane
367c16cebb
docs: update Python tutorial instructions to correct requirements.txt path (#697)
# Description
This PR updates the Setup Your Environment documentation to correct the
location of the requirements.txt file used for Python SDK installation.
The file is located in the samples/python directory, and the updated
command reflects this.

No code changes or functionality modifications were made—this is a
documentation-only update for accuracy.

Fixes #698
2025-06-02 13:26:25 -05:00
Holt Skinner
dbd2a022b8
docs: Update link to langgraph agent files in tutorial (#705) 2025-06-02 12:57:16 -05:00
Phill Gibson
de57ce4a4d
docs: Python tutorial update (#684)
# Description
Updated docs to use requirements file added to the a2a-samples repo and
updated path for the Start Server section.

Ref - https://github.com/google-a2a/a2a-samples/pull/67
2025-05-29 10:14:33 -05:00
Holt Skinner
e7e43d0ee9
docs: Convert Tutorial code samples to use embedded snippets (#685)
Followup to https://github.com/google-a2a/a2a-samples/pull/68
2025-05-29 10:13:10 -05: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
f99d96a245
fix: Update tutorial with 0.2.0 changes (#604)
- requires Python 3.13
- AgentAuthentication has been removed from the SDK with the
introduction of SecuritySchemes

Co-authored-by: Mike Smith <mikeas@google.com>
2025-05-20 09:33:10 -06:00
Holt Skinner
ce95d60c49
docs: Update Tutorial and README to use A2A Python SDK from PyPi (#597) 2025-05-19 19:59:13 -07:00
Mayuresh K
248f3a328e
docs: tutorials/python/2-step.md fixed pip cmd (#550)
Made minor fix to pip command under step titled "Install the A2A SDK and
its dependencies:"

# Description

Noticed that the command in step 2 - to install a2a and it's
dependencies had a slight error. Fixed it.
2025-05-15 12:15:30 -05:00
Holt Skinner
40f4b2f6e8
refactor: Move SDK to New Repository (#518)
Python SDK codebase is now in https://github.com/google/a2a-python
2025-05-14 13:14:28 -05:00
Holt Skinner
2d44597bc3
docs: Refactoring Python Tutorial (#474) 2025-05-12 14:29:47 -05: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
Daniel Dai
b1e7df03fb
docs: Fix typo in 9-ollama-agent.md (#393)
# Description

Fix typo  in 9-ollama-agent.md of python tutorial of docs dir
2025-05-05 15:32:23 -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
Holt Skinner
dc7739e64a
docs: Fix Broken Links (#412) 2025-05-05 14:59:14 -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
Kristopher Overholt
cec2b9973a Undo commit 2025-04-30 12:28:50 -05:00
Kristopher Overholt
17bc1e178e feat: Initial commit of mkdocs + docs source files 2025-04-30 12:24:18 -05:00