README
🚀 PestProCRM MCP 服务器
借助模型上下文协议(MCP),将 Claude 连接到你的 PestPro CRM 账户。通过自然对话,你可以管理客户、安排预约、发送短信、跟踪付款并生成报告。
🚀 快速开始
连接Claude.ai(推荐)
- 访问 claude.ai。
- 打开设置 → 集成(或点击 MCP 图标)。
- 点击添加自定义集成。
- 输入服务器 URL:
https://www.pestprocrm.com/api/mcp。 - 点击连接,你将被重定向到使用 PestProCRM 账户登录。
- 授权 Claude 访问你的数据。
- 开始聊天!
连接Claude桌面版
- 登录 PestProCRM,进入设置 → API 密钥。
- 点击生成新密钥并复制密钥(以
pp_live_开头)。 - 克隆此仓库并构建:
git clone https://github.com/yourusername/pestprocrm-mcp.git cd pestprocrm-mcp npm install && npm run build - 添加到你的 Claude 桌面版配置中:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - Windows:
%APPDATA%\Claude\claude_desktop_config.json
{ "mcpServers": { "pestpro": { "command": "node", "args": ["/absolute/path/to/pestprocrm-mcp/dist/index.js"], "env": { "PESTPRO_API_URL": "https://www.pestprocrm.com", "PESTPRO_API_KEY": "pp_live_your-key-here" } } } } - macOS:
- 重启 Claude 桌面版。
连接Claude代码版
在你的项目的 .mcp.json 中添加以下内容:
{
"mcpServers": {
"pestpro": {
"command": "node",
"args": ["/absolute/path/to/pestprocrm-mcp/dist/index.js"],
"env": {
"PESTPRO_API_URL": "https://www.pestprocrm.com",
"PESTPRO_API_KEY": "pp_live_your-key-here"
}
}
}
}
✨ 主要特性
可用工具
客户管理
| 工具 | 描述 |
|------|-------------|
| search_customers | 按姓名、地址、电话或电子邮件查找客户 |
| get_customer | 获取特定客户的完整详细信息 |
| create_customer | 添加具有联系信息、地址和服务详细信息的新客户 |
| update_customer | 更新客户信息(姓名、电话、地址、服务计划等) |
日程安排
| 工具 | 描述 |
|------|-------------|
| get_schedule | 查看特定日期范围内的预约 |
| book_appointment | 安排新的服务预约 |
| reschedule_appointment | 将预约移动到新的日期/时间 |
| cancel_appointment | 取消预约并说明原因 |
| log_drive_time | 记录工作之间的行驶时间 |
| complete_visit | 将服务访问标记为已完成并添加备注 |
短信消息
| 工具 | 描述 |
|------|-------------|
| send_sms | 向客户发送短信 |
| get_sms_history | 查看与客户的短信对话历史记录 |
支付管理
| 工具 | 描述 |
|------|-------------|
| create_payment_link | 生成 Stripe 支付链接并发送给客户 |
| get_payment_status | 检查客户的支付状态 |
| mark_payment_collected | 将现金、支票或外部支付记录为已收取 |
报告生成
| 工具 | 描述 |
|------|-------------|
| get_revenue_report | 获取特定日期范围内的收入摘要 |
| get_daily_summary | 获取特定日期的服务、收入和活动摘要 |
| get_customer_metrics | 获取客户数量、流失率和增长率等指标 |
只读资源
| 资源 | 描述 |
|----------|-------------|
| pestpro://customers | 浏览所有客户 |
| pestpro://schedule/today | 今日日程安排 |
| pestpro://schedule/week | 本周日程安排 |
| pestpro://payments/outstanding | 有未支付款项的客户 |
| pestpro://metrics | 业务指标仪表盘 |
💻 使用示例
基础用法
1. 查找客户并检查余额
"查找我的客户 John Smith 并告诉我他是否有未支付的款项"
Claude 将搜索你的客户,调出 John 的详细信息,并检查他的支付状态,所有操作都在一个回复中完成。
2. 安排预约
"为 Jane Doe 在下周二下午 2 点安排一次德国蟑螂处理服务"
Claude 将查找客户,检查你的可用时间,并安排预约。
3. 通过短信发送付款提醒
"哪些客户欠我钱?给逾期的客户发送友好的付款提醒,并附上他们的支付链接"
Claude 将检查未支付款项,生成支付链接,并向每个逾期客户发送短信。
4. 获取每日日程简报
"我明天的日程安排是怎样的?"
Claude 将显示当天的所有预约,包括客户姓名、服务类型、地址和任何空闲时间段。
5. 记录已完成的服务
"我刚刚完成了 Mary Johnson 家的服务。将其标记为已完成 — 一般害虫处理,室内和室外,无问题。她用现金支付了 75 美元"
Claude 将根据你的备注将访问标记为已完成,并记录现金支付。
6. 月度业务回顾
"给我上个月与前一个月相比的收入报告。我新增了多少客户?"
Claude 将提取收入数据和客户指标,为你提供业务摘要。
🔧 技术细节
安全机制
- OAuth(Claude.ai):使用行业标准的 OAuth 2.0 与 PKCE。无需管理 API 密钥,只需通过浏览器登录。
- API 密钥(桌面版/代码版):密钥存储在你的 Claude 配置中。绝不会与第三方共享。
- 所有 API 调用都经过身份验证,并且仅限于你的账户范围。
- 可以随时从设置 → API 密钥中撤销 API 密钥。
故障排除
| 问题 | 解决方案 |
|-------|----------|
| Claude 中未显示工具 | 确保服务器成功构建,并且配置中的路径正确。重启 Claude 桌面版。 |
| "身份验证失败" | 你的 API 密钥可能已过期。在设置 → API 密钥中生成新密钥。 |
| OAuth 登录失败 | 确保你在 pestprocrm.com 拥有有效的 PestProCRM 账户。 |
| "连接被拒绝" | 验证 PESTPRO_API_URL 是否正确。对于本地开发,请确保你的应用正在运行。 |
📚 详细文档
相关链接
- PestPro CRM:https://www.pestprocrm.com
- 文档:https://www.pestprocrm.com/docs
- MCP 文档:https://www.pestprocrm.com/docs/mcp
- MCP 协议:https://modelcontextprotocol.io
📄 许可证
本项目采用 MIT 许可证。
微信扫一扫