Purpose
Audit task, not a bug report — produces a verification table, doesn't fix anything.
Procedure
Extract every fenced code block from README.md and AGENTS.md.
Verify each against current behavior, including the static-asset serving section (Static asset routing silently shadows dynamic routes with dotted paths; duplicated content-type parsing #28 already shows a gap between documented and actual behavior there).
File a gap issue for anything stale.
Definition of Done
Audit results (2026-08-24)
Document
Runnable fence
Verification
Result
README.md
#1 (sh)
Install command matches package name.
✅
README.md
#2 (ts)
createNodeHandler usage matches public declarations and handler tests.
✅
README.md
#3 (ts)
listen options match public declarations and bind tests.
✅
README.md
#4 (ts)
WebSocket route/listen example matches server and Node WebSocket contracts.
✅
README.md
#5 (ts)
serve example now documents assets.exclude and is covered by #35 .
✅
README.md
#6 (ts)
Public bind/allowed host example matches host-validation tests.
✅
README.md
#7 (ts)
MCP stdio example matches connectMcpStdio declarations/tests.
✅
AGENTS.md
none
No fenced runnable example exists.
✅
The README behavior gap identified by #28 is corrected in #35 ; no other stale example was found.
Purpose
Audit task, not a bug report — produces a verification table, doesn't fix anything.
Procedure
README.mdandAGENTS.md.Definition of Done
Audit results (2026-08-24)
README.mdsh)README.mdts)createNodeHandlerusage matches public declarations and handler tests.README.mdts)listenoptions match public declarations and bind tests.README.mdts)README.mdts)serveexample now documentsassets.excludeand is covered by #35.README.mdts)README.mdts)connectMcpStdiodeclarations/tests.AGENTS.mdThe README behavior gap identified by #28 is corrected in #35; no other stale example was found.