Skip to content

AIntegrator/twenty-crm-mcp-server

Β 
Β 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

7 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ€– Twenty CRM MCP Server

Transform your CRM into an AI-powered assistant

License: MIT Node.js Version Twenty CRM MCP

A Model Context Protocol server that connects Twenty CRM with Claude and other AI assistants, enabling natural language interactions with your customer data.

πŸš€ Quick Start β€’ πŸ“– Usage Examples β€’ πŸ› οΈ API Reference β€’ 🀝 Contributing


✨ Features

πŸ”„ Complete CRUD Operations

Create, read, update, and delete people, companies, tasks, and notes with simple commands

🧠 Dynamic Schema Discovery

Automatically adapts to your Twenty CRM configuration and custom fields

πŸ” Advanced Search

Search across multiple object types with intelligent filtering and natural language queries

πŸ“Š Metadata Access

Retrieve schema information and field definitions dynamically

πŸ’¬ Natural Language Interface

Use conversational commands to manage your CRM data effortlessly

⚑ Real-time Updates

All changes sync immediately with your Twenty CRM instance


πŸš€ Installation

Prerequisites

  • Node.js 18 or higher
  • A Twenty CRM instance (cloud or self-hosted)
  • Claude Desktop or compatible MCP client

Setup

  1. Clone the repository:
git clone https://github.com/mhenry3164/twenty-crm-mcp-server.git
cd twenty-crm-mcp-server
  1. Install dependencies:
npm install
  1. Get your Twenty CRM API key:

    • Log in to your Twenty CRM workspace
    • Navigate to Settings β†’ API & Webhooks (under Developers)
    • Generate a new API key
  2. Configure Claude Desktop:

Add the server to your 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"
      }
    }
  }
}

For self-hosted Twenty instances, change TWENTY_BASE_URL to your domain.

  1. Restart Claude Desktop to load the new server.

πŸ’¬ Usage

Once configured, you can use natural language to interact with your Twenty CRM:

πŸ‘₯ People Management

"List the first 10 people in my CRM"
"Create a new person named John Doe with email [email protected]"
"Update Sarah's job title to Senior Developer"
"Find all people working at tech companies"

🏒 Company Management

"Show me all companies with more than 100 employees"
"Create a company called Tech Solutions with domain techsolutions.com"
"Update Acme Corp's annual revenue to $5M"

βœ… Task Management

"Create a task to follow up with John next Friday"
"Show me all overdue tasks"
"Mark the task 'Call client' as completed"

πŸ“ Notes & Search

"Add a note about my meeting with the client today"
"Search for any records mentioning 'blockchain'"
"Find all contacts without LinkedIn profiles"

πŸ› οΈ API Reference

The server provides the following tools:

πŸ‘₯ People Operations
  • create_person - Create a new person
  • get_person - Get person details by ID
  • update_person - Update person information
  • list_people - List people with filtering
  • delete_person - Delete a person
🏒 Company Operations
  • create_company - Create a new company
  • get_company - Get company details by ID
  • update_company - Update company information
  • list_companies - List companies with filtering
  • delete_company - Delete a company
βœ… Task Operations
  • create_task - Create a new task
  • get_task - Get task details by ID
  • update_task - Update task information
  • list_tasks - List tasks with filtering
  • delete_task - Delete a task
πŸ“ Note Operations
  • create_note - Create a new note
  • get_note - Get note details by ID
  • update_note - Update note information
  • list_notes - List notes with filtering
  • delete_note - Delete a note
πŸ” Metadata & Search
  • get_metadata_objects - Get all object types and schemas
  • get_object_metadata - Get metadata for specific object
  • search_records - Search across multiple object types

βš™οΈ Configuration

Environment Variables

  • TWENTY_API_KEY (required): Your Twenty CRM API key
  • TWENTY_BASE_URL (optional): Twenty CRM base URL (defaults to https://api.twenty.com)

Custom Fields

The server automatically discovers and supports custom fields in your Twenty CRM instance. No configuration changes needed when you add new fields.


🀝 Contributing

We welcome contributions! Please see CONTRIBUTING.md for guidelines.

Development

  1. Clone the repo:
git clone https://github.com/mhenry3164/twenty-crm-mcp-server.git
cd twenty-crm-mcp-server
  1. Install dependencies:
npm install
  1. Set up environment variables:
cp .env.example .env
# Edit .env with your API key
  1. Test the server:
npm test

πŸ› Troubleshooting

Common Issues

Authentication Error: Verify your API key is correct and has appropriate permissions.

Connection Failed: Check that your TWENTY_BASE_URL is correct (especially for self-hosted instances).

Field Not Found: The server automatically discovers fields. If you're getting field errors, try getting the metadata first: "Show me the available fields for people"


πŸ“„ License

MIT License - see LICENSE file for details.


πŸ™ Acknowledgments

  • Twenty CRM for providing an excellent open-source CRM
  • Anthropic for the Model Context Protocol
  • The MCP community for inspiration and examples

πŸ”— Links


Made with ❀️ for the open-source community

⭐ Star this repo if you find it helpful!

About

A Model Context Protocol (MCP) server for Twenty CRM integration. Enables natural language interactions with your CRM data through Claude and other AI assistants. Supports CRUD operations, dynamic schema discovery, and advanced search across people, companies, tasks, and notes.

Resources

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • JavaScript 100.0%