すぐにMCPサーバー
Instantly API v2用の MCP サーバー。電子メール キャンペーンおよびリード管理機能へのアクセスを提供します。
Instantly APIについて
Instantly API v2 は、Instantly プラットフォームのさまざまなリソースと機能へのアクセスを提供する RESTful API です。これには以下が含まれます。
キャンペーン管理
リード管理
メールの取り扱いと検証
分析
アカウント管理
ブロックリスト管理
その他
この MCP サーバーは、これらのエンドポイントのサブセットを実装して、最もよく使用される機能に簡単にアクセスできるようにします。
Related MCP server: SendGrid MCP Server
APIリファレンス
完全な Instantly API v2 ドキュメントは、次の場所から入手できます。
すべての API リクエストのベース URL はhttps://api.instantly.ai/api/v2です。
ツール
この MCP サーバーは、Instantly API v2 エンドポイントにマップされる次のツールを実装します。
instantly_create_leadAPIエンドポイント:
POST /api/v2/leads新しいリードを作成する
入力:
email(文字列)first_name(オプションの文字列)last_name(オプションの文字列)company_name(オプションの文字列)campaign(オプションの文字列、UUID)list_id(オプションの文字列、UUID)personalization(オプションの文字列)website(オプションの文字列)phone(オプションの文字列)custom_variables(オプションのオブジェクト)
instantly_get_leadAPIエンドポイント:
GET /api/v2/leads/{id}IDでリードの詳細を取得する
入力:
id(文字列、UUID)返品: リード詳細
instantly_list_leadsAPIエンドポイント:
POST /api/v2/leads/listオプションのフィルターを使用してリードを一覧表示する
入力:
campaign(オプションの文字列、UUID)list_id(オプションの文字列、UUID)limit(オプションの数値)starting_after(オプションの文字列)
戻り値: リードの配列
instantly_update_leadAPIエンドポイント:
PATCH /api/v2/leads/{id}リード情報を更新する
入力:
id(文字列、UUID)first_name(オプションの文字列)last_name(オプションの文字列)company_name(オプションの文字列)personalization(オプションの文字列)website(オプションの文字列)phone(オプションの文字列)custom_variables(オプションのオブジェクト)
instantly_delete_leadAPIエンドポイント:
DELETE /api/v2/leads/{id}リードを削除する
入力:
id(文字列、UUID)
instantly_list_campaignsAPIエンドポイント:
GET /api/v2/campaignsページ区切りをサポートするリストキャンペーン
入力:
limit(オプションの数値、デフォルトは5、最大100)starting_after(オプションの文字列) - ページ区切りには、前のレスポンスのnext_starting_after値を使用します。status(オプションの数字) - キャンペーンをステータスでフィルタリングします(0:下書き、1:アクティブ、2:一時停止、3:完了、4:サブシーケンス実行中)
戻り値: ページ区切り情報を含むキャンペーンの配列
ページ番号:
最初のリクエスト:
starting_afterなしで呼び出す後続のページ: 前のレスポンスの
next_starting_after値を使用しますページがなくなると、レスポンスには
next_starting_after値は含まれません。
例: アクティブなキャンペーンのみを取得するには、
status: 1を使用します。
instantly_get_campaignAPIエンドポイント:
GET /api/v2/campaigns/{id}キャンペーンの詳細を取得する
入力:
id(文字列、UUID)返品:キャンペーンの詳細
instantly_get_warmup_analyticsAPIエンドポイント:
POST /api/v2/accounts/warmup-analytics指定したメールアカウントのウォームアップ分析を取得する
入力:
emails(文字列の配列)戻り値: メールウォームアップパフォーマンスのヘルススコアと指標
メールの配信性とアカウントの健全性を監視するのに役立ちます
instantly_test_account_vitalsAPIエンドポイント:
POST /api/v2/accounts/test/vitalsInstantly ワークスペースでメール アカウントの健全性と接続性をテストします
入力:
accounts(文字列の配列) - 複数のメールアドレスを一度にテストできます戻り値:
全体的なテストステータス
成功したアカウントと失敗したアカウントの概要
プロバイダーの詳細を含む各アカウントの詳細情報
失敗したアカウントのトラブルシューティングの推奨事項
メールアカウントの設定、認証、API アクセスに関する問題を特定するのに役立ちます
例:
{"accounts": ["user@example.com", "sales@company.com"]}
instantly_get_campaign_analytics
APIエンドポイント:
GET /api/v2/campaigns/analytics指定した期間のキャンペーンのパフォーマンス指標を取得する
入力:
id(オプションの文字列) - 特定のキャンペーンのキャンペーンIDstart_date(文字列) - 開始日(YYYY-MM-DD形式)end_date(文字列) - 終了日(YYYY-MM-DD形式)
返品: 開封率、返信率、リード数、商談データなどの包括的な指標
分析エンドポイント
Instantly API は、電子メール キャンペーンとアカウントのパフォーマンスを監視するための強力な分析エンドポイントを提供します。
ウォームアップ分析を取得する
APIエンドポイント:
POST /api/v2/accounts/warmup-analytics説明: 指定されたメールアカウントのウォームアップ分析データを取得します
必要なスコープ:
accounts:read、accounts:all、all:read、またはall:allリクエスト本文:
{ "emails": ["user@example.com"] }レスポンス: 送信メール、受信トレイの配置、スパムの配置、受信メールに関する日次データと集計データ、および各アカウントのヘルススコアを提供します。
テストアカウントの重要事項
APIエンドポイント:
POST /api/v2/accounts/test/vitals説明: メールアカウントの健全性と接続性をテストします
必要なスコープ:
accounts:read、accounts:all、all:read、またはall:allリクエスト本文:
{ "accounts": ["user@example.com"] }応答: アカウントのステータスと検出された問題に関する詳細情報を含む成功リストと失敗リストを返します。
キャンペーン分析を取得する
APIエンドポイント:
GET /api/v2/campaigns/analytics説明: 1つまたは複数のキャンペーンのパフォーマンス指標を取得します
クエリパラメータ:
id(オプション): 特定のキャンペーンのキャンペーンIDstart_date: 分析期間の開始日end_date: 分析期間の終了日
レスポンス: 以下を含む包括的なキャンペーン統計を返します:
総リード数
連絡したリード数
メールの開封数
返信数
バウンス数
登録解除数
完了数
送信メール数
新規リードへの連絡数
総機会
総機会価値
リクエスト パラメータと応答形式の詳細については、 Instantly Analytics API ドキュメントを参照してください。
追加のInstantly APIエンドポイント
Instantly API v2 には、この MCP サーバーに実装されていない他の多くのエンドポイントが含まれています。
キャンペーン管理:
キャンペーンの作成:
POST /api/v2/campaignsキャンペーンを有効化:
POST /api/v2/campaigns/{id}/activateキャンペーンを一時停止する:
POST /api/v2/campaigns/{id}/pauseキャンペーンを更新:
PATCH /api/v2/campaigns/{id}
メールアドレス:
メールへの返信:
POST /api/v2/emails/replyメールの一覧表示:
GET /api/v2/emailsメールを取得:
GET /api/v2/emails/{id}未読メールをカウントする:
GET /api/v2/emails/unread/count
アカウント管理:
これらのエンドポイントは、この MCP サーバーでツールとして利用できるようになりました。以下の「アカウント管理ツール」セクションを参照してください。
メール認証:
メールアドレスの確認:
POST /api/v2/email-verification
リードリスト:
リストを作成:
POST /api/v2/lead-listsリードリストの一覧:
GET /api/v2/lead-lists
利用可能なすべてのエンドポイントの完全なリファレンスについては、 Instantly API Explorer を参照してください。
設定
APIキー
Instantly アカウント設定から Instantly API キーを取得します。
Instantlyダッシュボードの統合に移動する
左側のサイドバーの「APIキー」セクションをクリックします
「APIキーを作成」ボタンをクリックします
APIキーの名前を入力してください
このキーにアクセスを許可するスコープを選択します
API キーを作成してコピーします (注: 一度だけ表示されます)
Claude Desktopでの使用
claude_desktop_config.jsonに以下を追加します。
ドッカー
NPX
建てる
Dockerビルド:
認証
Instantly API v2はベアラートークン認証を使用します。すべてのリクエストのAuthorizationヘッダーにAPIキーを含める必要があります。
環境変数を通じて API キーを提供すると、MCP サーバーはこれを自動的に処理します。
ライセンス
このMCPサーバーはMITライセンスに基づいてライセンスされています。つまり、MITライセンスの条件に従って、ソフトウェアを自由に使用、改変、配布することができます。詳細については、プロジェクトリポジトリのLICENSEファイルをご覧ください。
アカウント管理ツール
この MCP サーバーは、アカウント管理用に次のツールを実装します。
instantly_create_accountAPIエンドポイント:
POST /api/v2/accountsInstantlyで新しいメールアカウントを作成する
入力:
email(文字列): アカウントのメールアドレスfirst_name(文字列): アカウントに関連付けられた名last_name(文字列): アカウントに関連付けられた姓provider_code(数値): プロバイダーコード (1: カスタム IMAP/SMTP、2: Google、3: Microsoft、4: AWS)imap_username(文字列): IMAPユーザー名imap_password(文字列): IMAPパスワードimap_host(文字列): IMAP ホスト (例: imap.gmail.com)imap_port(数字): IMAP ポート (例: 993)smtp_username(文字列): SMTPユーザー名smtp_password(文字列): SMTPパスワードsmtp_host(文字列): SMTPホスト (例: smtp.gmail.com)smtp_port(数字): SMTPポート (例: 587)daily_limit(オプションの数値):1日のメール送信制限tracking_domain_nameドメイン名(オプション文字列)
instantly_list_accountsAPIエンドポイント:
GET /api/v2/accounts自動ページ区切りでメールアカウントを瞬時にリスト表示
入力:
limit(オプションの数値):ページごとに返されるアカウントの数(最大100、デフォルト10)starting_after(オプションの文字列): 前のページの最後の項目のID - ページ区切りに使用されますsearch(オプションの文字列): アカウントをフィルタリングするための検索語status(オプションの数字):ステータスフィルター(1:アクティブ、2:一時停止、-1:接続エラー、-2:ソフトバウンスエラー、-3:送信エラー)provider_code(オプションの数字):プロバイダーコードフィルター(1:カスタムIMAP/SMTP、2:Google、3:Microsoft、4:AWS)fetch_all(オプションのブール値):すべてのページを自動的に取得し、包括的な概要を提供するかどうか。すべてのアカウントに関する情報を取得するには、これを使用します。
ページ番号:
デフォルトの動作: 次のページへのリンクを含む 1 ページの結果を返します
fetch_all=trueの場合: すべてのページを自動的に取得し、次の内容を含むすべてのアカウントの包括的な概要を返します。合計アカウント数
プロバイダー別のアカウント分布
ステータス別のアカウント分布
参考アカウントのサンプル
instantly_get_accountAPIエンドポイント:
GET /api/v2/accounts/{email}特定のメールアカウントの詳細をすぐに取得する
入力:
email(文字列): 取得するアカウントのメールアドレス
instantly_update_accountAPIエンドポイント:
PATCH /api/v2/accounts/{email}既存のメールアカウントをInstantlyで更新する
入力:
email(文字列): 更新するアカウントのメールアドレスfirst_name(オプションの文字列): アカウントに関連付けられた名last_name(オプションの文字列): アカウントに関連付けられた姓daily_limit(オプションの数値):1日のメール送信制限tracking_domain_nameドメイン名(オプション文字列)skip_cname_check(オプションのブール値): トラッキングドメインのCNAMEチェックをスキップするかどうかremove_tracking_domain(オプションのブール値): アカウントからトラッキングドメインを削除するかどうか
instantly_delete_accountAPIエンドポイント:
DELETE /api/v2/accounts/{email}Instantlyからメールアカウントを削除する
入力:
email(文字列): 削除するアカウントのメールアドレス
instantly_pause_accountAPIエンドポイント:
POST /api/v2/accounts/{email}/pauseInstantlyでメールアカウントを一時停止する
入力:
email(文字列): 一時停止するアカウントのメールアドレス
instantly_resume_accountAPIエンドポイント:
POST /api/v2/accounts/{email}/resume一時停止したメールアカウントをInstantlyで再開する
入力:
email(文字列): 再開するアカウントのメールアドレス
ツールのテスト状況
このMCPサーバーに実装されているすべてのツールは、Instantly API v2で正常に動作することを確認するために徹底的にテストされています。テスト状況の概要は以下の通りです。
# | ツール名 | 状態 | 注記 |
1 |
| ✅ 検証済み | ページ区切りのサポートによりキャンペーンを正常にリスト化しました |
2 |
| ❌ 動作しません | リードをリストしようとすると、永続的な API エラー「無効なメールアドレス」が表示されます |
3 |
| ✅ 検証済み | IDまたはメールアドレスでリード情報を削除しました |
4 |
| ✅ 検証済み | 適切なデータで新しいリードを創出 |
5 |
| ✅ 検証済み | IDでリードの詳細を正常に取得しました |
6 |
| ✅ 検証済み | 既存のリード情報を正常に更新しました |
7 |
| ✅ 検証済み | 統計情報を含むすべてのメールアカウントを正常にリストします |
8 |
| ✅ 検証済み | 詳細なアカウント情報を正常に取得しました |
9 |
| ✅ 検証済み | アカウントの健全性情報を正常に取得しました |
10 |
| ✅ 検証済み | アカウントのウォームアップデータを正常に取得しました |
テストプロセスと結果の詳細については、リポジトリのTesting.md を参照してください。
既知の問題
現時点では、
instantly_list_leadsツールは、特定のメールフィルターを指定せずにリードリストを作成しようとすると、「無効なメールアドレス」というAPIエラーを返します。この問題を解決するために、以下の方法を含む複数の方法を試しました。メール検索に
contacts配列パラメータを使用する空のリクエストボディによる自動再試行の実装
さまざまなパラメータのフォーマット方法 今後のリリースでもこの問題の解決に取り組んでいきます。
開発のためのセットアップ
このプロジェクトに貢献したり、開発のためにローカルで実行したりしたい場合は、次の手順に従ってください。
リポジトリをクローンします。
git clone https://github.com/bcharleson/Instantly-MCP.git cd Instantly-MCP依存関係をインストールします:
npm installInstantly API キーを使用してルート ディレクトリに
.envファイルを作成します。INSTANTLY_API_KEY=your_api_key_here⚠️重要:
.envファイルや API キーをバージョン管理にコミットしないでください。.env ファイルは.gitignore.env含まれています。プロジェクトをビルドします。
npm run buildサーバーを実行します。
node dist/index.js
貢献
貢献大歓迎!貢献したい場合は:
リポジトリをフォークする
機能ブランチを作成する (
git checkout -b feature/amazing-feature)変更を加える
変更をコミットします (
git commit -m 'Add some amazing feature')ブランチにプッシュする (
git push origin feature/amazing-feature)プルリクエストを開く
プルリクエストを送信する前に、次の点を確認してください。
コードはプロジェクトのコーディングスタイルに従っている
新しい機能のテストを追加しました
すべてのテストに合格
必要に応じてドキュメントを更新しました