getting-started
Quickstart

Quickstart

Get started with Interstitial in 5 minutes.

Prerequisites

  • Node.js 18+ or Python 3.9+
  • API key (use dev-key-12345 for development)
  • API running at http://localhost:3001

Step 1: List Available Services

curl -H "x-api-key: dev-key-12345" \
  http://localhost:3001/api/v1/services

Response:

[
  {
    "id": "ndbc",
    "name": "NOAA Buoys",
    "description": "Ocean observations from NDBC buoy network",
    "domain": "ocean",
    "temporal_pattern": "periodic",
    "port": 3100,
    "status": "active"
  }
]

Step 2: Initialize MCP Connection

curl -X POST \
  -H "x-api-key: dev-key-12345" \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "initialize",
    "params": {
      "protocolVersion": "2024-11-05",
      "capabilities": {},
      "clientInfo": {"name": "test-client", "version": "1.0.0"}
    }
  }' \
  http://localhost:3001/api/v1/services/ndbc/mcp

Step 3: List Available Tools

curl -X POST \
  -H "x-api-key: dev-key-12345" \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 2,
    "method": "tools/list"
  }' \
  http://localhost:3001/api/v1/services/ndbc/mcp

Step 4: Call a Tool

curl -X POST \
  -H "x-api-key: dev-key-12345" \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 3,
    "method": "tools/call",
    "params": {
      "name": "ndbc.latest_observation",
      "arguments": {
        "station_id": "46108"
      }
    }
  }' \
  http://localhost:3001/api/v1/services/ndbc/mcp

Next Steps

AuthenticationOpenAPI Spec