API & CLI Quickstart

1. Create an API Key

1. Go to API Keys & Billing in the dashboard.
2. Click Create API Key, give it a name, and copy the key. It starts with mcp_sk_.
3. Store it securely — the full key is only shown once.

2. Install the CLI

npm install -g mcpshield-cli

Authenticate with your API key:

mcpshield auth mcp_sk_your_key_here

Run a scan:

mcpshield scan https://github.com/owner/repo

3. REST API

POST /api/v1/scan

Submit a scan and receive results synchronously.

curl -X POST https://www.mcpshield.co/api/v1/scan \
  -H "Authorization: Bearer mcp_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"target": "https://github.com/owner/repo"}'

Response

{
  "id": "scan_abc123",
  "target": "https://github.com/owner/repo",
  "grade": "B",
  "score": 72,
  "totalFindings": 5,
  "findings": [
    {
      "ruleId": "TOOL_POISONING",
      "severity": "high",
      "title": "Tool description contains hidden instructions",
      "evidence": "..."
    }
  ]
}

Rate Limits

All users are also subject to a 30-second cooldown between scans and per-IP abuse prevention limits.

Error Codes