-
Notifications
You must be signed in to change notification settings - Fork 0
Agent Usage
The MCPShield agent is a Python CLI tool that scans your machine for MCP server configurations and reports them to the central dashboard.
pip install mcpshield-agentVerify:
mcpshield --versionmcpshield configure --api-key mcp_sk_YOUR_KEY --api-url https://your-instanceStores credentials locally. See Configuration File Locations below.
mcpshield scanScans all known MCP config paths, calculates risk scores locally, and reports results to the dashboard.
Dry run (scan without sending data):
mcpshield scan --dry-runGenerate a local report file:
mcpshield scan --reportmcpshield statusShows current API URL, key status, and last scan time.
mcpshield listDisplays servers found in the last scan without hitting the API.
| OS | Path |
|---|---|
| Windows | %LOCALAPPDATA%\MCPShield\config.json |
| macOS | ~/Library/Application Support/MCPShield/config.json |
| Linux | ~/.config/mcpshield/config.json |
%APPDATA%\Claude\claude_desktop_config.json%APPDATA%\Cursor\User\globalStorage\saoudrizwan.claude-dev\settings\cline_mcp_settings.json%APPDATA%\Windsurf\mcp_settings.json
~/Library/Application Support/Claude/claude_desktop_config.json~/.cursor/mcp.json
~/.config/Claude/claude_desktop_config.json~/.config/cursor/mcp.json
Scanning for MCP servers...
MCP Servers Found:
┌────────────┬─────────────────────────────────────────┬──────────┬───────┐
│ Name │ Type │ Risk │ Score │
├────────────┼─────────────────────────────────────────┼──────────┼───────┤
│ postgres │ unknown │ critical │ 85 │
│ filesystem │ @modelcontextprotocol/server-filesystem │ medium │ 35 │
│ github │ @modelcontextprotocol/server-github │ low │ 18 │
└────────────┴─────────────────────────────────────────┴──────────┴───────┘
Reported to MCPShield dashboard.
The agent captures environment variable names only — values and secrets are never transmitted. Credential detection works by matching variable name patterns (e.g. DATABASE_URL, POSTGRES_PASSWORD) — not by reading their contents.
Getting Started
User Guide
Technical Reference