Skip to main content

Twenty CRM REST/GraphQL MCP Server for Agentic AI!

Project description

Twenty MCP

Status Version License

Documentation — Installation, deployment, usage across the MCP, API, and agent interfaces, and guidance for provisioning the Twenty CRM platform are maintained in the official documentation.

Twenty CRM Customer Relationship Management system orchestrator. Built with the highest architectural standards, incorporating dynamic facades, custom API routing, and FastMCP tool decoration.

Table of Contents


Overview

Twenty MCP provides a high-performance, model-optimized interface to Twenty capabilities. It isolates the model from underlying API transport complexity, ensuring safe, idempotent, and highly traceable system interactions.


Features

  • Dynamic Facade Orchestration: Integrates multi-inheritance clients cleanly under a single facade.
  • Battle-Tested Resilience: Out-of-the-box credential authentication, connection polling, and request retry strategies.
  • FastMCP Declarative Tools: Fast, native schema registration with full inline validation.
  • Complete Test Intent Diversity: Deep, automated unit, integration, and mock tests ensuring high code coverage.

⚙️ Dynamic Tool Selection & Visibility

This MCP server supports dynamic toolset selection and visibility filtering at runtime. This allows you to restrict the set of exposed tools in order to prevent blowing up the LLM's context window.

You can configure tool filtering via multiple input channels:

  • CLI Arguments: Pass --tools or --toolsets (or their disabled counterparts --disabled-tools and --disabled-toolsets) during startup.
  • Environment Variables: Define standard environment variables:
    • MCP_ENABLED_TOOLS / MCP_DISABLED_TOOLS
    • MCP_ENABLED_TAGS / MCP_DISABLED_TAGS
  • HTTP SSE Request Headers: Pass custom headers during transport initialization:
    • x-mcp-enabled-tools / x-mcp-disabled-tools
    • x-mcp-enabled-tags / x-mcp-disabled-tags
  • HTTP SSE Request Query Parameters: Append query parameters directly to your transport connection URL:
    • ?tools=tool1,tool2
    • ?tags=tag1

When query strings or parameters are supplied, an LLM-free Knowledge Graph resolution layer (using DynamicToolOrchestrator) matches query intents against known tool tags, names, or descriptions, with safe fallback and automated 24-hour background cache refreshing.


Installation

Install in editable mode directly inside your active workspace:

pip install -e .[all]

Or via the uv tool:

uv pip install -e .

Usage

You can launch the FastMCP server in stdio mode via Python module execution:

import asyncio
from twenty_mcp.mcp_server import get_mcp_instance

async def main():
    mcp = get_mcp_instance()
    # Execute stdio loop or launch server
    print("MCP Server ready.")

if __name__ == "__main__":
    asyncio.run(main())

For direct shell launch, execute:

python -m twenty_mcp.mcp_server

Configuration

The package is fully configurable via the environment variables listed below:

Variable Description Default Required
TWENTY_URL Twenty CRM Base Server URL http://localhost:3000 Yes
TWENTY_TOKEN Developer authentication token twenty_developer_access_token Yes
TWENTY_MCP_BASE_URL Base API URL to query http://localhost:3000/api Yes
TWENTY_MCP_USERNAME Auth username for service admin Yes
TWENTY_MCP_PASSWORD Auth password for service secure_password Yes
TWENTY_MCP_SSL_VERIFY SSL verification flag True Yes
CRMTOOL CRM Tool Enabled Flag True Yes

A local template is supplied inside .env.example. Copy this file as .env and fill out your specific service endpoint parameters before starting execution.


MCP Tools

The following declarative FastMCP tools are registered and available to upstream AI agents:

Tool Name Description Parameters
get_people Retrieve list of people in CRM limit: int = 50
create_person Create a new person in CRM first_name: str, last_name: str, email: str
get_companies Retrieve list of companies in CRM limit: int = 50
execute_gql Execute raw arbitrary GraphQL query query: str, variables: dict = None

See docs/overview.md or docs/concepts.md for deeper operational examples.


Architecture

This package uses the standardized Agent-Utilities dynamic facade architecture:

graph TD
    User([User Agent]) --> Server[FastMCP Server]
    Server --> Facade[Api Dynamic Facade]
    Facade --> ClientBase[ApiClientBase]
    Facade --> Auth[Credentials Auth Handler]
    ClientBase --> Service([External Service API])

Deployment

Bare-Metal (Standard pip)

  1. Set up your Python virtual environment (>= 3.10).
  2. Install the package: pip install .[all]
  3. Export credentials:
    export TWENTY_URL="http://localhost:3000"
    
  4. Run: python -m twenty_mcp.mcp_server

Container (Docker Compose)

A standard compose structure is provided inside the docker/ folder. Build and deploy:

docker compose -f docker/compose.yml up --build -d

Additional Deployment Options

twenty-mcp can also run as a local container (Docker / Podman / uv) or be consumed from a remote deployment. The Deployment guide has full, copy-paste mcp_config.json for all four transports — stdio, streamable-http, local container / uv, and remote URL:

  • Local container / uv — launch the server from mcp_config.json via uvx, docker run, or podman run, or point at a local streamable-http container by url.
  • Remote URL — connect to a server deployed behind Caddy at http://twenty-mcp.arpa/mcp using the "url" key.

Documentation

The complete documentation is published as the official documentation site and is the recommended reference for installation, deployment, and day-to-day operation.

Page Contents
Installation pip, source, extras, prebuilt Docker image
Deployment run the MCP and agent servers, Compose, Caddy + Technitium, env config
Usage the MCP tools, the Api client, the A2A agent
Backing Platform deploy Twenty CRM with Docker
Overview the dynamic facade architecture
Concepts concept registry (CONCEPT:TWENTY-*)

Contributing

Please audit all code changes against ecosystem guidelines in CONTRIBUTING.md if available, and run:

pre-commit run --all-files

License

This project is licensed under the MIT License. See the LICENSE file for complete details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

twenty_mcp-0.33.0.tar.gz (30.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

twenty_mcp-0.33.0-py3-none-any.whl (35.8 kB view details)

Uploaded Python 3

File details

Details for the file twenty_mcp-0.33.0.tar.gz.

File metadata

  • Download URL: twenty_mcp-0.33.0.tar.gz
  • Upload date:
  • Size: 30.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for twenty_mcp-0.33.0.tar.gz
Algorithm Hash digest
SHA256 542cabd3cc03ae6cc327ab574af3fbb0f3eea32125f10a11d1c5b217ba9f85dc
MD5 5f5a36b6fa3b57703cb6a528614de0a5
BLAKE2b-256 a01bb7d486bfb012cfd6022db1636ee89bef2311463db915da86a6bbef67000e

See more details on using hashes here.

File details

Details for the file twenty_mcp-0.33.0-py3-none-any.whl.

File metadata

  • Download URL: twenty_mcp-0.33.0-py3-none-any.whl
  • Upload date:
  • Size: 35.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for twenty_mcp-0.33.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f35155d5c805e251b1a7ca5d6ce88e292c8619e7c0150d433e764f26a0ee567a
MD5 742ea2be86d172a39aa2e2d83c7c0e6b
BLAKE2b-256 7bbadb1ca0aca825af4638aaab03a6a76a09ddfef537542e089bb1dce00436ca

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page