MCP Tools Reference

Complete reference for all Transactional MCP tools available to AI assistants.

MCP Tools Reference

This page documents all tools available through the Transactional MCP server.

Email Tools

transactional_email_send

Send a single email.

Parameters:

ParameterTypeRequiredDescription
fromstringYesSender email address
tostringYesRecipient email address
subjectstringNoEmail subject (required unless using template)
htmlBodystringNoHTML content
textBodystringNoPlain text content
templateIdnumberNoTemplate ID
templateAliasstringNoTemplate alias
templateModelobjectNoTemplate variables
ccstring[]NoCC recipients
bccstring[]NoBCC recipients
replyTostringNoReply-to address
tagstringNoMessage tag

Example request:

{
  "from": "hello@example.com",
  "to": "user@example.com",
  "subject": "Hello!",
  "htmlBody": "<h1>Welcome</h1><p>Thanks for signing up.</p>"
}

transactional_email_batch

Send multiple emails at once.

Parameters:

ParameterTypeRequiredDescription
messagesarrayYesArray of email objects

transactional_email_stats

Get email statistics.

Parameters:

ParameterTypeRequiredDescription
periodstringNo"day", "week", or "month" (default: "week")
serverIdnumberNoFilter by server
streamIdnumberNoFilter by stream

Returns:

{
  "period": "week",
  "sent": 1234,
  "delivered": 1220,
  "bounced": 14,
  "complained": 2,
  "opened": 856,
  "clicked": 234,
  "deliveryRate": 0.9887,
  "openRate": 0.7016,
  "clickRate": 0.1926,
  "bounceRate": 0.0113,
  "complaintRate": 0.00016
}

Template Tools

transactional_templates_list

List email templates.

Parameters:

ParameterTypeRequiredDescription
serverIdnumberNoFilter by server
statusstringNo"DRAFT", "ACTIVE", or "ARCHIVED"
limitnumberNoMax results (default: 50)

transactional_templates_get

Get template details.

Parameters:

ParameterTypeRequiredDescription
idnumberYesTemplate ID

transactional_templates_create

Create a new template.

Parameters:

ParameterTypeRequiredDescription
namestringYesTemplate name
subjectstringYesEmail subject
serverIdnumberYesServer ID
aliasstringNoTemplate alias
htmlBodystringNoHTML content
textBodystringNoPlain text content

Domain Tools

transactional_domains_list

List configured email domains.

Returns:

{
  "domains": [
    {
      "id": 1,
      "name": "mail.example.com",
      "status": "VERIFIED",
      "dkimVerified": true,
      "spfVerified": true
    }
  ]
}

transactional_domains_add

Add a new domain.

Parameters:

ParameterTypeRequiredDescription
domainstringYesDomain name

Returns: Domain object with DNS records to configure.

Sender Tools

transactional_senders_list

List email senders.

transactional_suppressions_list

List suppressed email addresses.

Parameters:

ParameterTypeRequiredDescription
serverIdnumberNoFilter by server
streamIdnumberNoFilter by stream

Organization Tools

transactional_whoami

Get current user and organization info.

Returns:

{
  "user": {
    "id": "user_123",
    "email": "user@example.com",
    "name": "John Doe"
  },
  "organization": {
    "id": 1,
    "name": "My Company",
    "slug": "my-company",
    "role": "OWNER"
  }
}

transactional_orgs_list

List all organizations the user has access to.

transactional_orgs_switch

Switch to a different organization.

Parameters:

ParameterTypeRequiredDescription
slugstringYesOrganization slug

transactional_api_keys_list

List API keys for the current organization.

transactional_api_keys_create

Create a new API key.

Parameters:

ParameterTypeRequiredDescription
namestringYesKey name
serverIdnumberNoRestrict to server

transactional_members_list

List organization members.

Billing Tools

transactional_billing_usage

Get current billing usage.

Returns:

{
  "period": "2024-01",
  "emailsSent": 45678,
  "emailLimit": 100000
}

transactional_billing_invoices

List billing invoices.

transactional_billing_plan

Get current plan details.

Error Handling

All tools may return errors in this format:

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or expired token"
  }
}

Common error codes:

CodeDescription
UNAUTHORIZEDInvalid or expired token - re-authorize through Claude
FORBIDDENInsufficient permissions for this operation
NOT_FOUNDResource not found
VALIDATION_ERRORInvalid parameters
RATE_LIMITEDToo many requests

Authentication

All tools require OAuth 2.1 authentication. When you first use a tool, Claude will:

  1. Redirect you to the Transactional login page
  2. Ask you to authorize access
  3. Store the token securely for future requests

If you encounter UNAUTHORIZED errors, Claude will automatically prompt you to re-authorize.

Next Steps