Docs MCP Server MCP Server Quickstart

MCP Server Quickstart

Let Claude and other AI agents send transactional emails on your behalf — no custom code required.

What is MCP?

Model Context Protocol (MCP) is an open standard that lets AI assistants call external tools. The Brixus MCP server exposes 16 tools to any MCP-compatible agent, grouped by job:

Send — brixus_send_email, brixus_send_email_batch, brixus_cancel_email
Track & analyze — brixus_get_email, brixus_list_emails, brixus_get_email_analytics, brixus_get_api_key_info
Templates — brixus_list_starter_templates, brixus_preview_starter_template, plus the template-builder tools (brixus_create_email_template, brixus_update_email_template, brixus_get_email_template, brixus_get_email_component_schema)
Campaigns (paid plans) — brixus_list_campaigns, brixus_get_campaign, brixus_send_campaign_test

Everything except the campaign tools works on the Free plan — campaigns require a paid plan (Standard or Enterprise). See the Tools reference for full input and output details.

Install & connect

There are two ways to connect: the hosted server (recommended — no API key to manage) or self-hosting from source (you supply an API key). The server is open source on GitHub — Brixus-Technologies/brixus365-mcp

Hosted server — recommended

The fastest way to connect. The hosted server authenticates with OAuth — you sign in to your Brixus365 account in the browser, so there’s no API key to copy or store.

Claude Code — one command:

claude mcp add brixus365 --transport http https://mcp.brixus365.com/mcp

Claude Desktop — add it from the UI (Claude Desktop connects to remote MCP servers through the Connectors UI, not the JSON config):

Open Settings → Connectors.
Click Add custom connector.
Paste the URL https://mcp.brixus365.com/mcp and click Add.
Sign in to Brixus365 when prompted.

Cursor, Cline and other stdio clients — add this under mcpServers:

{
  "mcpServers": {
    "brixus365": {
      "command": "npx",
      "args": ["-y", "mcp-remote", "https://mcp.brixus365.com/mcp"]
    }
  }
}

On first use your client opens a browser to sign in. Restart the client and the Brixus tools appear in the tools panel.

Self-host from source

Prefer to run the server yourself? It’s open source — clone and build it, then point your client at the built entrypoint with an API key.

You’ll need a Brixus365 API key. The email-only widget on the developers page is the fastest path to a bx_preview_… key for testing — for a production-ready bx_live_… key, see Creating API keys.

git clone https://github.com/Brixus-Technologies/brixus365-mcp.git
cd brixus365-mcp
npm install && npm run build

claude mcp add brixus365 -- env BRIXUS365_API_KEY=bx_live_your_key_here node /path/to/brixus365-mcp/dist/index.js

Example prompts

Once connected, try these in Claude:

List the Brixus starter templates and summarise what each one does. Preview the welcome template with name=‘Alice’ and app_name=‘Acme’, then show me the subject line.

Using Brixus, send a password reset email to alice@example.com with reset_url=https://example.com/reset/abc123 and expiry_minutes=30.

Configuration

Environment variable		Default	Description
`BRIXUS365_API_KEY`	required	—	Your Brixus365 API key — free key (`bx_preview_…`) or full account key (`bx_live_…`).
`BRIXUS365_API_BASE_URL`	optional	`https://app.brixus365.com/api/v1`	Override for self-hosted or staging environments.

Troubleshooting

Error code	Cause	Fix
missing_api_key / invalid_api_key	Env var not set or the value is wrong	Re-copy the key from Settings → API Keys in the Brixus365 app
key_revoked_upgrade	Free key was revoked when the account upgraded to a paid plan	Copy the new `bx_live_…` key from the dashboard link in the error message
upgrade_required	Feature requires a paid plan, or free-key quota reached	Visit the `upgrade_url` returned in the error message
rate_limit_exceeded	Too many calls per minute (free key: 10/min)	Wait 60 seconds and retry
daily_limit_exceeded / monthly_limit_exceeded	Send volume cap reached for the current window	Upgrade your plan or wait for the window to reset (UTC)
template_not_found	The slug isn’t a known starter template	Call `brixus_list_starter_templates` to see valid slugs
tier_suspended	Account suspended for deliverability signals	Email support@brixus365.com