About vaemail
VaEmail is an MCP server and CLI for agents that need to send email and manage delivery operations. It combines sending, domain authentication, delivery tracking, and diagnostics with safeguards such as idempotency and bounded API-key permissions.
Key features
- 01Send transactional email
- 02Prepare and confirm newsletters
- 03Authenticate sending domains
- 04Track messages and diagnose delivery
- 05Manage contacts, bounces, and quota
- 06Audit API-key activity
Use cases
- 01Send transactional messages from an agent
- 02Check delivery events after sending
- 03Set up and verify a sending domain
- 04Test integrations with sandbox API keys
MCP support
The MCP server exposes VaEmail email, contact, domain, delivery, usage, and audit operations to MCP clients. It runs over stdio and uses VAEMAIL_API_KEY for authentication.
Configuration
Local server config is the same for every client. Copy it into your client’s MCP config file.
npx -y vaemailVAEMAIL_API_KEYSecretVaEmail API key (created in the dashboard, ideally scoped and capped for this agent). Required for every tool except vaemail_capabilities.VAEMAIL_BASE_URLAPI base URL. Default https://app.vaemail.fr.Local servers need a runtime on your machine (e.g. Node.js 18+). Config file locations differ by client; see your client’s docs.
Tools
17Saved tool list · updated 4d ago
| Parameter | Type | Required | Description |
|---|---|---|---|
| liste | string | Yes | To whom: the list name (approximate matches are accepted) or its number. |
| quand | string | No | “now”, or a future date “2026-09-17 10:00” (Paris time). Absent = draft; nothing is sent. |
| sujet | string | Yes | Email subject, as the reader will see it. |
| apercu | string | No | Preview text displayed next to the subject in the inbox. |
| contenu | string | Yes | The email: complete HTML, or plain text (automatically formatted into paragraphs). |
| test_vers | string | No | Address that receives a test copy BEFORE sending or scheduling. |
| nom_interne | string | No | Campaign name in the admin. Defaults to the subject. |
| liste_exclue | string | No | List whose contacts must not receive this email (name or number). |
Details
From the project READMEVaEmail — email infrastructure for AI agents
MCP server and CLI for VaEmail. Give an agent the ability to send email, authenticate a sending domain, track delivery and diagnose deliverability — without a human reading a dashboard in between.
European infrastructure: servers in Germany, sending through Amazon SES Europe.
Install
# Claude Code
claude mcp add vaemail --env VAEMAIL_API_KEY=swm_your_key -- npx -y vaemail mcp
# Any MCP client
npx -y vaemail mcp
Or as a config block:
{
"mcpServers": {
"vaemail": {
"command": "npx",
"args": ["-y", "vaemail", "mcp"],
"env": { "VAEMAIL_API_KEY": "swm_your_key" }
}
}
}
GET /api/v1/me identifies the tenant, key prefix, scopes and mode without
returning the secret. Contact operations accept a tenant-unique
external_reference for CRM identifiers and upserts.
Use a sandbox API key for integration tests: reads work normally, while every write
is validated in a transaction that is always rolled back. No row, job, email, SMS,
webhook or outbound HTTP call is emitted, and idempotency keys are not stored.
Sandbox write responses carry X-VaEmail-Sandbox: 1 and sandbox: true in JSON
objects. A sandbox response is never evidence that an email was delivered.
Check everything is wired up:
npx vaemail init
Tools
| Tool | What it does |
|---|---|
vaemail_preparer_envoi | Prepares a newsletter draft, resolves the list, optionally sends a test, and returns a recap plus a one-use confirmation token. It never sends or schedules. |
vaemail_confirmer_envoi | Executes the scheduled or immediate newsletter prepared with the token, after explicit human confirmation. This is destructive. |
vaemail_ou_en_est_ma_campagne | Where a campaign stands, in plain sentences: scheduled, sending, sent, opens, clicks. |
vaemail_qui_est_abonne | Lists by folder with subscriber counts, or the lists and status of one address. |
vaemail_importer_contacts | Adds contacts to a list (created if missing). Never re-subscribes an unsubscribed address. |
vaemail_capabilities | What the service supports. No API key needed. |
vaemail_send_email | Queue a transactional email, return its id. |
vaemail_validate_email | Dry run: would this send go out, and what would block it. |
vaemail_get_message | Delivery status and every event for one message. |
vaemail_list_messages | Recent messages, filtered by status, tag or recipient. |
vaemail_list_domains | Sending domains with live SPF, DKIM and DMARC state. |
vaemail_create_domain | Declare a domain, return the DNS records to publish. |
vaemail_verify_domain | Re-read the DNS and report what is authenticated. |
vaemail_dns_requirements | The records a declared domain still needs. |
vaemail_diagnose_deliverability | Why mail is landing badly, with the actions that fix it. |
vaemail_list_bounces | Addresses excluded from sending, and why. |
vaemail_get_usage | Quota, daily cap on the key, what is left. |
vaemail_get_audit_log | What this key has done, to report it accurately. |
Both vaemail_confirmer_envoi and vaemail_send_email advertise
destructiveHint: true: sending externally is irreversible. The newsletter confirmation
guard applies to immediate sending; drafts and scheduled campaigns keep their existing behavior.
What this is built to prevent
An agent fails differently from a person. It retries, it does not read a dashboard, and it reports success from a 200. The API is shaped around that:
- A send is accepted, not delivered.
vaemail_send_emailreturns 202 and an id. Onlyvaemail_get_messagesays what became of it. The tool descriptions say so, so an agent does not announce a delivery it cannot know about. - Retries do not duplicate. Pass
idempotency_keyand a repeat call replays the first response for 24 hours instead of sending twice. - Errors say what to do. Every failure carries a stable
code, whether it isretryable, and the corrective action with the endpoint that performs it. - Keys are bounded. Scopes, a daily send cap, a cap on recipients per email and an allow-list of sender domains. An agent cannot spend more than the key allows.
- Every call is logged. Which key, which operation, which parameters, which result — message bodies excluded. Autonomous, but accountable.
- Human steps are named as such. Publishing DNS records is one. A record
whose value still contains a placeholder is flagged
publishable: false, because publishing it would break the domain's authentication.
CLI
vaemail init # check config, print the MCP snippet
vaemail capabilities # what the service can do (no key needed)
vaemail send --to [email protected] --subject Hi --html '<p>Hello</p>'
vaemail status 42 # delivery status of a message
vaemail domains:add exemple.fr # declare a domain, print DNS records
vaemail doctor # why is my email not arriving?
vaemail usage # quota and remaining allowance
vaemail mcp # run the MCP server on stdio
Add --json to any command for machine-readable output.
Use it as a library
The same client the MCP server and the CLI run on is exported, so an application can call VaEmail directly. No dependencies.
import { VaEmail } from 'vaemail';
const client = new VaEmail({ apiKey: process.env.VAEMAIL_API_KEY });
await client.send(
{
to: '[email protected]',
subject: 'Your order is on its way',
html: '<p>Tracking number: 1Z999</p>',
},
'order-4711', // idempotency key: safe to replay for 24 hours
);
Errors carry what to do next, not just a status code:
try {
await client.send({ to: '[email protected]' });
} catch (error) {
error.code; // DOMAIN_NOT_VERIFIED
error.retryable; // false
error.pourAgent(); // reason, corrective action, whether to retry
}
Also: capabilities(), health(), validate(), getMessage(),
listMessages(), listDomains(), addDomain(), verifyDomain(),
dnsRecords(), diagnoseDeliverability(), listSuppressions(),
removeSuppression(), usage(), auditLogs().
Connecter Stripe
Utilise une clé Stripe restreinte rk_live_ ou rk_test_, avec Customers en lecture et
Webhook Endpoints en écriture. Une clé secrète sk_ est refusée. VaEmail ne renvoie
aucun secret Stripe : l'état de la connexion expose uniquement les quatre derniers
caractères de la clé et du token du webhook.
Routes REST :
GET /api/v1/integrations/stripe: lire l'état de la connexion ;POST /api/v1/integrations/stripe: créer ou réconcilier le webhook, avec{"api_key":"rk_live_..."}et la portéesettings.write;DELETE /api/v1/integrations/stripe: supprimer le webhook Stripe puis la connexion locale. Action irréversible, à confirmer explicitement par un humain.
Stripe appelle POST /api/v1/webhooks/stripe/{token}. Cette route publique vérifie
Stripe-Signature et ne reçoit pas la clé API VaEmail.
Événements pris en charge et déclencheurs d'automatisation :
| Événement Stripe | Déclencheur VaEmail |
|---|---|
invoice.payment_failed | stripe_payment_failed (payment_failed) |
customer.subscription.created | stripe_subscription_created (subscription_created) |
customer.subscription.deleted | stripe_subscription_deleted (subscription_deleted) |
checkout.session.completed | stripe_checkout_completed (checkout_completed) |
A Python SDK with the same surface is available: pip install vaemail
(https://github.com/vaemail/vaemail-python).
Environment
| Variable | Meaning |
|---|---|
VAEMAIL_API_KEY | Account API key. Created from the dashboard, under « Clés API ». |
VAEMAIL_BASE_URL | API base URL. Defaults to https://app.vaemail.fr. |
Also available
- OpenAPI specification: https://app.vaemail.fr/openapi.json
- Capabilities endpoint: https://app.vaemail.fr/api/v1/capabilities
- Agent documentation: https://vaemail.fr/agents
Skill and examples
- Agent skill (rules an agent should follow before its first call):
npx skills add vaemail/skills, source https://github.com/vaemail/skills - Examples for curl, Node, Python, Claude Code, Codex, OpenAI Agents, LangChain, CrewAI and n8n: https://github.com/vaemail/examples
- Registry entry:
io.github.vaemail/vaemail(seeserver.json)
Dependencies
None. Node 18+ for the built-in fetch, and nothing else — a package an agent
installs on its own should not pull a dependency tree behind it.
License
MIT
Comments
New to MCP?
From what the protocol is to installing your first server, these answers cover most first questions.
An open protocol that defines how AI applications connect to external tools and data in a uniform way. Clients talk to the model; MCP servers provide tools, resources and prompt templates. They exchange standard messages, so one server can be reused by many clients.