From 6aa43ff7dd19f593283a4cf8385b15606fc9a7dc Mon Sep 17 00:00:00 2001 From: Scrum4Me Agent <30029041+madhura68@users.noreply.github.com> Date: Thu, 7 May 2026 21:44:41 +0200 Subject: [PATCH] PBI-55: .env.example descriptive push placeholders + README push-integration section Co-Authored-By: Claude Sonnet 4.6 --- .env.example | 6 ++++-- README.md | 4 ++++ 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/.env.example b/.env.example index 4a99af7..62b28f7 100644 --- a/.env.example +++ b/.env.example @@ -5,5 +5,7 @@ DATABASE_URL="postgresql://user:pass@host:5432/dbname" SCRUM4ME_TOKEN="" # Internal push endpoint (main-app) for web-push notifications -INTERNAL_PUSH_URL="" -INTERNAL_PUSH_SECRET="" +# Set to the main-app /api/internal/push/send URL; leave empty to disable push (feature-gated). +INTERNAL_PUSH_URL="https://scrum4me.example.com/api/internal/push/send" +# Shared secret (≥32 chars) — must match INTERNAL_PUSH_SECRET in the main-app env. +INTERNAL_PUSH_SECRET="" diff --git a/README.md b/README.md index fb20e38..793cc07 100644 --- a/README.md +++ b/README.md @@ -296,6 +296,10 @@ Minimale agent-prompt (geen CLAUDE.md-context nodig): > *Pak de volgende job uit de Scrum4Me-queue.* +## Web-push integration + +When `INTERNAL_PUSH_URL` and `INTERNAL_PUSH_SECRET` are set, the MCP server fires a fire-and-forget push notification to the main-app's internal endpoint (`/api/internal/push/send`) on two events: when `ask_user_question` creates a new question (tag `claude-q-`), and when `update_job_status` transitions a job to `done` or `failed` (tag `job-`). Both calls are wrapped in a 5 s `AbortController` timeout and a `try/catch` so a push failure never interrupts the tool response. Omitting the env vars disables the feature entirely. The `INTERNAL_PUSH_SECRET` value must match the one configured in the main-app; generate a fresh secret with `openssl rand -hex 32`. + ## Schema sync The Prisma schema is the source of truth in the upstream Scrum4Me