本指南为您提供 Instantly-MCP 项目的安装、开发设置及贡献相关的详细说明,助您快速上手该项目。
按照以下步骤完成项目的安装与运行:
git clone https://github.com/bcharleson/Instantly-MCP.git
cd Instantly-MCP
npm install
.env 文件,在根目录下添加您的 Instantly API 密钥:INSTANTLY_API_KEY=your_api_key_here
⚠️ 重要提示
请勿将
.env文件或 API 密钥提交到版本控制系统。.gitignore已包含.env文件以防止意外提交。
npm run build
node dist/index.js
若您想为该项目做出贡献或在本地进行开发,可按以下步骤操作:
git clone https://github.com/bcharleson/Instantly-MCP.git
cd Instantly-MCP
npm install
.env 文件,在根目录下添加您的 Instantly API 密钥:INSTANTLY_API_KEY=your_api_key_here
⚠️ 重要提示
请勿将
.env文件或 API 密钥提交到版本控制系统。.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)在提交 Pull Request 前,请确认以下事项:
此 MCP 服务器实现的所有工具都已确认能与 Instantly API v2 正常配合使用。以下表格总结了各工具的测试情况:
| # | 工具名 | 状态 | 备注 |
|---|---|---|---|
| 1 | instantly_list_campaigns |
✅ 已认证 | 成功显示活动列表,并支持分页功能 |
| 2 | instantly_list_leads |
❌ 未正常工作 | 获取潜在客户列表时出现「无效电子邮件地址」API 错误 |
| 3 | instantly_delete_lead |
✅ 已认证 | 可通过 ID 或电子邮件地址成功删除潜在客户 |
| 4 | instantly_create_lead |
✅ 已认证 | 可创建新的潜在客户,并能使用正确的数据正常工作 |
| 5 | instantly_get_lead |
✅ 已认证 | 可通过 ID 成功获取潜在客户的详细信息 |
| 6 | instantly_update_lead |
✅ 已认证 | 可更新现有潜在客户的信息 |
| 7 | instantly_list_accounts |
✅ 已认证 | 成功列出所有电子邮件账户,并显示统计信息 |
| 8 | instantly_get_account |
✅ 已认证 | 成功获取详细的账户信息 |
| 9 | instantly_test_account_vitals |
✅ 已认证 | 成功获取账户的健康状态 |