@efficy/tribecrm-mcp-server 0.2.0 → 0.2.1
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.
- package/README.md +49 -34
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
# TribeCRM MCP Server
|
|
2
2
|
|
|
3
|
+
[](https://www.npmjs.com/package/@efficy/tribecrm-mcp-server)
|
|
3
4
|
[](https://www.typescriptlang.org/)
|
|
4
5
|
[](https://github.com/modelcontextprotocol)
|
|
5
6
|
[](https://opensource.org/licenses/MIT)
|
|
@@ -31,49 +32,47 @@ Model Context Protocol (MCP) server for TribeCRM API integration. This server en
|
|
|
31
32
|
|
|
32
33
|
## 🔧 Installation
|
|
33
34
|
|
|
34
|
-
|
|
35
|
-
npm install
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
## ⚙️ Configuration
|
|
35
|
+
### Option 1: Using npx (Recommended)
|
|
39
36
|
|
|
40
|
-
|
|
41
|
-
```bash
|
|
42
|
-
cp .env.example .env
|
|
43
|
-
```
|
|
37
|
+
No installation required! The server can be run directly using npx.
|
|
44
38
|
|
|
45
|
-
|
|
46
|
-
```env
|
|
47
|
-
TRIBECRM_API_URL=https://api.tribecrm.com
|
|
48
|
-
TRIBECRM_CLIENT_ID=your_client_id_here
|
|
49
|
-
TRIBECRM_CLIENT_SECRET=your_client_secret_here
|
|
50
|
-
TRIBECRM_ORGANIZATION_ID=optional_org_id
|
|
51
|
-
MCP_SERVER_NAME=tribecrm
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
## 🏗️ Building
|
|
39
|
+
### Option 2: Local Development
|
|
55
40
|
|
|
56
41
|
```bash
|
|
42
|
+
git clone https://github.com/efficy-sa/tribecrm-mcp-server.git
|
|
43
|
+
cd tribecrm-mcp-server
|
|
44
|
+
npm install
|
|
57
45
|
npm run build
|
|
58
46
|
```
|
|
59
47
|
|
|
60
|
-
##
|
|
48
|
+
## ⚙️ Configuration
|
|
61
49
|
|
|
62
|
-
###
|
|
50
|
+
### Claude Desktop Configuration
|
|
63
51
|
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
52
|
+
Add to your Claude Desktop config file:
|
|
53
|
+
- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
|
|
54
|
+
- **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
|
|
67
55
|
|
|
68
|
-
|
|
56
|
+
#### Using npx (Recommended)
|
|
69
57
|
|
|
70
|
-
```
|
|
71
|
-
|
|
58
|
+
```json
|
|
59
|
+
{
|
|
60
|
+
"mcpServers": {
|
|
61
|
+
"tribecrm": {
|
|
62
|
+
"command": "npx",
|
|
63
|
+
"args": ["-y", "@efficy/tribecrm-mcp-server"],
|
|
64
|
+
"env": {
|
|
65
|
+
"TRIBECRM_API_URL": "https://api.tribecrm.nl",
|
|
66
|
+
"TRIBECRM_CLIENT_ID": "your_client_id",
|
|
67
|
+
"TRIBECRM_CLIENT_SECRET": "your_client_secret",
|
|
68
|
+
"TRIBECRM_ORGANIZATION_ID": "your_org_id"
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
}
|
|
72
73
|
```
|
|
73
74
|
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
Add to your MCP client settings (e.g., `~/Library/Application Support/Claude/claude_desktop_config.json` for Claude Desktop):
|
|
75
|
+
#### Using Local Installation
|
|
77
76
|
|
|
78
77
|
```json
|
|
79
78
|
{
|
|
@@ -82,15 +81,31 @@ Add to your MCP client settings (e.g., `~/Library/Application Support/Claude/cla
|
|
|
82
81
|
"command": "node",
|
|
83
82
|
"args": ["/absolute/path/to/tribecrm-mcp-server/dist/index.js"],
|
|
84
83
|
"env": {
|
|
85
|
-
"TRIBECRM_API_URL": "https://api.tribecrm.
|
|
84
|
+
"TRIBECRM_API_URL": "https://api.tribecrm.nl",
|
|
86
85
|
"TRIBECRM_CLIENT_ID": "your_client_id",
|
|
87
|
-
"TRIBECRM_CLIENT_SECRET": "your_client_secret"
|
|
86
|
+
"TRIBECRM_CLIENT_SECRET": "your_client_secret",
|
|
87
|
+
"TRIBECRM_ORGANIZATION_ID": "your_org_id"
|
|
88
88
|
}
|
|
89
89
|
}
|
|
90
90
|
}
|
|
91
91
|
}
|
|
92
92
|
```
|
|
93
93
|
|
|
94
|
+
### Getting TribeCRM Credentials
|
|
95
|
+
|
|
96
|
+
1. Log in to your TribeCRM instance
|
|
97
|
+
2. Navigate to Settings > Integrations > OAuth2 Apps
|
|
98
|
+
3. Create a new OAuth2 application with "Service Account" type
|
|
99
|
+
4. Copy the Client ID and Client Secret
|
|
100
|
+
5. Add required scopes: `read write offline`
|
|
101
|
+
|
|
102
|
+
### Environment Variables
|
|
103
|
+
|
|
104
|
+
- `TRIBECRM_API_URL` (required): Your TribeCRM API URL
|
|
105
|
+
- `TRIBECRM_CLIENT_ID` (required): OAuth2 Client ID
|
|
106
|
+
- `TRIBECRM_CLIENT_SECRET` (required): OAuth2 Client Secret
|
|
107
|
+
- `TRIBECRM_ORGANIZATION_ID` (optional): Organization UUID for multi-tenant setups
|
|
108
|
+
|
|
94
109
|
## 📚 Available Tools
|
|
95
110
|
|
|
96
111
|
### Entity Operations
|
|
@@ -284,12 +299,12 @@ MIT License - see LICENSE file for details
|
|
|
284
299
|
|
|
285
300
|
- [TribeCRM](https://tribecrm.com) - Official TribeCRM website
|
|
286
301
|
- [Model Context Protocol](https://modelcontextprotocol.io) - MCP documentation
|
|
287
|
-
- [GitHub Repository](https://github.com/
|
|
302
|
+
- [GitHub Repository](https://github.com/efficy-sa/tribecrm-mcp-server)
|
|
288
303
|
|
|
289
304
|
## 📧 Support
|
|
290
305
|
|
|
291
306
|
For issues and questions:
|
|
292
|
-
- Open an issue on [GitHub](https://github.com/
|
|
307
|
+
- Open an issue on [GitHub](https://github.com/efficy-sa/tribecrm-mcp-server/issues)
|
|
293
308
|
- Check the [Troubleshooting Guide](docs/TROUBLESHOOTING.md)
|
|
294
309
|
|
|
295
310
|
---
|
package/package.json
CHANGED