Instantly MCP 服务器

为 Instantly API v2 提供的 MCP 服务器，提供电子邮件营销活动和潜在客户管理功能的访问。

关于 Instantly API

Instantly API v2 是一个 RESTful API，它提供了对 Instantly 平台的各种资源和功能的访问，包括：

• 营销活动管理
• 潜在客户管理
• 电子邮件处理和验证
• 分析
• 帐户管理
• 黑名单管理
• 等等

此 MCP 服务器实现了这些端点的一个子集，以便轻松访问最常用的功能。

API 参考

完整的 Instantly API v2 文档可在以下位置获取：

• API 探索器
• API 架构
• 分析端点

所有 API 请求的基本 URL 是：https://api.instantly.ai/api/v2

工具

此 MCP 服务器实现了映射到 Instantly API v2 端点的以下工具：

1. instantly_create_lead

   • API Endpoint: POST /api/v2/leads
   • Create a new lead
   • Inputs:
     • email (string)
     • first_name (optional string)
     • last_name (optional string)
     • company_name (optional string)
     • campaign (optional string, uuid)
     • list_id (optional string, uuid)
     • personalization (optional string)
     • website (optional string)
     • phone (optional string)
     • custom_variables (optional object)

2. instantly_get_lead

   • API Endpoint: GET /api/v2/leads/{id}
   • Get details of a lead by ID
   • Input: id (string, uuid)
   • Returns: lead details

3. instantly_list_leads

   • API Endpoint: POST /api/v2/leads/list
   • List leads with optional filters
   • Inputs:
     • campaign (optional string, uuid)
     • list_id (optional string, uuid)
     • limit (optional number)
     • starting_after (optional string)
   • Returns: array of leads

4. instantly_update_lead

   • API Endpoint: PATCH /api/v2/leads/{id}
   • Update a lead's information
   • Inputs:
     • id (string, uuid)
     • first_name (optional string)
     • last_name (optional string)
     • company_name (optional string)
     • personalization (optional string)
     • website (optional string)
     • phone (optional string)
     • custom_variables (optional object)

5. instantly_delete_lead

   • API Endpoint: DELETE /api/v2/leads/{id}
   • Delete a lead
   • Input: id (string, uuid)

6. instantly_list_campaigns

   • API Endpoint: GET /api/v2/campaigns
   • List campaigns with pagination support
   • Inputs:
     • limit (optional number, default 5, max 100)
     • starting_after (optional string) - For pagination, use the next_starting_after value from the previous response
     • status (optional number) - Filter campaigns by status (0: Draft, 1: Active, 2: Paused, 3: Completed, 4: Running Subsequences)
   • Returns: array of campaigns with pagination information
   • Pagination:
     • First request: Call without starting_after
     • Subsequent pages: Use the next_starting_after value from the previous response
     • When there are no more pages, the response will not contain a next_starting_after value
   • Example: To get only active campaigns, use status: 1

7. instantly_get_campaign

   • API Endpoint: GET /api/v2/campaigns/{id}
   • Get details of a campaign
   • Input: id (string, uuid)
   • Returns: campaign details

8. instantly_get_warmup_analytics

   • API Endpoint: POST /api/v2/accounts/warmup-analytics
   • Get warmup analytics for specified email accounts
   • Input: emails (array of strings)
   • Returns: Health scores and metrics for email warmup performance
   • Useful for monitoring email deliverability and account health

9. instantly_test_account_vitals

   • API Endpoint: POST /api/v2/accounts/test/vitals
   • Test the health and connectivity of email accounts in your Instantly workspace
   • Input: accounts (array of strings) - Can test multiple email addresses at once
   • Returns:
     • Overall test status
     • Summary of successful and failed accounts
     • Detailed information for each account including provider details
     • Troubleshooting recommendations for failed accounts
   • Helps identify issues with email account configuration, authentication, and API access
   • Example: {"accounts": ["user@example.com", "sales@company.com"]}

10. instantly_get_campaign_analytics

    • API Endpoint: GET /api/v2/campaigns/analytics
    • Get performance metrics for campaigns over a specified time period
    • Inputs:
      • id (optional string) - Campaign ID for a specific campaign
      • start_date (string) - Start date in YYYY-MM-DD format
      • end_date (string) - End date in YYYY-MM-DD format
    • Returns: Comprehensive metrics including open rates, reply rates, lead counts and opportunity data

分析端点

Instantly API 提供了强大的分析端点，用于监控您的电子邮件活动和账户的性能：

1. 获取预热分析

   • API 端点: POST /api/v2/accounts/warmup-analytics
   • 描述: 为指定的电子邮件账户检索预热分析数据
   • 所需权限范围: accounts:read, accounts:all, all:read 或 all:all
   • 请求体:

     {
       "emails": ["user@example.com"]
     }
     

   • 响应: 提供关于已发送邮件、收件箱投放、垃圾邮件投放和接收邮件的日度和汇总数据，以及每个账户的健康评分

2. 测试账户重要指标

   • API 端点: POST /api/v2/accounts/test/vitals
   • 描述: 测试电子邮件账户的健康状况和连接性
   • 所需权限范围: accounts:read, accounts:all, all:read 或 all:all
   • 请求体:

     {
       "accounts": ["user@example.com"]
     }
     

   • 响应: 返回成功和失败列表，包含有关账户状态和检测到的问题的详细信息

3. 获取活动分析

   • API 端点: GET /api/v2/campaigns/analytics
   • 描述: 检索一个或多个活动的性能指标
   • 查询参数:
     • id (可选): 特定活动的 ID
     • start_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/campai…