Twenty MCP Server

by Jdu278

234 downloads
Not rated
GitHub

About

An MCP server for integrating with Twenty CRM, providing access to Twenty's REST API through categorized tools. The available tools map the entire Twenty REST API and were generated using the openapi-mcp-generator.

Details

Author
Jdu278
Downloads
234
Categories
Developer Tools

- Category-based tool filtering reduces context window usage.
- Individual tool selection for precise control over enabled tools.
- Covers all Twenty REST API endpoints via categorized tools.
- Supports categories such as CRM, tasks, notes, and calendar.
- Default behavior enables all categories when no filters are set.
- Configuration supports combining categories and specific tools.

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Twenty MCP Server
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Configure the server in an MCP client by pointing to the built index.js script, setting the TWENTY_BASE_URL and TWENTY_API_KEY environment variables, and optionally passing --category or --tools arguments to filter which tools are enabled. If neither argument is provided, all categories are enabled by default.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

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

Twenty MCP Server

An MCP server for integrating with Twenty CRM, providing access to Twenty's REST API through categorized tools. The available tools map the entire Twenty REST API and were automatically generated using the openapi-mcp-generator.

> [!CAUTION]
> Development Version
> This server is currently in development and is not recommended for production use. Use at your own risk in production environments.

> [!CAUTION]
> For local use
> This MCP server provides access to your Twenty CRM API using your api-key. It has no built-in authorization, authentication, or access controls.

Tool Filtering

This MCP server supports both category-based and individual tool filtering, allowing you to selectively enable only the tools you need. This approach significantly reduces context window usage and improves performance.

Available Categories

| Category | Description |
|----------|-------------|
| api-schema | API Schema & Metadata |
| crm | CRM & Contact Management |
| tasks | Task & Project Management |
| notes | Notes & Documentation |
| attachments | File Attachments |
| calendar | Calendar & Events |
| messaging | Messaging & Communication |
| preferences | User Preferences & Organization |
| views | Data Views & Filtering |
| workflow | Workflow & Automation |
| system | System & Admin |

Available Tools

All available tools can be found in the Twenty REST API schema at https://your-twenty-instance.com/rest under the operationId field. You can either:

- Download the OpenAPI specification from your Twenty instance, or
- Browse tool definitions directly in this repository under the /src/tools/ directory

Usage

MCP Client Configuration

When configuring this server in an MCP client (like Claude Desktop), you can use category and/or specific tool arguments to control which tools are available.

> [!TIP]
> Performance Recommendation
> It's highly recommended to limit the available tools to only what you need. This reduces the context window size required to display available tools, improving both performance and cost efficiency.

> [!NOTE]
> The tools defined in the "Using Specific Tools" example below represent my currently used tool setup.

Using Categories

Filter tools by predefined categories:

{
"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"
}
}
}
}

Using Specific Tools

Select individual tools by their names:

{
"mcpServers": {
"twenty": {
"command": "node",
"args": [
"/path/to/twenty-mcp-server/build/index.js",
"--tools=findManyCompanies,createOneCompany,findOneCompany,UpdateOneCompany,findManyPeople,createOnePerson,findOnePerson,UpdateOnePerson,findManyTasks,createOneTask,createManyTasks,findOneTask,UpdateOneTask"
],
"env": {
"TWENTY_BASE_URL": "https://your-twenty-instance.com/rest",
"TWENTY_API_KEY": "your-api-key"
}
}
}
}

Combining Categories and Specific Tools

Use both approaches together:

{
"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"
}
}
}
}

---

Default Behavior

> [!NOTE]
> Default Configuration
> If neither --category nor --tools arguments are provided, all categories are enabled by default. This gives you access to the complete Twenty API but will impact performance and costs due to the large number of available tools.

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.