docs(readme): add codegraph_explore to MCP Tools table and bump Node badge to 20+#226
Open
AimoreRRD wants to merge 1 commit into
Open
docs(readme): add codegraph_explore to MCP Tools table and bump Node badge to 20+#226AimoreRRD wants to merge 1 commit into
AimoreRRD wants to merge 1 commit into
Conversation
…badge to 20+ Two small README mismatches between docs and project state: 1. MCP Tools table is missing `codegraph_explore`. src/mcp/tools.ts exports 9 tools but the table lists 8 — `codegraph_explore` is absent despite being referenced prominently elsewhere in the same README (lines 96, 239, 243, 246, 247). Added between `codegraph_node` and `codegraph_files` to match the source-file order. 2. Node.js badge is stale. package.json engines have been ">=20.0.0" since the better-sqlite3 ^12.4.1 bump (commit 9b06b0e dropped Node 18 prebuilds), so the "Node.js 18+" badge misleads users.
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.
Two small README mismatches between the docs and the current project state:
1.
codegraph_exploreis missing from the MCP Tools tablesrc/mcp/tools.tsexports 9 tools, but the table near the bottom of the README lists only 8 —codegraph_exploreis absent. The tool is referenced prominently elsewhere in the same README (lines 96, 239, 243, 246, 247) including being singled out as a primary exploration tool, so a reader who skims the table can miss that it exists.Added a row between
codegraph_nodeandcodegraph_filesto match the source-file order. Description matches the opening sentence of the tool's owndescriptionfield insrc/mcp/tools.ts.2. Node.js badge is stale (says 18+, should be 20+)
package.jsonengineshas required>=20.0.0since commit 9b06b0e (fix(db): require better-sqlite3 ^12.4.1 so Node 24 gets the native backend), which explicitly raised the floor because Node 18 was EOL and dropped from better-sqlite3 12.x prebuilds. The badge still claims "Node.js 18+", which misleads users.Bumped the badge to
20+. (Left the upper bound alone — the engines pin<25.0.0is being addressed by PR #222 and a one-shot badge change shouldn't pre-empt that.)Scope
README.mdtouched.