Skip to content

Node.js Version Requirements Missing from README #37

@tippi-fifestarr

Description

@tippi-fifestarr

Problem Description:

User testing confirmed that the README doesn't specify Node.js 20+ requirement, causing MCP server connection failures during setup. Developers attempting installation with Node 18 experience "Failed to connect" errors when the MCP server tries to start, with no clear indication that Node version is the root cause. This creates a complete setup blocker for developers using older Node versions, with advanced developers reporting significant time spent debugging MCP server connection issues before discovering the version incompatibility.

Reproduction Steps:

  1. Install Node.js 18: nvm install 18 && nvm use 18
  2. Install claude-code: npm install -g @anthropic-ai/claude-code
  3. Create test directory: mkdir test-project && cd test-project
  4. Add Aptos MCP server: claude mcp add -s local aptos-mcp npx -e APTOS_BOT_KEY=<valid_key> -- -y @aptos-labs/aptos-mcp
  5. Check MCP server status: claude mcp list
  6. Observe "✗ Failed to connect" error
  7. Switch to Node 20+: nvm use 20 && claude mcp list
  8. Observe "✓ Connected" success

Screenshots: N/A

Proposed Solution:

Investigation confirmed the issue: Code uses node: protocol imports requiring Node 16.14.0+, @aptos-labs/api-gateway-admin-api-client is built with Node 20.18.1, TypeScript configuration extends @tsconfig/node22, and testing confirmed Node 18 fails while Node 20+ works.

PR created: PR #36 - Adds Node.js 20+ requirement to README prerequisites, includes version check commands and upgrade instructions with nvm, and adds engines field to package.json for early warning detection.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions