docs: canonicalise GEMINI_API_KEY as the documented env var#3
Merged
will-fawcett-trillium merged 1 commit intomainfrom Apr 29, 2026
Merged
Conversation
The two env vars were aliases for the same key, but `.env.example` and the README listed them side-by-side as if they were different options, which suggested users had to choose one (or both). Now: - `.env.example` shows only `GEMINI_API_KEY`, with a comment that `GOOGLE_API_KEY` is also accepted (it's the SDK's own default name). - README's Gemini env-var table collapses to a single `GEMINI_API_KEY` row, with the same fallback note alongside. No code change: `genai.py:11` still reads either, so anyone whose shell already exports `GOOGLE_API_KEY` keeps working.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
.env.exampleand the README's Gemini section listedGEMINI_API_KEYorGOOGLE_API_KEYas if they were two separate options. They aren't - the code insrc/gee_mcp/server/genai.py:11reads either, so they're aliases for the same key. Listing both implies you need to pick one and confuses new users.This PR canonicalises on
GEMINI_API_KEYin the docs and demotesGOOGLE_API_KEYto a footnoted fallback. No code change - the dual-name read ingenai.pystays so anyone already exportingGOOGLE_API_KEYkeeps working.Changes
.env.example: Path A block now shows only# GEMINI_API_KEY=with a comment notingGOOGLE_API_KEYis also accepted.README.md: Gemini env-var table collapses to a singleGEMINI_API_KEYrow, with the fallback note as a sentence beneath.Test plan
python3 -m pytest tests- 23/23 passgrep -n "GEMINI_API_KEY\|GOOGLE_API_KEY" .env.example README.md src/gee_mcp/server/genai.py- only the intended references remain