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 以加載新服務器。

✨ 主要特性

💻 使用示例

基礎用法

配置完成後，你可以使用自然語言與你的 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