Mailmodo MCP Server

mailmodo-mcp

これは、Claude Desktop やその他のMCP対応クライアントとMailmodoを連携するための、Message Control Protocol（MCP）サーバーを実装したTypeScriptプロジェクトです。

前提条件

• Node.js（v20以上を推奨）
• npm（Node.jsに付属）

インストール

Smithery経由でインストール

Smithery経由で、Claude Desktop向けMailmodo連携サーバーを自動的にインストールするには、次の手順を実行します。

npx -y @smithery/cli install @mailmodo/mailmodo-mcp --client claude

手動インストール

1. リポジトリをクローンします。

git clone https://github.com/mailmodo/mailmodo-mcp.git
cd mailmodo-mcp

2. 依存関係をインストールします。

npm install

プロジェクトのビルド

TypeScriptコードをJavaScriptにコンパイルするには、次のコマンドを実行します。

npm run build

コンパイルされたJavaScriptファイルを含むdistディレクトリが作成されます。

プロジェクトの実行

ビルド後、次のコマンドを使用してプロジェクトを実行できます。

node dist/index.js

または、npmスクリプトを使用します。

npm start

Claude Desktopの設定

コードからローカル実行

このプロジェクトをClaude Desktopで設定するには、次の設定をClaude Desktopの設定に追加します。

{
  "mcpServers": {
    "mailmodo": {
      "command": "node",
      "args": [
        "/path/to/your/mailmodo-mcp/dist/index.js"
      ]
    }
  }
}

Dockerイメージから実行

{
  "mcpServers": {
    "mailmodo": {
      "command": "docker",
      "args": [
        "run",
        "--platform", 
        "linux/amd64",
        "-i",
        "--rm",
        "-e",
        "MAILMODO_API_KEY",
        "avneesh001/mailmodo-mcp"
      ],
      "env": {
        "MAILMODO_API_KEY": "<GET MAILMODO KEY from https://manage.mailmodo.com/app/settings/apikey and insert here>"
      }
    }
  }
}

npxから実行

{
  "mcpServers": {
    "mailmodo": {
      "command": "npx",
      "args": [
        "-y",
        "@mailmodo/mcp"
      ],
      "env": {
        "MAILMODO_API_KEY": "<GET MAILMODO KEY from https://manage.mailmodo.com/app/settings/apikey and insert here>"
      }
    }
  }
}

リモートサーバー経由で接続

{
  "mcpServers": {
    "mailmodo": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://mcp.app.mailmodo.com/mcp",
        "--header",
        "mmApiKey:${MAILMODO_API_KEY}"
      ],
      "env": {
        "MAILMODO_API_KEY": "<GET MAILMODO KEY from https://manage.mailmodo.com/app/settings/apikey and insert here>"
      }
    }
  }
}

args配列内のファイルパスを、ローカルのプロジェクトディレクトリに合わせて変更してください。

開発

自動再コンパイルを有効にして開発モードでプロジェクトを実行するには、次の手順に従います。

1. 開発用依存関係としてts-nodeとnodemonをインストールします。

npm install --save-dev ts-node nodemon

2. package.jsonに開発用スクリプトを追加します。

{
  "scripts": {
    "dev": "nodemon src/index.ts",
    "build": "tsc",
    "start": "node dist/index.js"
  }
}

3. 開発サーバーを実行します。

npm run dev

プロジェクト構成

mailmodo-mcp/
├── src/             # TypeScript source files
├── dist/            # Compiled JavaScript files
├── package.json     # Project dependencies and scripts
└── tsconfig.json    # TypeScript configuration

ツールとリソース

Mailmodo MCP サーバーは、Mailmodoの機能を操作するための複数のツールとリソースを提供します。以下にすべての項目を示します。

リソース

1. Mailmodoテンプレート（mailmodo://templates）

   • 利用可能なすべてのメールテンプレートの一覧をJSON形式で返します
   • MIMEタイプ：application/json

2. Mailmodoキャンペーン（mailmodo://campaigns）

   • すべてのキャンペーンの一覧をJSON形式で返します
   • MIMEタイプ：application/json

3. Mailmodo連絡先リスト（mailmodo://contact-lists）

   • すべての連絡先リストをJSON形式で返します
   • MIMEタイプ：application/json

ツール

1. ユーザー詳細

   • 名前：userDetails
   • 説明：連絡先のすべての詳細を取得します
   • パラメーター：
     • email（string）：連絡先のメールアドレス

2. キャンペーンレポートツール

   • 名前：MailmodoCampainReportTool
   • 説明：開封数、クリック数、送信数を含むキャンペーンレポートを取得します
   • パラメーター：
     • campaignId（UUID）：キャンペーンの ID
     • fromDate（YYYY-MM-DD）：レポートの開始日
     • toDate（YYYY-MM-DD）：レポートの終了日

3. 現在の日時

   • 名前：currentDateTime
   • 説明：現在の日時を取得します
   • パラメーター：なし

4. イベント送信

   • 名前：sendEvent
   • 説明：メールアドレスとイベントプロパティを指定してカスタムイベントを送信します
   • パラメーター：
     • email（string）：連絡先のメールアドレス
     • event_name（string）：イベント名
     • ts（number、任意）：タイムスタンプ
     • event_properties（object、任意）：追加のイベントプロパティ

5. 連絡先リストの管理

   • 連絡先をリストに追加

     • 名前：addContactToList
     • 説明：単一の連絡先をリストに追加します
     • パラメーター：
       • email（string）：連絡先のメールアドレス
       • listName（string）：リスト名
       • data（object、任意）：連絡先のプロパティ
       • 連絡先メタデータ用の各種任意フィールド

   • 連絡先を一括追加

     • 名前：addBulkContactToList
     • 説明：複数の連絡先を1回の操作でリストに追加します
     • パラメーター：
       • listName（string）：リスト名
       • values（array）：連絡先オブジェクトの配列

   • 連絡先をリストから削除

     • 名前：removeContactFromList
     • 説明：連絡先を特定のリストから削除します
     • パラメーター：
       • email（string）：連絡先のメールアドレス
       • listName（string）：リスト名

6. 連絡先ステータスの管理

   • 連絡先の配信登録を解除

     • 名前：unsubscribeContact
     • 説明：連絡先の配信登録を解除するか、配信対象から除外します
     • パラメーター：
       • email（string）：連絡先のメールアドレス

   • 連絡先の配信登録を再開

     • 名前：resubscribeContact
     • 説明：以前に配信登録を解除した連絡先の配信登録を再開します
     • パラメーター：
       • email（string）：連絡先のメールアドレス

   • 連絡先をアーカイブ

     • 名前：archiveContact
     • 説明：連絡先を完全にアーカイブします
     • パラメーター：
       • email（string）：連絡先のメールアドレス

7. キャンペーンの管理

   • メールキャンペーンを送信

     • 名前：sendEmailToCampaign
     • 説明：パーソナライズされたメールキャンペーンを開始します
     • パラメーター：
       • campaignId（string）：キャンペーン ID
       • email（string）：受信者のメールアドレス
       • カスタマイズ用の各種任意パラメーター

   • キャンペーンを一斉配信

     • 名前：broadcastCampaignToList
     • 説明：連絡先リスト全体を対象にキャンペーンを開始します
     • パラメーター：
       • campaignId（string）：キャンペーン ID
       • listId（string）：対象リストの ID
       • キャンペーンのカスタマイズ用の任意パラメーター

ライセンス

MIT ライセンス