Skip to main content

Hosted quickstart

Use this page to get one real Compass Guard verdict from the hosted API.
The public docs live at https://docs.compassguard.xyz. The hosted API examples below use the current API base URL: https://api.compassguard.xyz.

1. Check health

Expected: {"ok":true,"service":"compass-hosted-guard",...}.

2. Mint an API key

3. Ask for a verdict

Unknown recipients return review:
Set recipientKnown to true and keep amountUsd <= 10 to demo an allow verdict.

4. Optional: add the MCP proxy

Replace @your-downstream/mcp-server with the Solana MCP server you want protected.

Reference