@mcp-abap-adt/connection 0.1.1 → 0.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.
Files changed (2) hide show
  1. package/README.md +32 -15
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -21,7 +21,7 @@ ABAP connection layer for MCP ABAP ADT server. Provides a unified interface for
21
21
  - Auth-type specific implementations (BaseAbapConnection, JwtAbapConnection)
22
22
  - Proper separation of concerns - no JWT logic in base class
23
23
  - 📝 **Custom Logging**: Pluggable logger interface for integration with any logging system
24
- - 🛠️ **CLI Tool**: Built-in authentication helper for SAP BTP service key authentication
24
+ - 🛠️ **CLI Tool**: See [JWT Auth Tools](./docs/JWT_AUTH_TOOLS.md) for obtaining SAP BTP tokens
25
25
  - 📦 **TypeScript**: Full TypeScript support with type definitions included
26
26
  - ⚡ **Timeout Management**: Configurable timeouts for different operation types
27
27
 
@@ -233,20 +233,22 @@ const connection = createAbapConnection(config, logger);
233
233
 
234
234
  The package includes a CLI tool for authenticating with SAP BTP using service keys:
235
235
 
236
- ### Installation
237
-
238
- After installing the package, the CLI tool is available via `npx`:
239
-
240
- ```bash
241
- npx sap-abap-auth auth -k path/to/service-key.json
242
- ```
243
-
244
- ### Global Installation
245
-
246
- ```bash
247
- npm install -g @mcp-abap-adt/connection
248
- sap-abap-auth auth -k path/to/service-key.json
249
- ```
236
+ ### Installation Options
237
+
238
+ - **Local project install**
239
+ ```bash
240
+ npm install @mcp-abap-adt/connection --save-dev
241
+ npx sap-abap-auth auth -k path/to/service-key.json
242
+ ```
243
+ - **Global install**
244
+ ```bash
245
+ npm install -g @mcp-abap-adt/connection
246
+ sap-abap-auth auth -k path/to/service-key.json
247
+ ```
248
+ - **On-demand (npx)**
249
+ ```bash
250
+ npx @mcp-abap-adt/connection sap-abap-auth auth -k path/to/service-key.json
251
+ ```
250
252
 
251
253
  ### Usage
252
254
 
@@ -271,6 +273,21 @@ sap-abap-auth auth -k service-key.json --output .env.production
271
273
  - `-o, --output <path>` - Path to output .env file (default: .env)
272
274
  - `-h, --help` - Show help message
273
275
 
276
+ ### Using via `npx` (without global install)
277
+
278
+ If `@mcp-abap-adt/connection` is listed as a dependency in your project, you can invoke the CLI directly:
279
+
280
+ ```bash
281
+ npx sap-abap-auth auth -k service-key.json
282
+ ```
283
+
284
+ This works even when you do not install the package globally. For one-off usage, you can also run:
285
+
286
+ ```bash
287
+ npx @mcp-abap-adt/connection sap-abap-auth auth -k service-key.json
288
+ ```
289
+
290
+ This will download the package on demand and execute the CLI.
274
291
  ## API Reference
275
292
 
276
293
  ### Types
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mcp-abap-adt/connection",
3
- "version": "0.1.1",
3
+ "version": "0.1.3",
4
4
  "description": "ABAP connection layer for MCP ABAP ADT server",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -49,9 +49,9 @@
49
49
  "open": "^11.0.0"
50
50
  },
51
51
  "devDependencies": {
52
- "@types/jest": "^29.5.14",
52
+ "@types/jest": "^30.0.0",
53
53
  "@types/node": "^24.2.1",
54
- "jest": "^29.7.0",
54
+ "jest": "^30.2.0",
55
55
  "ts-jest": "^29.2.5",
56
56
  "typescript": "^5.9.2"
57
57
  }