Sidemail

Sidemail Model Context Protocol (MCP) 服务

Sidemail MCP 服务为 Sidemail.io 提供 Model Context Protocol (MCP) 集成，支持通过 VS Code 中的 MCP Agent 模式及其他 MCP 客户端，以编程方式访问 Sidemail 的事务性邮件、联系人、域名和 Messenger 功能。

功能

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

前提条件

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

Microsoft VS Code 设置（辅助安装）

1. 打开命令面板（Ctrl/Cmd + Shift + P）。
2. 输入 “MCP: Add Server…” 并选择该项。
3. 选择 "NPM Package"。
4. 输入 @sidemail/mcp 并确认。
5. 确认安装。
6. 输入 Sidemail API key 并确认。

Microsoft VS Code 设置（手动安装）

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

1. 打开命令面板（Ctrl/Cmd + Shift + P）。
2. 输入 “MCP: Open User Configuration” 并选择该项。
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

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：查询已发送的邮件