docs(mcp): state Node.js prerequisite - #57
Conversation
@microlink/mcp declares engines.node >= 24; a clean npx run on an older Node warns EBADENGINE and fails outright under engine-strict. Say so in the README, with a test deriving the minimum from package.json. Signed-off-by: Jose Francisco 'Kiko' Verdú Gambín <2096101+Kikobeats@users.noreply.github.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (2)
Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review. 📝 WalkthroughWalkthroughThe MCP package README now documents Node.js 24 or newer. A new test verifies that this text matches the minimum version in ChangesNode.js requirement documentation
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~5 minutes Change: Other Merge Risk: ⚪ Minimal · up to The README now documents the package's Node.js 24 requirement, with a test checking that it stays aligned with package.json. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Coverage Report for CI Build 34747035700Warning No base build found for commit Coverage: 79.621%Details
Uncovered ChangesNo uncovered changes found. Coverage RegressionsRequires a base build to compare against. How to fix this → Coverage Stats
💛 - Coveralls |
|
@coderabbitai review |
✅ Action performedReview finished.
|
Problem
@microlink/mcpdeclares"engines": { "node": ">= 24" }, but the README never says so. On Node 22 a cleannpx -y @microlink/mcprun emits EBADENGINE warnings and fails outright underengine-strict- the very first onboarding step, found during the real-client audit.Fix
State the requirement at the top of Install: "Requires Node.js 24 or newer." The regression test derives the minimum major version from
package.jsonengines.node, so it cannot drift from the docs.Tests
New
readme-requirements.test.js. MCP suite 104/104 (8 live opt-in tests skipped), lint green.Note
Low Risk
Documentation and a docs-sync test only; no runtime or API behavior changes.
Overview
Documents the Node.js 24+ prerequisite in the MCP package Install section so it matches
package.jsonengines.nodeand onboarding is clear beforenpx.Adds
readme-requirements.test.js, which reads the minimum major version fromengines.nodeand asserts the README includesNode.js {N} or newer, so docs cannot drift from the declared engine constraint.Reviewed by Cursor Bugbot for commit a363e6d. Bugbot is set up for automated code reviews on this repo. Configure here.
Summary by CodeRabbit
Documentation
Tests