@gravitee/apim-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 +31 -17
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -33,13 +33,32 @@ Recommended flow:
|
|
|
33
33
|
|
|
34
34
|
## Install
|
|
35
35
|
|
|
36
|
+
### From npm (recommended)
|
|
37
|
+
|
|
38
|
+
Run directly with `npx`:
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
npx @gravitee/apim-mcp-server start \
|
|
42
|
+
--bearer-auth "$APIM_BEARER_TOKEN" \
|
|
43
|
+
--server-url "http://localhost:8083/management/v2"
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Or install globally:
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
npm install -g @gravitee/apim-mcp-server
|
|
50
|
+
apim-mcp-server start \
|
|
51
|
+
--bearer-auth "$APIM_BEARER_TOKEN" \
|
|
52
|
+
--server-url "http://localhost:8083/management/v2"
|
|
53
|
+
```
|
|
54
|
+
|
|
36
55
|
### Claude Desktop Bundle
|
|
37
56
|
|
|
38
57
|
Official GitHub releases include a Claude Desktop bundle named `gravitee-apim-mcp-server.mcpb`. Install that file in Claude Desktop to use the packaged server. The bundle prompts for the APIM connection settings and bearer token.
|
|
39
58
|
|
|
40
59
|
### From GitHub Source
|
|
41
60
|
|
|
42
|
-
Clone and build locally:
|
|
61
|
+
Clone and build locally (requires Node.js 18+ and Bun):
|
|
43
62
|
|
|
44
63
|
```bash
|
|
45
64
|
git clone https://github.com/gravitee-io/gravitee-apim-mcp-server.git
|
|
@@ -48,13 +67,7 @@ npm install
|
|
|
48
67
|
npm run build
|
|
49
68
|
```
|
|
50
69
|
|
|
51
|
-
The build creates the server executable at
|
|
52
|
-
|
|
53
|
-
```bash
|
|
54
|
-
./bin/mcp-server.js
|
|
55
|
-
```
|
|
56
|
-
|
|
57
|
-
Use the absolute path to `./bin/mcp-server.js` in MCP client configuration.
|
|
70
|
+
The build creates the server executable at `./bin/mcp-server.js`.
|
|
58
71
|
|
|
59
72
|
## Basic Usage
|
|
60
73
|
|
|
@@ -63,7 +76,7 @@ Use the Management API v2 base URL as `--server-url`.
|
|
|
63
76
|
Self-hosted example:
|
|
64
77
|
|
|
65
78
|
```bash
|
|
66
|
-
|
|
79
|
+
npx @gravitee/apim-mcp-server start \
|
|
67
80
|
--bearer-auth "$APIM_BEARER_TOKEN" \
|
|
68
81
|
--server-url "http://localhost:8083/management/v2"
|
|
69
82
|
```
|
|
@@ -71,7 +84,7 @@ node ./bin/mcp-server.js start \
|
|
|
71
84
|
Cloud example:
|
|
72
85
|
|
|
73
86
|
```bash
|
|
74
|
-
|
|
87
|
+
npx @gravitee/apim-mcp-server start \
|
|
75
88
|
--bearer-auth "$APIM_BEARER_TOKEN" \
|
|
76
89
|
--server-url "https://<your-org>.<region>.api.gravitee.io/management/v2"
|
|
77
90
|
```
|
|
@@ -79,7 +92,7 @@ node ./bin/mcp-server.js start \
|
|
|
79
92
|
You can also use templated server arguments:
|
|
80
93
|
|
|
81
94
|
```bash
|
|
82
|
-
|
|
95
|
+
npx @gravitee/apim-mcp-server start \
|
|
83
96
|
--protocol https \
|
|
84
97
|
--management-api-host "<management-api-host>" \
|
|
85
98
|
--org-id DEFAULT \
|
|
@@ -96,7 +109,7 @@ Dynamic mode exposes a compact set of discovery and execution tools instead of r
|
|
|
96
109
|
- `execute_tool`
|
|
97
110
|
|
|
98
111
|
```bash
|
|
99
|
-
|
|
112
|
+
npx @gravitee/apim-mcp-server start \
|
|
100
113
|
--mode dynamic \
|
|
101
114
|
--bearer-auth "$APIM_BEARER_TOKEN" \
|
|
102
115
|
--server-url "$APIM_SERVER_URL"
|
|
@@ -109,7 +122,7 @@ In dynamic mode, an MCP client first discovers a tool, inspects its input schema
|
|
|
109
122
|
For safer exploration, mount only tools marked with the `read` scope:
|
|
110
123
|
|
|
111
124
|
```bash
|
|
112
|
-
|
|
125
|
+
npx @gravitee/apim-mcp-server start \
|
|
113
126
|
--mode dynamic \
|
|
114
127
|
--scope read \
|
|
115
128
|
--bearer-auth "$APIM_BEARER_TOKEN" \
|
|
@@ -125,7 +138,7 @@ MCP scopes and APIM permissions both control write tools. For operational use, c
|
|
|
125
138
|
Example:
|
|
126
139
|
|
|
127
140
|
```bash
|
|
128
|
-
|
|
141
|
+
npx @gravitee/apim-mcp-server start \
|
|
129
142
|
--mode dynamic \
|
|
130
143
|
--scope read \
|
|
131
144
|
--scope write \
|
|
@@ -136,7 +149,7 @@ node ./bin/mcp-server.js start \
|
|
|
136
149
|
The `dangerous` scope marks high-impact tools. Only enable that scope for controlled workflows:
|
|
137
150
|
|
|
138
151
|
```bash
|
|
139
|
-
|
|
152
|
+
npx @gravitee/apim-mcp-server start \
|
|
140
153
|
--mode dynamic \
|
|
141
154
|
--scope read \
|
|
142
155
|
--scope write \
|
|
@@ -153,9 +166,10 @@ Claude Desktop or compatible stdio clients can use:
|
|
|
153
166
|
{
|
|
154
167
|
"mcpServers": {
|
|
155
168
|
"GraviteeApim": {
|
|
156
|
-
"command": "
|
|
169
|
+
"command": "npx",
|
|
157
170
|
"args": [
|
|
158
|
-
"
|
|
171
|
+
"-y",
|
|
172
|
+
"@gravitee/apim-mcp-server",
|
|
159
173
|
"start",
|
|
160
174
|
"--mode",
|
|
161
175
|
"dynamic",
|