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.

Sample output

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.1.tar.gz (6.5 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.1-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mcpscanner-0.3.1.tar.gz
Algorithm Hash digest
SHA256 9e2108dbb0b6a61c6e8052fe4f45c6a804c9c1ef36e3944bec89f8608f90349d
MD5 518b3efd8c0834f8b494a496df3670bd
BLAKE2b-256 d03b8f8973085d588e0940f64c9baf463faa7f5d25557efa54390079f75878f1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mcpscanner-0.3.1-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.13.7

File hashes

Hashes for mcpscanner-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8ebc5c0b6ae39186310f3e3c38f66a903d9a0632ca5b08cc545a5cbbe0c0827d
MD5 ca0ae01c261f499769ff3de8db9e3df1
BLAKE2b-256 bfd69154c42b325309bb6de69014c4b59277ebd858f18611a5d8015a80b48040

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