Skip to content

docs: backfill JSDoc for all tool handlers in index.js#14

Open
cortexc0de wants to merge 1 commit into
0xKoda:mainfrom
cortexc0de:docs/backfill-jsdoc
Open

docs: backfill JSDoc for all tool handlers in index.js#14
cortexc0de wants to merge 1 commit into
0xKoda:mainfrom
cortexc0de:docs/backfill-jsdoc

Conversation

@cortexc0de
Copy link
Copy Markdown

@cortexc0de cortexc0de commented Feb 22, 2026

Summary

  • Add module-level @file JSDoc block describing the WireMCP server, its seven tools, dependencies, and startup example
  • Add @async/@returns/@throws JSDoc to findTshark() helper documenting PATH resolution and fallback logic
  • Add @param/@returns/@sideeffects/@throws JSDoc to all seven server.tool() handlers: capture_packets, get_summary_stats, get_conversations, check_threats, check_ip_threats, analyze_pcap, extract_credentials

Test plan

  • Verify node index.js starts without syntax errors
  • Confirm JSDoc blocks appear correctly with a documentation generator
  • Review that all exported tool names are documented

Nightshift-Task: docs-backfill
Nightshift-Ref: https://github.com/marcus/nightshift

Generated with Claude Code


Automated by nightshift

Add module-level @file JSDoc preamble and JSDoc block comments to
findTshark() and all seven server.tool() registrations:
capture_packets, get_summary_stats, get_conversations, check_threats,
check_ip_threats, analyze_pcap, and extract_credentials.

Nightshift-Task: docs-backfill
Nightshift-Ref: https://github.com/marcus/nightshift

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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