@qmailing/mcp-server

qmailing — Model Context Protocol

Two ways to plug an AI agent into qmailing — pick the one that matches your client.

Client	Recommended setup
Claude.ai (web / mobile)	Custom Connector — one URL, no token, OAuth handles auth
Claude Desktop, Cursor, Continue, Zed, custom CLIs	@qmailing/mcp-server — npm package + API token

The two paths give the same tool surface — qmailing_list_mailboxes, qmailing_send_email, etc. They differ only in how the client authenticates: OAuth flow (browser) vs static bearer token (CLI / config).

🔗 Claude.ai Custom Connector (recommended)

Works with the Claude.ai web app and Claude mobile. No package install, no token management — the OAuth flow brokers per-grant scope consent and rotates refresh tokens automatically.

Setup (60 seconds)

• Sign in at https://qmailing.com.
• Go to Settings → Developers — copy the Server URL at the top:

  https://qmailing.com/mcp
  

• Open Claude.ai → Settings → Connectors → Add custom connector.
• Paste the server URL into the form. Claude.ai redirects you back to qmailing to sign in.
• Approve the requested scopes (Read mailboxes / Send emails / etc.) — the consent screen lists each one with a description before you click Allow.
• Done. Claude.ai shows the qmailing tools in its tool tray on every chat.

Revoking access

• From Claude.ai: Settings → Connectors → qmailing → Remove.
• From qmailing: signing out of every device (Settings → Profile → Sign out everywhere) invalidates outstanding tokens immediately.

What scopes mean

Same vocabulary as the API token scopes below. You consent to each one separately on first connection; granted scopes persist across re-grants until you revoke.

📦 Legacy MCP clients (npm package + API token)

For clients that don't speak OAuth Custom Connectors yet — Claude Desktop, Cursor, Continue, Zed, and any CLI MCP client.

Requirements

• A qmailing account on the PRO tier or higher (the public API is gated on PRO+).
• Node.js 18.17 or later.

Setup

1. Generate an API token

• Sign in at https://qmailing.com.

• Go to Settings → Developers.

• Click New token, give it a label (e.g. "Claude Desktop"), pick the scopes you want the agent to have, and copy the qm_live_… value when it's shown.

  The token only appears once. If you lose it, generate a fresh one.

2. Wire it into your MCP client

The package is published on the public npm registry under the beta tag — npx pulls it on first run, no manual checkout required.

Claude Desktop

Edit claude_desktop_config.json:

• macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "qmailing": {
      "command": "npx",
      "args": ["-y", "@qmailing/mcp-server"],
      "env": {
        "QMAILING_API_TOKEN": "qm_live_your_token_here"
      }
    }
  }
}

Pin a specific version (e.g. @qmailing/mcp-server@0.1.1) if you don't want auto-upgrades.

Claude Code

claude mcp add qmailing -- npx -y @qmailing/mcp-server
# Add the env var separately or supply via a wrapper script.

Cursor / Continue / Zed / others

Any MCP client that supports stdio servers takes the same command + args + env shape. Restart the client after editing its config — the qmailing tools appear in the tools menu (the wrench icon in Claude Desktop, similar in others).

Local development checkout

Contributors can run from a checkout instead of npm. Build + point the client at the absolute path:

cd qmailing-web/mcp
npm install
npm run build       # produces dist/server.js

{
  "mcpServers": {
    "qmailing": {
      "command": "node",
      "args": ["/absolute/path/to/qmailing-web/mcp/dist/server.js"],
      "env": { "QMAILING_API_TOKEN": "qm_live_your_token_here" }
    }
  }
}

Tools

Tool	What it does	Required scope
qmailing_list_mailboxes	List every mailbox on the account	mailboxes:read
qmailing_get_mailbox	Fetch one mailbox by id	mailboxes:read
qmailing_create_mailbox	Create a new mailbox under qmailing.com or a verified custom domain	mailboxes:write
qmailing_list_domains	List custom domains and verification state	domains:read
qmailing_get_dns_records	DNS-records checklist for one domain	domains:read

Configuration

Env var	Default	Purpose
QMAILING_API_TOKEN	required	Bearer token from /settings/developers
QMAILING_API_URL	https://qmailing.com	Override for self-hosted / staging deployments

Security notes

• The token authenticates as your full qmailing account within the scopes you granted. Treat it like a password.
• Tokens are revocable and the FE shows the prefix + last-used timestamp, so you can identify a compromised one and kill it from /settings/developers.
• Plan downgrades disable existing tokens immediately — the API re-checks the plan on every request, no per-token revocation needed.
• The MCP server runs locally on your machine; your token never leaves the process you launched. Only the qmailing API itself sees it.

Development

The package source is maintained in the qmailing monorepo. To work on it locally with a checkout, install deps inside the mcp/ directory and build:

cd mcp
npm install
npm run build
QMAILING_API_TOKEN=qm_live_test_token npm start

For bug reports or questions, reach us through the contact form at qmailing.com/contact.

License

MIT