mcp-shield-cli 0.1.0__tar.gz

mcp_shield_cli-0.1.0/.gitignore

@@ -0,0 +1,19 @@
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+dist/
+build/
+.eggs/
+*.egg
+.venv/
+venv/
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+htmlcov/
+.coverage
+*.db
+*.sqlite
+.uv/
+uv.lock

mcp_shield_cli-0.1.0/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 MCP Shield Contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

mcp_shield_cli-0.1.0/PKG-INFO

@@ -0,0 +1,318 @@
+Metadata-Version: 2.4
+Name: mcp-shield-cli
+Version: 0.1.0
+Summary: Security scanner, runtime proxy, and audit logger for MCP servers
+Project-URL: Homepage, https://github.com/thuggeelya/mcp-shield
+Project-URL: Repository, https://github.com/thuggeelya/mcp-shield
+Project-URL: Issues, https://github.com/thuggeelya/mcp-shield/issues
+Author-email: thuggeelya <thuggeelya@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: audit,mcp,model-context-protocol,proxy,security,testing
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.11
+Requires-Dist: click>=8.1
+Requires-Dist: huggingface-hub>=0.24
+Requires-Dist: mcp>=1.0.0
+Requires-Dist: onnxruntime>=1.18
+Requires-Dist: pydantic>=2.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rich>=13.0
+Requires-Dist: tokenizers>=0.20
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest-timeout>=2.3; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# MCP Shield
+
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
+
+Like [Bandit](https://github.com/PyCQA/bandit) for Python code, but for MCP servers.
+
+Security scanner, runtime proxy, and audit logger for [Model Context Protocol](https://modelcontextprotocol.io/) servers.
+
+## Install
+
+```bash
+pip install mcp-shield-cli
+```
+
+Requires Python 3.11+ and Node.js (for npx-based MCP servers).
+
+## Usage
+
+### `mcp-shield test` — scan a server
+
+```bash
+# Scan a local stdio server
+mcp-shield test "npx -y @modelcontextprotocol/server-filesystem /tmp"
+
+# Scan a remote HTTP server
+mcp-shield test "http://localhost:8080/mcp"
+
+# Run only specific suites (compliance, security, advisory, or all)
+mcp-shield test "npx server" --suite security
+mcp-shield test "npx server" --suite security --suite advisory
+
+# Pass environment variables to the server process
+mcp-shield test "npx server" --env API_KEY=sk-123 --env DB_URL=postgres://host/db
+
+# Save JSON report to file
+mcp-shield test "npx server" --output report.json
+
+# JSON to stdout (for piping)
+mcp-shield test "npx server" --format json
+
+# Both terminal and JSON output
+mcp-shield test "npx server" --format both --output report.json
+
+# CI mode: exit code 1 if any high+ severity check fails
+mcp-shield test "npx server" --fail-on high
+
+# Enable ML-based poisoning detection (DeBERTa, slower but more accurate)
+mcp-shield test "npx server" --ml
+
+# Set connection/check timeout (default 30s)
+mcp-shield test "npx server" --timeout 10
+```
+
+Example output:
+
+```
+ Check        | Result | Severity | Message
+ COMP-001     |  PASS  | critical | Handshake OK
+ COMP-002     |  PASS  | error    | Server identity: filesystem-server v0.2.0
+ SEC-002      |  WARN  | high     | Found 11 potential injection vector(s)
+ SEC-004      |  FAIL  | high     | 2 dangerous tool(s): move_file, edit_file
+ SEC-005      |  WARN  | medium   | Write scope: local filesystem
+ ADV-002      |  WARN  | info     | External dependencies: filesystem access
+
+ Score: 57/100  Grade: D
+
+─────────────── Recommendations ───────────────
+
+  [1] Block dangerous tools (SEC-004)
+      Tools: move_file, edit_file
+      Action: Add --deny rules in proxy or require user confirmation
+
+┌──── Ready-to-use proxy command ────┐
+│ mcp-shield proxy "npx ..." \       │
+│   --deny move_file --deny edit_file│
+└────────────────────────────────────┘
+```
+
+### `mcp-shield proxy` — runtime firewall
+
+```bash
+# Block specific tools by name (glob patterns)
+mcp-shield proxy "npx server" --deny "delete_*" --deny "exec_*"
+
+# Allow only safe tools (everything else is blocked)
+mcp-shield proxy "npx server" --allow "read_*" --allow "list_*"
+
+# Rate-limit to 30 requests/minute per client
+mcp-shield proxy "npx server" --rate-limit 30
+
+# Custom audit database path
+mcp-shield proxy "npx server" --audit-db ./my-audit.db
+
+# Require authentication
+mcp-shield proxy "npx server" --auth bearer --token admin:secret123
+mcp-shield proxy "npx server" --auth bearer --token alice:tok-a --token bob:tok-b
+
+# Combine everything: deny + rate limit + auth + env
+mcp-shield proxy "npx server" \
+    --deny "git_push" --deny "git_reset" \
+    --rate-limit 30 \
+    --auth bearer --token ci:token123 \
+    --env GITHUB_TOKEN=ghp_xxx
+
+# Proxy a remote HTTP server
+mcp-shield proxy "http://upstream:9090/mcp" --deny "drop_*"
+```
+
+The proxy sits between the LLM client and the MCP server:
+
+```
+LLM Client  ──stdio──▶  mcp-shield proxy  ──stdio──▶  MCP Server
+                           │
+                     ┌─────┴─────┐
+                     │ deny list │
+                     │ rate limit│
+                     │ auth check│
+                     │ audit log │
+                     └───────────┘
+```
+
+Blocked calls return an error to the client and are logged with the block reason.
+
+### `mcp-shield audit` — query logs
+
+```bash
+# Show last 50 events (default)
+mcp-shield audit show
+
+# Show last 100 events
+mcp-shield audit show --last 100
+
+# Filter by tool name
+mcp-shield audit show --tool delete_file
+
+# Show only blocked calls
+mcp-shield audit show --blocked
+
+# Filter by risk tier (read, write_reversible, write_external, write_sensitive)
+mcp-shield audit show --risk write_sensitive
+
+# Filter by client ID (when using --auth)
+mcp-shield audit show --client admin
+
+# Combine filters
+mcp-shield audit show --blocked --risk write_sensitive --last 20
+```
+
+```bash
+# Summary statistics (default: last 24 hours)
+mcp-shield audit stats
+
+# Stats for a time range (h=hours, d=days, w=weeks, m=months)
+mcp-shield audit stats --since 1h
+mcp-shield audit stats --since 7d
+mcp-shield audit stats --since 4w
+```
+
+```bash
+# Export to JSON
+mcp-shield audit export -f json -o audit.json
+
+# Export to CSV
+mcp-shield audit export -f csv -o audit.csv
+```
+
+```bash
+# Use a custom database path (applies to all subcommands)
+mcp-shield audit --db /path/to/audit.db show --last 20
+mcp-shield audit --db /path/to/audit.db stats --since 7d
+```
+
+## What it checks
+
+22 checks across 3 suites, ~2 seconds per scan.
+
+### Compliance (COMP-001..010)
+
+| Check | What it verifies |
+|-------|-----------------|
+| COMP-001 | MCP handshake (JSON-RPC initialize) |
+| COMP-002 | Server identity (name + version) |
+| COMP-003 | Valid `inputSchema` on all tools |
+| COMP-004 | Tool naming conventions |
+| COMP-005 | Ping/pong support |
+| COMP-006 | Tool descriptions present |
+| COMP-007 | Server capabilities declared |
+| COMP-008 | Schema field descriptions |
+| COMP-009 | Schema constraints (`maxLength`, `pattern`) |
+| COMP-010 | Resource/prompt validation |
+
+### Security (SEC-001..007)
+
+| Check | What it detects | Severity |
+|-------|----------------|----------|
+| SEC-001 | Tool poisoning (hidden instructions in descriptions) | critical |
+| SEC-002 | Injection vectors (path, URL, SQL, code fields) | high |
+| SEC-003 | Aggregated security score (0-100) | -- |
+| SEC-004 | Dangerous operations (`delete`, `exec`, `deploy`) | high |
+| SEC-005 | Write scope (local vs cloud vs user-facing) | medium |
+| SEC-006 | Idempotency risk (non-retryable operations) | medium |
+| SEC-007 | Cost risk (cloud provisioning, paid APIs) | low |
+
+### Advisory (ADV-001..005)
+
+Informational only — does not affect the score.
+
+| Check | What it flags |
+|-------|--------------|
+| ADV-001 | Auth requirement hints (API key, OAuth) |
+| ADV-002 | External service dependencies (AWS, Stripe, GitHub) |
+| ADV-003 | Bulk operation warnings (unbounded arrays) |
+| ADV-004 | Sensitive data exposure (PII, credentials) |
+| ADV-005 | External network access (URL + fetch patterns) |
+
+### Scoring
+
+Composite score: **40% compliance + 60% security**. Deductions per finding:
+
+| Severity | Deduction |
+|----------|-----------|
+| critical | -25 |
+| high | -15 |
+| medium | -5 |
+| low | -2 |
+
+Advisory checks are informational and do not affect the score.
+
+### Poisoning detection
+
+**Layer 1** — ~45 regex patterns across 11 categories:
+
+| Category | Examples |
+|----------|----------|
+| Instruction override | "ignore previous instructions", "new instructions:" |
+| Role hijacking | "act as", "pretend to be", "you are now" |
+| Format injection | ChatML `<\|im_start\|>`, Llama `[INST]`, Handlebars `{{#system}}` |
+| Data exfiltration | Markdown image exfil, "send to URL", credential reading |
+| Hidden content | HTML comments, CSS `display:none`, ANSI escapes, zero-width Unicode |
+| Hardcoded secrets | API keys (`sk-live-*`), GitHub PATs, Slack tokens |
+| Agent injection | ReAct format injection, tool call injection |
+
+**Layer 2** (opt-in, `--ml`) — DeBERTa-v3-base classifier for semantic detection.
+
+ML dependencies (`onnxruntime`, `tokenizers`, `huggingface-hub`) are included in the default install. The `--ml` flag downloads the [protectai/deberta-v3-base-prompt-injection-v2](https://huggingface.co/protectai/deberta-v3-base-prompt-injection-v2) ONNX model (~740 MB, cached in `~/.cache/mcp-shield/models/`) on first use.
+
+**Why opt-in?** The ML classifier can produce false positives on directive-like tool descriptions (e.g., "DEPRECATED: Use X instead" may be flagged as an injection). Use `--ml` when you want maximum detection sensitivity and can tolerate reviewing flagged results.
+
+### Risk classification
+
+Every tool is classified into a risk tier:
+
+| Tier | Examples |
+|------|----------|
+| `read` | read_file, list_directory, search |
+| `write_reversible` | write_file, create_directory |
+| `write_external` | send_email, deploy, webhook |
+| `write_sensitive` | delete, exec, eval, drop |
+
+## Contributing
+
+Contributions are welcome. Open an issue or submit a pull request.
+
+```bash
+git clone https://github.com/thuggeelya/mcp-shield.git
+cd mcp-shield
+pip install -e ".[dev]"
+pytest
+```
+
+## Author
+
+**thuggeelya**
+
+- LinkedIn: [thuggeelya](https://www.linkedin.com/in/thuggeelya/)
+- Telegram: [@thuggeelya](https://t.me/thuggeelya)
+- Email: [thuggeelya@gmail.com](mailto:thuggeelya@gmail.com)
+
+## License
+
+[Apache 2.0](LICENSE)