[AAASM-4837] 📝 (examples): Correct node examples' fictional real-provider-mode guidance#337
Merged
Merged
Conversation
The langchain-js-basic-agent README advertised a 'Real-provider mode' (cp .env.example, then pnpm start connects to a real gateway/OpenAI) and an impossible 'Gateway connection refused' troubleshooting row, but src/ reads no env vars — the offline fail-closed policy stub always runs. Replace with an honest offline-only note and drop the non-functional .env.example. Refs AAASM-4837 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Same fiction as langchain-js: a 'Real-provider mode' section and an impossible 'Gateway connection refused' troubleshooting row, while src/ reads no env vars. Replace with the honest offline-only note and drop the non-functional .env.example. (src/tools.ts is owned by AAASM-4846 and left untouched.) Refs AAASM-4837 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The 'Note on .env.example' told readers to set AAASM_GATEWAY_URL directly to connect to a real gateway, but src/ reads no env vars. Replace with the honest offline-only note and drop the non-functional .env.example. Refs AAASM-4837 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The 'Note on .env.example' claimed setting AAASM_GATEWAY_URL / OPENAI_API_KEY would connect to a real gateway / drive a real LLM, but src/ reads no env vars. Replace with the honest offline-only note and drop the non-functional .env.example. Refs AAASM-4837 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The 'Note on .env.example' claimed setting AAASM_GATEWAY_URL / OPENAI_API_KEY would connect to a real gateway / drive a real LLM, but src/ reads no env vars. Replace with the honest offline-only note and drop the non-functional .env.example. Refs AAASM-4837 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The 'Note on .env.example' referenced a .env.example that never existed in this directory and claimed AAASM_GATEWAY_URL would connect to a real gateway, but src/ reads no env vars. Replace with the honest offline-only note (drop the dangling reference rather than create a non-functional file). Refs AAASM-4837 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Contributor
Author
🤖 Claude Code — PR reviewScope (AAASM-4837, MED): ✅ 6 node READMEs corrected to honest offline-only; 5 non-functional
|
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.



What changed
The six
node/*example READMEs described a "real-provider mode" that doesnot exist. Several claimed that copying
.env.exampleto.envand settingAAASM_GATEWAY_URL/OPENAI_API_KEYwould makepnpm start"connect to thereal gateway and real OpenAI API," and two shipped an impossible
Gateway connection refused → omit AAASM_GATEWAY_URLtroubleshooting row. Inreality none of the
node/*/srcfiles read any environment variable,dotenv, orinitAssembly(grep→ 0 matches): the offline, in-processfail-closed policy stub (
createPolicyGatewayClientin eachsrc/policy.ts)always runs, so those env vars have zero effect.
node/custom-tool-policyalsoreferenced a
.env.examplethat never existed in its directory.This PR corrects the docs to match reality (honest-minimal — no code wiring):
single consistent "Offline-only demo (no real-provider mode)" note that
states the example runs fully offline via the local policy stub, reads no env
vars, and that real gateway/LLM wiring is a possible future enhancement, not
current behavior.
.env.examplefiles (their vars are neverread) and removed all references to them, including the dangling reference in
custom-tool-policy.No
node/*/src/*.tswas touched. In particularopenai-node-tool-policy/src/tools.tsis deliberately left to sibling ticket AAASM-4846.
Follow-up (out of scope here): actually wiring real
initAssemblyenv-drivenbehavior into these six examples would be a separate feature ticket, not a doc fix.
Related ticket
Closes AAASM-4837
Jira: https://lightning-dust-mite.atlassian.net/browse/AAASM-4837
How to verify
grep -rn "process.env\|dotenv\|initAssembly" node/*/src/→ still 0 matches(the env vars genuinely have no effect).
grep -rn "Real-provider\|cp .env\|connect to the real\|Gateway connection refused" node/*/README.md→ no matches (fiction removed).
ls node/*/.env.example→ none remain; no README references.env.example.AAASM_GATEWAY_URL/OPENAI_API_KEYmention is onlyinside the honest "these have no effect here" note.
Checklist
[AAASM-XXXX] <GitEmoji> (<scope>): <summary>.envfiles committedREADME.mdwith prerequisites and run instructions🤖 Generated with Claude Code