npm package: @northrelay/mcp-server
Description: MCP server for NorthRelay Platform — expose all email infrastructure tools to AI agents via Model Context Protocol
Author: NorthRelay
Latest version: 1.1.1

# @northrelay/mcp-server

[Model Context Protocol](https://modelcontextprotocol.io/) server for the [NorthRelay](https://northrelay.ca) email infrastructure platform. Exposes 80+ tools for AI agents to send emails, manage templates, track deliveries, and more.

## Quick Start

```bash
NORTHRELAY_API_KEY=nr_live_xxx npx @northrelay/mcp-server
```

## Claude Desktop Configuration

Add to your `claude_desktop_config.json`:

```json
{
  "mcpServers": {
    "northrelay": {
      "command": "npx",
      "args": ["-y", "@northrelay/mcp-server"],
      "env": {
        "NORTHRELAY_API_KEY": "nr_live_your_api_key"
      }
    }
  }
}
```

## Environment Variables

| Variable | Required | Description |
|----------|----------|-------------|
| `NORTHRELAY_API_KEY` | Yes | Your NorthRelay API key (`nr_live_*` or `nr_test_*`) |
| `NORTHRELAY_BASE_URL` | No | API base URL (default: `https://app.northrelay.ca`) |

## Available Tools (17 groups, 80+ tools)

| Group | Tools | Description |
|-------|-------|-------------|
| **Emails** | `send_email`, `get_email_events` | Send transactional emails, track delivery events |
| **Templates** | `list_templates`, `get_template`, `create_template`, `update_template`, `delete_template`, `render_template` | Email template management with Handlebars |
| **Campaigns** | `list_campaigns`, `get_campaign`, `create_campaign`, `update_campaign`, `submit_campaign`, `send_campaign`, `delete_campaign` | Campaign lifecycle management |
| **Contacts** | `list_contacts`, `create_contact`, `update_contact`, `delete_contact` | Contact management |
| **Domains** | `check_deliverability`, `check_blocklist`, `check_dns` | Domain health and DNS verification |
| **Brand Theme** | `get_brand_theme`, `create_brand_theme`, `update_brand_theme`, `delete_brand_theme`, `preview_brand_theme` | Brand theming for emails |
| **Webhooks** | `list_webhooks`, `get_webhook`, `create_webhook`, `update_webhook`, `delete_webhook`, `rotate_webhook_secret`, `test_webhook`, `get_webhook_health` | Webhook management and monitoring |
| **API Keys** | `list_api_keys`, `create_api_key`, `revoke_api_key` | API key management |
| **Events** | `list_events`, `get_event`, `count_events` | Email event querying and counting |
| **Analytics** | `query_analytics`, `get_engagement_heatmap`, `get_geographic_data`, `get_provider_stats`, `export_analytics` | Analytics and reporting |
| **Metrics** | `get_metrics`, `get_metrics_summary` | Delivery metrics and summaries |
| **Suppressions** | `list_suppressions`, `add_suppression`, `remove_suppression`, `bulk_add_suppressions` | Global suppression list |
| **Suppression Groups** | `list_suppression_groups`, `get_suppression_group`, `create_suppression_group`, `update_suppression_group`, `delete_suppression_group`, `list_suppression_group_members` | Category-based unsubscribe groups |
| **Subusers** | `list_subusers`, `get_subuser`, `create_subuser`, `update_subuser`, `delete_subuser`, `suspend_subuser`, `reactivate_subuser`, `get_subuser_usage` | Subuser management |
| **Identity** | `list_identities`, `get_identity`, `create_identity`, `verify_identity`, `get_profile` | Sender identity and account profile |
| **IP Pools** | `list_ip_pools`, `get_ip_pool`, `create_ip_pool`, `update_ip_pool`, `list_pool_ips` | IP pool management |
| **IPs** | `list_ips`, `get_ip`, `get_ip_warmup_status`, `update_ip_warmup` | Dedicated IP management |

## Get Your API Key

1. Sign up at [northrelay.ca](https://northrelay.ca)
2. Go to Dashboard > Settings > API Keys
3. Create a new key and copy the `nr_live_*` value

## License

MIT