Quick Start
Oplane gives you two ways to run threat modeling: locally in your IDE or CLI via MCP, and automatically on pull requests via the GitHub integration. You can use either one independently or combine them for full coverage.
Local Threat Modeling with MCP
The fastest way to start is connecting Oplane to your IDE or CLI through MCP (Model Context Protocol). This lets you run threat models directly from Cursor, Claude Desktop, or Claude Code while you code — no setup on GitHub required.
What you get
Real-time security analysis of your architecture as you develop. Ask questions about threats, get implementation advice for security requirements, and update requirement status — all without leaving your editor or terminal.
Ready to set up? Follow the MCP Local guide for step-by-step installation instructions.
GitHub Integration
Connect Oplane to your GitHub organization to automatically threat model pull requests. Setup takes about five minutes and involves three steps:
- Install the Oplane GitHub App — Grant Oplane access to your organization's repositories so it can read code and post review comments.
- Link your GitHub account — Authorize the Oplane Bot so it knows which repositories you have access to.
- Choose a review mode — For each repository, decide whether Oplane reviews every PR automatically, only on request, or is disabled.
Full walkthrough: Organisation Setup covers step 1, and User Setup covers steps 2–3.
Automatic PR Reviews
Once connected, Oplane analyses pull requests for architectural security risks and posts findings as review comments. You can configure this per repository:
- Review every PR — Oplane runs automatically on every new pull request.
- On request — Comment
@oplane revieworoplane reviewon a PR to trigger a review when you need it.
Learn more: See the GitHub PRs workflow guide for details on how automated reviews work, severity thresholds, and branch protection.
What's Next?
Pick the path that fits your workflow:
I want to try it locally first
Head to the MCP Local guide and start threat modeling from your IDE or CLI in under 5 minutes.
I want automated reviews on PRs
Start with Organisation Setup to install the GitHub App, then User Setup to link your account and configure repositories.