Quick Start

Get Started in 5 Minutes

Follow these steps to install MCPSafe and run your first security scan. No account required for basic usage.

Install the CLI

Install MCPSafe CLI globally using npm, yarn, or pnpm.

# Using npm
npm install -g @mcpsafe/cli

# Using yarn
yarn global add @mcpsafe/cli

# Using pnpm
pnpm add -g @mcpsafe/cli

Configure your API key (optional)

Get higher rate limits with a free API key from your dashboard.

# Set your API key
mcpsafe config set api-key YOUR_API_KEY

# Verify configuration
mcpsafe config

Scan your first server

Run a security scan on your MCP server directory.

# Scan current directory
mcpsafe scan ./

# Scan with JSON output
mcpsafe scan ./ --format json

# Scan and fail on critical vulnerabilities
mcpsafe scan ./ --fail-on critical

Check existing packages

Look up security info for packages already in the registry.

# Check a package by name
mcpsafe check @modelcontextprotocol/server-filesystem

# Check with JSON output
mcpsafe check my-mcp-server --format json

Prefer the Web UI?

You can also scan servers directly from the web without installing anything. Just paste a GitHub, npm, or PyPI URL.

Open Web Scanner

What's Next?

Learn Core Concepts

Understand security grades, quality scores, and how scanning works.

Set Up CI/CD

Automate security scanning in your GitHub Actions or GitLab CI.