Skip to main content

A command-line tool for analyzing MCP servers.

Project description

MCPScanner

MCPScanner (formerly known as mcpry) is a command-line tool for analyzing MCP servers. It does the following:

  1. Discovers MCP Servers: It automatically searches for MCP server configuration files in well-known locations on the host system.
  2. Analyzes Tools and Resources: It connects to each discovered server to fetch the list of available tools and resources.
  3. Security Scanning with Pangea AI Guard: It uses the Pangea AI Guard service to scan the tools for malicious entities and prompts.
  4. Generates Reports: It creates a JSON report (default mcpscanner.json) containing the analysis results.
  5. Detects Changes: It can compare the current state of a server's tools with a previous report and display a diff if any changes are detected.
  6. Finds Similar Tools: It can identify tools with similar functionality.

Installation

pip install -U mcpscanner

Configuration

Before using MCPScanner, you need to set the PANGEA_AI_GUARD_TOKEN environment variable to a Pangea API token that has access to the Pangea AI Guard service.

export PANGEA_AI_GUARD_TOKEN="pts_your_token_here"

Usage

The primary command is scan, which runs the analysis.

mcpscanner scan

Options

Parameter Description Default
--input <PATH> The input file containing a previous report to compare against. mcpscanner.json
--output <PATH> The file where the new report will be saved. mcpscanner.json
--list-tools If set, the names of all tools for each MCP server will be listed in the output. False
--mcp-config-files <FILES> A list of files to discover MCP servers from. A list of well-known paths for different operating systems.
--similarity-threshold <FLOAT> The threshold (between 0.0 and 1.0) for two tools to be considered similar. 0.96
--syntax-theme <THEME> The syntax theme to use for displaying JSON diffs. github-dark

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcpscanner-0.3.0.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcpscanner-0.3.0-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

Details for the file mcpscanner-0.3.0.tar.gz.

File metadata

  • Download URL: mcpscanner-0.3.0.tar.gz
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for mcpscanner-0.3.0.tar.gz
Algorithm Hash digest
SHA256 d08fcae3329b08bd3e21bcc4130593f775c18aee7f2c81877fa8f100ad98f296
MD5 0938c42c372f051ed62a7ec78b770993
BLAKE2b-256 c332cf990c1abf401aa643708e684977ad9db5e61676add2e53f2ca53f7f0f5c

See more details on using hashes here.

File details

Details for the file mcpscanner-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: mcpscanner-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 7.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for mcpscanner-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ce8ed408b89bd235aedce41abfaeccfad3bb551339ed2499f54643cb090a38d1
MD5 861a51a4b68973303700ff8fe0d8401b
BLAKE2b-256 a32b88c19814f64607839ac723193d06b49fa1d8cda80bcceb6c29442e3530a9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page