docs(llm): clarify Vertex AI configuration options#318
Merged
asdek merged 1 commit intoMay 27, 2026
Merged
Conversation
Issue vxcontrol#310 asks how to provide a Google Vertex AI API key in .env for Anthropic Claude. PentAGI currently has no dedicated Vertex AI provider path in code: backend/pkg/config and backend/cmd/installer do not read VERTEX_API_KEY, GOOGLE_APPLICATION_CREDENTIALS, or any vertex_ai variable. The supported routes for Claude today are direct Anthropic (ANTHROPIC_API_KEY / ANTHROPIC_SERVER_URL) and AWS Bedrock (BEDROCK_*). Document this explicitly so users do not assume a hidden Vertex AI configuration path exists: - README.md: add a NOTE callout inside the Anthropic Provider Configuration section listing the supported routes and pointing users who need Vertex AI today at the OpenAI-compatible custom LLM provider path (LLM_SERVER_URL / LLM_SERVER_KEY / LLM_SERVER_MODEL) fronted by a translating gateway, with a caveat that reliability depends on the gateway. - backend/docs/config.md: add a matching Note paragraph under the Anthropic section that points at the AWS Bedrock and custom LLM provider sections, and states that no VERTEX_API_KEY or GOOGLE_APPLICATION_CREDENTIALS variable is wired into provider initialization today. Docs-only change. No runtime Go code, no installer behavior, no generated files, no new environment variables. All env var names cited in the new text already exist in the current PentAGI .env.example, backend/pkg/config, and backend/cmd/installer.
Contributor
There was a problem hiding this comment.
Pull request overview
Updates PentAGI’s LLM provider documentation to explicitly clarify that Anthropic Claude via Google Vertex AI is not currently configurable through dedicated .env variables, and to point users to the supported configuration paths that work today (direct Anthropic, AWS Bedrock, or a Custom LLM gateway workaround). This addresses confusion raised in issue #310 without changing runtime behavior.
Changes:
- Add a GitHub NOTE callout in
README.mdunder Anthropic provider configuration explaining the lack of Vertex AI.envwiring and listing supported Claude routes. - Add a matching “Note on Google Vertex AI” in
backend/docs/config.md, including links to the AWS Bedrock and Custom LLM provider sections and explicitly stating noVERTEX_API_KEY/GOOGLE_APPLICATION_CREDENTIALSwiring exists today.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Adds an Anthropic section NOTE clarifying Vertex AI isn’t directly configurable and describes supported alternatives/workaround. |
| backend/docs/config.md | Adds an Anthropic note clarifying no Vertex AI env vars are wired and points to Bedrock/Custom LLM provider configuration sections. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
|
thank you for the PR! |
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
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
Clarify in the user-facing LLM provider docs that PentAGI does not currently expose a dedicated Google Vertex AI configuration path for Anthropic Claude in
.env, and describe the routes that actually work today (direct Anthropic, AWS Bedrock, or a custom OpenAI-compatible gateway).Docs-only change. No Go code, no installer behavior, no new environment variables.
Problem
Issue #310 asks how to provide a Google Vertex AI API key in
.envfor Anthropic Claude. PentAGI's.env.example,backend/pkg/config, andbackend/cmd/installer/wizarddo not read anyVERTEX_*,GOOGLE_APPLICATION_CREDENTIALS, orvertex_aivariable. The current provider initialization for Claude only knows about:ANTHROPIC_API_KEY/ANTHROPIC_SERVER_URL(direct Anthropic API)BEDROCK_REGION/BEDROCK_DEFAULT_AUTH/BEDROCK_BEARER_TOKEN/BEDROCK_ACCESS_KEY_ID/BEDROCK_SECRET_ACCESS_KEY/BEDROCK_SESSION_TOKEN/BEDROCK_SERVER_URL(AWS Bedrock)LLM_SERVER_URL/LLM_SERVER_KEY/LLM_SERVER_MODEL(custom OpenAI-compatible endpoint)Today this leaves users guessing whether some hidden Vertex AI configuration exists. The user in issue #310 hit exactly this — they "tried multiple methods of adding Anthropic's Claude models Vertex AI keys but the application couldn't parse it."
Solution
Add a small clarification in two places, matching the existing style of each file:
README.md: a> [!NOTE]callout inside the Anthropic Provider Configuration section. It states the current limitation, lists the supported Claude routes (direct Anthropic, AWS Bedrock), and describes the safest workaround for users who must use Vertex AI today (front it with an OpenAI-compatible gateway and configure the existing Custom LLM provider, with a caveat that reliability depends on the gateway).backend/docs/config.md: a matching Note paragraph under the Anthropic section, pointing at the AWS Bedrock LLM Provider and Custom LLM Provider sections already in the same doc, and stating that noVERTEX_API_KEYorGOOGLE_APPLICATION_CREDENTIALSvariable is wired into provider initialization today.Wording is intentionally hedged ("currently", "at this time", "today") to avoid permanent claims, and no fake env vars are introduced.
User Impact
.envkeys that do nothing.Test Plan
git diff --checkcleangit statusshows onlyREADME.mdandbackend/docs/config.mdmodified; no unrelated dirty files stagedANTHROPIC_API_KEY,ANTHROPIC_SERVER_URL:backend/pkg/config/config.go,.env.example, README,backend/docs/config.mdBEDROCK_REGION,BEDROCK_DEFAULT_AUTH,BEDROCK_BEARER_TOKEN,BEDROCK_ACCESS_KEY_ID,BEDROCK_SECRET_ACCESS_KEY,BEDROCK_SESSION_TOKEN,BEDROCK_SERVER_URL:backend/pkg/config/config.go,.env.example, README,backend/docs/config.mdLLM_SERVER_URL,LLM_SERVER_KEY,LLM_SERVER_MODEL:backend/pkg/config/config.go,.env.example,backend/docs/config.mdVERTEX_*,vertex_ai, andGOOGLE_APPLICATION_CREDENTIALSare NOT present inbackend/pkg/configorbackend/pkg/providers— the doc claim that no such variable is wired in today is accurate#aws-bedrock-provider-configuration(README) and#aws-bedrock-llm-provider+#custom-llm-provider(config.md) match real headings in the same filesRefs #310