diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..0b68a6f --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,2 @@ +github: [smileygames] +patreon: yoshiharuuematsu diff --git a/README.md b/README.md index 1478065..76d30ba 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,16 @@ Detailed behavior, event metadata, trigger semantics, and file responsibilities - Supports direct trigger mode for immediate Codex reactions per event. - Ships as a Node-based `.mcpb` desktop extension and as an `npx` MCP server. +## Prerequisites + +| Component | Required for | Install | +|-----------|-------------|---------| +| **Python 3.12+** | Webhook receiver | [python.org](https://www.python.org/downloads/) — check "Add python to PATH" during install | +| **Node.js 18+** | MCP server (`npx`) | [nodejs.org](https://nodejs.org/) | +| **NSSM** *(optional)* | Running receiver as a Windows service | [nssm.cc](https://nssm.cc/) — extract and add to PATH | + +> Only install what you need. If you only use the `.mcpb` desktop extension, Python alone is sufficient for the receiver. + ## Installation ### Claude Desktop — Desktop Extension (.mcpb) @@ -131,7 +141,42 @@ python codex_reaction.py --workspace /path/to/workspace --resume-session \AppData\Local\Programs\Python\Python312\python.exe +# Startup dir: C:\Users\\github-webhook-mcp +# Arguments: main.py webhook --port 8080 --event-profile notifications +``` + +Or configure non-interactively from an **elevated** PowerShell: + +```powershell +nssm install github-webhook-mcp "C:\Users\\AppData\Local\Programs\Python\Python312\python.exe" +nssm set github-webhook-mcp AppDirectory "C:\Users\\github-webhook-mcp" +nssm set github-webhook-mcp AppParameters "main.py webhook --port 8080 --event-profile notifications" +nssm set github-webhook-mcp AppEnvironmentExtra "WEBHOOK_SECRET=your_secret" +nssm start github-webhook-mcp +``` + +Common management commands: + +```powershell +nssm status github-webhook-mcp # check status +nssm restart github-webhook-mcp # restart +nssm edit github-webhook-mcp # re-open the GUI +nssm remove github-webhook-mcp confirm # uninstall +``` + +> **Alternatives:** `sc create` with a `pywin32` service wrapper, or [WinSW](https://github.com/winsw/winsw) with an XML config, also work. NSSM requires no code changes. + +### 7. Optional channel push notifications The Node.js MCP server supports Claude Code's `claude/channel` capability (research preview, v2.1.80+). When enabled, new webhook events are pushed into your session automatically.