PortunusMCP Sentinel
Build-time security scanning for MCP servers.
PortunusMCP Sentinel scans local MCP server source before deployment. It combines deterministic Python and TypeScript analysis, GPT-5.6 semantic review, optional Docker-isolated runtime probes, OWASP Agentic Top 10 mappings, and validated SARIF output for GitHub code scanning.
Install
Sentinel supports Python 3.10–3.13 on Linux, macOS, and Windows. Install the current package with pipx:
pipx install portunusmcp-sentinel
Or use uv:
uv tool install portunusmcp-sentinel
Use portunusmcp-sentinel==1.2.1 for exact reproducibility.
Quickstart
From a local Python or TypeScript MCP server repository:
sentinel init
# Review the generated sentinel.permissions.yaml and grant only required scopes.
sentinel scan . --static-only --allow-degraded
sentinel init inspects source without importing or executing it. Generated
permissions deny access until reviewed, and existing configuration is preserved
unless --force is supplied. The scan above needs neither an OpenAI API key nor
Docker and keeps deterministic candidates visible for review.
Exit 0 and exit 1 both mean the scan completed: 0 means no finding reached
the configured threshold, while 1 means at least one did. Exit 2 is a target
or configuration error; exit 3 means analysis was incomplete.
Analysis tiers
| Tier | Command | Requirements | Result |
|---|---|---|---|
| Rules-only | sentinel scan . --static-only --allow-degraded |
None beyond Sentinel | Deterministic findings remain needs_review and fail-on eligible |
| Static + GPT review | sentinel scan . --static-only |
OPENAI_API_KEY |
GPT reviews every selected deterministic candidate |
| Full dynamic proof | sentinel scan . |
OPENAI_API_KEY, Docker, and a Python target |
GPT review plus four isolated runtime probes |
TypeScript support is static-only and covers .ts, .mts, and .cts sources
using the official MCP SDK v1 and server v2 shapes. JavaScript, TSX, declaration
files, workspaces, cross-file dataflow, imported handlers or schemas, and Node
execution are outside the supported boundary. Dynamic targets are local Python
3.10–3.12 MCP servers.
Rules
Every finding uses a stable rule ID and maps to the OWASP Agentic Top 10.
| Rule | Detection | OWASP | Impact |
|---|---|---|---|
| SENT-001 | Overly broad tool permission scope | ASI03:2026 | High |
| SENT-002 | Tool input reaches unsafe execution | ASI05:2026 | Critical |
| SENT-003 | Missing tool input validation | ASI02:2026 | Medium |
| SENT-004 | Unsanitized tool content enters a prompt | ASI01:2026 | High |
| SENT-005 | Hardcoded credential | ASI03:2026 | Critical |
| SENT-006 | Missing or ineffective route authentication | ASI03:2026 | High |
| SENT-007 | Unverified tool manifest | ASI04:2026 | Medium |
| SENT-008 | Out-of-scope tool execution | ASI02:2026 | Critical |
| SENT-009 | Oversized argument accepted | ASI05:2026 | Medium |
| SENT-010 | Injection payload executed | ASI05:2026 | Critical |
| SENT-011 | Malformed schema input processed | ASI02:2026 | Low |
Published IDs are compatibility contracts: an ID is never renumbered or reused for a different detection. The rule catalog documents each engine, boundary, false-positive risk, evidence, and remediation.
GitHub Action
The Marketplace Action runs the full Python pipeline, validates SARIF before upload, and preserves Sentinel's exit contract.
name: PortunusMCP Sentinel
on:
pull_request:
push:
branches: [main]
permissions:
contents: read
security-events: write
jobs:
sentinel:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- id: sentinel
uses: BashaarJavaid/MCP-Sentinel@v1
with:
target-path: .
fail-on: high
openai-api-key: ${{ secrets.OPENAI_API_KEY }}
The Action exposes sarif-path, findings-count, and highest-severity.
Forked pull requests, where secrets are withheld, run visibly degraded analysis
and skip upload. High-assurance consumers can replace @v1 with the immutable
commit SHA for the selected release.
Architecture
flowchart LR
A[Untrusted MCP repository] --> B[AST + Semgrep rules]
B --> C[Canonical candidates]
C --> D[GPT-5.6 semantic review]
D --> E[Constrained four-probe plan]
E --> F[Docker sandbox]
F --> G[Reviewed dynamic evidence]
D --> H[Deduplication + provenance merge]
G --> H
H --> I[Console]
H --> J[JSON 1.4.0]
H --> K[SARIF 2.1.0]
K --> L[GitHub code scanning]
Static analysis never imports or executes target code. GPT receives bounded, redacted context and can only review existing candidates or order four permanent inert probes. Dynamic analysis mounts local Python source read-only in fresh containers with no runtime network, resource limits, and forced cleanup. All stages feed one canonical Finding model consumed by console, JSON, and SARIF.
PortunusMCP Sentinel is the build-time plane of the PortunusMCP family. The PortunusMCP Gateway provides runtime enforcement in a separate repository, while PortunusMCP Identity is the separate short-lived credential-broker plane. Neither is required by Sentinel.
Configuration and adoption
Configuration precedence is CLI → SENTINEL_* environment → target-root
sentinel.toml → built-in defaults. A normal full scan also requires
sentinel.target.yaml and sentinel.permissions.yaml; --static-only does not
require launch configuration.
Create a baseline from a complete native JSON report, then compare later scans:
sentinel scan . --allow-degraded --format json --output sentinel-baseline.json
sentinel scan . --allow-degraded --baseline sentinel-baseline.json
Matched findings remain visible but do not affect --fail-on. Sentinel never
updates a baseline automatically.
Suppress a reviewed static source finding with a reason-bearing directive:
# sentinel: ignore[SENT-005] reason=test credential is inert and rotated
api_key = "ghp_example"
Only static SENT-001–SENT-007 findings can be suppressed. Applied
suppressions remain visible in every report; malformed, duplicate, unknown-rule,
or reasonless directives fail configuration validation.
Use Sentinel from pre-commit:
repos:
- repo: https://github.com/BashaarJavaid/MCP-Sentinel
rev: v1.2.1
hooks:
- id: mcp-sentinel
See the configuration guide for LLM endpoint trust, rule selection, baselines, suppressions, and pre-commit.
CLI and report reference
# Full static, GPT, and Docker analysis
sentinel scan ./path/to/server
# Static analysis with required GPT review
sentinel scan ./path/to/server --static-only
# Validated SARIF
sentinel scan ./path/to/server --format sarif --output results.sarif
# Select rules and change the failure threshold
sentinel scan ./path/to/server --rules SENT-001,SENT-005 --fail-on critical
# Exercise the packaged reference pipeline
sentinel demo --replay-review --verbose
--fail-on accepts critical, high, medium, low, or informational.
Console output is the default; --format json and --format sarif are stable
machine-readable paths. Validate reports offline with:
python -m sentinel.schema check
python -m sentinel.report.validate_sarif results.sarif
The production reviewer uses GPT-5.6 Sol through the Responses API with
store: false, medium reasoning effort, strict Structured Outputs, bounded
context, and host-validated evidence. Sentinel's public OpenAI cost calculation
uses the rates recorded on 2026-09-04: $4/M input, $0.40/M cached input, and
$20/M output, with cache writes at 1.25× input. See the official
GPT-5.6 Sol model and pricing page
and Responses API create reference.
Compatible endpoints retain token usage but report pricing as unavailable.
Project resources
- Scan a real MCP server before release
- Marketplace Action
- Documentation
- Architecture contract
- Roadmap
- Contributing
- SARIF guide
- Changelog
- Security policy
- Project history
PortunusMCP Sentinel is MIT licensed. Dependency licenses and packaged notices are recorded in THIRD_PARTY_NOTICES.md.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file portunusmcp_sentinel-1.2.1.tar.gz.
File metadata
- Download URL: portunusmcp_sentinel-1.2.1.tar.gz
- Upload date:
- Size: 210.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
753ea10b8256e0d91a9902d0473b817a73e740c5daca992360f6bb0a4fd5a38a
|
|
| MD5 |
e1a8ba10efbee878f6da78541821036e
|
|
| BLAKE2b-256 |
80aba176e0e768f1dce30e3083149e33a2436dbd4bd215f2a18b6a1155044d39
|
Provenance
The following attestation bundles were made for portunusmcp_sentinel-1.2.1.tar.gz:
Publisher:
release.yml on BashaarJavaid/MCP-Sentinel
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
portunusmcp_sentinel-1.2.1.tar.gz -
Subject digest:
753ea10b8256e0d91a9902d0473b817a73e740c5daca992360f6bb0a4fd5a38a - Sigstore transparency entry: 2718323126
- Sigstore integration time:
-
Permalink:
BashaarJavaid/MCP-Sentinel@9fae385c684781f12702f50cbae60a6cfc48c867 -
Branch / Tag:
refs/tags/v1.2.1 - Owner: https://github.com/BashaarJavaid
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@9fae385c684781f12702f50cbae60a6cfc48c867 -
Trigger Event:
push
-
Statement type:
File details
Details for the file portunusmcp_sentinel-1.2.1-py3-none-any.whl.
File metadata
- Download URL: portunusmcp_sentinel-1.2.1-py3-none-any.whl
- Upload date:
- Size: 330.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
143230824f214ac8d374d3c9850d2de8e4f568a069bc227f326722376140be94
|
|
| MD5 |
d4c2cb29e93502857eda7a500b834e4e
|
|
| BLAKE2b-256 |
2fbb11fb0caf490e918a6f25a6f758ab0cfea291d459be43025166118b37b6d2
|
Provenance
The following attestation bundles were made for portunusmcp_sentinel-1.2.1-py3-none-any.whl:
Publisher:
release.yml on BashaarJavaid/MCP-Sentinel
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
portunusmcp_sentinel-1.2.1-py3-none-any.whl -
Subject digest:
143230824f214ac8d374d3c9850d2de8e4f568a069bc227f326722376140be94 - Sigstore transparency entry: 2718323588
- Sigstore integration time:
-
Permalink:
BashaarJavaid/MCP-Sentinel@9fae385c684781f12702f50cbae60a6cfc48c867 -
Branch / Tag:
refs/tags/v1.2.1 - Owner: https://github.com/BashaarJavaid
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@9fae385c684781f12702f50cbae60a6cfc48c867 -
Trigger Event:
push
-
Statement type: