mcp-creatio 0.3.6 → 0.3.7

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.
Files changed (2) hide show
  1. package/README.md +46 -17
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -20,27 +20,29 @@ Model Context Protocol (MCP) server for Creatio (https://www.creatio.com/) - con
20
20
  - **Built-in OAuth server**: Automatic MCP client authentication
21
21
  - **Docker ready**: Multi-arch images available
22
22
 
23
- ## Quick Start
23
+ ## Run Modes
24
24
 
25
- 1. Set environment variables (see below)
26
- 2. Run: `npm start` or use Docker
25
+ This project supports two runtime modes:
27
26
 
28
- ## Command (stdio) mode
27
+ ### 1. CLI Mode (`stdio`)
29
28
 
30
- You can run the server as a command (no separate HTTP `/mcp` endpoint) so MCP clients can connect over stdio directly.
29
+ Use this mode for MCP clients that launch a command directly (VS Code MCP, Claude Desktop, etc.).
31
30
 
32
- ### Direct command
31
+ - No HTTP endpoint needed
32
+ - Easiest local setup
33
+ - Supports Legacy auth and OAuth2 Client Credentials
34
+ - OAuth2 Authorization Code is **not** supported in `stdio` mode
35
+
36
+ Run directly from npm:
33
37
 
34
38
  ```bash
35
39
  npx -y mcp-creatio \
36
40
  --base-url https://your-creatio.com \
37
- --login YourLogin \
38
- --password YourPassword
41
+ --login your_login \
42
+ --password your_password
39
43
  ```
40
44
 
41
- Default transport for CLI is `stdio`.
42
-
43
- ### MCP client config example (command-based)
45
+ VS Code MCP config (command-based):
44
46
 
45
47
  ```json
46
48
  {
@@ -52,18 +54,43 @@ Default transport for CLI is `stdio`.
52
54
  "--base-url",
53
55
  "https://your-creatio.com",
54
56
  "--login",
55
- "YourLogin",
57
+ "your_login",
56
58
  "--password",
57
- "YourPassword"
59
+ "your_password"
58
60
  ]
59
61
  }
60
62
  }
61
63
  ```
62
64
 
63
- ### Local repo (analogue without publishing)
65
+ Local repo command (without publishing):
66
+
67
+ ```bash
68
+ npm run start:stdio -- --base-url https://your-creatio.com --login your_login --password your_password
69
+ ```
70
+
71
+ ### 2. Server Mode (`http`)
72
+
73
+ Use this mode when your client connects by URL (for example `http://localhost:3000/mcp`).
74
+
75
+ - Exposes HTTP endpoint: `/mcp`
76
+ - Required for OAuth2 Authorization Code flow
77
+ - Works well with Docker and remote deployments
78
+
79
+ Start server:
64
80
 
65
81
  ```bash
66
- npm run start:stdio -- --base-url https://your-creatio.com --login YourLogin --password YourPassword
82
+ npm start
83
+ ```
84
+
85
+ Then connect using URL:
86
+
87
+ ```json
88
+ {
89
+ "creatio": {
90
+ "type": "http",
91
+ "url": "http://localhost:3000/mcp"
92
+ }
93
+ }
67
94
  ```
68
95
 
69
96
  ## Configuration
@@ -113,11 +140,13 @@ CREATIO_CODE_REDIRECT_URI=http://localhost:3000/oauth/callback
113
140
  CREATIO_CODE_SCOPE="offline_access ApplicationAccess_yourappguid"
114
141
  ```
115
142
 
116
- **Note**: Currently uses in-memory storage for OAuth tokens. Tokens will be lost on server restart.
143
+ **Note**: Currently uses in-memory storage for OAuth tokens. Tokens will be lost on server restart.
144
+
145
+ **Important**: OAuth2 Authorization Code requires **Server Mode (`http`)**.
117
146
 
118
147
  **Priority**: Authorization Code > Client Credentials > Legacy
119
148
 
120
- ## MCP Client Authentication
149
+ ## MCP Client Authentication (HTTP Mode)
121
150
 
122
151
  The server includes OAuth 2.1 Authorization Server for MCP clients (Claude Desktop, etc.). No additional setup required - clients authenticate automatically through standard OAuth flow.
123
152
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "mcp-creatio",
3
- "version": "0.3.6",
3
+ "version": "0.3.7",
4
4
  "main": "dist/index.js",
5
5
  "bin": {
6
6
  "mcp-creatio": "dist/cli.js"