- Home
- MCP servers
- Twenty
Twenty
- typescript
31
GitHub Stars
typescript
Language
6 months ago
First Indexed
2 months ago
Catalog Refreshed
Documentation & install
Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.
Installation
Add the following to your MCP client configuration file.
Configuration
View docs{
"mcpServers": {
"jezweb-twenty-mcp": {
"command": "npx",
"args": [
"twenty-mcp-server",
"setup"
],
"env": {
"TWENTY_API_KEY": "REPLACE_WITH_YOUR_API_KEY",
"TWENTY_BASE_URL": "https://api.twenty.com"
}
}
}
}You set up a Twenty MCP Server to connect Claude and other MCP-compatible AI assistants to your Twenty CRM data. This server provides secure, typed tools for reading, creating, updating, and automating CRM records like contacts, companies, opportunities, and activities using a familiar TypeScript-based interface.
How to use
Start by configuring the MCP server in your environment, then connect your MCP client (for example Claude) to expose the CRM capabilities as tools. You can run the server directly via the MCP CLI or through a temporary instant trial, and you will interact with the server through natural language prompts that map to concrete CRM actions.
How to install
Prerequisites you need before installation: node is installed (Node.js 18 or higher), npm is available, Git is installed, and you have a Twenty CRM instance with API access.
Option A: npx Instant Trial (no installation) use this to try immediately without installing anything on your system.
# Try it right now - no installation required!
npx twenty-mcp-server setup
# Configuration is saved globally for future npx runs
npx twenty-mcp-server test
# Start using it immediately
npx twenty-mcp-server start
Option B: npm Global Install (best for regular use) install globally and run the interactive setup wizard.
# Install globally
npm install -g twenty-mcp-server
# Run setup wizard
twenty-mcp setup
# Start the server
twenty-mcp start
Option C: Git Clone (for developers who want to modify the code) clone the repository and install dependencies, then run the installer.
# Clone the repository
git clone https://github.com/jezweb/twenty-mcp.git
cd twenty-mcp
# Make install script executable (Linux/macOS)
chmod +x install.sh
# Run the installation
./install.sh
Additional sections
Configuration details include obtaining your Twenty CRM API key, setting the base URL, and loading these values into your environment or an .env file.
OAuth authentication is supported for multi-user deployments. You can enable OAuth during setup and test the integration with the provided CLI commands.
Verification steps help you confirm that the server is correctly configured and can connect to Twenty CRM before you begin using it with Claude.
IDE and editor integrations are described to help you run the MCP server from your preferred development environment. Ensure you provide the absolute path to your runtime entry point for reliable operation.
If you run into issues, a quick validation of your configuration and a set of troubleshooting steps can help you diagnose common problems related to installation, API keys, and connectivity.