Skip to main content

Beacon MCP Tools

Beacon provides MCP (Model Context Protocol) tools for AI assistants to monitor uptime and manage incidents.

Available Tools

beacon_status

Get current status of all monitors or a specific monitor.
{
  "name": "beacon_status",
  "arguments": {
    "monitor": "production-api"  // optional, omit for all monitors
  }
}
Response:
{
  "monitors": [
    {
      "name": "production-api",
      "status": "up",
      "response_time_ms": 145,
      "last_check": "2024-01-15T10:30:00Z",
      "uptime_24h": 100.0
    }
  ]
}

beacon_incidents

List active or recent incidents.
{
  "name": "beacon_incidents",
  "arguments": {
    "status": "active",     // "active", "resolved", or "all"
    "limit": 10
  }
}
Response:
{
  "incidents": [
    {
      "id": "inc_abc123",
      "monitor": "production-api",
      "status": "investigating",
      "started_at": "2024-01-15T10:30:00Z",
      "duration_minutes": 5,
      "affected_regions": ["nyc", "london"]
    }
  ]
}

beacon_history

Get uptime history for a monitor.
{
  "name": "beacon_history",
  "arguments": {
    "monitor": "production-api",
    "period": "7d"  // "24h", "7d", "30d", "90d"
  }
}
Response:
{
  "monitor": "production-api",
  "period": "7d",
  "uptime_percentage": 99.95,
  "total_incidents": 1,
  "total_downtime_minutes": 21,
  "avg_response_time_ms": 142,
  "checks": {
    "total": 10080,
    "passed": 10075,
    "failed": 5
  }
}

Example Conversations

User: “Is the API up?” Assistant uses: beacon_status with monitor: "production-api" Response: “Yes, the production API is up with a response time of 145ms. It has been 100% available in the last 24 hours.”
User: “Any incidents today?” Assistant uses: beacon_incidents with status: "all", filtered to today Response: “There were no incidents today. The last incident was 3 days ago and lasted 21 minutes.”
User: “What’s our uptime this month?” Assistant uses: beacon_history with period: "30d" Response: “Your production API has 99.95% uptime this month with 1 incident totaling 21 minutes of downtime.”

Setup

Add Beacon MCP to your Claude Desktop or Cursor configuration:
{
  "mcpServers": {
    "brainzlab-beacon": {
      "command": "npx",
      "args": ["-y", "@brainzlab/mcp-server"],
      "env": {
        "BRAINZLAB_SECRET_KEY": "your-secret-key",
        "BRAINZLAB_PRODUCTS": "beacon"
      }
    }
  }
}