Relay

Relay

Plain-English client updates from every GitHub push

[CI] [Node.js Version]

Live at relay-vishnu.fly.dev. Install the GitHub App, then add https://relay-vishnu.fly.dev/mcp to your MCP client, find Relay in the MCP Registry, or install the extension from the VS Code Marketplace or Open VSX.

Relay is a GitHub App for freelancers and agencies. Install it on your repositories, map each one to a client, and every push to the main branch becomes a short, jargon-free email summary written by Claude. Clients confirm by email before anything is sent, and every digest has a one-click unsubscribe.

How it works

sequenceDiagram    participant Dev    participant GitHub    participant Web as Relay web    participant Queue as Postgres (pg-boss)    participant Worker as Relay worker    participant Claude    participant Resend    participant Client
    Dev->>GitHub: git push    GitHub->>Web: POST /webhook/github (HMAC-signed, installation id)    Web->>Web: verify signature, claim X-GitHub-Delivery    alt duplicate, filtered, or client not confirmed        Web-->>GitHub: 200 duplicate / filtered    else new push for an active mapping        Web->>Queue: enqueue process-push        Web-->>GitHub: 202 accepted        Queue->>Worker: job        Worker->>Claude: summarize commits (structured output), unless over the monthly cap        Claude-->>Worker: validated summary        Worker->>Resend: digest email + List-Unsubscribe        Resend-->>Client: digest    end

• GitHub App: one install connects any number of repositories, and no personal access tokens are needed (ADR 002).
• Multi-tenant: every row belongs to an installation, users are authorized by the installations GitHub says they can access, and uninstalling deletes that tenant's data.
• Postgres + pg-boss: the webhook replies 202 immediately, and a separate worker sends digests with retries and backoff (ADR 003).
• Consent built in: double opt-in confirmation, signed one-click unsubscribe (RFC 8058), and confirm/unsubscribe pages that only change state on POST.
• Cost controls: per-installation monthly cap on Claude-written digests (plain digests past it), token usage tracking, and a CLAUDE_ENABLED kill switch.
• Spec-first: OpenAPI 3.1 and JSON Schema contracts enforced at runtime and in CI.
• Remote MCP server with OAuth 2.1: add one URL to Claude Code, Claude Desktop, VS Code or Cursor, sign in with GitHub, and manage Relay by chatting (docs/mcp.md, ADR 004, ADR 005).
• Dashboard: a small server-rendered UI at /dashboard for people who don't use MCP.
• Richer summaries (opt-in): merged PR descriptions from GitHub, and issue details from the tenant's ticket tracker through Anthropic's MCP connector, with read-only tool allowlists and fallbacks (docs/summaries.md).

Running locally

Prerequisites: Node.js 22.12+, Docker (for Postgres), a GitHub App, an Anthropic API key and a Resend API key.

git clone https://github.com/vishnumuthyalu/relay-extension.gitcd relay-extensionnpm installcp .env.example .env          # fill in the values; see docs/github-app.mddocker compose up -d db       # Postgres on localhost:5432 (dev + test databases)npm run migratenpm run dev                   # web process on :3000npm run dev:worker            # worker process, in a second terminal

GitHub must reach your machine for webhooks and sign-in, so run a tunnel (ngrok http 3000) and use its URL as PUBLIC_URL and in the app settings.

Then:

1. Open PUBLIC_URL/install and install the app on a repository.
2. Open PUBLIC_URL/dashboard and sign in with GitHub.
3. Map the repository to a client in the dashboard, with the API (below) or with the MCP tools. The client receives a confirmation email.
4. After the client confirms, push to the default branch, or run node simulate-webhook.js.

To run everything in containers instead: docker compose up --build.

Deploying

One image, two processes (web, worker), one Postgres. The hosted instance runs on Fly.io (one web and one worker machine) with Supabase Postgres; migrations run as Fly's release command before each deploy. See docs/deploy.md. Tags drive releases: v* deploys the backend and updates the MCP Registry entry, and ext-v* publishes the VS Code extension.

Configuration

All settings are environment variables; .env.example lists and explains each one. The web and worker processes refuse to start if a required value is missing.

API

The JSON API is described in spec/openapi.yaml and validated at runtime. It uses the session cookie from Sign in with GitHub.

Other routes: POST /webhook/github (GitHub App deliveries), /mcp (remote MCP), /oauth/* and /.well-known/* (OAuth for MCP clients), /dashboard, /auth/login, /auth/callback, POST /auth/logout, /install, /confirm, /unsubscribe, /privacy, /health, /ready.

MCP server

Remote: add https://relay-vishnu.fly.dev/mcp to your MCP client (or https://<host>/mcp for your own deployment). For example:

claude mcp add --transport http relay https://relay-vishnu.fly.dev/mcp

Local, against your own database:

RELAY_INSTALLATION_ID=12345678 npm run mcp   # stdio server for one installationnpm run mcp:inspect                          # open it in the MCP Inspector

Client setup is in docs/mcp.md, and the tool contract is in spec/mcp-tools.md.

Testing

Tests run against a real Postgres: each test file gets its own schema, so suites run in parallel. docker compose up -d db creates the relay_test database.

npm testnpm run lintnpx @stoplight/spectral-cli lint spec/openapi.yaml --ruleset .spectral.yaml

CI runs the same steps on Node 22 and 24 with a Postgres service container, and fails if coverage drops (npm run test:coverage).

Project structure

relay-extension/├── server.js                 # Web process: webhooks, sign-in, API, email link pages├── worker.js                 # Worker process: sends digests from the queue├── lib/│   ├── config.js             # Env validation│   ├── db/                   # Postgres pool, migrations runner, tenant-scoped queries│   ├── jobs/process-push.js  # One delivery: caps, Claude or fallback, email, records│   ├── queue.js              # pg-boss setup│   ├── service.js            # Per-installation operations shared by API and MCP│   ├── pipeline.js           # Summarize + email│   ├── claude.js             # Claude structured outputs + schema validation│   ├── email.js              # Email HTML, unsubscribe headers, Resend│   ├── links.js              # Signed confirm/unsubscribe links│   ├── github.js             # GitHub OAuth (Sign in with GitHub)│   ├── oauth/                # MCP authorization server: clients, tokens, JWT│   ├── context/              # Optional PR and ticket context for summaries│   ├── github-app.js         # GitHub App JWT and installation tokens│   ├── crypto-box.js         # AES-256-GCM for stored tracker tokens│   ├── html.js, csrf.js      # Server-rendered pages and form protection│   ├── security.js           # Webhook HMAC verification│   └── retry.js              # Retry with backoff for Claude and Resend├── routes/                   # webhook, mcp, oauth, auth, dashboard, api, email links├── migrations/               # Numbered SQL migrations├── mcp/                      # MCP server, tools, resources, stdio entrypoint├── spec/                     # OpenAPI, JSON Schemas, webhook and MCP contracts├── tests/                    # Jest suites + helpers (per-file Postgres schema)├── extension/                # VS Code extension: registers the remote MCP server├── server.json               # MCP Registry entry├── fly.toml                  # Fly.io deployment (web + worker, migrations on release)├── docs/                     # GitHub App, MCP, summaries, deployment, ADRs, sequence diagram├── docker-compose.yml└── Dockerfile

Security

• Webhooks are verified with HMAC-SHA256 (constant-time) before anything else reads the body.
• Delivery IDs are claimed atomically, so duplicates and redeliveries never send twice.
• Sessions are signed httpOnly cookies with SameSite=Lax. The JSON API only accepts JSON bodies, which blocks cross-site form posts.
• Tenant data is always queried by installation, and other tenants' installations return 404.
• Email links are HMAC-signed and bound to the current address. Changing a client's email invalidates old links.
• Everything rendered into email or pages is HTML-escaped. Commit text is passed to Claude as untrusted data, and replies are schema-validated.
• No GitHub tokens are stored.
• MCP access tokens are bound to PUBLIC_URL/mcp (RFC 8707). PKCE is mandatory, authorization codes are single-use, refresh tokens rotate, and both are stored only as hashes. The /mcp endpoint checks the Host header against DNS rebinding.

License

MIT