Sphyr
Start for free
terminal Zero to One in 5 Minutes

Developer Docs

Zero to working integration in 5 minutes.

rocket_launch

Quickstart

A linear walkthrough. Paste and run — no edge cases, no advanced config.

1

Get an API key

Sign up at the Sphyr console to receive your API key.

Get API Keyarrow_forward

The Sphyr console is in early access. Your key will be provisioned automatically on signup.

2

Install the SDK

Add the Sphyr Guard SDK to your project.

Terminal 
npm install @sphyr/guard
Terminal 
pip install sphyr
3

Configure the client

Initialize the Sphyr Guard client with your API key.

JavaScript 
import { AgentGuardClient } from "@sphyr/guard";

const guard = new AgentGuardClient({
  apiKey:     process.env.SPHYR_API_KEY,
  hmacSecret: process.env.SPHYR_HMAC_SECRET,
  mcpUrl:     "https://api.sphyr.io/mcp",
});
4

Route your first request

Send an outbound request through Sphyr's security pipeline.

JavaScript 
import { AgentGuardClient } from "@sphyr/guard";

const guard = new AgentGuardClient({
  apiKey:     "YOUR_API_KEY",
  hmacSecret: "YOUR_HMAC_SECRET",
  mcpUrl:     "https://api.sphyr.io/mcp",
});

const result = await guard.guardNet({
  url:      "https://api.example.com/data",
  method:   "GET",
  category: "api-call",
});

console.log("Status:", result.status);
console.log("Body:", result.body);
code

SDK Samples

Complete, runnable scripts. Paste into a single file and run.

guard-demo.mjs 
// guard-demo.mjs — Run: node guard-demo.mjs
import { AgentGuardClient } from "@sphyr/guard";

const guard = new AgentGuardClient({
  apiKey:     process.env.SPHYR_API_KEY     || "YOUR_API_KEY",
  hmacSecret: process.env.SPHYR_HMAC_SECRET || "YOUR_HMAC_SECRET",
  mcpUrl:     "https://api.sphyr.io/mcp",
});

// Confirm the shield is active before routing traffic
await guard.agentGuardUp();

// Route an outbound request through Sphyr's security pipeline
const result = await guard.guardNet({
  url:      "https://api.example.com/data",
  method:   "GET",
  category: "api-call",
});

console.log("Status:", result.status);
console.log("Body:", result.body);
build

IDE Setup

Copy the config block for your IDE. Sphyr connects as an MCP server over HTTP.

Claude Desktop connects to remote MCP servers through the Integrations UI, not a JSON config file.

1

Open Claude Desktop and go to Settings → Integrations

2

Click Add and enter the MCP server URL: https://api.sphyr.io/mcp

3

Claude Desktop will connect to Sphyr automatically.

Alternative: mcp-remote bridge (advanced)

Config file: ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) · %APPDATA%\Claude\claude_desktop_config.json (Windows)

claude_desktop_config.json 
{
  "mcpServers": {
    "sphyr": {
      "command": "npx",
      "args": ["mcp-remote", "https://api.sphyr.io/mcp", "--header", "Authorization: Bearer YOUR_API_KEY"]
    }
  }
}