Connect your agent

The launcher @starkscan/mcp connects any MCP client to Starkscan. It runs the bundled CLI underneath and forwards your API key from the environment. Get a key first with Get your first API key, then pick your client below. After connecting, see the MCP tools reference.

Shared environment

export STARKSCAN_CHAIN="SN_MAIN"
export STARKSCAN_API_KEY="<your key>"
# Optional: only set this for preview or self-hosted hosts.
# export STARKSCAN_BASE_URL="https://preview.example.com/api"

The launcher injects https://api.starkscan.co when STARKSCAN_BASE_URL is unset and reads STARKSCAN_API_KEY from the environment — never put the key in a config file you commit.

Generate a config

@starkscan/mcp can print a ready-to-paste config for your client, so the docs never drift from the launcher:

npx -y @starkscan/[email protected] print-config

Client recipes

All unattended recipes use command: "npx", args: ["-y", "@starkscan/[email protected]"], and pass STARKSCAN_API_KEY plus STARKSCAN_CHAIN. Add STARKSCAN_BASE_URL only for preview or self-hosted hosts. Floating tags such as @alpha are for interactive onboarding and manual smoke checks only.

Cursor

Add .cursor/mcp.json in your project:

{
  "mcpServers": {
    "starkscan": {
      "command": "npx",
      "args": ["-y", "@starkscan/[email protected]"],
      "env": {
        "STARKSCAN_CHAIN": "SN_MAIN",
        "STARKSCAN_API_KEY": "${STARKSCAN_API_KEY}"
      }
    }
  }
}

Open Cursor Settings → MCP and refresh the starkscan server.

Claude Desktop

Edit claude_desktop_config.json (macOS: ~/Library/Application Support/Claude/claude_desktop_config.json):

{
  "mcpServers": {
    "starkscan": {
      "command": "npx",
      "args": ["-y", "@starkscan/[email protected]"],
      "env": {
        "STARKSCAN_CHAIN": "SN_MAIN",
        "STARKSCAN_API_KEY": "${STARKSCAN_API_KEY}"
      }
    }
  }
}

Restart Claude Desktop, then look for starkscan under the connectors menu.

Cline

Add .cline/mcp.json with the same mcpServers block as above, then reload Cline's MCP servers.

Claude Code and Codex

These have first-class CLI commands — see the one-line claude mcp add and codex mcp add recipes in the MCP quickstart.

Transports

The hosted /mcp endpoint on api.starkscan.co is authenticated with X-Starkscan-Api-Key and is origin-allowlisted: a request that sends a browser Origin must be on the allowlist or it is rejected with 403. The app-host /api/mcp path remains a compatibility alias. Server-to-server calls without an Origin header pass through.

Agent discovery

Agents can bootstrap from machine-readable context:

These advertise the auth header, the /v1 API-host base, the default chain, and the recommended first calls.