Developers

Connect Your Agent

Connect Claude, Cursor, or any MCP client to your Artmail organization with a developer API key (email, campaigns, and more — by scope)

Connect Your Agent

:

Which guide do I need?

  • This page is for connecting an MCP client (Claude Desktop, Cursor, OpenClaw, etc.) to your Artmail organization using a developer API key from Dashboard → Developers → API keys. You choose scopes; the agent can use email, contacts, campaigns, and analytics when those permissions are included.
  • Listed catalog agents (marketplace) are a different product: you publish a third-party agent for brands to find and activate. That flow uses provisioned keys, webhooks, and a fixed scope allow-list (no send, no contact PII for that surface). If that is what you are building, read Developer MCP vs listed agent first.

:

The Artmail MCP server exposes tools according to the permissions on your API key — for example send paths, contact management, campaigns, and analytics, when you grant the matching scopes. It works with any client that supports the Model Context Protocol.

What you get

Once connected, your agent can:

  • Send transactional emails or use templates
  • Search, create, and update contacts
  • Create campaign drafts and check performance stats
  • Browse templates and automations

All through natural language. Example: "Send a welcome email to jane@example.com using the welcome-email template" or "Show me the open rate for last week's campaign".

Setup

1

Get your API key

  1. Go to Dashboard > Developers > API Keys
  2. Click Create API Key
  3. Select the permissions your agent needs (see table below)
  4. Copy the key — you will only see it once
2

Pick your client

Choose your MCP client and add the configuration below.


Claude Desktop

Edit ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%\Claude\claude_desktop_config.json (Windows):

JSON
Loading...

Restart Claude Desktop. You should see the ArtMail tools in the tools panel.


Cursor

Create or edit .cursor/mcp.json in your project root:

JSON
Loading...

Reload Cursor. The ArtMail tools will appear in your MCP tools list.


OpenClaw

Create ~/.openclaw/workspace/skills/artmail/SKILL.md:

Markdown
Loading...

Set the env variable: export ARTMAIL_API_KEY=art_live_your_key_here


Any MCP client

The server runs over stdio. Point any MCP client at:

Bash
Loading...

With environment variable ARTMAIL_API_KEY set.


Available tools

ToolWhat it doesPermission needed
artmail_send_emailSend email with HTML/texttransactional:send
artmail_send_templateSend via template slugtransactional:send
artmail_list_emailsList sent emails
artmail_get_emailGet email delivery status
artmail_list_contactsSearch/filter contactscontacts:read
artmail_get_contactGet contact detailscontacts:read
artmail_create_contactAdd a contactcontacts:write
artmail_update_contactUpdate contact fieldscontacts:write
artmail_delete_contactDelete a contactcontacts:write
artmail_list_campaignsList campaignscampaigns:read
artmail_get_campaignGet campaign detailscampaigns:read
artmail_create_campaignCreate draft/scheduled campaigncampaigns:write
artmail_get_campaign_statsCampaign analyticscampaigns:read
artmail_list_templatesBrowse templatestemplates:read
artmail_get_templateGet template contenttemplates:read
artmail_list_automationsList automationsautomations:read
artmail_get_automationGet automation detailsautomations:read

Example conversations

Send a welcome email:

"Send a welcome email to sarah@example.com from hello@mycompany.com with subject 'Welcome aboard!'"

Check campaign results:

"What were the open and click rates for the Spring Sale campaign?"

Add contacts from a list:

"Create contacts for these emails: alice@co.com, bob@co.com, charlie@co.com — tag them all as 'webinar-signup'"

Find unengaged contacts:

"List all contacts with status UNSUBSCRIBED"


Security notes

- Your API key grants the permissions you selected. Use the minimum permissions your agent needs.

  • Never share your API key in prompts, screenshots, or public repos.
  • Set IP restrictions on your API key if your agent runs from a fixed server.
  • Use art_test_ keys for development and testing.

Next steps

API Reference

Full endpoint documentation for contacts, campaigns, templates, and automations.

API Reference →

Authentication

Learn about API key management, permissions, and security.

Authentication →