docs: name all five providers, and the flagship we actually default to - #46
Merged
Conversation
The front page described three providers and an Opus that is no longer the flagship, and said nothing about the HTTP mode the server has shipped since Cloud Run support landed. - Both Vertex providers join the README, the --help text, and the architecture doc. registry.ts exposes five: google, anthropic, openai, google-vertex, and anthropic-vertex. The --help text listed Google Vertex but not Anthropic's, so it named four of the five - The Anthropic flagship is Claude Opus 4.7, which is DEFAULT_MODEL in src/providers/anthropic.ts. The README still advertised Opus 4.6, which the same list carries as "Previous flagship" - A "Running as a hosted server" section covers the PORT-triggered Streamable HTTP mode and its /mcp, /analyze, and /health routes, and links deploy/README.md. docs/architecture.md gets a link too; it was reachable from nothing - The stdio diagram in docs/architecture.md no longer offers VS Code as an example client. #45 removed it from the supported list, but the words sat inside ASCII box art split across two lines, so a grep for "VS Code" never found them Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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
1 participant
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.
Third repo in the same pass, after IntelligentElectron/universal-netlist#122 and IntelligentElectron/pcb-lens#59.
Two providers were missing from every description
src/providers/registry.tsexposes five providers. The README named three, and--helpnamed four (it had Google's Vertex but not Anthropic's):--helpgoogleanthropicopenaigoogle-vertexanthropic-vertexThe advertised flagship was the previous one
src/providers/anthropic.tssetsDEFAULT_MODEL = "claude-opus-4-7"and labelsclaude-opus-4-6as"Previous flagship". The setup table advertised 4.6 as the flagship, so the README recommended a model the tool itself has moved on from. 4.6 is still selectable, and is now described as such.HTTP mode was undocumented on the front page
PORTstarts Streamable HTTP instead of stdio, serving/mcp,POST /analyze, andGET /health, anddeploy/carries a full Cloud Run guide with a provider/auth matrix. None of it was reachable from the README, nor wasdocs/architecture.md. Both are linked now.A leftover from #45
#45 removed VS Code (GitHub Copilot) from the supported clients, but the stdio diagram in
docs/architecture.mdstill offered it as an example. The string survived because ASCII box art splits it across two lines (│ Code, VS │/│ Code, etc) │), so a grep for "VS Code" does not match it.Testing
npm testis green (98 passed, 2 skipped). Note thatkeychain.test.tsandtransports/http.test.tsfail under a restrictive sandbox, since they need keychain access and a loopback socket; they pass normally and fail identically on an unmodified tree.Changelog
The README,
--help, and architecture doc describe all five providers, including Anthropic on Vertex AI, which no description mentioned. The Anthropic flagship is listed as Claude Opus 4.7, the model the server defaults to, rather than 4.6. The README now documents thePORT-triggered HTTP mode and links the Cloud Run deployment guide.🤖 Generated with Claude Code