adk-python
adk-python copied to clipboard
feat: add a2a agent card generation with the CLI
This PR introduces a new CLI command, generate_agent_card, to the ADK. This command simplifies the setup for A2A (Agent-to-Agent) communication by automating the generation of Agent Cards. It scans the project directory for available agents and produces the necessary JSON configuration for each one.
Key Features
- Automatic Discovery: Detects all agents in the current working directory using AgentLoader
- Configurable RPC URL: Supports customization of the
protocol,host, andportused in the agent's endpoint URL. - JSON Output: Outputs the generated Agent Cards to standard output (stdout) in JSON format, making it easy to pipe to other tools.
- File Generation: Includes a
--create-fileflag to automatically save the generated configuration asagent.jsonwithin each agent's directory. - Graceful Fallback: Handles the optional a2a dependency, providing a clear error message if the package is not installed.
Usage Examples
Print Agent Cards to console:
adk generate_agent_card
Generate agent.json files for all agents with a custom host and port:
adk generate_agent_card --host 0.0.0.0 --port 8080 --create-file
Summary of Changes
Hello @guillaumeblaquiere, I'm Gemini Code Assist[^1]! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request enhances the ADK (Agent Development Kit) by adding a new command-line interface tool, generate_agent_card. This tool automates the process of creating Agent Cards, which are crucial for Agent-to-Agent (A2A) communication. It streamlines development by discovering agents within a project, generating their necessary JSON configurations, and offering options to either print these configurations to the console or save them as files, significantly reducing manual setup and improving the developer experience for A2A integration.
Highlights
- New CLI Command: Introduced
generate_agent_cardto the ADK CLI, streamlining the setup for Agent-to-Agent (A2A) communication. - Automated Agent Card Generation: The new command automates the creation of Agent Cards by scanning the project directory for available agents and generating their necessary JSON configurations.
- Configurable RPC URL: Users can customize the
protocol,host, andportfor the agent's endpoint URL when generating Agent Cards. - Flexible Output Options: Generated Agent Cards can be outputted to standard output (stdout) in JSON format or automatically saved as
agent.jsonfiles within each agent's directory using the--create-fileflag. - Graceful Dependency Handling: The command gracefully handles the optional
a2adependency, providing a clear error message if the package is not installed.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in pull request comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with :thumbsup: and :thumbsdown: on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
[^1]: Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.
Response from ADK Triaging Agent
Hello @guillaumeblaquiere, thank you for creating this PR!
To help us review this PR more effectively, could you please provide the following:
- Associated Issue: This PR introduces a new feature. Could you please associate a GitHub issue with it? If one doesn't exist, please create one.
- Testing Plan: Please add a "Testing Plan" section to your PR description, detailing how you've tested these changes.
- Logs or Screenshots: Could you please provide logs or screenshots demonstrating the new CLI command in action?
This information will help reviewers to review your PR more efficiently. You can find more details in our contribution guidelines. Thanks!
Hi @guillaumeblaquiere , Thank you for your contribution through this pull request! Can you please fix the failing tests.