winnr-mcp

MCP server for the Winnr cold-email infrastructure API.

Lets Claude Desktop, Claude Code, Cursor, Windsurf, VS Code (Copilot) and any other MCP client manage your domains, mailboxes, warming, inbox, pre-warmed marketplace and webhooks through natural language.

Fastest setup: log in and open app.winnr.app/mcp — it creates the token, writes the config for your client, and confirms the connection.

54 tools, 25 of them read-only. One Python package, no local state, nothing but HTTPS calls to api.winnr.app.

---

Quick start

1. Get a token

app.winnr.app/mcp (or API → Create Token). Tokens start with wnr_. Pick read-only if you only want reports and reply triage: every tool that creates, sends, buys or deletes is then hidden from the assistant.

2. Install uv

The server runs with uvx, so uv must be installed once:

# macOS / Linux
curl -LsSf https://astral.sh/uv/install.sh | sh      # or: brew install uv
# Windows (PowerShell)
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

No uv? pip install winnr-mcp and use "command": "winnr-mcp" with no args instead.

3. Add the server to your client

Claude Desktop

Settings → Developer → Edit Config, then paste (macOS ~/Library/Application Support/Claude/claude_desktop_config.json, Windows %APPDATA%\Claude\claude_desktop_config.json). Fully quit and reopen Claude.

{
  "mcpServers": {
    "winnr": {
      "command": "uvx",
      "args": ["winnr-mcp"],
      "env": { "WINNR_API_TOKEN": "wnr_your_token_here" }
    }
  }
}

Claude Code

claude mcp add --scope user winnr -e WINNR_API_TOKEN=wnr_your_token_here -- uvx winnr-mcp

Then /mcp inside Claude Code shows Winnr as connected. Optional guided workflows (/winnr setup, /winnr health, /winnr export) come from winnr-claude-skills:

curl -sL https://raw.githubusercontent.com/winnr-app/winnr-claude-skills/main/install.sh | bash

Cursor

~/.cursor/mcp.json (global) or .cursor/mcp.json (project) — same JSON as Claude Desktop. Settings → MCP shows Winnr with a green dot when it is up.

Windsurf

~/.codeium/windsurf/mcp_config.json — same JSON. Refresh in Settings → Cascade → MCP Servers.

VS Code (Copilot agent mode)

.vscode/mcp.json:

{
  "servers": {
    "winnr": {
      "type": "stdio",
      "command": "uvx",
      "args": ["winnr-mcp"],
      "env": { "WINNR_API_TOKEN": "wnr_your_token_here" }
    }
  }
}

4. Try it

What's in my Winnr account, and how much capacity do I have left?

The assistant calls winnr_get_account and winnr_get_usage. The app.winnr.app/mcp page flips to Connected once the token has been used.

Configuration

Source	Variable / flag	Description
Env var	WINNR_API_TOKEN	Required. Your Winnr API token (wnr_*)
Env var	WINNR_API_URL	API base URL (default https://api.winnr.app; resellers use their own host)
Env var	WINNR_TIMEOUT	HTTP timeout in seconds (default 30; purchases use 60)
Env var	WINNR_READ_ONLY	true to register read tools only, even with a read/write token
CLI	--token, --api-url, --timeout, --read-only, --version	Override the env vars

CLI args take precedence over environment variables.

At startup the server calls GET /v1/account. An invalid token exits immediately with a clear message (a server that starts and then fails every call is worse). If the token is read-only, write tools are hidden automatically — no flag needed.

How the assistant is guided

The server ships instructions to the client (most hosts put them in the system prompt), and every tool carries MCP annotations (readOnlyHint, destructiveHint, idempotentHint) so hosts can ask for confirmation at the right moments. The instructions cover:

• IDs and async jobs (job_id → poll winnr_get_job)
• The four tools that charge the card (domain purchase, pre-warmed purchase ×2, warming enable) and the rule to get an explicit yes with the exact price first. Domain purchases re-check availability and price right before ordering and refuse the order if anything changed, so the confirmed total is the charged total
• Never retrying a purchase after a timeout without checking winnr_list_jobs
• Domain-name hygiene (brand-like names; no outreach/blast/bulk words)
• Cold-email ratios (2–5 mailboxes per domain, warm 2–3 weeks, modest daily sends)

Tools

Permission is the token scope the tool needs. Read tools are visible to every token.

Account, jobs, export

Tool	Description	Permission
winnr_get_account	Account, plan, limits, and the calling token's scope	read
winnr_get_usage	Domains / email users / pre-warmed addresses vs limits	read
winnr_list_jobs	Recent async jobs (status / type filters)	read
winnr_get_job	One job's status, progress, result, error	read
winnr_list_export_formats	Supported CSV formats	read
winnr_export_email_users	CSV of credentials (15-minute link), 22 sequencer formats	write

Domains

Tool	Description	Permission
winnr_list_domains	List domains (paginated, optional status filter: complete, pending, …)	read
winnr_get_domain	One domain with DNS status and live health	read
winnr_search_domains	Availability + price for one name	read
winnr_search_domains_bulk	Availability + price for up to 100 names	read
winnr_get_dns_status	Provisioning/propagation state (MX, SPF, DKIM, DMARC)	read
winnr_get_dns_records	Records to add for manual-DNS domains	read
winnr_check_dns_provider	Where a domain's DNS is hosted today (≤20 per call)	read
winnr_purchase_domains	Buy + set up domains, async job; re-verifies quoted prices first (charges card)	write
winnr_setup_domain	Re-run DNS/mail provisioning, add mailboxes/redirect	write
winnr_connect_domains	Bring your own domains (nameserver, manual DNS, or Cloudflare token)	write
winnr_check_nameservers	Verify NS change; auto-queues provisioning	write
winnr_verify_dns	Live-verify manual-DNS records	write
winnr_tag_domains	Add/remove/set tags on up to 50 domains	write
winnr_delete_domain	Delete a domain and its mailboxes (destructive)	write

Mailboxes (email users)

Tool	Description	Permission
winnr_list_email_users	List mailboxes, filterable by domain	read
winnr_get_email_user	One mailbox with IMAP/SMTP details	read
winnr_create_email_user	Create one mailbox (async job)	write
winnr_bulk_create_email_users	Create up to 100 mailboxes on one domain	write
winnr_update_email_user	Rename or set password	write
winnr_delete_email_user	Delete a mailbox (destructive)	write

Inbox

Tool	Description	Permission
winnr_list_inbox	Messages across all mailboxes; warm-up hidden by default	read
winnr_get_message_body	Full body by uid + mailbox (truncated at 10k chars)	read
winnr_send_email	Send from a mailbox, with threading headers	write
winnr_refresh_inbox	Trigger a sync	write
winnr_delete_message	Delete one message (destructive)	write

Warming

Tool	Description	Permission
winnr_list_warming	Every warming mailbox with health/inbox rate	read
winnr_get_warming_overview	Aggregate stats + estimated monthly cost	read
winnr_get_warming_metrics	Daily series for one mailbox	read
winnr_enable_warming	Enable, with emails_per_day (1–20) and rampup_speed ($0.60/mailbox/mo)	write
winnr_disable_warming	Disable and stop billing	write
winnr_pause_warming / winnr_resume_warming	Temporary stop / restart	write
winnr_update_warming_settings	emails_per_day, rampup_enabled, rampup_speed	write

Pre-warmed marketplace

Tool	Description	Permission
winnr_browse_prewarmed	Available aged, warmed domains	read
winnr_get_prewarmed_domain	Per-address health for one listing	read
winnr_check_prewarmed_blocklist	Live blocklist check (9 lists)	read
winnr_list_my_prewarmed	Purchased pre-warmed domains	read
winnr_purchase_prewarmed	Buy one domain, $3/address/mo (charges card)	write
winnr_purchase_prewarmed_batch	Buy up to 25 domains as one charge (charges card)	write
winnr_cancel_prewarmed	Cancel and return the domain (destructive)	write

Webhooks

Tool	Description	Permission
winnr_list_webhooks	Endpoints with status and health	read
winnr_get_webhook_deliveries	Recent delivery attempts	read
winnr_create_webhook	Create (response includes signing secret)	write
winnr_update_webhook	Change URL/events/description/status	write
winnr_test_webhook	Send a test.ping	write
winnr_rotate_webhook_secret	Rotate secret (old valid 24 h)	write
winnr_get_webhook_secret	Read the signing secret (sensitive; hidden from read-only tokens)	write
winnr_delete_webhook	Delete (destructive)	write

Errors

Every tool returns JSON. Failures look like:

{ "error": { "message": "Payment required: …", "status_code": 402, "code": "payment_method_required" } }

so an agent can branch on code. Read-only 403s explain that the token lacks write scope; 429s on reads are retried once automatically.

Security

• Token-scoped. Everything runs as one account, with the token's permissions. Revoke it in the dashboard and the assistant is cut off instantly.
• Passwords never appear in tool output. Credentials leave only through winnr_export_email_users, a 15-minute presigned CSV link that needs a read/write token.
• Nothing is logged. The token is sent as a bearer header and never printed; the server writes one startup line to stderr.
• Rate limits are the API's (300 req/min Startup, 500 Enterprise). The server warns when fewer than 10 requests remain in the window.

Development

git clone https://github.com/winnr-app/winnr-mcp.git
cd winnr-mcp
python3 -m venv .venv && source .venv/bin/activate
pip install -e ".[dev]"
pytest          # 102 tests, all HTTP mocked
ruff check src tests
WINNR_API_TOKEN=wnr_xxx python -m winnr_mcp   # run locally over stdio

License

MIT