Twenty MCP Server

Twenty MCP 服务

用于集成 Twenty CRM 的 MCP 服务，通过分类工具访问 Twenty 的 REST API。可用工具涵盖整个 Twenty REST API，并使用 openapi-mcp-generator 自动生成。

安装

克隆仓库并构建：npm install && npm run build

使用说明

此服务的使用说明位于 src/instructions/instructions.md，其中包含通过试验总结的最佳实践（例如工作流要求、格式规范和搜索技巧）。你可以编辑该文件并运行 npm run build 重新构建，以便根据具体用例进行自定义。

工具筛选

此 MCP 服务支持按类别和单个工具筛选，让你可以只启用所需工具。这样能显著减少上下文窗口占用并提升性能。

可用类别

类别	说明
api-schema	API 架构和元数据
crm	CRM 和联系人管理
tasks	任务和项目管理
notes	笔记和文档
attachments	文件附件
calendar	日历和活动
messaging	消息和通信
preferences	用户偏好和组织
views	数据视图和筛选
workflow	工作流和自动化
system	系统和管理

可用工具

所有可用工具都可以在 Twenty REST API 架构中的 operationId 字段下找到，地址为 https://your-twenty-instance.com/rest。你可以：

• 从 Twenty 实例下载 OpenAPI 规范，或
• 在此仓库的 /src/tools/ 目录中直接浏览工具定义

使用方法

MCP 客户端配置

在 MCP 客户端（例如 Claude Desktop）中配置此服务时，你可以使用类别和/或特定工具参数来控制可用工具。

提示

性能建议
强烈建议仅启用所需工具。这样可以减少显示可用工具所需的上下文窗口大小，从而提升性能并提高成本效益。

说明

以下“使用特定工具”示例中定义的工具，是我目前使用的工具配置。

使用类别

按预定义类别筛选工具：

{
  "mcpServers": {
    "twenty": {
      "command": "node",
      "args": [
        "/path/to/twenty-mcp-server/build/index.js",
        "--category=crm,tasks,notes"
      ],
      "env": {
        "TWENTY_BASE_URL": "https://your-twenty-instance.com/rest",
        "TWENTY_API_KEY": "your-api-key"
      }
    }
  }
}

使用特定工具

按名称选择单个工具：

{
  "mcpServers": {
    "twenty": {
      "command": "node",
      "args": [
        "/path/to/twenty-mcp-server/build/index.js",
        "--tools=findManyCompanies, createOneCompany, findOneCompany, UpdateOneCompany, findManyPeople, createOnePerson, findOnePerson, UpdateOnePerson,findOneNote, findManyNotes, createOneNote, createManyNotes, UpdateOneNote, createOneNoteTarget, createManyNoteTargets, findManyOpportunities, createOneOpportunity, findOneOpportunity, UpdateOneOpportunity"
      ],
      "env": {
        "TWENTY_BASE_URL": "https://your-twenty-instance.com/rest",
        "TWENTY_API_KEY": "your-api-key"
      }
    }
  }
}

组合使用类别和特定工具

同时使用这两种方式：

{
  "mcpServers": {
    "twenty": {
      "command": "node",
      "args": [
        "/path/to/twenty-mcp-server/build/index.js",
        "--category=crm,tasks",
        "--tools=findManyAttachments,createOneAttachment"
      ],
      "env": {
        "TWENTY_BASE_URL": "https://your-twenty-instance.com/rest",
        "TWENTY_API_KEY": "your-api-key"
      }
    }
  }
}

---

默认行为

说明

默认配置 如果未提供 --category 或 --tools 参数，则默认启用所有类别。这样你可以访问完整的 Twenty API，但由于可用工具数量较多，会影响性能并增加成本。

注意

开发版本
此服务目前仍在开发中，不建议用于生产环境。在生产环境中使用的风险由你自行承担。 此 MCP 服务使用你的 api-key 访问 Twenty CRM API。它不内置授权、身份验证或访问控制。