sidemail-mcp-server

🚀 Sidemail模型上下文协议（MCP）服务器

Sidemail MCP服务器为 Sidemail.io 提供了模型上下文协议（MCP）集成，允许通过VS Code中的MCP代理模式和其他MCP客户端以编程方式访问Sidemail的事务性电子邮件、联系人、域名和Messenger功能。

✨ 主要特性

• 管理发送域名
• 测试发送事务性电子邮件
• 管理联系人及联系人组
• 创建、更新和删除Messenger草稿
• 查询已发送的电子邮件和联系人

📦 安装指南

前提条件

• Node.js v18 或更高版本
• Sidemail API密钥

Microsoft VS Code设置（辅助方式）

1. 打开命令面板（Ctrl/Cmd + Shift + P）。
2. 输入 “MCP: 添加服务器…” 并选择该选项。
3. 选择 “NPM包”。
4. 输入 @sidemail/mcp 并确认。
5. 确认安装。
6. 输入你的Sidemail API密钥并确认。

Microsoft VS Code设置（手动方式）

或者，你可以通过修改 mcp.json 配置文件手动安装。

1. 打开命令面板（Ctrl/Cmd + Shift + P）。
2. 输入 “MCP: 打开用户配置” 并选择该选项。
3. 添加以下配置并保存更改。

{
    "servers": {
        "sidemail-mcp": {
            "type": "stdio",
            "command": "npx",
            "args": ["-y", "@sidemail/mcp"],
            "env": {
                "SIDEMAIL_API_KEY": "${input:sidemail-key}",
            },
        },
    },
    "inputs": [
        {
            "type": "promptString",
            "id": "sidemail-key",
            "description": "Sidemail API Key",
            "password": true,
        },
    ],
}

Claude Desktop设置

编辑（或创建）配置文件：

• macOS：~/Library/Application Support/Claude/claude_desktop_config.json
• Windows：%APPDATA%\Claude\claude_desktop_config.json
• Linux：~/.config/Claude/claude_desktop_config.json

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

Cursor设置

创建或编辑 ~/.cursor/mcp.json 文件：

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

💻 使用示例

CLI使用方法

npx @sidemail/mcp

📚 详细文档

域名相关操作

• list-domains：列出所有发送域名
• create-domain：添加新的发送域名
• delete-domain：删除发送域名

Messenger相关操作

• list-messenger-drafts：列出Messenger草稿
• get-messenger-draft：按ID获取Messenger草稿
• create-messenger-draft：创建Messenger草稿
• update-messenger-draft：更新Messenger草稿
• delete-messenger-draft：删除Messenger草稿

联系人组相关操作

• list-groups：列出所有联系人组
• create-group：创建新的联系人组
• update-group：更新联系人组

联系人相关操作

• create-or-update-contact：创建或更新联系人
• query-contacts：使用过滤器查询联系人
• find-contact：按电子邮件查找联系人
• delete-contact：删除联系人

电子邮件相关操作

• send-email：发送事务性电子邮件（仅用于测试）
• query-emails：查询已发送的电子邮件