docs: add AGENT.md for AI coding assistants #142
Conversation
Add comprehensive documentation for AI agents working on the AP2 repository: - Project overview and repository structure - Key concepts (Mandate types, Agent roles, Protocol flow) - Code style requirements (Python, Shell, Markdown) - CI/CD pipeline checks and linter configuration - Development setup and environment configuration - Contributing workflow and PR checklist - Common tasks with code examples - Dynamic issue search guide using GitHub CLI - Document maintenance guidelines Also adds technical terms to cspell custom dictionary. Fixes google-agentic-commerce#49
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
Summary of ChangesHello @onlyhyde, I'm Gemini Code Assist1! 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 introduces a new, detailed Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe 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
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 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 👍 and 👎 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. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces an excellent and comprehensive AGENT.md file to guide AI coding assistants. The documentation is well-structured, detailed, and covers crucial aspects of the project, from setup and architecture to coding standards and contribution workflows. The update to the custom dictionary is also noted. My review focuses on a few minor corrections to ensure accuracy and consistency, including fixing a command path, correcting potential typos in a model name, and removing example terms from the spellcheck dictionary. Overall, this is a high-quality addition to the project's documentation.
| bash samples/python/scenarios/a2a/human-present/cards/run.sh | ||
|
|
||
| # x402 payment scenario | ||
| bash samples/python/scenarios/a2a/human-present/cards/run.sh --payment-method x402 |
There was a problem hiding this comment.
The command for the x402 payment scenario incorrectly points to the run.sh script within the cards directory. According to the repository structure outlined in this document, it should point to the run.sh within the x402 directory.
| bash samples/python/scenarios/a2a/human-present/cards/run.sh --payment-method x402 | |
| bash samples/python/scenarios/a2a/human-present/x402/run.sh --payment-method x402 |
There was a problem hiding this comment.
The x402/ directory only contains a README.md file and does not have a run.sh script. The cards/run.sh script is designed to handle multiple payment methods via the --payment-method flag, so --payment-method x402 is the correct way to run the x402 scenario.
.cspell/custom-words.txt
Outdated
| Agentic | ||
| agenticpayments | ||
| Algorand | ||
| anotherterm |
There was a problem hiding this comment.
The word anotherterm appears to be an example placeholder from the AGENT.md documentation (lines 387-388). It should probably be removed from the project's actual custom words dictionary.
There was a problem hiding this comment.
Thanks! These placeholder words have been removed from the custom-words.txt file.
.cspell/custom-words.txt
Outdated
| celerybeat | ||
| classpath | ||
| CLASSPATH | ||
| customterm |
There was a problem hiding this comment.
The word customterm appears to be an example placeholder from the AGENT.md documentation (lines 387-388). It should probably be removed from the project's actual custom words dictionary.
There was a problem hiding this comment.
Thanks! These placeholder words have been removed from the custom-words.txt file.
| | License | Apache 2.0 | | ||
| | Languages | Python (primary), Go, Kotlin (Android) | | ||
| | Framework | Google Agent Development Kit (ADK) | | ||
| | LLM | Gemini 2.5 Flash | |
There was a problem hiding this comment.
The model name Gemini 2.5 Flash appears to be a typo. The latest available model in this family is Gemini 1.5 Flash. Please verify and correct the version number.
| | LLM | Gemini 2.5 Flash | | |
| | LLM | Gemini 1.5 Flash | |
There was a problem hiding this comment.
Gemini 2.5 Flash is the correct model name. It's Google's latest efficient "thinking model" that was released and is now generally available. See the https://docs.cloud.google.com/vertex-ai/generative-ai/docs/models/gemini/2-5-flash. The project consistently uses this model across README.md and code examples.
There was a problem hiding this comment.
Thank you for the clarification and the link to the documentation. I appreciate you providing the updated information. My apologies for the incorrect assumption; it seems I was working with outdated information regarding the latest model releases. I will ensure my knowledge base is updated accordingly. The current value Gemini 2.5 Flash is correct.
AGENT.md
Outdated
|
|
||
| agent = RetryingLlmAgent( | ||
| max_retries=5, | ||
| model='gemini-2.5-flash', |
There was a problem hiding this comment.
Similar to the project overview table, the model name gemini-2.5-flash in this code example seems to be a typo. It should likely be gemini-1.5-flash.
| model='gemini-2.5-flash', | |
| model='gemini-1.5-flash', |
There was a problem hiding this comment.
Gemini 2.5 Flash is the correct model name. It's Google's latest efficient "thinking model" that was released and is now generally available. See the https://docs.cloud.google.com/vertex-ai/generative-ai/docs/models/gemini/2-5-flash. The project consistently uses this model across README.md and code examples.
There was a problem hiding this comment.
Thank you for the clarification, onlyhyde. I appreciate you providing the context and the link to the official documentation. My apologies for the incorrect assumption; it's good to know that gemini-2.5-flash is the correct and intended model name for this project.
AGENT.md
Outdated
| customterm | ||
| anotherterm |
There was a problem hiding this comment.
The example words under Adding Custom Words for Spellcheck are not in alphabetical order, which contradicts the instruction on line 383. Swapping them would make the example consistent with the rule.
| customterm | |
| anotherterm | |
| anotherterm | |
| anotherterm |
There was a problem hiding this comment.
Thanks for catching this! I've already fixed it in a subsequent commit - the example now uses anotherword and myword in correct alphabetical order.
- Fix markdown lint errors (MD060, MD029, MD031) - Remove placeholder words from cspell dictionary - Fix alphabetical order in spellcheck example - Align table formatting for consistency
- Remove example words (newterm, yourterm) from custom-words.txt - Update AGENT.md example with cspell ignore directive - Fix alphabetical order in spellcheck example section Addresses code review feedback from PR google-agentic-commerce#142
1 participant
Summary
AGENT.mddocumentation for AI coding assistants (Gemini, Claude, Cursor, etc.).cspell/custom-words.txtwith technical terms (docstrings, shellcheck, shfmt)Changes
AGENT.md.cspell/custom-words.txtDocument Sections
GEMINI.md,CLAUDE.md)Checklist
Fixes #49