使用说明
Pipedrive MCP服务器
Claude最完整、最强大的Pipedrive MCP实现
生产准备就绪 模型上下文协议 为Claude提供全面访问Pipedrive CRM API的服务器。该服务器通过自然语言对话实现了销售工作流程、交易管理、联系人组织和活动跟踪的无缝自动化。
由以下人员建造和维护 努比亚 -自动化和与商业人工智能(MCP、Holded、PipeDrive等)的集成。你想为你的公司做这样的事情吗?写信给我们 新闻.es.
特征
- 29个类别的300多种工具 -全面覆盖整个Pipedrive REST API(v1+v2)
- 高级速率限制 -每秒10个请求,突发容量高达100个请求
- 多级缓存 -5-15分钟TTL用于频繁访问的数据
- 重试逻辑 -失败请求的指数回退(429500502503504)
- 全面的错误处理 -带有可操作建议的详细错误消息
- 完全支持TypeScript -贯穿始终的类型安全模式和接口
- Zod验证 -对所有输入进行运行时验证,并显示有用的错误消息
- MCP资源 -对管道、自定义字段和用户信息的只读访问
- MCP提示 -5个常见操作的指导工作流程
- 性能指标 -内置请求持续时间和成功率跟踪功能
- 只读模式 -阻止所有写入操作的可选安全模式
- 工具集筛选 -根据需要启用/禁用特定工具类别
工具类别
29个类别的307个工具-全面覆盖Pipedrive REST API(v1+v2):
| 类别 | 工具 | 描述 |
|---|---|---|
| 交易 | 43 | 完整生命周期:CRUD、阶段、参与者、产品、文件、合并、转换、分期付款(v2) |
| 领域 | 30 | 自定义字段发现+交易/人员/组织/产品/项目字段的CRUD,以及潜在客户和注释字段 |
| 人员 | 23 | 具有自定义字段、活动、交易、文件和关注者的联系人管理 |
| 组织 | 21 | 公司管理与人员、交易和活动的关系 |
| 项目 | 16 | 项目、董事会、阶段、小组、任务和计划管理 |
| 管道 | 15 | 管道管理、阶段、转换和移动统计 |
| 潜在客户 | 15 | 潜在客户CRUD、标签、来源、搜索和潜在客户↔交易转换 |
| 角色 | 14 | 角色、分配、设置和管道可见性 |
| 产品 | 13 | 产品目录、交易/个人附件、文件和关注者 |
| 用户 | 12 | 用户、权限、关注者和角色分配 |
| 备注 | 9 | 交易、个人和组织的注释和评论 |
| 活动 | 9 | 任务、通话和会议安排,包括截止日期和完成情况 |
| 系统 | 9 | 运行状况、指标、货币、用户设置、最近事件和缓存 |
| 团队 | 8 | 团队管理和成员 |
| 文件 | 7 | 文件上传、下载、管理和远程文件链接 |
| 过滤器 | 7 | 过滤CRUD和辅助元数据 |
| 搜索 | 6 | 通用搜索和特定实体搜索 |
| 邮箱 | 6 | 邮件线程和消息 |
| 阶段 | 5 | 管道级CRUD(v2) |
| 任务 | 5 | 项目任务管理 |
| 目标 | 5 | 目标CRUD和结果 |
| 通讯记录 | 5 | 通话日志CRUD和音频附件 |
| 活动类型 | 5 | 活动类型管理 |
| 组织关系 | 5 | 组织间关系 |
| 频道 | 4 | 消息渠道集成 |
| 网络钩子 | 3 | Webhook CRUD |
| 权限集 | 3 | 权限集检查和分配 |
| 项目模板 | 2 | 项目模板发现 |
| 会议 | 2 | 视频通话提供商链接 |
安装
全球安装
npm install -g @nubiia/mcp-pipedrive
使用npx(无需安装)
npx -y @nubiia/mcp-pipedrive
配置
先决条件
- 从获取您的Pipedrive API令牌 设置>API
- 已安装Claude Desktop
Claude桌面设置
macOS
编辑 ~/Library/Application Support/Claude/claude_desktop_config.json:
{
"mcpServers": {
"pipedrive": {
"command": "npx",
"args": ["-y", "@nubiia/mcp-pipedrive"],
"env": {
"PIPEDRIVE_API_TOKEN": "your_api_token_here"
}
}
}
}
视窗
编辑 %APPDATA%\Claude\claude_desktop_config.json:
{
"mcpServers": {
"pipedrive": {
"command": "npx",
"args": ["-y", "@nubiia/mcp-pipedrive"],
"env": {
"PIPEDRIVE_API_TOKEN": "your_api_token_here"
}
}
}
}
环境变量
| 变量 | 必填 | 默认 | 描述 |
|---|---|---|---|
PIPEDRIVE_API_TOKEN |
是 | - | 您的Pipedrive API令牌 |
PIPEDRIVE_READ_ONLY |
没有 | false |
启用只读模式(阻止所有写入操作) |
PIPEDRIVE_TOOLSETS |
没有 | deals,persons,organizations,activities |
以逗号分隔的已启用工具类别列表 |
LOG_LEVEL |
没有 | info |
日志记录级别(debug, info, warn, error) |
高级配置示例
只读模式
非常适合探索性使用或当您想防止意外修改时:
{
"mcpServers": {
"pipedrive": {
"command": "npx",
"args": ["-y", "@nubiia/mcp-pipedrive"],
"env": {
"PIPEDRIVE_API_TOKEN": "your_token",
"PIPEDRIVE_READ_ONLY": "true"
}
}
}
}
筛选工具集
仅启用特定的工具类别:
{
"mcpServers": {
"pipedrive": {
"command": "npx",
"args": ["-y", "@nubiia/mcp-pipedrive"],
"env": {
"PIPEDRIVE_API_TOKEN": "your_token",
"PIPEDRIVE_TOOLSETS": "deals,persons,search"
}
}
}
}
调试日志
启用详细日志记录以进行故障排除:
{
"mcpServers": {
"pipedrive": {
"command": "npx",
"args": ["-y", "@nubiia/mcp-pipedrive"],
"env": {
"PIPEDRIVE_API_TOKEN": "your_token",
"LOG_LEVEL": "debug"
}
}
}
}
使用示例
示例1:与联系人创建交易
Claude, create a new deal for "Enterprise Software License" worth $50,000.
The contact is John Smith (john@acme.com). Set the expected close date
to the end of next month and add a follow-up call for tomorrow.
克劳德将:
- 搜索或创建“John Smith”这个人
- 创建与此人关联的交易
- 安排明天的通话活动
- 提供带有ID和后续步骤的摘要
示例2:搜索联系人
Find all contacts at Acme Corporation and show me their recent deals.
克劳德将:
- 搜索“Acme Corporation”的组织
- 获取与该组织相关的所有人员
- 检索每个人的交易
- 展示有组织的结果和总计
示例3:管理活动
Show me all overdue activities for my open deals and reschedule them
to next week.
克劳德将:
- 列出所有活动
done=false以及逾期 - 筛选与未结交易相关的活动
- 用下周的新日期更新每个活动
- 提供重新安排的项目摘要
示例4:使用自定义字段
Before creating this deal, show me what custom fields are available
for deals and explain what each one means.
克劳德将:
- 访问
pipedrive://custom-fields资源 - 提取特定交易的自定义字段
- 显示字段名称、类型和选项
- 解释如何在交易创建中使用它们
示例5:管道管理
Generate a pipeline report showing deal counts and total values for
each stage in my sales pipeline.
克劳德将:
- 使用
pipedrive://pipelines资源 - 获取按阶段分组的交易摘要
- 计算总数和百分比
- 格式为可读报告
示例6:每周审查工作流程
Run the weekly pipeline review prompt.
克劳德将:
- 执行
weekly-pipeline-review提示 - 按阶段收集所有未结交易
- 计算指标(赢/输、接近尾声、过期交易)
- 生成可操作的建议
自定义字段
在创建或更新交易、人员、组织、产品或潜在客户时,按显示名称传递自定义字段值:
{
"title": "ACME Enterprise Deal",
"value": 50000,
"currency": "USD",
"custom_fields": {
"Industria": "Tech",
"Budget": 50000
}
}
MCP服务器会自动将名称解析为Pipedrive哈希键。看 docs/CUSTOM_FIELDS.md 完整的指南。
阶段和线索标签管理
直接从LLM管理管道阶段和领导标签:
{ "name": "Qualified", "pipeline_id": 1, "deal_probability": 75 }
通过异步方式将合格的潜在客户转化为交易(或将交易回滚为潜在客户)
*_convert_to_* / *_convert_status 工具对。
交易分期付款
管理交易的定期固定付款(API v2-传统的现代替代品 订阅功能):
{ "id": 123, "description": "Deposit", "amount": 500, "billing_date": "2026-01-15" }
工具: deals_list_installments, deals_add_installment, deals_update_installment,
deals_delete_installment.
全现场覆盖
现场工具现在涵盖了每个实体:交易、人员、组织、产品、, 领导 和
笔记 现场列表(fields_list_lead_fields, fields_list_note_fields --只读),
加满 项目字段 通过API v2的CRUD(fields_list_project_fields,
fields_create_project_field, fields_update_project_field, fields_delete_project_field).
建筑
核心组件
- Pipedrive客户端 -具有速率限制、缓存和重试逻辑的HTTP客户端
- 速率限制器 -基于瓶颈的限制器(10个要求/秒,爆裂能力)
- 缓存层 -基于TTL的缓存,带有LRU驱逐功能(最多500个项目)
- 重试处理程序 -瞬态故障的指数回退
- 指标收集器 -请求跟踪和性能监控
- 错误处理程序 -带上下文的标准化错误格式
刀具结构
每个工具都遵循一致的模式:
- Zod模式 -存在描述性错误的输入验证
- 描述 -LLM的详细使用说明
- 处理器 -调用PipedriveClient的异步函数
资源
三种MCP资源提供只读参考数据:
pipedrive://pipelines-所有有阶段和交易数量的管道pipedrive://custom-fields-所有实体的自定义字段定义pipedrive://current-user-经过身份验证的用户信息和权限
提示
常见操作的五个指导工作流程:
create-deal-workflow-与个人和活动一起完成交易创建sales-qualification-BANT资格检查表follow-up-sequence-多日活动序列weekly-pipeline-review-管道健康报告lost-deal-analysis-损失交易模式分析
演出
速率限制
- 默认:10个请求/秒(请求之间间隔100毫秒)
- 爆发:每分钟补充100个代币
- 自动重试:429个错误在5秒后自动重试
缓存策略
| 数据类型 | TTL | 原因 |
|---|---|---|
| 管道 | 10分钟 | 管道结构很少变化 |
| 自定义字段 | 15分钟 | 字段定义相对静态 |
| 用户信息 | 1分钟 | 会话期间用户数据可能会更改 |
| 列表请求 | 5分钟 | 分页结果的默认值 |
指标
服务器跟踪:
- 总请求数和成功率
- 平均响应时间
- 按类型分类的错误率
- 缓存命中率
- 速率限制事件
通过以下方式访问指标 system/metrics 工具。
API 参考
此MCP服务器实现Pipedrive REST API v1。有关API的详细文档,请参阅:
高级用法
自定义字段发现
在创建或更新实体之前,请检查可用的自定义字段:
// Access via MCP resource
//custom-fields
// Or use field tools
pipedrive: fields / deal - fields;
fields / person - fields;
fields / org - fields;
fields / activity - fields;
错误处理
所有工具返回结构化错误,包括:
- 错误类型(验证、身份验证、速率限制等)
- 详细信息
- 建议采取的行动
- API原始错误(如适用)
工作流程自动化
将多个工具链接在一起,以实现复杂的工作流程:
-
潜在客户资格认证
- 搜索人员
- 了解他们的交易和活动
- 创建资格说明
- 更新交易阶段
-
交易管道移动
- 获取交易详情
- 检查自定义字段要求
- 更新自定义字段
- 进入下一阶段
- 创建下一个活动
-
报告
- 按阶段列出交易
- 获取交易摘要
- 计算指标
- 格式为markdown
故障排除
看 故障排除.md 常见问题和解决方案。
快速修复:
- 身份验证错误:在验证您的API令牌https://app.pipedrive.com/settings/api
- 速率限制:降低请求频率或启用缓存
- 验证错误:检查工具输入模式和必填字段
- 在Claude中看不到工具:更改配置后重新启动Claude Desktop
贡献
我们欢迎捐款!请看 贡献.md 作为指导方针。
开发设置
# Clone the repository
git clone https://github.com/nubiia-dev/mcp-pipedrive.git
cd mcp-pipedrive
# Install dependencies
npm install
# Build the project
npm run build
# Run tests
npm test
# Run with auto-reload during development
npm run dev
运行测试
# Run all tests
npm test
# Run with coverage
npm run test:coverage
# Run with UI
npm run test:ui
安全
请看 安全.md 了解我们的安全策略以及如何报告漏洞。
重要:永远不要将API令牌提交到版本控制。始终使用环境变量。
关于努比亚
此MCP服务器由以下人员构建和维护 努比亚.
努比亚 帮助企业 自动化流程并将其工具与人工智能集成:定制的MCP服务器,与CRMS和ERP(PipeDrive,Holded等)的集成,以及将您的业务数据与Claude等与会者连接的代理。这 @nubiia/mcp-pipedrive 这是我们所做的开源例子。
👉 您是否希望与人工智能集成或自动化以促进您的业务? 新闻.es · ✉️ hola@nubiia.es
许可证
此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。
学分
灵感来自 mcp保持 -Holded CRM的优秀MCP服务器实现。
支持
更新日志
看 更改日志.md 查看版本历史和发行说明。
路线图
- []Webhook支持实时更新
- []批量更新的批量操作
- []复杂查询的高级过滤
- []导出/导入功能
- []与其他CRM集成
- []GraphQL支持
作者
建造于 努比亚 — 新闻.es · hola@nubiia.es
维护者:塞缪尔·弗拉加-- GitHub
由 努比亚