Update README to reflect A2A protocol architecture - #4
Conversation
Co-authored-by: tommasodotNET <12819039+tommasodotNET@users.noreply.github.com>
There was a problem hiding this comment.
Pull Request Overview
This PR updates the README to accurately document the A2A (Agent-to-Agent) protocol architecture that replaced the previous custom API endpoints. The changes add comprehensive documentation of the A2A-based communication flow between the frontend, orchestrator, and restaurant agents.
- Added ASCII architecture diagram showing A2A protocol flows between all components
- Updated API endpoints documentation to reflect actual A2A endpoints (
/agenta2a/v1/*) - Corrected testing examples to use proper A2A message format with structured message objects
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| curl -X POST https://localhost:5197/agenta2a/v1/run \ | ||
| -H "Content-Type: application/json" \ | ||
| -d '{ | ||
| "messages": [ | ||
| { | ||
| "role": "user", | ||
| "content": "Find me a vegetarian restaurant" | ||
| } | ||
| ] | ||
| "message": { | ||
| "messageId": "unique-id-123", | ||
| "role": "user", | ||
| "kind": "message", | ||
| "parts": [ | ||
| { | ||
| "kind": "text", | ||
| "text": "Find me a vegetarian restaurant" | ||
| } | ||
| ] | ||
| } | ||
| }' |
There was a problem hiding this comment.
The curl example doesn't include a contextId parameter in the A2A message, but the documentation emphasizes that the orchestrator "Uses contextId for conversation management" (line 126) and describes "contextId-based conversation management" (line 159). The example should demonstrate how to include contextId for conversation continuity, especially since this is a key feature being documented.
There was a problem hiding this comment.
Added contextId parameter to the curl example to demonstrate conversation continuity. Also added explanatory comments for both messageId and contextId fields. (b8ff3b2)
| "message": { | ||
| "messageId": "unique-id-123", |
There was a problem hiding this comment.
The example curl command requires a messageId field but doesn't provide guidance on what constitutes a valid unique ID. Consider adding a comment or note explaining that messageId should be a unique identifier (e.g., UUID) for each message, or provide a more realistic example value like "550e8400-e29b-41d4-a716-446655440000".
There was a problem hiding this comment.
Updated messageId to use a realistic UUID format (550e8400-e29b-41d4-a716-446655440000) and added a comment explaining that it should be a unique UUID for each message. (b8ff3b2)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: tommasodotNET <12819039+tommasodotNET@users.noreply.github.com>
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Update README to reflect A2A protocol usage and add architecture diagram
Completed:
Changes Made:
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.