AI Onboarding

Easy-to-follow documentation to onboard your AI agent to Mailtrap.

Building with AI? Mailtrap provides several resources to make your life easier:

• Mailtrap MCP server

• Mailtrap docs for agents

• Mailtrap CLI app

• Mailtrap skills

Email API/SMTPEmail SandboxEmail Marketing

Getting started

Before you start, keep in mind that we require a human to:

• Sign up for a free Mailtrap account

• Create an API Token

Mailtrap MCP server

With the Mailtrap MCP server, you can perform various email operations through your favorite AI IDE (e.g., VS Code, Cursor, etc.) or your AI assistant (e.g., Claude). Some of the use cases include sending transactional emails, testing emails in your sandbox, managing templates, getting sending statistics, and more.

The Mailtrap MCP server is implemented as a Node.js command line utility and comes with quick-install buttons and pre-made code snippets for easy installation:

Claude or Cursor

{
  "mcpServers": {
    "mailtrap": {
      "command": "npx",
      "args": ["-y", "mcp-mailtrap"],
      "env": {
        "MAILTRAP_API_TOKEN": "your_mailtrap_api_token",
        "DEFAULT_FROM_EMAIL": "[email protected]",
        "MAILTRAP_ACCOUNT_ID": "your_account_id",
        "MAILTRAP_TEST_INBOX_ID": "your_test_inbox_id"
      }
    }
  }
}

VS Code

Claude (asdf)

MCP Bundle (MCPB)

Mailtrap MCP Server

Mailtrap docs for agents

To give your agent more context regarding Mailtrap you can share the following docs:

Markdown

To fetch a markdown version of any page from Mailtrap documentation, simply add .md to the end of the page URL. For instance:

AI onboarding documentation https://docs.mailtrap.io/getting-started/ai-onboarding.md

Full llms.txt

Or, you can also give your agent to all of our docs in a single llms.txt file:

Full Mailtrap documentation https://docs.mailtrap.io/llms-full.txt

Mailtrap CLI app

With Mailtrap’s CLI app, you can send emails, inspect sandbox, monitor deliverability stats, and administer domains, templates, contacts, and more – all from your terminal.

To install, you can download the latest release from GitHub Releases and add it to your PATH, or use either Homebrew:

brew install mailtrap/cli/mailtrap

or Go:

go install github.com/mailtrap/mailtrap-cli@latest

Here’s some examples:

# Send a transactional email
mailtrap send transactional \
  --from "[email protected]" \
  --to "[email protected]" \
  --subject "Order confirmed" \
  --html "<h1>Thanks for your order</h1>"

# Check spam score on a sandbox message
mailtrap messages spam-score --sandbox-id 12345 --id 67890

# Pull sending stats by mailbox provider
mailtrap stats by-esp --domain-id 111 --period 30

# Bulk import contacts from JSON
mailtrap contacts import --file contacts.json

Mailtrap skills

Mailtrap skills allow you to give your AI coding assistant accurate Mailtrap context for tasks such as sending emails, testing with sandbox, using email templates, setting up a sending domain, and managing contacts.

To install, simply copy the skills folders into the directory your agent reads. For example, for Cursor, that’s .cursor/skills/. Or, you can install via npx:

npx skills add mailtrap/mailtrap-skills

And here's a table with each skill and a brief description

Skill	Description
sending-emails	Use when integrating, configuring, or troubleshooting Mailtrap (Email API or SMTP).
testing-with-sandbox	Use when capturing outbound email in development or staging in a fake inbox.
using-email-templates	Use when creating, managing, and sending Mailtrap-hosted email templates.
setting-up-sending-domain	Use when adding or verifying a Mailtrap sending domain.
managing-contacts	Use when using Mailtrap Contacts API or UI to add, update, bulk import, list, segment marketing contacts, custom fields, or custom events.