项目简介

本项目是 Model Context Protocol (MCP) 服务器的 Ploomes CRM 集成实现。它允许 AI 助手（如 Claude）通过标准化的 MCP 协议与 Ploomes CRM 系统进行交互，从而扩展 AI 助手在客户关系管理方面的能力。

主要功能点

客户管理：支持列出、查询、创建和更新 Ploomes CRM 中的客户信息。
交易管理：支持列出、查询、创建和更新 Ploomes CRM 中的交易（销售机会）信息。
联系人管理：支持列出和查询 Ploomes CRM 中客户的联系人信息。
活动管理：支持列出和创建 Ploomes CRM 中的活动（例如：会议、电话）信息。
数据访问：通过工具化的方式提供对 Ploomes CRM 数据的访问，方便 AI 助手获取上下文信息。
速率限制：内置速率限制机制，防止API调用过载。

安装步骤

准备工作：确保已安装 Node.js 和 npm。

克隆仓库：在本地克隆 'mcp-servers' 仓库：

git clone https://github.com/integrabotia/mcp-servers

进入目录：导航到 'src/ploomes-crm' 目录：

cd mcp-servers/src/ploomes-crm

安装依赖：安装项目依赖：
```
npm install
```

服务器配置

MCP 客户端需要以下配置信息来连接 Ploomes CRM MCP 服务器。请将以下 JSON 配置添加到您的 MCP 客户端配置中。

{
  "serverName": "ploomes-crm",
  "command": "node",
  "args": ["index.js", "--api-key=<YOUR_PLOOMES_API_KEY>"],
  "api_key_comment": "请将 <YOUR_PLOOMES_API_KEY> 替换为您的 Ploomes CRM API 密钥，或者设置为 PLOOMES_API_KEY 环境变量。",
  "transport": "stdio"
}

配置参数说明：

'serverName': 服务器名称，设置为 'ploomes-crm'。
'command': 启动服务器的命令，这里使用 'node'。
'args': 启动命令的参数，'index.js' 是入口文件，'--api-key=<YOUR_PLOOMES_API_KEY>' 用于传递 Ploomes CRM API 密钥。
- 重要：请务必将 '<YOUR_PLOOMES_API_KEY>' 替换为您在 Ploomes CRM 中获得的 API 密钥。也可以选择将 API 密钥设置为名为 'PLOOMES_API_KEY' 的环境变量，这样可以省略 '--api-key' 参数。
'transport': MCP 服务器使用的传输协议，这里使用 'stdio' (标准输入输出)。

基本使用方法

配置 API 密钥：按照 "服务器配置" 中的说明，配置 Ploomes CRM API 密钥。
启动服务器：在 'src/ploomes-crm' 目录下，运行以下命令启动服务器：
```
npm start
```
您应该看到 'Ploomes CRM MCP Server running through stdio' 的日志输出，表示服务器已成功启动。
配置 MCP 客户端：将上文提供的 JSON 配置添加到您的 MCP 客户端中，并确保客户端已正确连接到服务器。
使用工具：在 MCP 客户端中，您可以使用以下工具来与 Ploomes CRM 进行交互：
- 'ploomes_list_customers': 列出客户。
- 'ploomes_get_customer': 获取客户详情。
- 'ploomes_create_customer': 创建客户。
- 'ploomes_update_customer': 更新客户信息。
- 'ploomes_list_deals': 列出交易。
- 'ploomes_get_deal': 获取交易详情。
- 'ploomes_create_deal': 创建交易。
- 'ploomes_update_deal': 更新交易信息。
- 'ploomes_list_contacts': 列出客户的联系人。
- 'ploomes_get_contact': 获取联系人详情。
- 'ploomes_create_contact': 创建联系人。
- 'ploomes_list_activities': 列出活动。
- 'ploomes_create_activity': 创建活动。
在 MCP 客户端中，您可以像调用其他工具一样调用这些 Ploomes CRM 工具，并根据工具的参数描述传递相应的参数，以实现与 Ploomes CRM 系统的集成。

关键词

项目简介

主要功能点

安装步骤

服务器配置

基本使用方法

信息