@mcp-abap-adt/core 7.1.0 → 7.1.3
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/CHANGELOG.md +34 -0
- package/README.md +6 -9
- package/dist/handlers/function_include/high/handleUpdateFunctionInclude.d.ts +6 -0
- package/dist/handlers/function_include/high/handleUpdateFunctionInclude.d.ts.map +1 -1
- package/dist/handlers/function_include/high/handleUpdateFunctionInclude.js +9 -2
- package/dist/handlers/function_include/high/handleUpdateFunctionInclude.js.map +1 -1
- package/dist/lib/config/ServerConfigManager.d.ts.map +1 -1
- package/dist/lib/config/ServerConfigManager.js +10 -2
- package/dist/lib/config/ServerConfigManager.js.map +1 -1
- package/docs/architecture/ARCHITECTURE.md +8 -6
- package/docs/architecture/HANDLER_EXPORTER.md +6 -6
- package/docs/architecture/README.md +1 -1
- package/docs/architecture/TOOLS_ARCHITECTURE.md +13 -4
- package/docs/configuration/YAML_CONFIG.md +7 -23
- package/docs/deployment/GITHUB_ACTIONS.md +2 -2
- package/docs/development/ASSISTANT_GUIDELINES.md +1 -1
- package/docs/development/tests/TESTING_AUTH.md +3 -3
- package/docs/installation/CLINE_CONFIGURATION.md +12 -20
- package/docs/installation/INSTALLATION.md +34 -38
- package/docs/installation/examples/README.md +10 -10
- package/docs/installation/examples/SERVICE_KEY_SETUP.md +3 -3
- package/docs/installation/examples/cline-stdio-npx-config.json +1 -1
- package/docs/installation/platforms/INSTALL_LINUX.md +28 -27
- package/docs/installation/platforms/INSTALL_MACOS.md +27 -26
- package/docs/installation/platforms/INSTALL_WINDOWS.md +27 -26
- package/docs/user-guide/AVAILABLE_TOOLS.md +110 -4
- package/docs/user-guide/AVAILABLE_TOOLS_COMPACT.md +1 -1
- package/docs/user-guide/AVAILABLE_TOOLS_HIGH.md +51 -2
- package/docs/user-guide/AVAILABLE_TOOLS_LEGACY.md +128 -4
- package/docs/user-guide/AVAILABLE_TOOLS_LOW.md +1 -1
- package/docs/user-guide/AVAILABLE_TOOLS_READONLY.md +59 -2
- package/docs/user-guide/CLIENT_CONFIGURATION.md +4 -4
- package/docs/user-guide/CLI_OPTIONS.md +35 -84
- package/docs/user-guide/HANDLERS_MANAGEMENT.md +9 -9
- package/docs/user-guide/README.md +8 -8
- package/package.json +3 -3
|
@@ -18,7 +18,7 @@ After installation, you'll be able to:
|
|
|
18
18
|
## 🔧 Prerequisites
|
|
19
19
|
|
|
20
20
|
All platforms require:
|
|
21
|
-
- **Node.js**
|
|
21
|
+
- **Node.js** 22 or later
|
|
22
22
|
- **npm** (comes with Node.js)
|
|
23
23
|
- **Git**
|
|
24
24
|
- Access to SAP ABAP system (on-premise or BTP)
|
|
@@ -36,14 +36,14 @@ Download and install from a pre-built `.tgz` package:
|
|
|
36
36
|
# Or receive it from your administrator
|
|
37
37
|
|
|
38
38
|
# Install globally (recommended)
|
|
39
|
-
npm install -g ./
|
|
39
|
+
npm install -g ./mcp-abap-adt-core-<version>.tgz
|
|
40
40
|
|
|
41
41
|
# Or install locally in your project
|
|
42
|
-
npm install ./
|
|
42
|
+
npm install ./mcp-abap-adt-core-<version>.tgz
|
|
43
43
|
```
|
|
44
44
|
|
|
45
45
|
After installation, you'll have access to:
|
|
46
|
-
- `mcp-abap-adt` - MCP ABAP ADT Server (default:
|
|
46
|
+
- `mcp-abap-adt` - MCP ABAP ADT Server (default: stdio mode)
|
|
47
47
|
- `mcp-abap-adt --transport=stdio` - stdio transport (for MCP clients)
|
|
48
48
|
- `mcp-abap-adt --transport=http` - HTTP server transport
|
|
49
49
|
- `mcp-abap-adt --transport=sse` - SSE transport
|
|
@@ -90,7 +90,7 @@ mcp-auth auth -k path/to/service-key.json
|
|
|
90
90
|
|
|
91
91
|
**Run the server:**
|
|
92
92
|
```bash
|
|
93
|
-
# Default
|
|
93
|
+
# Default stdio mode (bare command starts stdio; HTTP/SSE require --transport=http/--transport=sse)
|
|
94
94
|
# Note: auth-broker is available for stdio/SSE via `--mcp=<destination>` and for HTTP via destination headers
|
|
95
95
|
mcp-abap-adt
|
|
96
96
|
|
|
@@ -111,7 +111,7 @@ mcp-abap-adt --env-path=/path/to/my.env
|
|
|
111
111
|
mcp-abap-adt --env-path ~/configs/sap-dev.env
|
|
112
112
|
|
|
113
113
|
# Start HTTP server on custom port
|
|
114
|
-
mcp-abap-adt --transport=http --
|
|
114
|
+
mcp-abap-adt --transport=http --port=8080
|
|
115
115
|
```
|
|
116
116
|
|
|
117
117
|
**Environment File Priority:**
|
|
@@ -245,10 +245,10 @@ This project uses **npm workspaces** to manage multiple packages (`@mcp-abap-adt
|
|
|
245
245
|
|
|
246
246
|
### Installing from Pre-built Package
|
|
247
247
|
|
|
248
|
-
The pre-built package (`
|
|
248
|
+
The pre-built package (`mcp-abap-adt-core-<version>.tgz`) contains everything you need to run the server without building from source.
|
|
249
249
|
|
|
250
250
|
#### Prerequisites
|
|
251
|
-
- Node.js
|
|
251
|
+
- Node.js 22 or later
|
|
252
252
|
- npm 9 or later
|
|
253
253
|
|
|
254
254
|
#### Global Installation (Recommended)
|
|
@@ -257,7 +257,7 @@ Install globally to use commands from anywhere:
|
|
|
257
257
|
|
|
258
258
|
```bash
|
|
259
259
|
# Install from local package file
|
|
260
|
-
npm install -g ./
|
|
260
|
+
npm install -g ./mcp-abap-adt-core-<version>.tgz
|
|
261
261
|
|
|
262
262
|
# Verify installation
|
|
263
263
|
mcp-abap-adt --help
|
|
@@ -268,7 +268,7 @@ mcp-abap-adt --transport=sse --help
|
|
|
268
268
|
**Available commands after global installation:**
|
|
269
269
|
|
|
270
270
|
```bash
|
|
271
|
-
# Default
|
|
271
|
+
# Default stdio mode (HTTP/SSE require --transport=http/--transport=sse)
|
|
272
272
|
mcp-abap-adt
|
|
273
273
|
|
|
274
274
|
# Force use of auth-broker (service keys), ignore .env file
|
|
@@ -281,10 +281,10 @@ mcp-abap-adt --transport=stdio
|
|
|
281
281
|
mcp-abap-adt --env-path=/path/to/.env
|
|
282
282
|
|
|
283
283
|
# HTTP server transport
|
|
284
|
-
mcp-abap-adt --transport=http --
|
|
284
|
+
mcp-abap-adt --transport=http --port=3000
|
|
285
285
|
|
|
286
286
|
# SSE transport
|
|
287
|
-
mcp-abap-adt --transport=sse --
|
|
287
|
+
mcp-abap-adt --transport=sse --port=3001
|
|
288
288
|
```
|
|
289
289
|
|
|
290
290
|
**For JWT authentication with service keys**, install separately:
|
|
@@ -302,10 +302,10 @@ Install in your project directory:
|
|
|
302
302
|
cd /path/to/your/project
|
|
303
303
|
|
|
304
304
|
# Install the package
|
|
305
|
-
npm install /path/to/
|
|
305
|
+
npm install /path/to/mcp-abap-adt-core-<version>.tgz
|
|
306
306
|
|
|
307
307
|
# Use via npx
|
|
308
|
-
npx mcp-abap-adt --transport=http --port
|
|
308
|
+
npx mcp-abap-adt --transport=http --port=3000
|
|
309
309
|
```
|
|
310
310
|
|
|
311
311
|
#### Configuration
|
|
@@ -375,7 +375,7 @@ EOF
|
|
|
375
375
|
Or use a custom environment file:
|
|
376
376
|
|
|
377
377
|
```bash
|
|
378
|
-
mcp-abap-adt --transport=http --env-path /path/to/custom/.env --port
|
|
378
|
+
mcp-abap-adt --transport=http --env-path /path/to/custom/.env --port=3000
|
|
379
379
|
```
|
|
380
380
|
|
|
381
381
|
#### Usage Examples
|
|
@@ -387,22 +387,22 @@ mcp-abap-adt --transport=http
|
|
|
387
387
|
|
|
388
388
|
**Example 2: Start HTTP server on custom port**
|
|
389
389
|
```bash
|
|
390
|
-
mcp-abap-adt --transport=http --port
|
|
390
|
+
mcp-abap-adt --transport=http --port=8080
|
|
391
391
|
```
|
|
392
392
|
|
|
393
393
|
**Example 3: Start HTTP server accessible from network**
|
|
394
394
|
```bash
|
|
395
|
-
mcp-abap-adt --transport=http --host
|
|
395
|
+
mcp-abap-adt --transport=http --host=0.0.0.0 --port=3000
|
|
396
396
|
```
|
|
397
397
|
|
|
398
398
|
**Example 4: Use custom environment file**
|
|
399
399
|
```bash
|
|
400
|
-
mcp-abap-adt --transport=http --env-path /opt/config/.env.production --port
|
|
400
|
+
mcp-abap-adt --transport=http --env-path /opt/config/.env.production --port=8080
|
|
401
401
|
```
|
|
402
402
|
|
|
403
403
|
**Example 5: Start SSE server**
|
|
404
404
|
```bash
|
|
405
|
-
mcp-abap-adt --transport=sse --port
|
|
405
|
+
mcp-abap-adt --transport=sse --port=3000
|
|
406
406
|
```
|
|
407
407
|
|
|
408
408
|
#### Command Line Options
|
|
@@ -426,19 +426,16 @@ All server commands (`mcp-abap-adt`, `mcp-abap-adt --transport=http`, `mcp-abap-
|
|
|
426
426
|
- `--transport=<type>` - Transport type: `stdio`, `http`, `streamable-http`, or `sse`
|
|
427
427
|
|
|
428
428
|
**HTTP Server Options (for `mcp-abap-adt --transport=http`):**
|
|
429
|
-
- `--
|
|
430
|
-
- `--
|
|
429
|
+
- `--host=<host>` - Server host (default: 127.0.0.1; use 0.0.0.0 for all interfaces)
|
|
430
|
+
- `--port=<port>` - Server port (default: 3000 for http)
|
|
431
|
+
- `--path=<path>` / `--http-path=<path>` (alias) - HTTP endpoint path (default: /mcp/stream/http)
|
|
431
432
|
- `--http-json-response` - Enable JSON response format
|
|
432
|
-
- `--http-allowed-origins=<list>` - Comma-separated allowed origins for CORS
|
|
433
|
-
- `--http-allowed-hosts=<list>` - Comma-separated allowed hosts
|
|
434
|
-
- `--http-enable-dns-protection` - Enable DNS rebinding protection
|
|
435
433
|
|
|
436
434
|
**SSE Server Options (for `mcp-abap-adt --transport=sse`):**
|
|
437
|
-
- `--
|
|
438
|
-
- `--
|
|
439
|
-
- `--sse-
|
|
440
|
-
- `--
|
|
441
|
-
- `--sse-enable-dns-protection` - Enable DNS rebinding protection
|
|
435
|
+
- `--host=<host>` - Server host (default: 127.0.0.1; use 0.0.0.0 for all interfaces)
|
|
436
|
+
- `--port=<port>` - Server port (default: 3001 for sse)
|
|
437
|
+
- `--sse-path=<path>` - SSE connection path (default: /sse)
|
|
438
|
+
- `--post-path=<path>` - SSE message post path (default: /messages)
|
|
442
439
|
|
|
443
440
|
**Environment Variables:**
|
|
444
441
|
|
|
@@ -491,12 +488,11 @@ mcp-abap-adt --help
|
|
|
491
488
|
# Use custom .env from different location
|
|
492
489
|
mcp-abap-adt --env=~/configs/sap-production.env
|
|
493
490
|
|
|
494
|
-
# Start HTTP server
|
|
495
|
-
mcp-abap-adt --transport=http --
|
|
496
|
-
--http-allowed-origins=http://localhost:3000,https://myapp.com
|
|
491
|
+
# Start HTTP server
|
|
492
|
+
mcp-abap-adt --transport=http --port=8080
|
|
497
493
|
|
|
498
|
-
# Start SSE
|
|
499
|
-
mcp-abap-adt --transport=sse --
|
|
494
|
+
# Start SSE server
|
|
495
|
+
mcp-abap-adt --transport=sse --port=3001
|
|
500
496
|
```
|
|
501
497
|
|
|
502
498
|
**Example 6: Use stdio transport (for MCP clients)**
|
|
@@ -510,10 +506,10 @@ To update to a newer version:
|
|
|
510
506
|
|
|
511
507
|
```bash
|
|
512
508
|
# Uninstall old version
|
|
513
|
-
npm uninstall -g @
|
|
509
|
+
npm uninstall -g @mcp-abap-adt/core
|
|
514
510
|
|
|
515
511
|
# Install new version
|
|
516
|
-
npm install -g ./
|
|
512
|
+
npm install -g ./mcp-abap-adt-core-<version>.tgz
|
|
517
513
|
```
|
|
518
514
|
|
|
519
515
|
#### Troubleshooting Package Installation
|
|
@@ -537,7 +533,7 @@ $env:PATH += ";$(npm config get prefix)"
|
|
|
537
533
|
Solution:
|
|
538
534
|
```bash
|
|
539
535
|
# Use sudo for global installation
|
|
540
|
-
sudo npm install -g ./
|
|
536
|
+
sudo npm install -g ./mcp-abap-adt-core-<version>.tgz
|
|
541
537
|
|
|
542
538
|
# Or configure npm to use a different directory (recommended)
|
|
543
539
|
mkdir ~/.npm-global
|
|
@@ -546,7 +542,7 @@ echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc
|
|
|
546
542
|
source ~/.bashrc
|
|
547
543
|
|
|
548
544
|
# Then install without sudo
|
|
549
|
-
npm install -g ./
|
|
545
|
+
npm install -g ./mcp-abap-adt-core-<version>.tgz
|
|
550
546
|
```
|
|
551
547
|
|
|
552
548
|
---
|
|
@@ -17,7 +17,7 @@ Quick configuration files for connecting Cline to MCP ABAP ADT server.
|
|
|
17
17
|
|
|
18
18
|
### STDIO with Global Install
|
|
19
19
|
**File**: `cline-stdio-global-config.json`
|
|
20
|
-
- Requires: `npm install -g @
|
|
20
|
+
- Requires: `npm install -g @mcp-abap-adt/core`
|
|
21
21
|
- Faster startup than npx
|
|
22
22
|
- Version controlled by you
|
|
23
23
|
|
|
@@ -33,13 +33,13 @@ Quick configuration files for connecting Cline to MCP ABAP ADT server.
|
|
|
33
33
|
1. Start server in separate terminal:
|
|
34
34
|
```bash
|
|
35
35
|
# With NPX (recommended) - uses auth-broker by default
|
|
36
|
-
npx @
|
|
36
|
+
npx @mcp-abap-adt/core --transport=http --port=3000
|
|
37
37
|
|
|
38
38
|
# Or force auth-broker (ignores .env)
|
|
39
|
-
npx @
|
|
39
|
+
npx @mcp-abap-adt/core --transport=http --port=3000 --auth-broker
|
|
40
40
|
|
|
41
41
|
# Or with global install
|
|
42
|
-
mcp-abap-adt --transport=http --
|
|
42
|
+
mcp-abap-adt --transport=http --port=3000
|
|
43
43
|
|
|
44
44
|
# Or local dev
|
|
45
45
|
npm run start:http
|
|
@@ -73,10 +73,10 @@ Use `cline-http-service-key-npx-config.json` for destination-based authenticatio
|
|
|
73
73
|
2. **Start server with auth-broker**:
|
|
74
74
|
```bash
|
|
75
75
|
# With NPX (recommended)
|
|
76
|
-
npx @
|
|
76
|
+
npx @mcp-abap-adt/core --transport=http --port=3000 --auth-broker
|
|
77
77
|
|
|
78
78
|
# Or with global install
|
|
79
|
-
mcp-abap-adt --transport=http --
|
|
79
|
+
mcp-abap-adt --transport=http --port=3000 --auth-broker
|
|
80
80
|
```
|
|
81
81
|
|
|
82
82
|
**Note**:
|
|
@@ -111,10 +111,10 @@ Use `cline-http-service-key-npx-config.json` for destination-based authenticatio
|
|
|
111
111
|
1. Start server in separate terminal:
|
|
112
112
|
```bash
|
|
113
113
|
# With NPX (recommended)
|
|
114
|
-
npx @
|
|
114
|
+
npx @mcp-abap-adt/core --transport=sse --port=3001 --env=/path/to/.env
|
|
115
115
|
|
|
116
116
|
# Or with global install
|
|
117
|
-
mcp-abap-adt --transport=sse --
|
|
117
|
+
mcp-abap-adt --transport=sse --port=3001 --env=/path/to/.env
|
|
118
118
|
|
|
119
119
|
# Or local dev
|
|
120
120
|
npm run start:sse
|
|
@@ -140,7 +140,7 @@ Use `cline-http-service-key-npx-config.json` for destination-based authenticatio
|
|
|
140
140
|
"command": "npx",
|
|
141
141
|
"args": [
|
|
142
142
|
"-y",
|
|
143
|
-
"@
|
|
143
|
+
"@mcp-abap-adt/core",
|
|
144
144
|
"--transport=stdio",
|
|
145
145
|
"--env=/Users/YOUR_USERNAME/.env"
|
|
146
146
|
],
|
|
@@ -159,7 +159,7 @@ Use `cline-http-service-key-npx-config.json` for destination-based authenticatio
|
|
|
159
159
|
"command": "npx",
|
|
160
160
|
"args": [
|
|
161
161
|
"-y",
|
|
162
|
-
"@
|
|
162
|
+
"@mcp-abap-adt/core",
|
|
163
163
|
"--transport=stdio",
|
|
164
164
|
"--env=C:/Users/YOUR_USERNAME/.env"
|
|
165
165
|
],
|
|
@@ -40,13 +40,13 @@ mkdir "%USERPROFILE%\Documents\mcp-abap-adt\service-keys"
|
|
|
40
40
|
|
|
41
41
|
```bash
|
|
42
42
|
# With NPX (recommended)
|
|
43
|
-
npx @
|
|
43
|
+
npx @mcp-abap-adt/core --transport=http --port=3000 --auth-broker
|
|
44
44
|
|
|
45
45
|
# Or with global install
|
|
46
|
-
mcp-abap-adt --transport=http --
|
|
46
|
+
mcp-abap-adt --transport=http --port=3000 --auth-broker
|
|
47
47
|
|
|
48
48
|
# With custom path for service keys and sessions
|
|
49
|
-
mcp-abap-adt --transport=http --
|
|
49
|
+
mcp-abap-adt --transport=http --port=3000 --auth-broker --auth-broker-path=~/prj/tmp/
|
|
50
50
|
```
|
|
51
51
|
|
|
52
52
|
**Why --auth-broker is required:**
|
|
@@ -141,14 +141,14 @@ Install from a pre-built `.tgz` package file:
|
|
|
141
141
|
```bash
|
|
142
142
|
# Download or obtain the package file
|
|
143
143
|
# Then install globally
|
|
144
|
-
npm install -g ./
|
|
144
|
+
npm install -g ./mcp-abap-adt-core-<version>.tgz
|
|
145
145
|
|
|
146
146
|
# Verify installation
|
|
147
147
|
mcp-abap-adt --help
|
|
148
148
|
```
|
|
149
149
|
|
|
150
150
|
**Available commands after installation:**
|
|
151
|
-
- `mcp-abap-adt` -
|
|
151
|
+
- `mcp-abap-adt` - stdio transport (default)
|
|
152
152
|
- `mcp-abap-adt --transport=stdio` - stdio transport (for MCP clients)
|
|
153
153
|
- `mcp-abap-adt --transport=http` - HTTP server transport
|
|
154
154
|
- `mcp-abap-adt --transport=sse` - SSE server transport
|
|
@@ -159,13 +159,13 @@ mcp-abap-adt --help
|
|
|
159
159
|
mcp-abap-adt --transport=http
|
|
160
160
|
|
|
161
161
|
# HTTP server on custom port
|
|
162
|
-
mcp-abap-adt --transport=http --port
|
|
162
|
+
mcp-abap-adt --transport=http --port=8080
|
|
163
163
|
|
|
164
164
|
# SSE server accessible from network
|
|
165
|
-
mcp-abap-adt --transport=sse --host
|
|
165
|
+
mcp-abap-adt --transport=sse --host=0.0.0.0 --port=3000
|
|
166
166
|
|
|
167
167
|
# Use custom .env file
|
|
168
|
-
mcp-abap-adt --transport=http --env /path/to/custom/.env --port
|
|
168
|
+
mcp-abap-adt --transport=http --env /path/to/custom/.env --port=8080
|
|
169
169
|
```
|
|
170
170
|
|
|
171
171
|
**Local Installation (Project-specific):**
|
|
@@ -175,10 +175,10 @@ mcp-abap-adt --transport=http --env /path/to/custom/.env --port 8080
|
|
|
175
175
|
cd /path/to/your/project
|
|
176
176
|
|
|
177
177
|
# Install package locally
|
|
178
|
-
npm install /path/to/
|
|
178
|
+
npm install /path/to/mcp-abap-adt-core-<version>.tgz
|
|
179
179
|
|
|
180
180
|
# Use via npx
|
|
181
|
-
npx mcp-abap-adt --transport=http --port
|
|
181
|
+
npx mcp-abap-adt --transport=http --port=3000
|
|
182
182
|
```
|
|
183
183
|
|
|
184
184
|
**Troubleshooting:**
|
|
@@ -201,7 +201,7 @@ echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc
|
|
|
201
201
|
source ~/.bashrc
|
|
202
202
|
|
|
203
203
|
# Then install without sudo
|
|
204
|
-
npm install -g ./
|
|
204
|
+
npm install -g ./mcp-abap-adt-core-<version>.tgz
|
|
205
205
|
```
|
|
206
206
|
|
|
207
207
|
### Option B: Install from Source (For Development)
|
|
@@ -261,15 +261,15 @@ SAP_TIMEOUT_DEFAULT=45000
|
|
|
261
261
|
|
|
262
262
|
MCP ABAP ADT Server supports two transport protocols:
|
|
263
263
|
|
|
264
|
-
1. **
|
|
265
|
-
2. **
|
|
264
|
+
1. **stdio** (default) - Standard input/output, used by Cline/Cursor (requires .env file)
|
|
265
|
+
2. **http** - HTTP StreamableHTTP transport (requires `--transport=http`), works without .env file
|
|
266
266
|
2. **SSE/HTTP** - Server-Sent Events over HTTP, for web interfaces
|
|
267
267
|
|
|
268
268
|
### Cline (VS Code Extension)
|
|
269
269
|
|
|
270
270
|
Uses **stdio** mode (must be explicitly specified).
|
|
271
271
|
|
|
272
|
-
**⚠️ IMPORTANT:** After global installation (`npm install -g @
|
|
272
|
+
**⚠️ IMPORTANT:** After global installation (`npm install -g @mcp-abap-adt/core`), use the `mcp-abap-adt` command with `--transport=stdio` and `--env` arguments.
|
|
273
273
|
|
|
274
274
|
1. Install Cline extension in VS Code
|
|
275
275
|
2. Open Cline settings (JSON): `Ctrl+Shift+P` → "Preferences: Open User Settings (JSON)"
|
|
@@ -292,7 +292,7 @@ Uses **stdio** mode (must be explicitly specified).
|
|
|
292
292
|
```
|
|
293
293
|
|
|
294
294
|
**Important notes:**
|
|
295
|
-
- `--transport=stdio` is
|
|
295
|
+
- `--transport=stdio` is the default; HTTP/SSE require `--transport=http`/`--transport=sse`
|
|
296
296
|
- `--env` argument is **required** if `.env` file is not in the current working directory
|
|
297
297
|
- If `.env` file is in the current directory, you can omit `--env` argument:
|
|
298
298
|
|
|
@@ -315,7 +315,7 @@ Uses **stdio** mode (must be explicitly specified).
|
|
|
315
315
|
"mcp-abap-adt": {
|
|
316
316
|
"command": "node",
|
|
317
317
|
"args": [
|
|
318
|
-
"/home/your-username/.npm-global/lib/node_modules/@
|
|
318
|
+
"/home/your-username/.npm-global/lib/node_modules/@mcp-abap-adt/core/bin/mcp-abap-adt.js",
|
|
319
319
|
"--transport=stdio",
|
|
320
320
|
"--env=/path/to/your/e19.env"
|
|
321
321
|
]
|
|
@@ -350,29 +350,30 @@ Add to Cursor settings (`~/.cursor/config.json`):
|
|
|
350
350
|
|
|
351
351
|
### HTTP Mode (Streamable HTTP)
|
|
352
352
|
|
|
353
|
-
**⚠️ IMPORTANT:** HTTP mode
|
|
353
|
+
**⚠️ IMPORTANT:** HTTP mode requires `--transport=http` (the default transport is stdio). No `.env` file is required for HTTP mode (connection can be configured via HTTP headers).
|
|
354
354
|
|
|
355
355
|
**Starting HTTP Server:**
|
|
356
356
|
|
|
357
357
|
```bash
|
|
358
|
-
# Start server in HTTP mode (
|
|
359
|
-
mcp-abap-adt
|
|
358
|
+
# Start server in HTTP mode (requires --transport=http)
|
|
359
|
+
mcp-abap-adt --transport=http
|
|
360
360
|
|
|
361
361
|
# Or explicitly specify HTTP mode
|
|
362
362
|
mcp-abap-adt --transport=streamable-http
|
|
363
363
|
|
|
364
364
|
# Or with custom port
|
|
365
|
-
mcp-abap-adt --transport=streamable-http --
|
|
365
|
+
mcp-abap-adt --transport=streamable-http --port=8080
|
|
366
366
|
```
|
|
367
367
|
|
|
368
368
|
**HTTP Server Options:**
|
|
369
|
-
- `--transport=streamable-http` or `--transport=http` - Use HTTP transport (default)
|
|
370
|
-
- `--
|
|
371
|
-
- `--
|
|
369
|
+
- `--transport=streamable-http` or `--transport=http` - Use HTTP transport (stdio is the default)
|
|
370
|
+
- `--host=<host>` - Server host (default: 127.0.0.1; use 0.0.0.0 for all interfaces)
|
|
371
|
+
- `--port=<port>` - Server port (default: 3000 for http)
|
|
372
|
+
- `--path=<path>` (alias `--http-path=<path>`) - HTTP endpoint path (default: /mcp/stream/http)
|
|
372
373
|
|
|
373
374
|
**Example with custom port:**
|
|
374
375
|
```bash
|
|
375
|
-
mcp-abap-adt --transport=streamable-http --
|
|
376
|
+
mcp-abap-adt --transport=streamable-http --port=8080
|
|
376
377
|
```
|
|
377
378
|
|
|
378
379
|
Server will be available at: `http://localhost:8080/mcp/stream/http`
|
|
@@ -415,20 +416,20 @@ mcp-abap-adt --transport=streamable-http --env=/path/to/your/e19.env
|
|
|
415
416
|
mcp-abap-adt --transport=sse --env=/path/to/your/e19.env
|
|
416
417
|
|
|
417
418
|
# Or with custom port
|
|
418
|
-
mcp-abap-adt --transport=sse --
|
|
419
|
+
mcp-abap-adt --transport=sse --port=3001 --env=/path/to/your/e19.env
|
|
419
420
|
```
|
|
420
421
|
|
|
421
422
|
**SSE Server Options:**
|
|
422
423
|
- `--transport=sse` - Use SSE transport
|
|
423
|
-
- `--
|
|
424
|
-
- `--
|
|
425
|
-
- `--sse-
|
|
426
|
-
- `--
|
|
424
|
+
- `--host=<host>` - Server host (default: 127.0.0.1; use 0.0.0.0 for all interfaces)
|
|
425
|
+
- `--port=<port>` - Server port (default: 3001 for sse)
|
|
426
|
+
- `--sse-path=<path>` - SSE connection path (default: /sse)
|
|
427
|
+
- `--post-path=<path>` - SSE message post path (default: /messages)
|
|
427
428
|
- `--env=PATH` - Path to `.env` file (required for SSE mode)
|
|
428
429
|
|
|
429
430
|
**Example with custom port and host:**
|
|
430
431
|
```bash
|
|
431
|
-
mcp-abap-adt --transport=sse --
|
|
432
|
+
mcp-abap-adt --transport=sse --port=4100 --host=127.0.0.1 --env=/path/to/your/e19.env
|
|
432
433
|
```
|
|
433
434
|
|
|
434
435
|
Server will be available at: `http://127.0.0.1:4100/sse`
|
|
@@ -97,14 +97,14 @@ Install from a pre-built `.tgz` package file:
|
|
|
97
97
|
```bash
|
|
98
98
|
# Download or obtain the package file
|
|
99
99
|
# Then install globally
|
|
100
|
-
npm install -g ./
|
|
100
|
+
npm install -g ./mcp-abap-adt-core-<version>.tgz
|
|
101
101
|
|
|
102
102
|
# Verify installation
|
|
103
103
|
mcp-abap-adt --help
|
|
104
104
|
```
|
|
105
105
|
|
|
106
106
|
**Available commands after installation:**
|
|
107
|
-
- `mcp-abap-adt` -
|
|
107
|
+
- `mcp-abap-adt` - stdio transport (default)
|
|
108
108
|
- `mcp-abap-adt --transport=stdio` - stdio transport (for MCP clients)
|
|
109
109
|
- `mcp-abap-adt --transport=http` - HTTP server transport
|
|
110
110
|
- `mcp-abap-adt --transport=sse` - SSE server transport
|
|
@@ -115,13 +115,13 @@ mcp-abap-adt --help
|
|
|
115
115
|
mcp-abap-adt --transport=http
|
|
116
116
|
|
|
117
117
|
# HTTP server on custom port
|
|
118
|
-
mcp-abap-adt --transport=http --port
|
|
118
|
+
mcp-abap-adt --transport=http --port=8080
|
|
119
119
|
|
|
120
120
|
# SSE server accessible from network
|
|
121
|
-
mcp-abap-adt --transport=sse --host
|
|
121
|
+
mcp-abap-adt --transport=sse --host=0.0.0.0 --port=3000
|
|
122
122
|
|
|
123
123
|
# Use custom .env file
|
|
124
|
-
mcp-abap-adt --transport=http --env /path/to/custom/.env --port
|
|
124
|
+
mcp-abap-adt --transport=http --env /path/to/custom/.env --port=8080
|
|
125
125
|
```
|
|
126
126
|
|
|
127
127
|
**Local Installation (Project-specific):**
|
|
@@ -131,10 +131,10 @@ mcp-abap-adt --transport=http --env /path/to/custom/.env --port 8080
|
|
|
131
131
|
cd /path/to/your/project
|
|
132
132
|
|
|
133
133
|
# Install package locally
|
|
134
|
-
npm install /path/to/
|
|
134
|
+
npm install /path/to/mcp-abap-adt-core-<version>.tgz
|
|
135
135
|
|
|
136
136
|
# Use via npx
|
|
137
|
-
npx mcp-abap-adt --transport=http --port
|
|
137
|
+
npx mcp-abap-adt --transport=http --port=3000
|
|
138
138
|
```
|
|
139
139
|
|
|
140
140
|
**Troubleshooting:**
|
|
@@ -206,15 +206,15 @@ SAP_TIMEOUT_DEFAULT=45000
|
|
|
206
206
|
|
|
207
207
|
MCP ABAP ADT Server supports two transport protocols:
|
|
208
208
|
|
|
209
|
-
1. **
|
|
210
|
-
2. **
|
|
209
|
+
1. **stdio** (default) - Standard input/output, used by Cline/Cursor (requires .env file)
|
|
210
|
+
2. **http** - HTTP StreamableHTTP transport (requires `--transport=http`), works without .env file
|
|
211
211
|
2. **SSE/HTTP** - Server-Sent Events over HTTP, for web interfaces
|
|
212
212
|
|
|
213
213
|
### Cline (VS Code Extension)
|
|
214
214
|
|
|
215
215
|
Uses **stdio** mode (must be explicitly specified).
|
|
216
216
|
|
|
217
|
-
**⚠️ IMPORTANT:** After global installation (`npm install -g @
|
|
217
|
+
**⚠️ IMPORTANT:** After global installation (`npm install -g @mcp-abap-adt/core`), use the `mcp-abap-adt` command with `--transport=stdio` and `--env` arguments.
|
|
218
218
|
|
|
219
219
|
1. Install Cline extension in VS Code
|
|
220
220
|
2. Open Cline settings (JSON): `Cmd+Shift+P` → "Preferences: Open User Settings (JSON)"
|
|
@@ -237,7 +237,7 @@ Uses **stdio** mode (must be explicitly specified).
|
|
|
237
237
|
```
|
|
238
238
|
|
|
239
239
|
**Important notes:**
|
|
240
|
-
- `--transport=stdio` is
|
|
240
|
+
- `--transport=stdio` is the default; HTTP/SSE require `--transport=http`/`--transport=sse`
|
|
241
241
|
- `--env` argument is **required** if `.env` file is not in the current working directory
|
|
242
242
|
- If `.env` file is in the current directory, you can omit `--env` argument:
|
|
243
243
|
|
|
@@ -260,7 +260,7 @@ Uses **stdio** mode (must be explicitly specified).
|
|
|
260
260
|
"mcp-abap-adt": {
|
|
261
261
|
"command": "node",
|
|
262
262
|
"args": [
|
|
263
|
-
"/usr/local/lib/node_modules/@
|
|
263
|
+
"/usr/local/lib/node_modules/@mcp-abap-adt/core/bin/mcp-abap-adt.js",
|
|
264
264
|
"--transport=stdio",
|
|
265
265
|
"--env=/path/to/your/e19.env"
|
|
266
266
|
]
|
|
@@ -295,29 +295,30 @@ Add to Cursor settings (`~/.cursor/config.json`):
|
|
|
295
295
|
|
|
296
296
|
### HTTP Mode (Streamable HTTP)
|
|
297
297
|
|
|
298
|
-
**⚠️ IMPORTANT:** HTTP mode
|
|
298
|
+
**⚠️ IMPORTANT:** HTTP mode requires `--transport=http` (the default transport is stdio). No `.env` file is required for HTTP mode (connection can be configured via HTTP headers).
|
|
299
299
|
|
|
300
300
|
**Starting HTTP Server:**
|
|
301
301
|
|
|
302
302
|
```bash
|
|
303
|
-
# Start server in HTTP mode (
|
|
304
|
-
mcp-abap-adt
|
|
303
|
+
# Start server in HTTP mode (requires --transport=http)
|
|
304
|
+
mcp-abap-adt --transport=http
|
|
305
305
|
|
|
306
306
|
# Or explicitly specify HTTP mode
|
|
307
307
|
mcp-abap-adt --transport=streamable-http
|
|
308
308
|
|
|
309
309
|
# Or with custom port
|
|
310
|
-
mcp-abap-adt --transport=streamable-http --
|
|
310
|
+
mcp-abap-adt --transport=streamable-http --port=8080
|
|
311
311
|
```
|
|
312
312
|
|
|
313
313
|
**HTTP Server Options:**
|
|
314
|
-
- `--transport=streamable-http` or `--transport=http` - Use HTTP transport (default)
|
|
315
|
-
- `--
|
|
316
|
-
- `--
|
|
314
|
+
- `--transport=streamable-http` or `--transport=http` - Use HTTP transport (stdio is the default)
|
|
315
|
+
- `--host=<host>` - Server host (default: 127.0.0.1; use 0.0.0.0 for all interfaces)
|
|
316
|
+
- `--port=<port>` - Server port (default: 3000 for http)
|
|
317
|
+
- `--path=<path>` (alias `--http-path=<path>`) - HTTP endpoint path (default: /mcp/stream/http)
|
|
317
318
|
|
|
318
319
|
**Example with custom port:**
|
|
319
320
|
```bash
|
|
320
|
-
mcp-abap-adt --transport=streamable-http --
|
|
321
|
+
mcp-abap-adt --transport=streamable-http --port=8080
|
|
321
322
|
```
|
|
322
323
|
|
|
323
324
|
Server will be available at: `http://localhost:8080/mcp/stream/http`
|
|
@@ -360,20 +361,20 @@ mcp-abap-adt --transport=streamable-http --env=/path/to/your/e19.env
|
|
|
360
361
|
mcp-abap-adt --transport=sse --env=/path/to/your/e19.env
|
|
361
362
|
|
|
362
363
|
# Or with custom port
|
|
363
|
-
mcp-abap-adt --transport=sse --
|
|
364
|
+
mcp-abap-adt --transport=sse --port=3001 --env=/path/to/your/e19.env
|
|
364
365
|
```
|
|
365
366
|
|
|
366
367
|
**SSE Server Options:**
|
|
367
368
|
- `--transport=sse` - Use SSE transport
|
|
368
|
-
- `--
|
|
369
|
-
- `--
|
|
370
|
-
- `--sse-
|
|
371
|
-
- `--
|
|
369
|
+
- `--host=<host>` - Server host (default: 127.0.0.1; use 0.0.0.0 for all interfaces)
|
|
370
|
+
- `--port=<port>` - Server port (default: 3001 for sse)
|
|
371
|
+
- `--sse-path=<path>` - SSE connection path (default: /sse)
|
|
372
|
+
- `--post-path=<path>` - SSE message post path (default: /messages)
|
|
372
373
|
- `--env=PATH` - Path to `.env` file (required for SSE mode)
|
|
373
374
|
|
|
374
375
|
**Example with custom port and host:**
|
|
375
376
|
```bash
|
|
376
|
-
mcp-abap-adt --transport=sse --
|
|
377
|
+
mcp-abap-adt --transport=sse --port=4100 --host=127.0.0.1 --env=/path/to/your/e19.env
|
|
377
378
|
```
|
|
378
379
|
|
|
379
380
|
Server will be available at: `http://127.0.0.1:4100/sse`
|