Skip to content

Warn about ws:// key revocation, correct the Node floor - #2

Merged
maverick0628 merged 1 commit into
mainfrom
docs/wss-warning-and-node-floor
Aug 4, 2026
Merged

Warn about ws:// key revocation, correct the Node floor#2
maverick0628 merged 1 commit into
mainfrom
docs/wss-warning-and-node-floor

Conversation

@maverick0628

Copy link
Copy Markdown
Owner

Two documentation corrections, both found by checking claims against the code rather than trusting them.

ws:// silently kills your API key

src/client.ts:28-30 rewrites http:// and https:// to wss://, but an explicit ws:// passes through untouched. TrueNAS auto-revokes any API key it sees used over an insecure transport, so the result is an authentication failure that looks like a typo in the key — except the key really is dead and needs regenerating.

Nothing in the README said so. Added as a callout in Configuration.

The Node floor was stated three ways

Source Claim
README Node.js 20+
package.json engines >=18.0.0
CI runtime job builds and imports on 18 and 22

18 is the verified answer — @modelcontextprotocol/sdk declares >=18, the build targets ES2022, and CI now imports the built server on 18 every run. README corrected to match, rather than leaving the one number nothing was checking.

client.ts rewrites http:// and https:// to wss://, but an explicit ws://
passes through untouched — and TrueNAS auto-revokes any API key it sees
used over an insecure transport. The failure presents as a bad key, and
the key really is dead, so it is worth naming.

README claimed Node 20+ while package.json declared >=18 and CI now
proves the built server imports on 18. Corrected to match the verified
floor rather than the middle guess.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@maverick0628
maverick0628 merged commit ecdcfd8 into main Aug 4, 2026
3 checks passed
@maverick0628
maverick0628 deleted the docs/wss-warning-and-node-floor branch August 4, 2026 17:07
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.

1 participant