@mcp-abap-adt/core 7.1.1 → 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 +28 -0
- package/README.md +6 -9
- 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
|
@@ -90,14 +90,14 @@ Install from a pre-built `.tgz` package file:
|
|
|
90
90
|
```powershell
|
|
91
91
|
# Download or obtain the package file
|
|
92
92
|
# Then install globally
|
|
93
|
-
npm install -g .\
|
|
93
|
+
npm install -g .\mcp-abap-adt-core-<version>.tgz
|
|
94
94
|
|
|
95
95
|
# Verify installation
|
|
96
96
|
mcp-abap-adt --help
|
|
97
97
|
```
|
|
98
98
|
|
|
99
99
|
**Available commands after installation:**
|
|
100
|
-
- `mcp-abap-adt` -
|
|
100
|
+
- `mcp-abap-adt` - stdio transport (default)
|
|
101
101
|
- `mcp-abap-adt --transport=stdio` - stdio transport (for MCP clients)
|
|
102
102
|
- `mcp-abap-adt --transport=http` - HTTP server transport
|
|
103
103
|
- `mcp-abap-adt --transport=sse` - SSE server transport
|
|
@@ -108,13 +108,13 @@ mcp-abap-adt --help
|
|
|
108
108
|
mcp-abap-adt --transport=http
|
|
109
109
|
|
|
110
110
|
# HTTP server on custom port
|
|
111
|
-
mcp-abap-adt --transport=http --port
|
|
111
|
+
mcp-abap-adt --transport=http --port=8080
|
|
112
112
|
|
|
113
113
|
# SSE server accessible from network
|
|
114
|
-
mcp-abap-adt --transport=sse --host
|
|
114
|
+
mcp-abap-adt --transport=sse --host=0.0.0.0 --port=3000
|
|
115
115
|
|
|
116
116
|
# Use custom .env file
|
|
117
|
-
mcp-abap-adt --transport=http --env C:\path\to\custom\.env --port
|
|
117
|
+
mcp-abap-adt --transport=http --env C:\path\to\custom\.env --port=8080
|
|
118
118
|
```
|
|
119
119
|
|
|
120
120
|
**Local Installation (Project-specific):**
|
|
@@ -124,10 +124,10 @@ mcp-abap-adt --transport=http --env C:\path\to\custom\.env --port 8080
|
|
|
124
124
|
cd C:\path\to\your\project
|
|
125
125
|
|
|
126
126
|
# Install package locally
|
|
127
|
-
npm install C:\path\to\
|
|
127
|
+
npm install C:\path\to\mcp-abap-adt-core-<version>.tgz
|
|
128
128
|
|
|
129
129
|
# Use via npx
|
|
130
|
-
npx mcp-abap-adt --transport=http --port
|
|
130
|
+
npx mcp-abap-adt --transport=http --port=3000
|
|
131
131
|
```
|
|
132
132
|
|
|
133
133
|
**Troubleshooting:**
|
|
@@ -195,15 +195,15 @@ notepad .env
|
|
|
195
195
|
|
|
196
196
|
MCP ABAP ADT Server supports two transport protocols:
|
|
197
197
|
|
|
198
|
-
1. **
|
|
199
|
-
2. **
|
|
198
|
+
1. **stdio** (default) - Standard input/output, used by Cline/Cursor (requires .env file)
|
|
199
|
+
2. **http** - HTTP StreamableHTTP transport (requires `--transport=http`), works without .env file
|
|
200
200
|
2. **SSE/HTTP** - Server-Sent Events over HTTP, for web interfaces
|
|
201
201
|
|
|
202
202
|
### Cline (VS Code Extension)
|
|
203
203
|
|
|
204
204
|
Uses **stdio** mode (must be explicitly specified).
|
|
205
205
|
|
|
206
|
-
**⚠️ IMPORTANT:** After global installation (`npm install -g @
|
|
206
|
+
**⚠️ IMPORTANT:** After global installation (`npm install -g @mcp-abap-adt/core`), use the `mcp-abap-adt` command with `--transport=stdio` and `--env` arguments.
|
|
207
207
|
|
|
208
208
|
1. Install Cline extension in VS Code
|
|
209
209
|
2. Open Cline settings (JSON): `Ctrl+Shift+P` → "Preferences: Open User Settings (JSON)"
|
|
@@ -227,7 +227,7 @@ Uses **stdio** mode (must be explicitly specified).
|
|
|
227
227
|
|
|
228
228
|
**Important notes for Windows:**
|
|
229
229
|
- Use double backslashes `\\` or forward slashes `/` in file paths
|
|
230
|
-
- `--transport=stdio` is
|
|
230
|
+
- `--transport=stdio` is the default; HTTP/SSE require `--transport=http`/`--transport=sse`
|
|
231
231
|
- `--env` argument is **required** if `.env` file is not in the current working directory
|
|
232
232
|
- If `.env` file is in the current directory, you can omit `--env` argument:
|
|
233
233
|
|
|
@@ -250,7 +250,7 @@ Uses **stdio** mode (must be explicitly specified).
|
|
|
250
250
|
"mcp-abap-adt": {
|
|
251
251
|
"command": "node",
|
|
252
252
|
"args": [
|
|
253
|
-
"C:\\Users\\YourUsername\\AppData\\Roaming\\npm\\node_modules\\@
|
|
253
|
+
"C:\\Users\\YourUsername\\AppData\\Roaming\\npm\\node_modules\\@mcp-abap-adt\\core\\bin\\mcp-abap-adt.js",
|
|
254
254
|
"--transport=stdio",
|
|
255
255
|
"--env=C:\\path\\to\\your\\e19.env"
|
|
256
256
|
]
|
|
@@ -304,29 +304,30 @@ Add to Cursor settings:
|
|
|
304
304
|
|
|
305
305
|
### HTTP Mode (Streamable HTTP)
|
|
306
306
|
|
|
307
|
-
**⚠️ IMPORTANT:** HTTP mode
|
|
307
|
+
**⚠️ 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).
|
|
308
308
|
|
|
309
309
|
**Starting HTTP Server:**
|
|
310
310
|
|
|
311
311
|
```powershell
|
|
312
|
-
# Start server in HTTP mode (
|
|
313
|
-
mcp-abap-adt
|
|
312
|
+
# Start server in HTTP mode (requires --transport=http)
|
|
313
|
+
mcp-abap-adt --transport=http
|
|
314
314
|
|
|
315
315
|
# Or explicitly specify HTTP mode
|
|
316
316
|
mcp-abap-adt --transport=streamable-http
|
|
317
317
|
|
|
318
318
|
# Or with custom port
|
|
319
|
-
mcp-abap-adt --transport=streamable-http --
|
|
319
|
+
mcp-abap-adt --transport=streamable-http --port=8080
|
|
320
320
|
```
|
|
321
321
|
|
|
322
322
|
**HTTP Server Options:**
|
|
323
|
-
- `--transport=streamable-http` or `--transport=http` - Use HTTP transport (default)
|
|
324
|
-
- `--
|
|
325
|
-
- `--
|
|
323
|
+
- `--transport=streamable-http` or `--transport=http` - Use HTTP transport (stdio is the default)
|
|
324
|
+
- `--host=<host>` - Server host (default: 127.0.0.1; use 0.0.0.0 for all interfaces)
|
|
325
|
+
- `--port=<port>` - Server port (default: 3000 for http)
|
|
326
|
+
- `--path=<path>` (alias `--http-path=<path>`) - HTTP endpoint path (default: /mcp/stream/http)
|
|
326
327
|
|
|
327
328
|
**Example with custom port:**
|
|
328
329
|
```powershell
|
|
329
|
-
mcp-abap-adt --transport=streamable-http --
|
|
330
|
+
mcp-abap-adt --transport=streamable-http --port=8080
|
|
330
331
|
```
|
|
331
332
|
|
|
332
333
|
Server will be available at: `http://localhost:8080/mcp/stream/http`
|
|
@@ -369,20 +370,20 @@ mcp-abap-adt --transport=streamable-http --env=C:\\path\\to\\your\\e19.env
|
|
|
369
370
|
mcp-abap-adt --transport=sse --env=C:\\path\\to\\your\\e19.env
|
|
370
371
|
|
|
371
372
|
# Or with custom port
|
|
372
|
-
mcp-abap-adt --transport=sse --
|
|
373
|
+
mcp-abap-adt --transport=sse --port=3001 --env=C:\\path\\to\\your\\e19.env
|
|
373
374
|
```
|
|
374
375
|
|
|
375
376
|
**SSE Server Options:**
|
|
376
377
|
- `--transport=sse` - Use SSE transport
|
|
377
|
-
- `--
|
|
378
|
-
- `--
|
|
379
|
-
- `--sse-
|
|
380
|
-
- `--
|
|
378
|
+
- `--host=<host>` - Server host (default: 127.0.0.1; use 0.0.0.0 for all interfaces)
|
|
379
|
+
- `--port=<port>` - Server port (default: 3001 for sse)
|
|
380
|
+
- `--sse-path=<path>` - SSE connection path (default: /sse)
|
|
381
|
+
- `--post-path=<path>` - SSE message post path (default: /messages)
|
|
381
382
|
- `--env=PATH` - Path to `.env` file (required for SSE mode)
|
|
382
383
|
|
|
383
384
|
**Example with custom port and host:**
|
|
384
385
|
```powershell
|
|
385
|
-
mcp-abap-adt --transport=sse --
|
|
386
|
+
mcp-abap-adt --transport=sse --port=4100 --host=127.0.0.1 --env=C:\\path\\to\\your\\e19.env
|
|
386
387
|
```
|
|
387
388
|
|
|
388
389
|
Server will be available at: `http://127.0.0.1:4100/sse`
|
|
@@ -4,9 +4,9 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
4
4
|
|
|
5
5
|
## Summary
|
|
6
6
|
|
|
7
|
-
- Total tools:
|
|
8
|
-
- Read-only tools:
|
|
9
|
-
- High-level tools:
|
|
7
|
+
- Total tools: 313
|
|
8
|
+
- Read-only tools: 59
|
|
9
|
+
- High-level tools: 130
|
|
10
10
|
- Low-level tools: 124
|
|
11
11
|
|
|
12
12
|
- Compact tools: 22 (included in High-level group)
|
|
@@ -38,6 +38,10 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
38
38
|
- [GetEnhancementSpot](#getenhancementspot-read-only-enhancement)
|
|
39
39
|
- [Function Group](#read-only-function-group)
|
|
40
40
|
- [ReadFunctionGroup](#readfunctiongroup-read-only-function-group)
|
|
41
|
+
- [Function Include](#read-only-function-include)
|
|
42
|
+
- [ListFunctionGroupIncludes](#listfunctiongroupincludes-read-only-function-include)
|
|
43
|
+
- [ListFunctionModules](#listfunctionmodules-read-only-function-include)
|
|
44
|
+
- [ReadFunctionInclude](#readfunctioninclude-read-only-function-include)
|
|
41
45
|
- [Function Module](#read-only-function-module)
|
|
42
46
|
- [ReadFunctionModule](#readfunctionmodule-read-only-function-module)
|
|
43
47
|
- [Include](#read-only-include)
|
|
@@ -61,6 +65,7 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
61
65
|
- [Service Definition](#read-only-service-definition)
|
|
62
66
|
- [ReadServiceDefinition](#readservicedefinition-read-only-service-definition)
|
|
63
67
|
- [Structure](#read-only-structure)
|
|
68
|
+
- [GetStructuresList](#getstructureslist-read-only-structure)
|
|
64
69
|
- [ReadStructure](#readstructure-read-only-structure)
|
|
65
70
|
- [System](#read-only-system)
|
|
66
71
|
- [DescribeByList](#describebylist-read-only-system)
|
|
@@ -179,6 +184,10 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
179
184
|
- [Function Group](#high-level-function-group)
|
|
180
185
|
- [DeleteFunctionGroup](#deletefunctiongroup-high-level-function-group)
|
|
181
186
|
- [GetFunctionGroup](#getfunctiongroup-high-level-function-group)
|
|
187
|
+
- [Function Include](#high-level-function-include)
|
|
188
|
+
- [CreateFunctionInclude](#createfunctioninclude-high-level-function-include)
|
|
189
|
+
- [DeleteFunctionInclude](#deletefunctioninclude-high-level-function-include)
|
|
190
|
+
- [UpdateFunctionInclude](#updatefunctioninclude-high-level-function-include)
|
|
182
191
|
- [Function Module](#high-level-function-module)
|
|
183
192
|
- [DeleteFunctionModule](#deletefunctionmodule-high-level-function-module)
|
|
184
193
|
- [GetFunctionModule](#getfunctionmodule-high-level-function-module)
|
|
@@ -526,6 +535,44 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
526
535
|
|
|
527
536
|
---
|
|
528
537
|
|
|
538
|
+
<a id="read-only-function-include"></a>
|
|
539
|
+
### Read-Only / Function Include
|
|
540
|
+
|
|
541
|
+
<a id="listfunctiongroupincludes-read-only-function-include"></a>
|
|
542
|
+
#### ListFunctionGroupIncludes (Read-Only / Function Include)
|
|
543
|
+
**Description:** [read-only] List the includes (TOP, custom) of an ABAP function group.
|
|
544
|
+
|
|
545
|
+
**Source:** `src/handlers/function_include/readonly/handleListFunctionGroupIncludes.ts`
|
|
546
|
+
|
|
547
|
+
**Parameters:**
|
|
548
|
+
- `function_group_name` (string, required) - Function group name (e.g., Z_MY_FG).
|
|
549
|
+
|
|
550
|
+
---
|
|
551
|
+
|
|
552
|
+
<a id="listfunctionmodules-read-only-function-include"></a>
|
|
553
|
+
#### ListFunctionModules (Read-Only / Function Include)
|
|
554
|
+
**Description:** [read-only] List the function modules of an ABAP function group.
|
|
555
|
+
|
|
556
|
+
**Source:** `src/handlers/function_include/readonly/handleListFunctionModules.ts`
|
|
557
|
+
|
|
558
|
+
**Parameters:**
|
|
559
|
+
- `function_group_name` (string, required) - Function group name (e.g., Z_MY_FG).
|
|
560
|
+
|
|
561
|
+
---
|
|
562
|
+
|
|
563
|
+
<a id="readfunctioninclude-read-only-function-include"></a>
|
|
564
|
+
#### ReadFunctionInclude (Read-Only / Function Include)
|
|
565
|
+
**Description:** [read-only] Read ABAP function group include source code and metadata. Answers: "show function group include code", "display include source", "view include of function group". Returns source code and include metadata.
|
|
566
|
+
|
|
567
|
+
**Source:** `src/handlers/function_include/readonly/handleReadFunctionInclude.ts`
|
|
568
|
+
|
|
569
|
+
**Parameters:**
|
|
570
|
+
- `function_group_name` (string, required) - Function group name containing the include (e.g., Z_MY_FG).
|
|
571
|
+
- `include_name` (string, required) - Include name (e.g., LZ_MY_FGTOP, LZ_MY_FGU01).
|
|
572
|
+
- `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive".
|
|
573
|
+
|
|
574
|
+
---
|
|
575
|
+
|
|
529
576
|
<a id="read-only-function-module"></a>
|
|
530
577
|
### Read-Only / Function Module
|
|
531
578
|
|
|
@@ -719,6 +766,20 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
719
766
|
<a id="read-only-structure"></a>
|
|
720
767
|
### Read-Only / Structure
|
|
721
768
|
|
|
769
|
+
<a id="getstructureslist-read-only-structure"></a>
|
|
770
|
+
#### GetStructuresList (Read-Only / Structure)
|
|
771
|
+
**Description:** [read-only] Recursively list the structures embedded in an ABAP structure (.INCLUDE / append), as a tree.
|
|
772
|
+
|
|
773
|
+
**Source:** `src/handlers/structure/readonly/handleGetStructuresList.ts`
|
|
774
|
+
|
|
775
|
+
**Parameters:**
|
|
776
|
+
- `include_extensions` (boolean, optional (default: true)) - [read-only] Also find extension (append) structures via where-used (objects that `extend type <this> with …`). Default true. Set false to skip the (slower) where-used lookups and return includes only.
|
|
777
|
+
- `structure_name` (string, required) - Structure name (e.g., Z_MY_STRUCTURE).
|
|
778
|
+
- `timeout` (number, optional) - [read-only] Timeout in ms for each ADT request.
|
|
779
|
+
- `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive".
|
|
780
|
+
|
|
781
|
+
---
|
|
782
|
+
|
|
722
783
|
<a id="readstructure-read-only-structure"></a>
|
|
723
784
|
#### ReadStructure (Read-Only / Structure)
|
|
724
785
|
**Description:** Operation: Read, Create, Update. Subject: Structure. Will be useful for reading, creating, or updating structure. [read-only] Read ABAP structure definition and metadata. Answers: "show structure fields", "display structure X", "view structure definition", "get structure components". Returns field list, package, responsible, description.
|
|
@@ -2310,6 +2371,51 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
2310
2371
|
|
|
2311
2372
|
---
|
|
2312
2373
|
|
|
2374
|
+
<a id="high-level-function-include"></a>
|
|
2375
|
+
### High-Level / Function Include
|
|
2376
|
+
|
|
2377
|
+
<a id="createfunctioninclude-high-level-function-include"></a>
|
|
2378
|
+
#### CreateFunctionInclude (High-Level / Function Include)
|
|
2379
|
+
**Description:** Operation: Create. Subject: FunctionInclude. Will be useful for creating function group include. Create a new ABAP include within an existing function group. Creates the include in initial state.
|
|
2380
|
+
|
|
2381
|
+
**Source:** `src/handlers/function_include/high/handleCreateFunctionInclude.ts`
|
|
2382
|
+
|
|
2383
|
+
**Parameters:**
|
|
2384
|
+
- `description` (string, optional) - Optional description for the include
|
|
2385
|
+
- `function_group_name` (string, required) - Parent function group name (e.g., ZTEST_FG_001)
|
|
2386
|
+
- `include_name` (string, required) - Include name (e.g., LZTEST_FG_001F01).
|
|
2387
|
+
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable packages.
|
|
2388
|
+
|
|
2389
|
+
---
|
|
2390
|
+
|
|
2391
|
+
<a id="deletefunctioninclude-high-level-function-include"></a>
|
|
2392
|
+
#### DeleteFunctionInclude (High-Level / Function Include)
|
|
2393
|
+
**Description:** Delete an ABAP function group include from the SAP system. Note: function module includes must be deleted via the Function Builder; the backend rejects such deletions. Transport request optional for $TMP objects.
|
|
2394
|
+
|
|
2395
|
+
**Source:** `src/handlers/function_include/high/handleDeleteFunctionInclude.ts`
|
|
2396
|
+
|
|
2397
|
+
**Parameters:**
|
|
2398
|
+
- `function_group_name` (string, required) - Function group name containing the include (e.g., Z_MY_FG).
|
|
2399
|
+
- `include_name` (string, required) - Include name (e.g., LZ_MY_FGF01).
|
|
2400
|
+
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable objects. Optional for local objects ($TMP).
|
|
2401
|
+
|
|
2402
|
+
---
|
|
2403
|
+
|
|
2404
|
+
<a id="updatefunctioninclude-high-level-function-include"></a>
|
|
2405
|
+
#### UpdateFunctionInclude (High-Level / Function Include)
|
|
2406
|
+
**Description:** Operation: Update. Subject: FunctionInclude. Will be useful for updating a function group include. Update source code of an existing ABAP function group include.
|
|
2407
|
+
|
|
2408
|
+
**Source:** `src/handlers/function_include/high/handleUpdateFunctionInclude.ts`
|
|
2409
|
+
|
|
2410
|
+
**Parameters:**
|
|
2411
|
+
- `activate` (boolean, optional (default: false)) - Activate the include after the source update. Default: false. Set true to make the updated source the active version immediately.
|
|
2412
|
+
- `function_group_name` (string, required) - Function group name containing the include (e.g., ZOK_FG_MCP01).
|
|
2413
|
+
- `include_name` (string, required) - Include name (e.g., LZOK_FG_MCP01F01). Include must already exist.
|
|
2414
|
+
- `source_code` (string, required) - Complete ABAP include source code.
|
|
2415
|
+
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable includes.
|
|
2416
|
+
|
|
2417
|
+
---
|
|
2418
|
+
|
|
2313
2419
|
<a id="high-level-function-module"></a>
|
|
2314
2420
|
### High-Level / Function Module
|
|
2315
2421
|
|
|
@@ -4935,4 +5041,4 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
4935
5041
|
|
|
4936
5042
|
---
|
|
4937
5043
|
|
|
4938
|
-
*Last updated: 2026-
|
|
5044
|
+
*Last updated: 2026-06-20*
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
Generated from code in `src/handlers/**` (not from docs).
|
|
4
4
|
|
|
5
5
|
- Level: High-Level
|
|
6
|
-
- Total tools:
|
|
6
|
+
- Total tools: 130
|
|
7
7
|
|
|
8
8
|
## Navigation
|
|
9
9
|
|
|
@@ -88,6 +88,10 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
88
88
|
- [Function Group](#high-level-function-group)
|
|
89
89
|
- [DeleteFunctionGroup](#deletefunctiongroup-high-level-function-group)
|
|
90
90
|
- [GetFunctionGroup](#getfunctiongroup-high-level-function-group)
|
|
91
|
+
- [Function Include](#high-level-function-include)
|
|
92
|
+
- [CreateFunctionInclude](#createfunctioninclude-high-level-function-include)
|
|
93
|
+
- [DeleteFunctionInclude](#deletefunctioninclude-high-level-function-include)
|
|
94
|
+
- [UpdateFunctionInclude](#updatefunctioninclude-high-level-function-include)
|
|
91
95
|
- [Function Module](#high-level-function-module)
|
|
92
96
|
- [DeleteFunctionModule](#deletefunctionmodule-high-level-function-module)
|
|
93
97
|
- [GetFunctionModule](#getfunctionmodule-high-level-function-module)
|
|
@@ -1263,6 +1267,51 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
1263
1267
|
|
|
1264
1268
|
---
|
|
1265
1269
|
|
|
1270
|
+
<a id="high-level-function-include"></a>
|
|
1271
|
+
### High-Level / Function Include
|
|
1272
|
+
|
|
1273
|
+
<a id="createfunctioninclude-high-level-function-include"></a>
|
|
1274
|
+
#### CreateFunctionInclude (High-Level / Function Include)
|
|
1275
|
+
**Description:** Operation: Create. Subject: FunctionInclude. Will be useful for creating function group include. Create a new ABAP include within an existing function group. Creates the include in initial state.
|
|
1276
|
+
|
|
1277
|
+
**Source:** `src/handlers/function_include/high/handleCreateFunctionInclude.ts`
|
|
1278
|
+
|
|
1279
|
+
**Parameters:**
|
|
1280
|
+
- `description` (string, optional) - Optional description for the include
|
|
1281
|
+
- `function_group_name` (string, required) - Parent function group name (e.g., ZTEST_FG_001)
|
|
1282
|
+
- `include_name` (string, required) - Include name (e.g., LZTEST_FG_001F01).
|
|
1283
|
+
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable packages.
|
|
1284
|
+
|
|
1285
|
+
---
|
|
1286
|
+
|
|
1287
|
+
<a id="deletefunctioninclude-high-level-function-include"></a>
|
|
1288
|
+
#### DeleteFunctionInclude (High-Level / Function Include)
|
|
1289
|
+
**Description:** Delete an ABAP function group include from the SAP system. Note: function module includes must be deleted via the Function Builder; the backend rejects such deletions. Transport request optional for $TMP objects.
|
|
1290
|
+
|
|
1291
|
+
**Source:** `src/handlers/function_include/high/handleDeleteFunctionInclude.ts`
|
|
1292
|
+
|
|
1293
|
+
**Parameters:**
|
|
1294
|
+
- `function_group_name` (string, required) - Function group name containing the include (e.g., Z_MY_FG).
|
|
1295
|
+
- `include_name` (string, required) - Include name (e.g., LZ_MY_FGF01).
|
|
1296
|
+
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable objects. Optional for local objects ($TMP).
|
|
1297
|
+
|
|
1298
|
+
---
|
|
1299
|
+
|
|
1300
|
+
<a id="updatefunctioninclude-high-level-function-include"></a>
|
|
1301
|
+
#### UpdateFunctionInclude (High-Level / Function Include)
|
|
1302
|
+
**Description:** Operation: Update. Subject: FunctionInclude. Will be useful for updating a function group include. Update source code of an existing ABAP function group include.
|
|
1303
|
+
|
|
1304
|
+
**Source:** `src/handlers/function_include/high/handleUpdateFunctionInclude.ts`
|
|
1305
|
+
|
|
1306
|
+
**Parameters:**
|
|
1307
|
+
- `activate` (boolean, optional (default: false)) - Activate the include after the source update. Default: false. Set true to make the updated source the active version immediately.
|
|
1308
|
+
- `function_group_name` (string, required) - Function group name containing the include (e.g., ZOK_FG_MCP01).
|
|
1309
|
+
- `include_name` (string, required) - Include name (e.g., LZOK_FG_MCP01F01). Include must already exist.
|
|
1310
|
+
- `source_code` (string, required) - Complete ABAP include source code.
|
|
1311
|
+
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable includes.
|
|
1312
|
+
|
|
1313
|
+
---
|
|
1314
|
+
|
|
1266
1315
|
<a id="high-level-function-module"></a>
|
|
1267
1316
|
### High-Level / Function Module
|
|
1268
1317
|
|
|
@@ -2049,4 +2098,4 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
2049
2098
|
|
|
2050
2099
|
---
|
|
2051
2100
|
|
|
2052
|
-
*Last updated: 2026-
|
|
2101
|
+
*Last updated: 2026-06-20*
|
|
@@ -5,9 +5,9 @@ Generated from code in `src/handlers/**` (not from docs).
|
|
|
5
5
|
Tools available on legacy SAP systems (BASIS < 7.50).
|
|
6
6
|
Legacy systems support a subset of tools — primarily Class, Interface, View, Program, Function Group/Module, Package (read/update/delete), Include, Unit Test, and common utilities.
|
|
7
7
|
|
|
8
|
-
- Total tools:
|
|
9
|
-
- Read-Only:
|
|
10
|
-
- High-Level:
|
|
8
|
+
- Total tools: 141
|
|
9
|
+
- Read-Only: 15
|
|
10
|
+
- High-Level: 65
|
|
11
11
|
- Low-Level: 61
|
|
12
12
|
|
|
13
13
|
## Navigation
|
|
@@ -17,6 +17,10 @@ Legacy systems support a subset of tools — primarily Class, Interface, View, P
|
|
|
17
17
|
- [ReadClass](#readclass-read-only-class)
|
|
18
18
|
- [Function Group](#read-only-function-group)
|
|
19
19
|
- [ReadFunctionGroup](#readfunctiongroup-read-only-function-group)
|
|
20
|
+
- [Function Include](#read-only-function-include)
|
|
21
|
+
- [ListFunctionGroupIncludes](#listfunctiongroupincludes-read-only-function-include)
|
|
22
|
+
- [ListFunctionModules](#listfunctionmodules-read-only-function-include)
|
|
23
|
+
- [ReadFunctionInclude](#readfunctioninclude-read-only-function-include)
|
|
20
24
|
- [Function Module](#read-only-function-module)
|
|
21
25
|
- [ReadFunctionModule](#readfunctionmodule-read-only-function-module)
|
|
22
26
|
- [Include](#read-only-include)
|
|
@@ -29,6 +33,8 @@ Legacy systems support a subset of tools — primarily Class, Interface, View, P
|
|
|
29
33
|
- [ReadPackage](#readpackage-read-only-package)
|
|
30
34
|
- [Program](#read-only-program)
|
|
31
35
|
- [ReadProgram](#readprogram-read-only-program)
|
|
36
|
+
- [Structure](#read-only-structure)
|
|
37
|
+
- [GetStructuresList](#getstructureslist-read-only-structure)
|
|
32
38
|
- [System](#read-only-system)
|
|
33
39
|
- [SearchSource](#searchsource-read-only-system)
|
|
34
40
|
- [View](#read-only-view)
|
|
@@ -69,6 +75,10 @@ Legacy systems support a subset of tools — primarily Class, Interface, View, P
|
|
|
69
75
|
- [Function Group](#high-level-function-group)
|
|
70
76
|
- [DeleteFunctionGroup](#deletefunctiongroup-high-level-function-group)
|
|
71
77
|
- [GetFunctionGroup](#getfunctiongroup-high-level-function-group)
|
|
78
|
+
- [Function Include](#high-level-function-include)
|
|
79
|
+
- [CreateFunctionInclude](#createfunctioninclude-high-level-function-include)
|
|
80
|
+
- [DeleteFunctionInclude](#deletefunctioninclude-high-level-function-include)
|
|
81
|
+
- [UpdateFunctionInclude](#updatefunctioninclude-high-level-function-include)
|
|
72
82
|
- [Function Module](#high-level-function-module)
|
|
73
83
|
- [DeleteFunctionModule](#deletefunctionmodule-high-level-function-module)
|
|
74
84
|
- [GetFunctionModule](#getfunctionmodule-high-level-function-module)
|
|
@@ -216,6 +226,50 @@ Legacy systems support a subset of tools — primarily Class, Interface, View, P
|
|
|
216
226
|
|
|
217
227
|
---
|
|
218
228
|
|
|
229
|
+
<a id="read-only-function-include"></a>
|
|
230
|
+
### Read-Only / Function Include
|
|
231
|
+
|
|
232
|
+
<a id="listfunctiongroupincludes-read-only-function-include"></a>
|
|
233
|
+
#### ListFunctionGroupIncludes (Read-Only / Function Include)
|
|
234
|
+
**Description:** [read-only] List the includes (TOP, custom) of an ABAP function group.
|
|
235
|
+
|
|
236
|
+
**Source:** `src/handlers/function_include/readonly/handleListFunctionGroupIncludes.ts`
|
|
237
|
+
|
|
238
|
+
**Available in:** `onprem`, `cloud`, `legacy`
|
|
239
|
+
|
|
240
|
+
**Parameters:**
|
|
241
|
+
- `function_group_name` (string, required) - Function group name (e.g., Z_MY_FG).
|
|
242
|
+
|
|
243
|
+
---
|
|
244
|
+
|
|
245
|
+
<a id="listfunctionmodules-read-only-function-include"></a>
|
|
246
|
+
#### ListFunctionModules (Read-Only / Function Include)
|
|
247
|
+
**Description:** [read-only] List the function modules of an ABAP function group.
|
|
248
|
+
|
|
249
|
+
**Source:** `src/handlers/function_include/readonly/handleListFunctionModules.ts`
|
|
250
|
+
|
|
251
|
+
**Available in:** `onprem`, `cloud`, `legacy`
|
|
252
|
+
|
|
253
|
+
**Parameters:**
|
|
254
|
+
- `function_group_name` (string, required) - Function group name (e.g., Z_MY_FG).
|
|
255
|
+
|
|
256
|
+
---
|
|
257
|
+
|
|
258
|
+
<a id="readfunctioninclude-read-only-function-include"></a>
|
|
259
|
+
#### ReadFunctionInclude (Read-Only / Function Include)
|
|
260
|
+
**Description:** [read-only] Read ABAP function group include source code and metadata. Answers: "show function group include code", "display include source", "view include of function group". Returns source code and include metadata.
|
|
261
|
+
|
|
262
|
+
**Source:** `src/handlers/function_include/readonly/handleReadFunctionInclude.ts`
|
|
263
|
+
|
|
264
|
+
**Available in:** `onprem`, `cloud`, `legacy`
|
|
265
|
+
|
|
266
|
+
**Parameters:**
|
|
267
|
+
- `function_group_name` (string, required) - Function group name containing the include (e.g., Z_MY_FG).
|
|
268
|
+
- `include_name` (string, required) - Include name (e.g., LZ_MY_FGTOP, LZ_MY_FGU01).
|
|
269
|
+
- `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive".
|
|
270
|
+
|
|
271
|
+
---
|
|
272
|
+
|
|
219
273
|
<a id="read-only-function-module"></a>
|
|
220
274
|
### Read-Only / Function Module
|
|
221
275
|
|
|
@@ -330,6 +384,25 @@ Legacy systems support a subset of tools — primarily Class, Interface, View, P
|
|
|
330
384
|
|
|
331
385
|
---
|
|
332
386
|
|
|
387
|
+
<a id="read-only-structure"></a>
|
|
388
|
+
### Read-Only / Structure
|
|
389
|
+
|
|
390
|
+
<a id="getstructureslist-read-only-structure"></a>
|
|
391
|
+
#### GetStructuresList (Read-Only / Structure)
|
|
392
|
+
**Description:** [read-only] Recursively list the structures embedded in an ABAP structure (.INCLUDE / append), as a tree.
|
|
393
|
+
|
|
394
|
+
**Source:** `src/handlers/structure/readonly/handleGetStructuresList.ts`
|
|
395
|
+
|
|
396
|
+
**Available in:** `onprem`, `cloud`, `legacy`
|
|
397
|
+
|
|
398
|
+
**Parameters:**
|
|
399
|
+
- `include_extensions` (boolean, optional (default: true)) - [read-only] Also find extension (append) structures via where-used (objects that `extend type <this> with …`). Default true. Set false to skip the (slower) where-used lookups and return includes only.
|
|
400
|
+
- `structure_name` (string, required) - Structure name (e.g., Z_MY_STRUCTURE).
|
|
401
|
+
- `timeout` (number, optional) - [read-only] Timeout in ms for each ADT request.
|
|
402
|
+
- `version` (string, optional (default: active)) - Version to read: "active" (default) or "inactive".
|
|
403
|
+
|
|
404
|
+
---
|
|
405
|
+
|
|
333
406
|
<a id="read-only-system"></a>
|
|
334
407
|
### Read-Only / System
|
|
335
408
|
|
|
@@ -889,6 +962,57 @@ Legacy systems support a subset of tools — primarily Class, Interface, View, P
|
|
|
889
962
|
|
|
890
963
|
---
|
|
891
964
|
|
|
965
|
+
<a id="high-level-function-include"></a>
|
|
966
|
+
### High-Level / Function Include
|
|
967
|
+
|
|
968
|
+
<a id="createfunctioninclude-high-level-function-include"></a>
|
|
969
|
+
#### CreateFunctionInclude (High-Level / Function Include)
|
|
970
|
+
**Description:** Operation: Create. Subject: FunctionInclude. Will be useful for creating function group include. Create a new ABAP include within an existing function group. Creates the include in initial state.
|
|
971
|
+
|
|
972
|
+
**Source:** `src/handlers/function_include/high/handleCreateFunctionInclude.ts`
|
|
973
|
+
|
|
974
|
+
**Available in:** `onprem`, `cloud`, `legacy`
|
|
975
|
+
|
|
976
|
+
**Parameters:**
|
|
977
|
+
- `description` (string, optional) - Optional description for the include
|
|
978
|
+
- `function_group_name` (string, required) - Parent function group name (e.g., ZTEST_FG_001)
|
|
979
|
+
- `include_name` (string, required) - Include name (e.g., LZTEST_FG_001F01).
|
|
980
|
+
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable packages.
|
|
981
|
+
|
|
982
|
+
---
|
|
983
|
+
|
|
984
|
+
<a id="deletefunctioninclude-high-level-function-include"></a>
|
|
985
|
+
#### DeleteFunctionInclude (High-Level / Function Include)
|
|
986
|
+
**Description:** Delete an ABAP function group include from the SAP system. Note: function module includes must be deleted via the Function Builder; the backend rejects such deletions. Transport request optional for $TMP objects.
|
|
987
|
+
|
|
988
|
+
**Source:** `src/handlers/function_include/high/handleDeleteFunctionInclude.ts`
|
|
989
|
+
|
|
990
|
+
**Available in:** `onprem`, `cloud`, `legacy`
|
|
991
|
+
|
|
992
|
+
**Parameters:**
|
|
993
|
+
- `function_group_name` (string, required) - Function group name containing the include (e.g., Z_MY_FG).
|
|
994
|
+
- `include_name` (string, required) - Include name (e.g., LZ_MY_FGF01).
|
|
995
|
+
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable objects. Optional for local objects ($TMP).
|
|
996
|
+
|
|
997
|
+
---
|
|
998
|
+
|
|
999
|
+
<a id="updatefunctioninclude-high-level-function-include"></a>
|
|
1000
|
+
#### UpdateFunctionInclude (High-Level / Function Include)
|
|
1001
|
+
**Description:** Operation: Update. Subject: FunctionInclude. Will be useful for updating a function group include. Update source code of an existing ABAP function group include.
|
|
1002
|
+
|
|
1003
|
+
**Source:** `src/handlers/function_include/high/handleUpdateFunctionInclude.ts`
|
|
1004
|
+
|
|
1005
|
+
**Available in:** `onprem`, `cloud`, `legacy`
|
|
1006
|
+
|
|
1007
|
+
**Parameters:**
|
|
1008
|
+
- `activate` (boolean, optional (default: false)) - Activate the include after the source update. Default: false. Set true to make the updated source the active version immediately.
|
|
1009
|
+
- `function_group_name` (string, required) - Function group name containing the include (e.g., ZOK_FG_MCP01).
|
|
1010
|
+
- `include_name` (string, required) - Include name (e.g., LZOK_FG_MCP01F01). Include must already exist.
|
|
1011
|
+
- `source_code` (string, required) - Complete ABAP include source code.
|
|
1012
|
+
- `transport_request` (string, optional) - Transport request number (e.g., E19K905635). Required for transportable includes.
|
|
1013
|
+
|
|
1014
|
+
---
|
|
1015
|
+
|
|
892
1016
|
<a id="high-level-function-module"></a>
|
|
893
1017
|
### High-Level / Function Module
|
|
894
1018
|
|
|
@@ -2395,4 +2519,4 @@ Legacy systems support a subset of tools — primarily Class, Interface, View, P
|
|
|
2395
2519
|
|
|
2396
2520
|
---
|
|
2397
2521
|
|
|
2398
|
-
*Last updated: 2026-
|
|
2522
|
+
*Last updated: 2026-06-20*
|