Platform Architecture & Documentation
Comprehensive technical guide on the multi-stage review pipeline, arbitration model, GitHub App integration, and REST API specification.
Multi-Stage Review Pipeline
The platform never runs LLM code reviews synchronously during HTTP requests. All analysis runs through a resilient BullMQ worker pipeline with distinct, observable state transitions:
PR review request is validated, assigned an idempotency key, and queued in BullMQ.
Authoritative PR metadata and file patches/diffs are fetched via GitHub REST APIs.
AST and rule-based static analyzers (ESLint, TypeScript) run concurrently in sandboxed isolation.
The centralized AI Platform inspects diffs with structured output schema validation.
Arbitration engine deduplicates identical findings and calibrates severity rankings.
GitHub Check Runs and configured in-line PR comments are created.
Final results are persisted to MongoDB and notifications are dispatched.
Chrome Extension (Manifest V3)
The Chrome extension injects an autonomous review button onto any GitHub Pull Request page (github.com/:owner/:repo/pull/:number).
- Run
npm run buildinside theextension/directory. - Open Google Chrome and navigate to
chrome://extensions. - Enable Developer Mode in the top-right corner.
- Click Load Unpacked and select the
extension/dist/directory. - Navigate to any GitHub PR to see the ✨ Review PR with AI button.
REST API Specification
Interactive Swagger Docs| Method | Endpoint | Description | Access |
|---|---|---|---|
| POST | /api/v1/reviews | Enqueue a GitHub PR for automated review | Public / Optional |
| GET | /api/v1/reviews | List reviews with filters & pagination | Public / Optional |
| GET | /api/v1/reviews/:id | Get review metadata and status | Public |
| GET | /api/v1/reviews/:id/findings | Get granular findings for a review | Public |
| POST | /api/v1/reviews/:id/cancel | Cancel an active or queued review | Public / Optional |
| POST | /api/v1/reviews/:id/retry | Retry a failed review | Public / Optional |
| POST | /api/v1/github/webhooks | GitHub App webhook receiver (HMAC validated) | Webhook Secret |
| GET | /api/v1/repositories | List connected repositories | Public / Optional |
| PATCH | /api/v1/repositories/:id/config | Update repository review policies | Protected |
| GET | /health | Health check endpoint with uptime & DB status | Public |