SH

sidhpurwala-huzaifa/mcp-security-scanner

Developer tools
21 stars 0 forks Качество 60 Тренд 60

Scan any running MCP server to produce an actionable security report of vulnerabilities and misconfigurations.

Обзор

This is a Python-based penetration testing tool for Model Context Protocol (MCP) servers. It supports HTTP, stdio, and experimental SSE transports, runs a suite of checks mapped to scanner_specs.schema (auth, transport, tools, prompts, resources), and includes a deliberately insecure MCP-like server for testing. Choose a tag from the releases page. In an activated virtual environment, replace with your chosen tag: An editable install can hide missing package data. To check actual distributions from a clean checkout: The check requires one wheel and one source distribution in dist/. It verifies both contain the schema, then installs the wheel into a temporary virtual environment and loads the default checks outside the checkout. CI runs this check on pull requests, main-branch pushes, and tag pushes. Reports use schema_version: 2. Each finding has an authoritative status: Existing boolean findings can still be read.

README

MCP Security Scanner

This is a Python-based penetration testing tool for Model Context Protocol (MCP) servers. It supports HTTP, stdio, and experimental SSE transports, runs a suite of checks mapped to scanner_specs.schema (auth, transport, tools, prompts, resources), and includes a deliberately insecure MCP-like server for testing.

Legacy HTTP+SSE transport is deprecated; compatibility support is experimental. Streamable HTTP continues to support SSE responses.

Install

Install a tagged release

Choose a tag from the releases page. In an activated virtual environment, replace `` with your chosen tag:

python -m pip install --upgrade "git+https://github.com/sidhpurwala-huzaifa/mcp-security-scanner.git@"
python -c "from mcp_scanner.spec import load_spec; print(f'Loaded {len(load_spec())} checks')"

Install from source

# 1) Clone
git clone https://github.com/sidhpurwala-huzaifa/mcp-security-scanner
cd mcp-security-scanner

# 2) Create venv (Python >= 3.10)
python -m venv .venv
source .venv/bin/activate

# 3) Install dependencies
pip install -r requirements.txt

# 4) (Optional) Dev install for CLI entrypoints
pip install -e .

Verify release packaging

An editable install can hide missing package data. To check actual distributions from a clean checkout:

python -m pip install build
python -m build
python scripts/check_distribution.py dist

The check requires one wheel and one source distribution in dist/. It verifies both contain the schema, then installs the wheel into a temporary virtual environment and loads the default checks outside the checkout. CI runs this check on pull requests, main-branch pushes, and tag pushes.

Usage

Scan outcomes and report compatibility

Reports use schema_version: 2. Each finding has an authoritative status:

Status Meaning Compatibility field passed
pass The check evaluated its evidence and passed true
fail The check evaluated its evidence and failed false
error A prerequisite or probe failed; the check could not be evaluated null
skipped Not evaluated, with the reason in details null

Existing boolean findings can still be read. JSON consumers must handle null and use status instead of treating every false-like passed value as a vulnerability. JSON summaries count passed, failed, errors, and skipped separately; severity totals count only failed checks.

HTTP scans stop dependent probes when initialization fails, report a BASE-01 error even if a custom spec omits that check, and skip the dependent checks. Independent TLS/Origin/bind and OAuth-metadata checks can still run. Failed or malformed tool, prompt, and resource enumerations produce errors for the checks that require them. Successful empty enumerations produce explicit skips rather than security passes. A failed second tool listing is an error, not evidence of a rug pull. Paginated results with more pages are treated as incomplete until full enumeration support is implemented.

Exit codes for scan and scan-range are 0 for completion without failures or errors, 1 for evaluated failures, and 2 for incomplete scans with errors (errors take precedence over failures). Expected empty-result skips alone do not make a scan incomplete. CLI argument errors can also return 2. Scan summaries go to stderr in JSON mode so stdout remains the report; verbose traces are human diagnostics and should not be combined with machine parsing.

HTTP health output uses status: "ok" or "error", initialize_http_status, enumeration_status, and an errors mapping. An unavailable enumeration is null; a successfully retrieved empty enumeration is []. --only-health returns 2 on an error and displays unavailable data explicitly.

Active probe outcomes

Active checks classify transport outcomes before examining response text for vulnerability evidence. R-01/R-02 and access-control resource/remote probes accept HTTP 401/403 as explicit denials; P-01 accepts a well-formed JSON-RPC -32602 error for intentionally invalid arguments. Other RPC errors and tool isError results are inconclusive. A check with any unexpected probe failure is reported as an error, even if another attempt in that same check returned data. Independent checks still retain their own findings; no request is automatically replayed.

Diagnostics and redaction

HTTP error diagnostics retain server details with a 16 KiB read limit and the existing time budget. Diagnostic summaries are redacted and bounded. Each scan keeps an isolated secret set containing supplied credentials and learned session identifiers (including legacy endpoint tokens); it is shared with verbose traces and final scan/health/RPC output. Redaction occurs after evidence evaluation so it does not turn a detected exposure into a pass.

Redaction preserves dictionary keys to keep protocol/report structure intact. Short secrets (fewer than eight characters) are matched as complete values or word-delimited tokens, avoiding corruption of ordinary words. Recognized secret fields and token query parameters remain redacted. Raw and JSON-escaped forms are deduplicated and replaced in one pass; existing redaction markers are stable. Substring occurrences of short identifiers inside unrelated words are inherently ambiguous and are deliberately left unchanged.

HTTP session handling

Scan, health, and RPC share session handling. http selects Streamable HTTP; auto tries it first and falls back to legacy HTTP+SSE only after an initialize POST returns 404 or 405 and a valid legacy endpoint event is received. The session accepts JSON or SSE, correlates response IDs, negotiates protocol 2025-06-18 or 2025-03-26, propagates session/version headers, and sends notifications/initialized before normal requests. It advertises no optional client capabilities. Requests are never automatically replayed after failure. Streamable HTTP SSE responses close as soon as the matching result arrives. Response data is limited to 8 MiB, with an elapsed budget checked between response chunks and HTTPX network timeouts. This is not a strict wall-clock cancellation deadline. Discovery continues probing lists even if not advertised, as this is a scanner. Legacy SSE keeps the original GET connection open, posts a real initialize to the advertised endpoint, and waits for its correlated response on that connection. A legacy endpoint discovery event alone does not verify MCP initialization. Active probes retain structured HTTP/RPC outcomes: unexpected HTTP failures, JSON-RPC errors, tool execution errors, and timeouts produce error findings rather than security passes. Independent checks continue, and incomplete scans retain exit code 2. Check-specific access denials and invalid-argument rejections remain distinct from infrastructure errors.

Legacy HTTP+SSE compatibility

  • Discovery uses the supplied SSE URL and its endpoint event. Query parameter names such as sessionId never select a transport or fabricate a session header.
  • --sse-endpoint /sse resolves from the origin root; a relative path resolves against --url. auto uses it only after HTTP initialization returns 404/405. Authentication failures, other HTTP failures, malformed initialization, and normal RPC failures do not trigger fallback.
  • The advertised endpoint must have the same origin, without embedded credentials or a fragment. Legacy redirects are rejected; supply the final SSE URL directly.
  • Legacy protocol 2024-11-05 initialization, initialized notifications, and normal replies use the original SSE connection. Both message bodies and headers are handled independently of URL query spelling. Health includes the chosen transport.
  • Disconnects, endpoint rotation, missing replies, and invalid initialization produce errors. Connections close on success and failure; calls are not replayed and streams are not automatically resumed. Start a new scan to reconnect.
  • The shared SSE parser handles comments, multiline data, split UTF-8, CR/LF/CRLF, and unrelated events. The 8 MiB bound applies to each Streamable HTTP response and to the lifetime of a legacy receive stream; elapsed budgets are checked between chunks/events alongside network timeouts, not hard wall-clock cancellation.

References: legacy transport and Streamable HTTP backwards compatibility.

Quick test

# Verify CLI is available
mcp-scan --help

# Connection failure example
mcp-scan scan --url http://127.0.0.1:65000
# -> Reports an initialization error if nothing is listening

Run insecure test server (HTTP)

# Basic (HTTP JSON-RPC). Supports --test modes (Defaults to 0, otherwise choose a vulnerable model from below)
insecure-mcp-server --host 127.0.0.1 --port 9001

# Test modes currently supported
# --test 0 (default): basic insecure MCP-like server
# --test 1: prompt injection-style vulnerable server
# --test 2: tool poisoning-style vulnerable server
# --test 3: rug-pull tool mutation between listings
# --test 4: excessive permissions (admin tools exposed), private:// resource leakage
# --test 5: token theft (server leaks upstream access tokens to clients)
# --test 6: indirect prompt injection (external resource carries hidden instructions)
# --test 7: remote access control exposure (unauth tool enables remote access)

insecure-mcp-server --host 127.0.0.1 --port 9001 --test 0/1/2/3/4/5/6/7

Scan the server (HTTP, stdio, or SSE)

# HTTP: Text report (--url is the MCP endpoint)
mcp-scan scan --url http://127.0.0.1:9001/mcp --format text

# HTTP: JSON report
mcp-scan scan --url http://127.0.0.1:9001/mcp --format json --output report.json

# HTTP: Verbose tracing (real-time)
mcp-scan scan --url http://127.0.0.1:9001/mcp --verbose

# stdio: Scan local MCP servers via stdin/stdout
mcp-scan scan --transport stdio --command "npx -y @modelcontextprotocol/server-memory" --format json

# SSE: connect to explicit SSE endpoint, then scan via emitted /messages?sessionId=...
mcp-scan scan --url https://your-mcp.example.com --transport sse --sse-endpoint /sse --timeout 30 --verbose

RPC passthrough (Inspector-like)

Note: RPC commands only support HTTP and SSE transports, not stdio.

HTTP scanning, RPC, and health checks set Accept: application/json, text/event-stream for MCP requests, replacing HTTPX’s default or a custom Accept value. Authentication and other custom headers are preserved. SSE GET requests use Accept: text/event-stream.

# List tools (HTTP)
mcp-scan rpc --url https://your-mcp.example.com/mcp --method tools/list --transport http

# Call a tool (HTTP)
mcp-scan rpc --url https://your-mcp.example.com/mcp \
  --method tools/call \
  --params '{"name":"weather","arguments":{"city":"Paris"}}' \
  --transport http

# With SSE transport
mcp-scan rpc --url https://your-mcp.example.com --method tools/list --transport sse --sse-endpoint /sse

Explanations

  • --explain prints a focused explanation for a single finding (e.g., --explain X-01). It includes:
    • Test (ID and title)
    • Expected outcome
    • Got (scanner-observed details)
    • Result (why PASS/FAIL)
    • Remediation (from the spec)

Example:

mcp-scan scan --url https://your-mcp.example.com/mcp --explain X-01

Only health

  • --only-health prints server details and enumerations without running the full scan.
  • Works for HTTP, stdio, and SSE transports.
  • Supports --format text and --format json.

Examples:

# HTTP
mcp-scan scan --url https://your-mcp.example.com/mcp --only-health --format text

# stdio
mcp-scan scan --transport stdio --command "npx -y @modelcontextprotocol/server-memory" --only-health --format json

# SSE
mcp-scan scan --url https://your-mcp.example.com --transport sse --sse-endpoint /sse --only-health --format json

Authentication

# Bearer token
mcp-scan scan \
  --url http://your-mcp.example.com/mcp \
  --auth-type bearer \
  --auth-token "$TOKEN"

# OAuth2 Client Credentials
mcp-scan scan \
  --url http://your-mcp.example.com/mcp \
  --auth-type oauth2-client-credentials \
  --token-url https://issuer.example.com/oauth2/token \
  --client-id "$CLIENT_ID" --client-secret "$CLIENT_SECRET" \
  --scope "mcp.read mcp.tools"

Transport, timeouts, session

  • –transport auto|http|stdio|sse: Select transport explicitly or use the bounded fallback described above.
    • http: Requires --url for JSON-RPC endpoint
    • stdio: Requires --command for local MCP server process
    • sse: Legacy HTTP+SSE at --url; optional --sse-endpoint resolves a URL/path against it (experimental).
  • **–timeout **: Per-request read timeout (default 12s). Increase for slow streams.
  • **–session-id **: Pre-established session (Mcp-Session-Id header).

Testing

Running Tests

# Set up environment (if not already done)
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
pip install -e .

# Run all tests
python -m pytest tests/ -v

# Run specific test module
python -m pytest tests/test_stdio_scanner.py -v
python -m pytest tests/test_security_checks.py -v

# Run specific test class
python -m pytest tests/test_stdio_scanner.py::TestStdioIntegration -v

Running with Container

# Build container

podman build -t mcp-scan .

# Run
podman run --rm mcp-scan scan --url ${MCP_SERVER} --format text

Acknowledgements

View this README on GitHub

Установка

This server does not publish a one-line install command.

Open the repository installation guide