@postman/postman-mcp-server 2.8.4 → 2.8.5-alpha.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.
Files changed (3) hide show
  1. package/README.md +188 -114
  2. package/dist/package.json +1 -1
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -18,12 +18,12 @@ For the best developer experience and fastest setup, use **OAuth** on the remote
18
18
 
19
19
  ### Use Cases
20
20
 
21
- * **API Testing** - Continuously test your API using your Postman collection. To be able to test local APIs, use the [local server](#local-server), as the remote server won't have network access to your workstation.
22
- * **Code synchronization** - Effortlessly keep your code in sync with your [Postman Collections](https://learning.postman.com/docs/design-apis/collections/overview/) and specs.
23
- * **Collection management** - Create and [tag](https://learning.postman.com/docs/collections/use-collections/collaborate-with-collections/#tag-a-collection) collections, update collection and request [documentation](https://learning.postman.com/docs/publishing-your-api/api-documentation-overview/), add [comments](https://learning.postman.com/docs/collaborating-in-postman/comments/), or perform actions across multiple collections without leaving your editor.
24
- * **Workspace and environment management** - Create [workspaces](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/overview/) and [environments](https://learning.postman.com/docs/sending-requests/variables/managing-environments/), plus manage your environment variables.
25
- * **Automatic spec creation** - Create [specs](https://learning.postman.com/docs/design-apis/specifications/overview/) from your code and use them to generate collections.
26
- * **Client code generation** - Generate production-ready client code that consumes APIs following best practices and project conventions. The `code` toolset produces code that precisely matches your API definitions, organizes it into an intuitive tree structure mirroring your Postman collections and requests, and leverages example responses to create accurate response types and error handling.
21
+ * **API Testing** — Continuously test your API using your Postman collection. To be able to test local APIs, use the [local server](#local-server), as the remote server won't have network access to your workstation.
22
+ * **Code synchronization** — Effortlessly keep your code in sync with your [Postman Collections](https://learning.postman.com/docs/design-apis/collections/overview/) and specs.
23
+ * **Collection management** — Create and [tag](https://learning.postman.com/docs/collections/use-collections/collaborate-with-collections/#tag-a-collection) collections, update collection and request [documentation](https://learning.postman.com/docs/publishing-your-api/api-documentation-overview/), add [comments](https://learning.postman.com/docs/collaborating-in-postman/comments/), or perform actions across multiple collections without leaving your editor.
24
+ * **Workspace and environment management** — Create [workspaces](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/overview/) and [environments](https://learning.postman.com/docs/sending-requests/variables/managing-environments/), plus manage your environment variables.
25
+ * **Automatic spec creation** — Create [specs](https://learning.postman.com/docs/design-apis/specifications/overview/) from your code and use them to generate collections.
26
+ * **Client code generation** — Generate production-ready client code that consumes APIs following best practices and project conventions. The `code` toolset produces code that precisely matches your API definitions, organizes it into an intuitive tree structure mirroring your Postman collections and requests, and leverages example responses to create accurate response types and error handling.
27
27
 
28
28
  Designed for developers who want to integrate their AI tools with Postman's context and features. Supports quick natural language queries to advanced agent workflows.
29
29
 
@@ -31,13 +31,13 @@ Designed for developers who want to integrate their AI tools with Postman's cont
31
31
 
32
32
  The Postman MCP Server supports the EU region for remote and local servers:
33
33
 
34
- * For streamable HTTP, the remote server is available at `https://mcp.eu.postman.com`.
35
- * For our STDIO public package, use the `--region` flag to specify the Postman API region (`us` or `eu`), or set the `POSTMAN_API_BASE_URL` environment variable directly.
34
+ * For streamable HTTP, the remote server is available at `https://mcp.eu.postman.com/mcp` (Full), `https://mcp.eu.postman.com/code`, and `https://mcp.eu.postman.com/minimal`.
35
+ * For the STDIO public package, use the `--region eu` flag to specify the Postman API EU region, or set the `POSTMAN_API_BASE_URL` environment variable directly.
36
36
  * OAuth isn't supported for the EU Postman MCP Server. The EU remote server only supports API key authentication.
37
37
 
38
38
  ---
39
39
 
40
- ### Contents
40
+ ## Contents
41
41
 
42
42
  * [**Remote server**](#remote-server)
43
43
  * [**VS Code**](#install-in-visual-studio-code)
@@ -57,6 +57,7 @@ The Postman MCP Server supports the EU region for remote and local servers:
57
57
  * [**Antigravity**](#install-in-antigravity-1)
58
58
  * [**GitHub Copilot CLI**](#install-in-github-copilot-cli-1)
59
59
  * [**Gemini CLI**](#use-as-a-gemini-cli-extension)
60
+ * [**Install in Kiro**](#install-in-kiro)
60
61
  * [**Docker**](#install-in-docker)
61
62
  * [**Questions and support**](#questions-and-support)
62
63
  * [**Migration from Postman MCP Server v1 to v2**](#migration-from-v1x-to-v2x)
@@ -77,17 +78,16 @@ MCP hosts that support OAuth can discover and use it automatically for all tools
77
78
 
78
79
  Consider using the remote Postman MCP server if:
79
80
 
80
- * You want to get started quickly and easily.
81
- * You are working with public APIs.
82
81
  * Your MCP host doesn't support local MCP servers.
83
-
82
+ * You want a quick way to get started with the Postman MCP server.
83
+ * You are working with public APIs.
84
84
 
85
85
  **Supported configurations**
86
86
 
87
87
  The remote server supports the following tool configurations:
88
88
 
89
- * **Minimal** — (Default) Only includes essential tools for basic Postman operations, available at `https://mcp.postman.com/minimal` and `https://mcp.eu.postman.com/minimal` for EU users.
90
- * **Code** — Includes tools for searching public and internal API definitions and generating client code, available at `https://mcp.postman.com/code` and `https://mcp.eu.postman.com/code` for EU users.
89
+ * **Minimal** — (Default) Only includes essential tools for basic Postman operations, available at `https://mcp.postman.com/minimal` and `https://mcp.eu.postman.com/minimal` for EU users. This offers faster performance and simplifies use for those who only need basic Postman operations.
90
+ * **Code** — Includes tools for searching public and internal API definitions and generating client code, available at `https://mcp.postman.com/code` and `https://mcp.eu.postman.com/code` for EU users. This configuration is ideal for users who need to consume APIs or get context about APIs to their agents.
91
91
  * **Full** — Includes all available Postman API tools (100+ tools), available at `https://mcp.postman.com/mcp` and `https://mcp.eu.postman.com/mcp` for EU users.
92
92
 
93
93
  ### Install in Cursor
@@ -96,156 +96,184 @@ The remote server supports the following tool configurations:
96
96
 
97
97
  To install the remote Postman MCP Server in Cursor, click the install button.
98
98
 
99
- **Note:** If your MCP host supports OAuth, use the `https://mcp.postman.com` server URL with no headers for the fastest setup. Otherwise, ensure the Authorization header uses the `Bearer <YOUR_API_KEY>` format. OAuth is not available on the EU server.
99
+ If your MCP host supports OAuth, use the `https://mcp.postman.com/mcp`, `https://mcp.postman.com/minimal`, or `https://mcp.postman.com/code` server URL without headers for the fastest setup. Otherwise, ensure the Authorization header uses the `Bearer <YOUR_API_KEY>` format. Note that OAuth isn’t supported for EU servers.
100
100
 
101
- By default, the server uses **Minimal** mode. To access **Full** mode, change the `url` value to `https://mcp.postman.com/mcp` in the `mcp.json` file. To access **Code** mode, change the value to `https://mcp.postman.com/code`.
101
+ After installing, ensure that the Authorization header uses the `Bearer $POSTMAN-API-KEY` format.
102
102
 
103
- ### Install in Visual Studio Code
103
+ To access **Full** mode, change the `url` value to `https://mcp.postman.com/mcp` in the `mcp.json` file. To access **Code** mode, change the value to `https://mcp.postman.com/code` in this file.
104
104
 
105
- [![Install in VS Code](https://img.shields.io/badge/VS_Code-Install_Server-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=postman_mcp_server&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fmcp.postman.com%2Fminimal%22%2C%22headers%22%3A%7B%22Authorization%22%3A%22Bearer%20YOUR_API_KEY%22%7D%7D)
105
+ ### Install in Visual Studio Code
106
106
 
107
107
  To install the remote Postman MCP Server in VS Code, click the install button or use the [Postman VS Code Extension](https://marketplace.visualstudio.com/items?itemName=Postman.postman-for-vscode).
108
108
 
109
- By default, the server uses **Minimal** mode. To access **Full** mode, change the `url` value to `https://mcp.postman.com/mcp` in the `mcp.json` file. To access **Code** mode, change the value to `https://mcp.postman.com/code`.
109
+ [![Install in VS Code](https://img.shields.io/badge/VS_Code-Install_Server-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=postman_mcp_server&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fmcp.postman.com%2Fminimal%22%2C%22headers%22%3A%7B%22Authorization%22%3A%22Bearer%20YOUR_API_KEY%22%7D%7D)
110
+
111
+ To access **Full** mode, change the `url` value to `https://mcp.postman.com/mcp` in the `mcp.json` file. To access **Code** mode, change the value to `https://mcp.postman.com/code` in this file.
110
112
 
111
113
  #### Manual configuration
112
114
 
113
115
  You can use the Postman MCP Server with MCP-compatible extensions in VS Code, such as GitHub Copilot, Claude for VS Code, or other AI assistants that support MCP. To do so, add the following JSON block to the `.vscode/mcp.json` configuration file:
114
116
 
115
- **OAuth**
117
+ ##### OAuth
116
118
 
117
119
  Add the following JSON block to use the recommended OAuth installation method:
118
120
 
119
121
  ```json
120
122
  {
121
- "servers": {
122
- "postman": {
123
- "type": "http",
124
- "url": "https://mcp.postman.com/{minimal OR code OR mcp}"
123
+ "servers": {
124
+ "postman": {
125
+ "type": "http",
126
+ "url": "https://mcp.postman.com/minimal"
127
+ // "https://mcp.postman.com/code" for Code mode
128
+ // "https://mcp.postman.com/mcp" for Full mode
129
+ }
125
130
  }
126
- }
127
131
  }
128
132
  ```
129
133
 
130
- When prompted, enter your Postman API key.
134
+ Start the server. When prompted, enter your Postman API key.
131
135
 
132
- **API key**
136
+ ##### API key
133
137
 
134
138
  Use the following JSON block to use the API key installation method:
135
139
 
136
140
  ```json
137
141
  {
138
- "servers": {
139
- "postman": {
140
- "type": "http",
141
- "url": "https://mcp.postman.com/{minimal OR code OR mcp}",
142
- // For the EU server, use "https://mcp.eu.postman.com/{minimal OR code OR mcp}"
143
- "headers": {
144
- "Authorization": "Bearer ${input:postman-api-key}"
145
- }
146
- }
147
- },
148
- "inputs": [
149
- {
150
- "id": "postman-api-key",
151
- "type": "promptString",
152
- "description": "Enter your Postman API key"
153
- }
154
- ]
142
+ "servers": {
143
+ "postman": {
144
+ "type": "http",
145
+ "url": "https://mcp.postman.com/minimal",
146
+ // "https://mcp.postman.com/code" for Code mode
147
+ // "https://mcp.postman.com/mcp" for Full mode
148
+ "headers": {
149
+ "Authorization": "Bearer ${input:postman-api-key}"
150
+ }
151
+ }
152
+ },
153
+ "inputs": [
154
+ {
155
+ "id": "postman-api-key",
156
+ "type": "promptString",
157
+ "description": "Enter your Postman API key"
158
+ }
159
+ ]
155
160
  }
156
161
  ```
157
162
 
158
- When prompted, enter your Postman API key.
163
+ Start the server. When prompted, enter your Postman API key.
159
164
 
160
165
  ### Install in Claude Code
161
166
 
162
- To install the MCP server in Claude Code, run the following command in your terminal. On the US server, Claude Code uses OAuth automatically for the best installation experience. To use an API key (required for the EU server), add the `--header` flag.
167
+ On the US server, Claude Code automatically uses OAuth for the best installation experience. To use an API key (required for the EU server), add the `--header` flag.
168
+
169
+ #### OAuth
163
170
 
164
- **OAuth**
171
+ To use the OAuth installation method for US servers, run the following command in your terminal:
165
172
 
166
- Use the recommended OAuth installation method for US servers:
173
+ ##### Minimal
167
174
 
168
175
  ```bash
169
176
  claude mcp add --transport http postman https://mcp.postman.com/minimal
170
177
  ```
171
178
 
179
+ ##### Code
180
+
172
181
  ```bash
173
182
  claude mcp add --transport http postman https://mcp.postman.com/code
174
183
  ```
175
184
 
185
+ ##### Full
186
+
176
187
  ```bash
177
188
  claude mcp add --transport http postman https://mcp.postman.com/mcp
178
189
  ```
179
190
 
180
- **API key**
191
+ #### API key
181
192
 
182
- Use the API key installation method if required and for EU servers:
193
+ To use the API key installation method if required and for EU servers (`mcp.eu.postman`), run the following command in your terminal:
194
+
195
+ ##### Minimal
183
196
 
184
197
  ```bash
185
198
  claude mcp add --transport http postman https://mcp.postman.com/minimal --header "Authorization: Bearer <POSTMAN_API_KEY>"
186
199
  ```
187
200
 
201
+ ##### Code
202
+
188
203
  ```bash
189
204
  claude mcp add --transport http postman https://mcp.postman.com/code --header "Authorization: Bearer <POSTMAN_API_KEY>"
190
205
  ```
191
206
 
207
+ ##### Full
208
+
192
209
  ```bash
193
210
  claude mcp add --transport http postman https://mcp.postman.com/mcp --header "Authorization: Bearer <POSTMAN_API_KEY>"
194
211
  ```
195
212
 
196
- ### Install in Codex
213
+ ### Codex
197
214
 
198
215
  To install the remote server in Codex, use one of the following methods, depending on your authentication and region.
199
216
 
200
- **OAuth**
217
+ #### OAuth
201
218
 
202
- Use the recommended OAuth installation method with the US server for the best installation experience. This requires no manual API key setup.
219
+ Use this method with the US server for the best installation experience. OAuth requires no manual API key setup.
203
220
 
204
- For **Minimal** mode:
221
+ ##### Minimal
205
222
 
206
223
  ```bash
207
224
  codex mcp add postman --remote-url https://mcp.postman.com/minimal
208
225
  ```
209
226
 
210
- For **Code** mode:
227
+ ##### Code
211
228
 
212
229
  ```bash
213
230
  codex mcp add postman --remote-url https://mcp.postman.com/code
214
231
  ```
215
232
 
216
- For **Full** mode:
233
+ ##### Full
217
234
 
218
235
  ```bash
219
236
  codex mcp add postman --remote-url https://mcp.postman.com/mcp
220
237
  ```
221
238
 
222
- **API key**
239
+ #### API key
223
240
 
224
- If you're using the EU server, a [local server](#install-in-codex-1), or prefer API key authentication, use the API key method. Set the `POSTMAN_API_KEY` environment variable and invoke the MCP server using `npx`.
241
+ If you're using the EU server (`mcp.eu.postman`), a [local server](/docs/developer/postman-api/postman-mcp-server/postman-mcp-local-server#codex), or prefer API key authentication, use the API key method. Set the `POSTMAN_API_KEY` environment variable and invoke the MCP server using `npx`.
225
242
 
226
- For **Minimal** mode:
243
+ ##### Minimal
227
244
 
228
245
  ```bash
229
246
  codex mcp add postman --env POSTMAN_API_KEY=<POSTMAN_API_KEY> -- npx @postman/postman-mcp-server --minimal
230
247
  ```
231
248
 
232
- For **Code** mode:
249
+ ##### Code
233
250
 
234
251
  ```bash
235
252
  codex mcp add postman --env POSTMAN_API_KEY=<POSTMAN_API_KEY> -- npx @postman/postman-mcp-server --code
236
253
  ```
237
254
 
238
- For **Full** mode:
255
+ ##### Full
239
256
 
240
257
  ```bash
241
258
  codex mcp add postman --env POSTMAN_API_KEY=<POSTMAN_API_KEY> -- npx @postman/postman-mcp-server --full
242
259
  ```
243
260
 
244
- ### Install in Windsurf
261
+ #### Manual installation
262
+
263
+ To manually install the MCP server in Codex, create a `~/.codex/config.toml` config file, then copy the following config into the file:
245
264
 
246
- To install the MCP server in Windsurf, copy the following JSON config into the `.codeium/windsurf/mcp_config.json` file.
265
+ ```plaintext
266
+ [mcp_servers.postman-mcp-server]
267
+ command = "npx"
268
+ args = ["-y", "@postman/postman-mcp-server"]
247
269
 
248
- This configuration uses the remote server (`https://mcp.postman.com`), which authenticates with OAuth automatically.
270
+ [mcp_servers.postman-mcp-server.env]
271
+ POSTMAN_API_KEY="XXX"
272
+ ```
273
+
274
+ ### Install in Windsurf
275
+
276
+ To install the MCP server in Windsurf, copy the following JSON config into the `.codeium/windsurf/mcp_config.json` file. This configuration uses the remote server, which automatically authenticates with OAuth.
249
277
 
250
278
  ```json
251
279
  {
@@ -283,9 +311,7 @@ This configuration uses the remote server (`https://mcp.postman.com`), which aut
283
311
 
284
312
  ### Install in Antigravity
285
313
 
286
- To install the MCP server in Antigravity, click **Manage MCP servers > View raw config**. Then, copy the following JSON config into the `mcp_config.json` file.
287
-
288
- This configuration uses the remote server (`https://mcp.postman.com`), which authenticates automatically with OAuth.
314
+ To install the MCP server in Antigravity, click **Manage MCP servers > View raw config**. Then, copy the following JSON config into the `.mcp_config.json` file. This configuration uses the remote server, which automatically authenticates with OAuth.
289
315
 
290
316
  ```json
291
317
  {
@@ -331,41 +357,47 @@ Use the Copilot CLI to interactively add the MCP server:
331
357
  /mcp add
332
358
  ```
333
359
 
360
+ #### Manual installation
361
+
334
362
  Or, add the following to your `~/.copilot/mcp-config.json` config file:
335
363
 
336
364
  ```json
337
365
  {
338
- "mcpServers": {
339
- "postman": {
340
- "type": "http",
341
- "url": "https://mcp.postman.com/minimal" // Use "https://mcp.postman.com/mcp" for Full mode, or "https://mcp.postman.com/code"` for Code mode.
366
+ "mcpServers": {
367
+ "postman": {
368
+ "type": "http",
369
+ "url": "https://mcp.postman.com/minimal"
370
+ // "https://mcp.postman.com/mcp" for Full mode
371
+ // "https://mcp.postman.com/code" for Code mode
372
+ }
342
373
  }
343
- }
344
374
  }
345
375
  ```
346
376
 
347
- **API key**
377
+ ##### API key
348
378
 
349
- Use the following method to install on EU servers or if API key is required:
379
+ Use the following method to install if API key authentication is required for EU servers:
350
380
 
351
381
  ```json
352
382
  {
353
- "mcpServers": {
354
- "postman": {
355
- "type": "http",
356
- "url": "https://mcp.eu.postman.com/minimal",
357
- "headers": {
358
- "Authorization": "Bearer ${input:postman-api-key}"
359
- }
360
- }
361
- },
362
- "inputs": [
363
- {
364
- "id": "postman-api-key",
365
- "type": "promptString",
366
- "description": "Enter your Postman API key"
367
- }
368
- ]
383
+ "mcpServers": {
384
+ "postman": {
385
+ "type": "http",
386
+ "url": "https://mcp.eu.postman.com/minimal",
387
+ // "https://mcp.eu.postman.com/mcp" for Full mode
388
+ // "https://mcp.eu.postman.com/code" for Code mode
389
+ "headers": {
390
+ "Authorization": "Bearer ${input:postman-api-key}"
391
+ }
392
+ }
393
+ },
394
+ "inputs": [
395
+ {
396
+ "id": "postman-api-key",
397
+ "type": "promptString",
398
+ "description": "Enter your Postman API key"
399
+ }
400
+ ]
369
401
  }
370
402
  ```
371
403
 
@@ -393,8 +425,8 @@ Consider using the local Postman MCP server if:
393
425
  The local server supports the following tool configurations:
394
426
 
395
427
  * **Minimal** — (Default) Only includes essential tools for basic Postman operations.
396
- * **Code** — Includes tools for searching public and internal API definitions and generating client code
397
- * **Full** — Includes all available Postman API tools (100+ tools). Use the `--full` flag to enable this configuration.
428
+ * **Code** — Includes tools for searching public and internal API definitions and generating client code.
429
+ * **Full** — Includes all available Postman API tools (100+ tools).
398
430
 
399
431
  **Note:**
400
432
  * Use the `--region` flag to specify the Postman API region (`us` or `eu`), or set the `POSTMAN_API_BASE_URL` environment variable directly. By default, the server uses the `us` option.
@@ -410,7 +442,7 @@ By default, the server uses **Full** mode. To access **Minimal** mode, remove th
410
442
 
411
443
  #### Manual configuration
412
444
 
413
- You can manually integrate your MCP server with Cursor or VS Code to use it with extensions that support MCP. To do this, create a `mcp.json` file in your project and add the following JSON block to it:
445
+ You can manually integrate your MCP server with VS Code to use it with extensions that support MCP. To do this, create a `mcp.json` file in your project and add the following JSON block to it:
414
446
 
415
447
  ```json
416
448
  {
@@ -447,6 +479,37 @@ To install the local Postman MCP Server in Cursor, click the install button.
447
479
 
448
480
  By default, the server uses **Full** mode. To access **Minimal** mode, remove the `--full` flag from the `mcp.json` configuration file. To access **Code** mode, replace the `--full` flag with `--code`.
449
481
 
482
+ #### Manual installation
483
+
484
+ To manually integrate your MCP server with Cursor and VS Code, create a `.vscode/mcp.json` file in your project and add the following JSON block to it:
485
+
486
+ ```json
487
+ {
488
+ "servers": {
489
+ "postman": {
490
+ "type": "stdio",
491
+ "command": "npx",
492
+ "args": [
493
+ "@postman/postman-mcp-server",
494
+ "--full", // (optional) Use this flag to enable full mode...
495
+ "--code", // (optional) ...or this flag to enable code mode.
496
+ "--region us" // (optional) Use this flag to specify the Postman API region (us or eu). Defaults to us.
497
+ ],
498
+ "env": {
499
+ "POSTMAN_API_KEY": "${input:postman-api-key}"
500
+ }
501
+ }
502
+ },
503
+ "inputs": [
504
+ {
505
+ "id": "postman-api-key",
506
+ "type": "promptString",
507
+ "description": "Enter your Postman API key"
508
+ }
509
+ ]
510
+ }
511
+ ```
512
+
450
513
  ### Claude integration
451
514
 
452
515
  To integrate the MCP server with Claude, check the latest [Postman MCP Server release](https://github.com/postmanlabs/postman-mcp-server/releases) and get the `.mcpb` file.
@@ -461,19 +524,19 @@ For more information, see the [Claude Desktop Extensions](https://www.anthropic.
461
524
 
462
525
  To install the MCP server in Claude Code, run the following command in your terminal:
463
526
 
464
- For **Minimal** mode:
527
+ ##### Minimal
465
528
 
466
529
  ```bash
467
530
  claude mcp add postman --env POSTMAN_API_KEY=YOUR_KEY -- npx @postman/postman-mcp-server@latest
468
531
  ```
469
532
 
470
- For **Code** mode:
533
+ ##### Code
471
534
 
472
535
  ```bash
473
536
  claude mcp add postman --env POSTMAN_API_KEY=YOUR_KEY -- npx @postman/postman-mcp-server@latest --code
474
537
  ```
475
538
 
476
- For **Full** mode:
539
+ ##### Full
477
540
 
478
541
  ```bash
479
542
  claude mcp add postman --env POSTMAN_API_KEY=YOUR_KEY -- npx @postman/postman-mcp-server@latest --full
@@ -483,19 +546,19 @@ claude mcp add postman --env POSTMAN_API_KEY=YOUR_KEY -- npx @postman/postman-mc
483
546
 
484
547
  To install the local server, use the API key installation method. Set the `POSTMAN_API_KEY` environment variable and invoke the MCP server using `npx`.
485
548
 
486
- For **Minimal** mode:
549
+ ##### Minimal
487
550
 
488
551
  ```bash
489
552
  codex mcp add postman --env POSTMAN_API_KEY=<POSTMAN_API_KEY> -- npx @postman/postman-mcp-server --minimal
490
553
  ```
491
554
 
492
- For **Code** mode:
555
+ ##### Code
493
556
 
494
557
  ```bash
495
558
  codex mcp add postman --env POSTMAN_API_KEY=<POSTMAN_API_KEY> -- npx @postman/postman-mcp-server --code
496
559
  ```
497
560
 
498
- For **Full** mode:
561
+ ##### Full
499
562
 
500
563
  ```bash
501
564
  codex mcp add postman --env POSTMAN_API_KEY=<POSTMAN_API_KEY> -- npx @postman/postman-mcp-server --full
@@ -536,7 +599,7 @@ Copy the following JSON config into the `.codeium/windsurf/mcp_config.json` file
536
599
 
537
600
  ### Install in Antigravity
538
601
 
539
- To install the MCP server in Antigravity, click **Manage MCP servers > View raw config**. Then, copy the following JSON config into the `.codeium/windsurf/mcp_config.json` file:
602
+ To install the MCP server in Antigravity, click **Manage MCP servers > View raw config**. Then, copy the following JSON config into the `mcp_config.json` file:
540
603
 
541
604
  ```json
542
605
  {
@@ -549,11 +612,12 @@ To install the MCP server in Antigravity, click **Manage MCP servers > View raw
549
612
  "disabled": false,
550
613
  "disabledTools": [],
551
614
  "env": {
552
- "POSTMAN_API_KEY": "XXXX"
615
+ "POSTMAN_API_KEY": "<POSTMAN_API_KEY>"
553
616
  }
554
617
  }
555
618
  }
556
619
  }
620
+
557
621
  ```
558
622
 
559
623
  ### Install in GitHub Copilot CLI
@@ -564,19 +628,23 @@ Use the Copilot CLI to interactively add the MCP server:
564
628
  /mcp add
565
629
  ```
566
630
 
567
- Alternatively, create or edit the configuration file `~/.copilot/mcp-config.json` and add:
631
+ #### Manual configuration
632
+
633
+ Copy the following JSON config into the `~/.copilot/mcp-config.json` file:
568
634
 
569
635
  ```json
570
636
  {
571
- "mcpServers": {
572
- "postman": {
573
- "command": "npx",
574
- "args": ["@postman/postman-mcp-server"],
575
- "env": {
576
- "POSTMAN_API_KEY": "YOUR_API_KEY"
577
- }
637
+ "mcpServers": {
638
+ "postman": {
639
+ "command": "npx",
640
+ "args": [
641
+ "@postman/postman-mcp-server"
642
+ ],
643
+ "env": {
644
+ "POSTMAN_API_KEY": "<POSTMAN_API_KEY>"
645
+ }
646
+ }
578
647
  }
579
- }
580
648
  }
581
649
  ```
582
650
 
@@ -592,9 +660,15 @@ gemini extensions install https://github.com/postmanlabs/postman-mcp-server
592
660
 
593
661
  ### Install in Kiro
594
662
 
595
- To use the Postman MCP Server in Kiro, you can use one of the following methods:
663
+ To install the local Postman MCP Server in Kiro, click the install button for the version that you want to use:
596
664
 
597
- To set up the Postman MCP Server with one-click, see [API Testing with Postman](https://kiro.dev/powers/) on the Kiro Powers page. Click **Add to Kiro**.
665
+ | **Minimal** | **Code** | **Full**
666
+ | --- | -- | -- |
667
+ | [![Add Postman MCP Minimal server to Kiro](https://kiro.dev/images/add-to-kiro.svg)](https://kiro.dev/launch/mcp/add?name=postman-mcp-server&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40postman%2Fpostman-mcp-server%40latest%22%5D%2C%22env%22%3A%7B%22POSTMAN_API_KEY%22%3A%22%24%7BPOSTMAN_API_KEY%7D%22%7D%2C%22disabled%22%3Afalse%2C%22autoApprove%22%3A%5B%5D%7D) | [![Add Postman MCP Code server to Kiro](https://kiro.dev/images/add-to-kiro.svg)](https://kiro.dev/launch/mcp/add?name=postman-mcp-server&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40postman%2Fpostman-mcp-server%40latest%22%2C%22--code%22%5D%2C%22env%22%3A%7B%22POSTMAN_API_KEY%22%3A%22%24%7BPOSTMAN_API_KEY%7D%22%7D%2C%22disabled%22%3Afalse%2C%22autoApprove%22%3A%5B%5D%7D) | [![Add Postman MCP Full server to Kiro](https://kiro.dev/images/add-to-kiro.svg)](https://kiro.dev/launch/mcp/add?name=postman-mcp-server&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40postman%2Fpostman-mcp-server%40latest%22%2C%22--full%22%5D%2C%22env%22%3A%7B%22POSTMAN_API_KEY%22%3A%22%24%7BPOSTMAN_API_KEY%7D%22%7D%2C%22disabled%22%3Afalse%2C%22autoApprove%22%3A%5B%5D%7D) |
668
+
669
+ To install the Postman MCP server with Kiro powers, go to [Kiro Powers](https://kiro.dev/powers/) and navigate to **API Testing with Postman** in the **Browse powers** section. Then, click **Add to Kiro**.
670
+
671
+ #### Manual configuration
598
672
 
599
673
  To install the Postman MCP Server manually, do the following:
600
674
 
@@ -611,7 +685,7 @@ To install the Postman MCP Server manually, do the following:
611
685
  "@postman/postman-mcp-server"
612
686
  ],
613
687
  "env": {
614
- "POSTMAN_API_KEY": "postman-api-key"
688
+ "POSTMAN_API_KEY": "<POSTMAN_API_KEY>"
615
689
  },
616
690
  "disabled": false,
617
691
  "autoApprove": [
@@ -632,7 +706,7 @@ For Docker set up and installation, see [DOCKER.md](./DOCKER.md).
632
706
 
633
707
  If you're migrating from Postman MCP Server version 1.x to 2.x, be aware of the following:
634
708
 
635
- * **Tool naming changes** - All tool names changed from kebab-case to camelCase. For example:
709
+ * **Tool naming changes** — All tool names changed from kebab-case to camelCase. For example:
636
710
  * `create-collection` → `createCollection`
637
711
  * `get-workspaces` → `getWorkspaces`
638
712
  * `delete-environment` → `deleteEnvironment`
package/dist/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@postman/postman-mcp-server",
3
- "version": "2.8.4",
3
+ "version": "2.8.5-alpha.1",
4
4
  "description": "A simple MCP server to operate on the Postman API",
5
5
  "mcpName": "com.postman/postman-mcp-server",
6
6
  "main": "dist/src/index.js",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@postman/postman-mcp-server",
3
- "version": "2.8.4",
3
+ "version": "2.8.5-alpha.1",
4
4
  "description": "A simple MCP server to operate on the Postman API",
5
5
  "mcpName": "com.postman/postman-mcp-server",
6
6
  "main": "dist/src/index.js",