Skip to content

docs(mcp): state Node.js prerequisite - #57

Open
Kikobeats wants to merge 1 commit into
masterfrom
docs/mcp-node-prerequisite
Open

docs(mcp): state Node.js prerequisite#57
Kikobeats wants to merge 1 commit into
masterfrom
docs/mcp-node-prerequisite

Conversation

@Kikobeats

@Kikobeats Kikobeats commented Sep 13, 2026

Copy link
Copy Markdown
Member

Problem

@microlink/mcp declares "engines": { "node": ">= 24" }, but the README never says so. On Node 22 a clean npx -y @microlink/mcp run emits EBADENGINE warnings and fails outright under engine-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.json engines.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.json engines.node and onboarding is clear before npx.

Adds readme-requirements.test.js, which reads the minimum major version from engines.node and asserts the README includes Node.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

    • Updated installation guidance to state that Node.js 24 or newer is required.
  • Tests

    • Added validation to ensure the documented Node.js requirement matches the package configuration.

@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>
@coderabbitai

coderabbitai Bot commented Sep 13, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 054e3ea2-f455-4c10-ab37-0924c73074e5

📥 Commits

Reviewing files that changed from the base of the PR and between 69d1f76 and a363e6d.

📒 Files selected for processing (2)
  • packages/mcp/README.md
  • packages/mcp/test/readme-requirements.test.js

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The MCP package README now documents Node.js 24 or newer. A new test verifies that this text matches the minimum version in package.json.

Changes

Node.js requirement documentation

Layer / File(s) Summary
Requirement documentation and validation
packages/mcp/README.md, packages/mcp/test/readme-requirements.test.js
The README states the Node.js 24 requirement. The test reads package.json and checks for the matching README phrase.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to a363e

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)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: documenting the Node.js prerequisite for MCP.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/mcp-node-prerequisite

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coveralls

Copy link
Copy Markdown

Coverage Report for CI Build 34747035700

Warning

No base build found for commit 69d1f76 on master.
Coverage changes can't be calculated without a base build.
If a base build is processing, this comment will update automatically when it completes.

Coverage: 79.621%

Details

  • Patch coverage: No coverable lines changed in this PR.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

Requires a base build to compare against. How to fix this →


Coverage Stats

Coverage Status
Relevant Lines: 5196
Covered Lines: 4148
Line Coverage: 79.83%
Relevant Branches: 869
Covered Branches: 681
Branch Coverage: 78.37%
Branches in Coverage %: Yes
Coverage Strength: 25.95 hits per line

💛 - Coveralls

@Kikobeats

Copy link
Copy Markdown
Member Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Sep 13, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants