Documentation

Quick Start

Get up and running with MCPShield in 5 minutes.

1. Create an Account

Sign up at app.mcpshield.app/register

2. Create an Agent

Go to the Agents page in your dashboard and click "Add Agent". Copy the API key shown (you'll only see it once!).

3. Install & Run

# Install the agent
pip install mcpshield-agent

# Configure with your API key
mcpshield configure --api-key mcp_sk_your_key_here

# Run a scan
mcpshield scan

That's it! Check your dashboard to see discovered MCP servers.

Install Agent

Requirements

• Python 3.8 or higher
• pip (Python package manager)
• Windows, macOS, or Linux

Installation

# Using pip (recommended)
pip install mcpshield-agent

# Verify installation
mcpshield --version

From Source

git clone https://github.com/mcpshield/agent.git
cd agent
pip install -e .

Your First Scan

Before scanning, you need to configure the agent with your API key.

# Configure (one time)
mcpshield configure --api-key mcp_sk_abc123...

# Run scan
mcpshield scan

The agent will scan for MCP configuration files in these locations:

• Windows: %APPDATA%\Claude\, %APPDATA%\Cursor\
• macOS: ~/Library/Application Support/Claude/
• Linux: ~/.config/Claude/, ~/.config/cursor/

Agent Commands

mcpshield configure

Set up the agent with your API key.

mcpshield configure --api-key YOUR_API_KEY [--api-url URL]

mcpshield scan

Scan for MCP servers and report to dashboard.

mcpshield scan

mcpshield status

Check agent configuration and API connectivity.

mcpshield status

Agent Configuration

Configuration is stored in:

• Windows: %LOCALAPPDATA%\MCPShield\config.json
• macOS/Linux: ~/.config/mcpshield/config.json

{
  "api_url": "https://api.mcpshield.app",
  "api_key": "mcp_sk_...",
  "scan_interval": 300,
  "log_level": "INFO"
}

API Authentication

MCPShield API uses two authentication methods:

JWT Tokens (Dashboard)

For user authentication. Obtained via login endpoint.

Authorization: Bearer eyJhbGciOiJIUzI1NiIs...

API Keys (Agents)

For agent authentication. Created in dashboard.

X-API-Key: mcp_sk_abc123def456...

API Endpoints

Base URL: https://api.mcpshield.app/api/v1

Authentication

Agents

MCP Servers

Dashboard