twenty-crm-mcp-server

🚀 🤖 Twenty CRM MCP Server

将你的客户关系管理（CRM）系统转变为由人工智能驱动的助手，通过模型上下文协议（MCP）服务器连接 Twenty CRM 与 Claude 等人工智能助手，实现与客户数据的自然语言交互。

🚀 快速开始

前提条件

• Node.js 18 或更高版本
• 一个 Twenty CRM 实例（云部署或自托管）
• Claude Desktop 或兼容的 MCP 客户端

安装步骤

1. 克隆仓库：

git clone https://github.com/mhenry3164/twenty-crm-mcp-server.git
cd twenty-crm-mcp-server

2. 安装依赖：

npm install

3. 获取 Twenty CRM API 密钥：

   • 登录你的 Twenty CRM 工作区
   • 导航到“设置”→“API 与 Webhook”（在“开发者”板块下）
   • 生成一个新的 API 密钥

4. 配置 Claude Desktop： 将服务器添加到你的 claude_desktop_config.json 文件中：

{
  "mcpServers": {
    "twenty-crm": {
      "command": "node",
      "args": ["/path/to/twenty-crm-mcp-server/index.js"],
      "env": {
        "TWENTY_API_KEY": "your_api_key_here",
        "TWENTY_BASE_URL": "https://api.twenty.com"
      }
    }
  }
}

对于自托管的 Twenty 实例，将 TWENTY_BASE_URL 更改为你的域名。

5. 重启 Claude Desktop 以加载新服务器。

✨ 主要特性

| 特性分类 | 详情 | | ---- | ---- | | 🔄 完整的 CRUD 操作 | 使用简单命令创建、读取、更新和删除人员、公司、任务和笔记 | | 🧠 动态模式发现 | 自动适应你的 Twenty CRM 配置和自定义字段 | | 🔍 高级搜索 | 通过智能过滤和自然语言查询跨多个对象类型进行搜索 | | 📊 元数据访问 | 动态检索模式信息和字段定义 | | 💬 自然语言界面 | 使用对话式命令轻松管理你的 CRM 数据 | | ⚡ 实时更新 | 所有更改立即与你的 Twenty CRM 实例同步 |

💻 使用示例

基础用法

配置完成后，你可以使用自然语言与你的 Twenty CRM 进行交互：

👥 人员管理

"列出我的 CRM 中的前 10 个人"
"创建一个名为 John Doe 的新人，邮箱为 john@example.com"
"将 Sarah 的职位更新为高级开发人员"
"查找所有在科技公司工作的人员"

🏢 公司管理

"显示所有员工超过 100 人的公司"
"创建一个名为 Tech Solutions 的公司，域名是 techsolutions.com"
"将 Acme 公司的年收入更新为 500 万美元"

✅ 任务管理

"创建一个下周五跟进 John 的任务"
"显示所有逾期任务"
"将任务 '致电客户' 标记为已完成"

📝 笔记与搜索

"添加一条关于我今天与客户会议的笔记"
"搜索任何提及 '区块链' 的记录"
"查找所有没有 LinkedIn 资料的联系人"

📚 详细文档

🛠️ API 参考

服务器提供以下工具：

⚙️ 配置

环境变量

• TWENTY_API_KEY（必需）：你的 Twenty CRM API 密钥
• TWENTY_BASE_URL（可选）：Twenty CRM 基础 URL（默认为 https://api.twenty.com）

自定义字段

服务器会自动发现并支持你 Twenty CRM 实例中的自定义字段。添加新字段时无需更改配置。

🤝 贡献代码

我们欢迎贡献！请参阅 CONTRIBUTING.md 获取指南。

开发步骤

1. 克隆仓库：

git clone https://github.com/mhenry3164/twenty-crm-mcp-server.git
cd twenty-crm-mcp-server

2. 安装依赖：

npm install

3. 设置环境变量：

cp .env.example .env
# 使用你的 API 密钥编辑 .env 文件

4. 测试服务器：

npm test

🐛 故障排除

常见问题

• 认证错误：验证你的 API 密钥是否正确且具有适当的权限。
• 连接失败：检查你的 TWENTY_BASE_URL 是否正确（特别是对于自托管实例）。
• 字段未找到：服务器会自动发现字段。如果你遇到字段错误，尝试先获取元数据："显示人员的可用字段"

📄 许可证

本项目采用 MIT 许可证 - 详情请参阅 LICENSE 文件。

🙏 致谢

• Twenty CRM 提供了优秀的开源 CRM 系统
• Anthropic 提供了模型上下文协议
• MCP 社区提供了灵感和示例

🔗 链接

• Twenty CRM 文档
• 模型上下文协议规范
• Claude Desktop