Sidemail

Sidemail.io's official MCP Server

javascript

3

GitHub Stars

javascript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "sidemail-sidemail-mcp-server": {
      "command": "npx",
      "args": [
        "-y",
        "@sidemail/mcp"
      ],
      "env": {
        "SIDEMAIL_API_KEY": "${SIDEMAIL_API_KEY}"
      }
    }
  }
}

You can access Sidemail programmatically through the Model Context Protocol (MCP) server, enabling you to manage transactional emails, contacts, domains, and Messenger drafts from MCP clients such as VS Code or other MCP-enabled tools. This server provides a programmable interface to Sidemail features, making it easy to automate sending, querying, and managing your Sidemail resources.

How to use

Start the MCP server client-side by running the MCP runtime locally and supplying your Sidemail API key as an environment variable. Once running, you can perform actions to manage domains, messenger drafts, groups, contacts, and emails. Use your MCP client to invoke the server’s tools to list, create, update, or delete resources, as well as send transactional emails for testing.

How to install

Prerequisites you need before installing the MCP server:

Node.js v18 or newer
Sidemail API Key

Install and run the MCP server with the provided runtime command. The server runs locally via a standard MCP runtime that you invoke with the following command. Ensure your API key is set in the environment before starting.

npx -y @sidemail/mcp

Alternatively, you can supply the API key through an environment variable when starting the server.

SIDEMAIL_API_KEY=YOUR_API_KEY npx -y @sidemail/mcp

Available tools

list-domains

List all sending domains configured for your Sidemail account.

create-domain

Add a new sending domain to Sidemail.

delete-domain

Remove an existing sending domain.

list-messenger-drafts

List all Messenger drafts.

get-messenger-draft

Retrieve a Messenger draft by its ID.

create-messenger-draft

Create a new Messenger draft.

update-messenger-draft

Update an existing Messenger draft.

delete-messenger-draft

Delete a Messenger draft.

list-groups

List all contact groups.

create-group

Create a new contact group.

update-group

Update an existing contact group.

create-or-update-contact

Create a new contact or update an existing one.

query-contacts

Query contacts with filter criteria.

find-contact

Find a contact by email.

delete-contact

Delete a contact.

send-email

Send a transactional email (testing use).

query-emails

Query sent emails.