twenty-mcp 0.30.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- twenty_mcp-0.30.0/LICENSE +21 -0
- twenty_mcp-0.30.0/PKG-INFO +209 -0
- twenty_mcp-0.30.0/README.md +181 -0
- twenty_mcp-0.30.0/pyproject.toml +53 -0
- twenty_mcp-0.30.0/setup.cfg +4 -0
- twenty_mcp-0.30.0/tests/conftest.py +16 -0
- twenty_mcp-0.30.0/tests/test_api_client.py +18 -0
- twenty_mcp-0.30.0/tests/test_api_extensions.py +206 -0
- twenty_mcp-0.30.0/tests/test_concept_parity.py +7 -0
- twenty_mcp-0.30.0/tests/test_init_dynamics.py +8 -0
- twenty_mcp-0.30.0/tests/test_mcp_server.py +26 -0
- twenty_mcp-0.30.0/tests/test_startup.py +9 -0
- twenty_mcp-0.30.0/twenty_mcp/__init__.py +64 -0
- twenty_mcp-0.30.0/twenty_mcp/__main__.py +4 -0
- twenty_mcp-0.30.0/twenty_mcp/agent_server.py +73 -0
- twenty_mcp-0.30.0/twenty_mcp/api/__init__.py +6 -0
- twenty_mcp-0.30.0/twenty_mcp/api/api_client_base.py +64 -0
- twenty_mcp-0.30.0/twenty_mcp/api/api_client_crm.py +153 -0
- twenty_mcp-0.30.0/twenty_mcp/api/api_client_metadata.py +67 -0
- twenty_mcp-0.30.0/twenty_mcp/api/api_client_oauth.py +119 -0
- twenty_mcp-0.30.0/twenty_mcp/api_client.py +13 -0
- twenty_mcp-0.30.0/twenty_mcp/auth.py +30 -0
- twenty_mcp-0.30.0/twenty_mcp/mcp/__init__.py +3 -0
- twenty_mcp-0.30.0/twenty_mcp/mcp/mcp_crm.py +50 -0
- twenty_mcp-0.30.0/twenty_mcp/mcp/mcp_metadata.py +48 -0
- twenty_mcp-0.30.0/twenty_mcp/mcp/mcp_oauth.py +56 -0
- twenty_mcp-0.30.0/twenty_mcp/mcp_config.json +12 -0
- twenty_mcp-0.30.0/twenty_mcp/mcp_server.py +65 -0
- twenty_mcp-0.30.0/twenty_mcp/models.py +10 -0
- twenty_mcp-0.30.0/twenty_mcp.egg-info/PKG-INFO +209 -0
- twenty_mcp-0.30.0/twenty_mcp.egg-info/SOURCES.txt +33 -0
- twenty_mcp-0.30.0/twenty_mcp.egg-info/dependency_links.txt +1 -0
- twenty_mcp-0.30.0/twenty_mcp.egg-info/entry_points.txt +3 -0
- twenty_mcp-0.30.0/twenty_mcp.egg-info/requires.txt +16 -0
- twenty_mcp-0.30.0/twenty_mcp.egg-info/top_level.txt +6 -0
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Advanced Agentic Coding
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,209 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: twenty-mcp
|
|
3
|
+
Version: 0.30.0
|
|
4
|
+
Summary: Twenty CRM REST/GraphQL MCP Server for Agentic AI!
|
|
5
|
+
Author-email: Audel Rouhi <knucklessg1@gmail.com>
|
|
6
|
+
License: MIT
|
|
7
|
+
Classifier: Development Status :: 4 - Beta
|
|
8
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
9
|
+
Classifier: Environment :: Console
|
|
10
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
11
|
+
Classifier: Programming Language :: Python :: 3
|
|
12
|
+
Requires-Python: <3.14,>=3.11
|
|
13
|
+
Description-Content-Type: text/markdown
|
|
14
|
+
License-File: LICENSE
|
|
15
|
+
Requires-Dist: agent-utilities>=0.45.0
|
|
16
|
+
Provides-Extra: mcp
|
|
17
|
+
Requires-Dist: agent-utilities[mcp]>=0.45.0; extra == "mcp"
|
|
18
|
+
Provides-Extra: agent
|
|
19
|
+
Requires-Dist: agent-utilities[agent,logfire]>=0.45.0; extra == "agent"
|
|
20
|
+
Provides-Extra: all
|
|
21
|
+
Requires-Dist: agent-utilities[agent,logfire,mcp]>=0.45.0; extra == "all"
|
|
22
|
+
Provides-Extra: test
|
|
23
|
+
Requires-Dist: pytest-xdist>=3.6.0; extra == "test"
|
|
24
|
+
Requires-Dist: pytest; extra == "test"
|
|
25
|
+
Requires-Dist: pytest-asyncio; extra == "test"
|
|
26
|
+
Requires-Dist: pytest-cov; extra == "test"
|
|
27
|
+
Dynamic: license-file
|
|
28
|
+
|
|
29
|
+
# Twenty MCP
|
|
30
|
+
|
|
31
|
+
[](https://github.com/genius-agents/twenty-mcp)
|
|
32
|
+
[](pyproject.toml)
|
|
33
|
+
[](LICENSE)
|
|
34
|
+
|
|
35
|
+
Twenty CRM Customer Relationship Management system orchestrator. Built with the highest architectural standards, incorporating dynamic facades, custom API routing, and FastMCP tool decoration.
|
|
36
|
+
|
|
37
|
+
## Table of Contents
|
|
38
|
+
- [Overview](#overview)
|
|
39
|
+
- [Features](#features)
|
|
40
|
+
- [Installation](#installation)
|
|
41
|
+
- [Usage](#usage)
|
|
42
|
+
- [Configuration](#configuration)
|
|
43
|
+
- [MCP Tools](#mcp-tools)
|
|
44
|
+
- [Architecture](#architecture)
|
|
45
|
+
- [Deployment](#deployment)
|
|
46
|
+
- [Contributing](#contributing)
|
|
47
|
+
- [License](#license)
|
|
48
|
+
|
|
49
|
+
---
|
|
50
|
+
|
|
51
|
+
## Overview
|
|
52
|
+
|
|
53
|
+
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.
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
57
|
+
## Features
|
|
58
|
+
|
|
59
|
+
- **Dynamic Facade Orchestration**: Integrates multi-inheritance clients cleanly under a single facade.
|
|
60
|
+
- **Battle-Tested Resilience**: Out-of-the-box credential authentication, connection polling, and request retry strategies.
|
|
61
|
+
- **FastMCP Declarative Tools**: Fast, native schema registration with full inline validation.
|
|
62
|
+
- **Complete Test Intent Diversity**: Deep, automated unit, integration, and mock tests ensuring high code coverage.
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
66
|
+
## ⚙️ Dynamic Tool Selection & Visibility
|
|
67
|
+
|
|
68
|
+
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.
|
|
69
|
+
|
|
70
|
+
You can configure tool filtering via multiple input channels:
|
|
71
|
+
|
|
72
|
+
- **CLI Arguments:** Pass `--tools` or `--toolsets` (or their disabled counterparts `--disabled-tools` and `--disabled-toolsets`) during startup.
|
|
73
|
+
- **Environment Variables:** Define standard environment variables:
|
|
74
|
+
- `MCP_ENABLED_TOOLS` / `MCP_DISABLED_TOOLS`
|
|
75
|
+
- `MCP_ENABLED_TAGS` / `MCP_DISABLED_TAGS`
|
|
76
|
+
- **HTTP SSE Request Headers:** Pass custom headers during transport initialization:
|
|
77
|
+
- `x-mcp-enabled-tools` / `x-mcp-disabled-tools`
|
|
78
|
+
- `x-mcp-enabled-tags` / `x-mcp-disabled-tags`
|
|
79
|
+
- **HTTP SSE Request Query Parameters:** Append query parameters directly to your transport connection URL:
|
|
80
|
+
- `?tools=tool1,tool2`
|
|
81
|
+
- `?tags=tag1`
|
|
82
|
+
|
|
83
|
+
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.
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
---
|
|
87
|
+
|
|
88
|
+
## Installation
|
|
89
|
+
|
|
90
|
+
Install in editable mode directly inside your active workspace:
|
|
91
|
+
|
|
92
|
+
```bash
|
|
93
|
+
pip install -e .[all]
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
Or via the `uv` tool:
|
|
97
|
+
|
|
98
|
+
```bash
|
|
99
|
+
uv pip install -e .
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
---
|
|
103
|
+
|
|
104
|
+
## Usage
|
|
105
|
+
|
|
106
|
+
You can launch the FastMCP server in stdio mode via Python module execution:
|
|
107
|
+
|
|
108
|
+
```python
|
|
109
|
+
import asyncio
|
|
110
|
+
from twenty_mcp.mcp_server import get_mcp_instance
|
|
111
|
+
|
|
112
|
+
async def main():
|
|
113
|
+
mcp = get_mcp_instance()
|
|
114
|
+
# Execute stdio loop or launch server
|
|
115
|
+
print("MCP Server ready.")
|
|
116
|
+
|
|
117
|
+
if __name__ == "__main__":
|
|
118
|
+
asyncio.run(main())
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
For direct shell launch, execute:
|
|
122
|
+
|
|
123
|
+
```bash
|
|
124
|
+
python -m twenty_mcp.mcp_server
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
---
|
|
128
|
+
|
|
129
|
+
## Configuration
|
|
130
|
+
|
|
131
|
+
The package is fully configurable via the environment variables listed below:
|
|
132
|
+
|
|
133
|
+
| Variable | Description | Default | Required |
|
|
134
|
+
|----------|-------------|---------|----------|
|
|
135
|
+
| `TWENTY_URL` | Twenty CRM Base Server URL | `http://localhost:3000` | Yes |
|
|
136
|
+
| `TWENTY_TOKEN` | Developer authentication token | `twenty_developer_access_token` | Yes |
|
|
137
|
+
| `TWENTY_MCP_BASE_URL` | Base API URL to query | `http://localhost:3000/api` | Yes |
|
|
138
|
+
| `TWENTY_MCP_USERNAME` | Auth username for service | `admin` | Yes |
|
|
139
|
+
| `TWENTY_MCP_PASSWORD` | Auth password for service | `secure_password` | Yes |
|
|
140
|
+
| `TWENTY_MCP_SSL_VERIFY` | SSL verification flag | `True` | Yes |
|
|
141
|
+
| `CRMTOOL` | CRM Tool Enabled Flag | `True` | Yes |
|
|
142
|
+
|
|
143
|
+
A local template is supplied inside [.env.example](.env.example). Copy this file as `.env` and fill out your specific service endpoint parameters before starting execution.
|
|
144
|
+
|
|
145
|
+
---
|
|
146
|
+
|
|
147
|
+
## MCP Tools
|
|
148
|
+
|
|
149
|
+
The following declarative FastMCP tools are registered and available to upstream AI agents:
|
|
150
|
+
|
|
151
|
+
| Tool Name | Description | Parameters |
|
|
152
|
+
|-----------|-------------|------------|
|
|
153
|
+
| `get_people` | Retrieve list of people in CRM | `limit: int = 50` |
|
|
154
|
+
| `create_person` | Create a new person in CRM | `first_name: str, last_name: str, email: str` |
|
|
155
|
+
| `get_companies` | Retrieve list of companies in CRM | `limit: int = 50` |
|
|
156
|
+
| `execute_gql` | Execute raw arbitrary GraphQL query | `query: str, variables: dict = None` |
|
|
157
|
+
|
|
158
|
+
See [docs/overview.md](docs/overview.md) or [docs/concepts.md](docs/concepts.md) for deeper operational examples.
|
|
159
|
+
|
|
160
|
+
---
|
|
161
|
+
|
|
162
|
+
## Architecture
|
|
163
|
+
|
|
164
|
+
This package uses the standardized Agent-Utilities dynamic facade architecture:
|
|
165
|
+
|
|
166
|
+
```mermaid
|
|
167
|
+
graph TD
|
|
168
|
+
User([User Agent]) --> Server[FastMCP Server]
|
|
169
|
+
Server --> Facade[Api Dynamic Facade]
|
|
170
|
+
Facade --> ClientBase[ApiClientBase]
|
|
171
|
+
Facade --> Auth[Credentials Auth Handler]
|
|
172
|
+
ClientBase --> Service([External Service API])
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
---
|
|
176
|
+
|
|
177
|
+
## Deployment
|
|
178
|
+
|
|
179
|
+
### Bare-Metal (Standard pip)
|
|
180
|
+
1. Set up your Python virtual environment (>= 3.10).
|
|
181
|
+
2. Install the package: `pip install .[all]`
|
|
182
|
+
3. Export credentials:
|
|
183
|
+
```bash
|
|
184
|
+
export TWENTY_URL="http://localhost:3000"
|
|
185
|
+
```
|
|
186
|
+
4. Run: `python -m twenty_mcp.mcp_server`
|
|
187
|
+
|
|
188
|
+
### Container (Docker Compose)
|
|
189
|
+
A standard compose structure is provided inside the `docker/` folder. Build and deploy:
|
|
190
|
+
|
|
191
|
+
```bash
|
|
192
|
+
docker compose -f docker/compose.yml up --build -d
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
---
|
|
196
|
+
|
|
197
|
+
## Contributing
|
|
198
|
+
|
|
199
|
+
Please audit all code changes against ecosystem guidelines in [CONTRIBUTING.md](CONTRIBUTING.md) if available, and run:
|
|
200
|
+
|
|
201
|
+
```bash
|
|
202
|
+
pre-commit run --all-files
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
---
|
|
206
|
+
|
|
207
|
+
## License
|
|
208
|
+
|
|
209
|
+
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for complete details.
|
|
@@ -0,0 +1,181 @@
|
|
|
1
|
+
# Twenty MCP
|
|
2
|
+
|
|
3
|
+
[](https://github.com/genius-agents/twenty-mcp)
|
|
4
|
+
[](pyproject.toml)
|
|
5
|
+
[](LICENSE)
|
|
6
|
+
|
|
7
|
+
Twenty CRM Customer Relationship Management system orchestrator. Built with the highest architectural standards, incorporating dynamic facades, custom API routing, and FastMCP tool decoration.
|
|
8
|
+
|
|
9
|
+
## Table of Contents
|
|
10
|
+
- [Overview](#overview)
|
|
11
|
+
- [Features](#features)
|
|
12
|
+
- [Installation](#installation)
|
|
13
|
+
- [Usage](#usage)
|
|
14
|
+
- [Configuration](#configuration)
|
|
15
|
+
- [MCP Tools](#mcp-tools)
|
|
16
|
+
- [Architecture](#architecture)
|
|
17
|
+
- [Deployment](#deployment)
|
|
18
|
+
- [Contributing](#contributing)
|
|
19
|
+
- [License](#license)
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
## Overview
|
|
24
|
+
|
|
25
|
+
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.
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## Features
|
|
30
|
+
|
|
31
|
+
- **Dynamic Facade Orchestration**: Integrates multi-inheritance clients cleanly under a single facade.
|
|
32
|
+
- **Battle-Tested Resilience**: Out-of-the-box credential authentication, connection polling, and request retry strategies.
|
|
33
|
+
- **FastMCP Declarative Tools**: Fast, native schema registration with full inline validation.
|
|
34
|
+
- **Complete Test Intent Diversity**: Deep, automated unit, integration, and mock tests ensuring high code coverage.
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
## ⚙️ Dynamic Tool Selection & Visibility
|
|
39
|
+
|
|
40
|
+
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.
|
|
41
|
+
|
|
42
|
+
You can configure tool filtering via multiple input channels:
|
|
43
|
+
|
|
44
|
+
- **CLI Arguments:** Pass `--tools` or `--toolsets` (or their disabled counterparts `--disabled-tools` and `--disabled-toolsets`) during startup.
|
|
45
|
+
- **Environment Variables:** Define standard environment variables:
|
|
46
|
+
- `MCP_ENABLED_TOOLS` / `MCP_DISABLED_TOOLS`
|
|
47
|
+
- `MCP_ENABLED_TAGS` / `MCP_DISABLED_TAGS`
|
|
48
|
+
- **HTTP SSE Request Headers:** Pass custom headers during transport initialization:
|
|
49
|
+
- `x-mcp-enabled-tools` / `x-mcp-disabled-tools`
|
|
50
|
+
- `x-mcp-enabled-tags` / `x-mcp-disabled-tags`
|
|
51
|
+
- **HTTP SSE Request Query Parameters:** Append query parameters directly to your transport connection URL:
|
|
52
|
+
- `?tools=tool1,tool2`
|
|
53
|
+
- `?tags=tag1`
|
|
54
|
+
|
|
55
|
+
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.
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
---
|
|
59
|
+
|
|
60
|
+
## Installation
|
|
61
|
+
|
|
62
|
+
Install in editable mode directly inside your active workspace:
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
pip install -e .[all]
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
Or via the `uv` tool:
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
uv pip install -e .
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
---
|
|
75
|
+
|
|
76
|
+
## Usage
|
|
77
|
+
|
|
78
|
+
You can launch the FastMCP server in stdio mode via Python module execution:
|
|
79
|
+
|
|
80
|
+
```python
|
|
81
|
+
import asyncio
|
|
82
|
+
from twenty_mcp.mcp_server import get_mcp_instance
|
|
83
|
+
|
|
84
|
+
async def main():
|
|
85
|
+
mcp = get_mcp_instance()
|
|
86
|
+
# Execute stdio loop or launch server
|
|
87
|
+
print("MCP Server ready.")
|
|
88
|
+
|
|
89
|
+
if __name__ == "__main__":
|
|
90
|
+
asyncio.run(main())
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
For direct shell launch, execute:
|
|
94
|
+
|
|
95
|
+
```bash
|
|
96
|
+
python -m twenty_mcp.mcp_server
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
---
|
|
100
|
+
|
|
101
|
+
## Configuration
|
|
102
|
+
|
|
103
|
+
The package is fully configurable via the environment variables listed below:
|
|
104
|
+
|
|
105
|
+
| Variable | Description | Default | Required |
|
|
106
|
+
|----------|-------------|---------|----------|
|
|
107
|
+
| `TWENTY_URL` | Twenty CRM Base Server URL | `http://localhost:3000` | Yes |
|
|
108
|
+
| `TWENTY_TOKEN` | Developer authentication token | `twenty_developer_access_token` | Yes |
|
|
109
|
+
| `TWENTY_MCP_BASE_URL` | Base API URL to query | `http://localhost:3000/api` | Yes |
|
|
110
|
+
| `TWENTY_MCP_USERNAME` | Auth username for service | `admin` | Yes |
|
|
111
|
+
| `TWENTY_MCP_PASSWORD` | Auth password for service | `secure_password` | Yes |
|
|
112
|
+
| `TWENTY_MCP_SSL_VERIFY` | SSL verification flag | `True` | Yes |
|
|
113
|
+
| `CRMTOOL` | CRM Tool Enabled Flag | `True` | Yes |
|
|
114
|
+
|
|
115
|
+
A local template is supplied inside [.env.example](.env.example). Copy this file as `.env` and fill out your specific service endpoint parameters before starting execution.
|
|
116
|
+
|
|
117
|
+
---
|
|
118
|
+
|
|
119
|
+
## MCP Tools
|
|
120
|
+
|
|
121
|
+
The following declarative FastMCP tools are registered and available to upstream AI agents:
|
|
122
|
+
|
|
123
|
+
| Tool Name | Description | Parameters |
|
|
124
|
+
|-----------|-------------|------------|
|
|
125
|
+
| `get_people` | Retrieve list of people in CRM | `limit: int = 50` |
|
|
126
|
+
| `create_person` | Create a new person in CRM | `first_name: str, last_name: str, email: str` |
|
|
127
|
+
| `get_companies` | Retrieve list of companies in CRM | `limit: int = 50` |
|
|
128
|
+
| `execute_gql` | Execute raw arbitrary GraphQL query | `query: str, variables: dict = None` |
|
|
129
|
+
|
|
130
|
+
See [docs/overview.md](docs/overview.md) or [docs/concepts.md](docs/concepts.md) for deeper operational examples.
|
|
131
|
+
|
|
132
|
+
---
|
|
133
|
+
|
|
134
|
+
## Architecture
|
|
135
|
+
|
|
136
|
+
This package uses the standardized Agent-Utilities dynamic facade architecture:
|
|
137
|
+
|
|
138
|
+
```mermaid
|
|
139
|
+
graph TD
|
|
140
|
+
User([User Agent]) --> Server[FastMCP Server]
|
|
141
|
+
Server --> Facade[Api Dynamic Facade]
|
|
142
|
+
Facade --> ClientBase[ApiClientBase]
|
|
143
|
+
Facade --> Auth[Credentials Auth Handler]
|
|
144
|
+
ClientBase --> Service([External Service API])
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
---
|
|
148
|
+
|
|
149
|
+
## Deployment
|
|
150
|
+
|
|
151
|
+
### Bare-Metal (Standard pip)
|
|
152
|
+
1. Set up your Python virtual environment (>= 3.10).
|
|
153
|
+
2. Install the package: `pip install .[all]`
|
|
154
|
+
3. Export credentials:
|
|
155
|
+
```bash
|
|
156
|
+
export TWENTY_URL="http://localhost:3000"
|
|
157
|
+
```
|
|
158
|
+
4. Run: `python -m twenty_mcp.mcp_server`
|
|
159
|
+
|
|
160
|
+
### Container (Docker Compose)
|
|
161
|
+
A standard compose structure is provided inside the `docker/` folder. Build and deploy:
|
|
162
|
+
|
|
163
|
+
```bash
|
|
164
|
+
docker compose -f docker/compose.yml up --build -d
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
---
|
|
168
|
+
|
|
169
|
+
## Contributing
|
|
170
|
+
|
|
171
|
+
Please audit all code changes against ecosystem guidelines in [CONTRIBUTING.md](CONTRIBUTING.md) if available, and run:
|
|
172
|
+
|
|
173
|
+
```bash
|
|
174
|
+
pre-commit run --all-files
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
---
|
|
178
|
+
|
|
179
|
+
## License
|
|
180
|
+
|
|
181
|
+
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for complete details.
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = [ "setuptools>=80.9.0", "wheel",]
|
|
3
|
+
build-backend = "setuptools.build_meta"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "twenty-mcp"
|
|
7
|
+
version = "0.30.0"
|
|
8
|
+
description = "Twenty CRM REST/GraphQL MCP Server for Agentic AI!"
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
classifiers = [ "Development Status :: 4 - Beta", "License :: OSI Approved :: MIT License", "Environment :: Console", "Operating System :: POSIX :: Linux", "Programming Language :: Python :: 3",]
|
|
11
|
+
requires-python = ">=3.11, <3.14"
|
|
12
|
+
dependencies = [ "agent-utilities>=0.45.0",]
|
|
13
|
+
[[project.authors]]
|
|
14
|
+
name = "Audel Rouhi"
|
|
15
|
+
email = "knucklessg1@gmail.com"
|
|
16
|
+
|
|
17
|
+
[project.license]
|
|
18
|
+
text = "MIT"
|
|
19
|
+
|
|
20
|
+
[project.optional-dependencies]
|
|
21
|
+
mcp = [ "agent-utilities[mcp]>=0.45.0",]
|
|
22
|
+
agent = [ "agent-utilities[agent,logfire]>=0.45.0",]
|
|
23
|
+
all = [ "agent-utilities[mcp,agent,logfire]>=0.45.0",]
|
|
24
|
+
test = [ "pytest-xdist>=3.6.0", "pytest", "pytest-asyncio", "pytest-cov",]
|
|
25
|
+
|
|
26
|
+
[project.scripts]
|
|
27
|
+
twenty-mcp = "twenty_mcp.mcp_server:mcp_server"
|
|
28
|
+
twenty-agent = "twenty_mcp.agent_server:agent_server"
|
|
29
|
+
|
|
30
|
+
[tool.setuptools]
|
|
31
|
+
include-package-data = true
|
|
32
|
+
|
|
33
|
+
[tool.ruff]
|
|
34
|
+
line-length = 88
|
|
35
|
+
target-version = "py310"
|
|
36
|
+
|
|
37
|
+
[tool.mypy]
|
|
38
|
+
python_version = "3.10"
|
|
39
|
+
ignore_missing_imports = true
|
|
40
|
+
check_untyped_defs = true
|
|
41
|
+
|
|
42
|
+
[dependency-groups]
|
|
43
|
+
dev = [ "pytest-timeout>=2.4.0",]
|
|
44
|
+
|
|
45
|
+
[tool.setuptools.package-data]
|
|
46
|
+
twenty_mcp = [ "mcp_config.json", "agent_data/**",]
|
|
47
|
+
|
|
48
|
+
[tool.ruff.lint]
|
|
49
|
+
select = [ "E", "F", "I", "UP", "B",]
|
|
50
|
+
ignore = [ "E402", "E501", "B008",]
|
|
51
|
+
|
|
52
|
+
[tool.setuptools.packages.find]
|
|
53
|
+
where = [ ".",]
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import pytest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
@pytest.mark.concept("TWENTY-001")
|
|
5
|
+
def test_api_client_basic_mock(mock_ctx):
|
|
6
|
+
"""CONCEPT:TWENTY-001 Test basic mock initialization of client facade."""
|
|
7
|
+
assert mock_ctx is not None
|
|
8
|
+
assert hasattr(mock_ctx, "info")
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
@pytest.mark.concept("TWENTY-001")
|
|
12
|
+
def test_api_client_endpoints(mock_ctx):
|
|
13
|
+
"""CONCEPT:TWENTY-001 Verify endpoint configuration on dynamic client."""
|
|
14
|
+
from twenty_mcp.auth import get_client
|
|
15
|
+
|
|
16
|
+
client = get_client()
|
|
17
|
+
assert client is not None
|
|
18
|
+
assert hasattr(client, "request")
|