使用说明
二十crm mcp
MCP服务器 二十CRM,为公司、人员、机会、笔记、任务、活动、搜索、批量操作和自定义对象公开工具。
最初改编自 vomos ua/n8n节点二十个.
运输
此服务器运行在 可流式传输http (远程MCP)并服务于单个端点:
POST /mcp?apiUrl=YOUR_TWENTY_API_URL&apiKey=YOUR_TWENTY_API_KEY用于JSON-RPC请求GET /mcp和DELETE /mcp返回405 Method not allowed
需求
- Node.js
>=18.18 - A Twenty CRM API URL
- A Twenty CRM API密钥
安装
npm install
构建
npm run build
跑
npm start
服务器URL:
http://127.0.0.1:3000/mcp?apiUrl=YOUR_TWENTY_API_URL&apiKey=YOUR_TWENTY_API_KEY- 例子:
http://127.0.0.1:3000/mcp?apiUrl=https%3A%2F%2Fyour-twenty-instance.com&apiKey=YOUR_TWENTY_API_KEY
码头工人
使用Docker Compose构建和运行:
docker compose up --build -d
停止:
docker compose down
MCP端点位于:
http://127.0.0.1:3000/mcp?apiUrl=YOUR_TWENTY_API_URL&apiKey=YOUR_TWENTY_API_KEY
Codex桌面设置(已验证工作正常)
已验证 2026年2月14日 Codex Desktop使用此仓库和端点。
- 在本地启动服务器(
npm start)或者使用Docker(docker compose up --build -d). - 在Codex配置中添加MCP服务器:
[mcp_servers.twenty_crm]
url = "http://127.0.0.1:3000/mcp?apiUrl=https%3A%2F%2Fyour-twenty-instance.com&apiKey=YOUR_TWENTY_API_KEY"
- 重新启动Codex桌面。
- 打开一个新的聊天并调用一个工具(例如,
list_opportunities)以确认其已连接。
故障排除
如果您遇到任何问题,请提出问题:
- https://github.com/sebbaker/twenty-mcp-maybe/issues
发展
npm run dev
测试
运行所有测试:
npm test
新闻报道:
npm run test:coverage
集成测试(使用当前shell环境)
套房包括 tests/integration/core-models.integration.test.ts.
使用 TWENTY_API_URL 和 TWENTY_API_KEY 并验证API是否可以为每个核心资源获取至少一条记录:
- 公司
- 人们
- 机会
如果缺少这些环境变量,则跳过集成套件。
暴露的工具组
- 公司:创建/获取/列表/更新/删除/追加销售
- 人员:创建/获取/列表/更新/删除/追加销售
- 机会:创建/获取/列出/更新/删除/追加销售
- 注意:创建/获取/列表/更新/删除
- 任务:创建/获取/列表/更新/删除
- 活动:创建/获取/列表/更新/删除
- 参与度:按公司或个人获取消息/日历事件/活动
- 批量:创建/更新/删除
- 搜索:跨对象搜索
- 自定义对象:创建/获取/列表/更新/删除
许可证
麻省理工学院