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:
| Parameter | Type | Required | Description |
|---|---|---|---|
from | string | Yes | Sender email address |
to | string | Yes | Recipient email address |
subject | string | No | Email subject (required unless using template) |
htmlBody | string | No | HTML content |
textBody | string | No | Plain text content |
templateId | number | No | Template ID |
templateAlias | string | No | Template alias |
templateModel | object | No | Template variables |
cc | string[] | No | CC recipients |
bcc | string[] | No | BCC recipients |
replyTo | string | No | Reply-to address |
tag | string | No | Message 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:
| Parameter | Type | Required | Description |
|---|---|---|---|
messages | array | Yes | Array of email objects |
transactional_email_stats
Get email statistics.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
period | string | No | "day", "week", or "month" (default: "week") |
serverId | number | No | Filter by server |
streamId | number | No | Filter 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:
| Parameter | Type | Required | Description |
|---|---|---|---|
serverId | number | No | Filter by server |
status | string | No | "DRAFT", "ACTIVE", or "ARCHIVED" |
limit | number | No | Max results (default: 50) |
transactional_templates_get
Get template details.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | number | Yes | Template ID |
transactional_templates_create
Create a new template.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Template name |
subject | string | Yes | Email subject |
serverId | number | Yes | Server ID |
alias | string | No | Template alias |
htmlBody | string | No | HTML content |
textBody | string | No | Plain 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:
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | Domain 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:
| Parameter | Type | Required | Description |
|---|---|---|---|
serverId | number | No | Filter by server |
streamId | number | No | Filter 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:
| Parameter | Type | Required | Description |
|---|---|---|---|
slug | string | Yes | Organization slug |
transactional_api_keys_list
List API keys for the current organization.
transactional_api_keys_create
Create a new API key.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Key name |
serverId | number | No | Restrict 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:
| Code | Description |
|---|---|
UNAUTHORIZED | Invalid or expired token - re-authorize through Claude |
FORBIDDEN | Insufficient permissions for this operation |
NOT_FOUND | Resource not found |
VALIDATION_ERROR | Invalid parameters |
RATE_LIMITED | Too many requests |
Authentication
All tools require OAuth 2.1 authentication. When you first use a tool, Claude will:
- Redirect you to the Transactional login page
- Ask you to authorize access
- Store the token securely for future requests
If you encounter UNAUTHORIZED errors, Claude will automatically prompt you to re-authorize.
Next Steps
- MCP Overview - Introduction to MCP
- Setup Guide - Installation instructions
- Troubleshooting - Common issues
On This Page
- MCP Tools Reference
- Email Tools
- transactional_email_send
- transactional_email_batch
- transactional_email_stats
- Template Tools
- transactional_templates_list
- transactional_templates_get
- transactional_templates_create
- Domain Tools
- transactional_domains_list
- transactional_domains_add
- Sender Tools
- transactional_senders_list
- transactional_suppressions_list
- Organization Tools
- transactional_whoami
- transactional_orgs_list
- transactional_orgs_switch
- transactional_api_keys_list
- transactional_api_keys_create
- transactional_members_list
- Billing Tools
- transactional_billing_usage
- transactional_billing_invoices
- transactional_billing_plan
- Error Handling
- Authentication
- Next Steps