You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* feat: add code generation toolset and update enabled resources
- Introduced `getCodeGenerationInstructions` tool to provide step-by-step guidance for generating API client code from Postman collections.
- Added `getCollectionMap` tool to retrieve a recursive index of all folders and requests in a Postman collection.
- Updated `enabledResources` to include new tools and modified the `excludedFromGeneration` list.
- Enhanced the `run` function to support a new `--code` argument for selecting code generation tools.
- Adjusted `ServerContext` to accommodate the new 'code' server type.
* feat: add code toolset bundling flows
* feat: add searchPostmanElements tool
* Various README updates for code toolset
* Tweaks to code manifest description and long description
---------
Co-authored-by: Josh Dzielak <[email protected]>
Copy file name to clipboardExpand all lines: README.md
+27-11Lines changed: 27 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,7 @@ Postman supports the following tool configurations:
6
6
7
7
***Minimal** — (Default) Only includes essential tools for basic Postman operations This offers faster performance and simplifies use for those who only need basic Postman operations. Ideal for users who want to modify a single Postman elements, such as collections, workspaces, or environments.
8
8
***Full** — Includes all available Postman API tools (100+ tools). This configuration is ideal for users who engage in advanced collaboration and Postman's Enterprise features.
9
+
***Code** — Includes tools to generate high-quality, well-organized client code from public and internal API definitions. This configuration is ideal for users who need to consume APIs or simply get context about APIs to their agents.
9
10
10
11
For a complete list of the Postman MCP Server's tools, see the [Postman MCP Server collection](https://www.postman.com/postman/postman-public-workspace/collection/681dc649440b35935978b8b7). This collection offers both the remote [full](https://www.postman.com/postman/postman-public-workspace/mcp-request/6821a76b17ccb90a86df48d3) and [minimal](https://www.postman.com/postman/postman-public-workspace/mcp-request/689e1c635be722a98b723238) servers, and the [local server](https://www.postman.com/postman/postman-public-workspace/mcp-request/6866a655b36c67cc435b5033).
11
12
@@ -19,8 +20,9 @@ Postman also offers servers as an [npm package](https://www.npmjs.com/package/@p
19
20
***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.
20
21
***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.
21
22
***Automatic spec creation** - Create [specs](https://learning.postman.com/docs/design-apis/specifications/overview/) from your code and use them to generate collections.
23
+
***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.
22
24
23
-
Designed for developers who want to integrate their AI tools with Postman’s context and features. Supports quick natural language queries queries to advanced agent workflows.
25
+
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.
24
26
25
27
### Support for EU
26
28
@@ -55,6 +57,7 @@ The remote Postman MCP Server is hosted by Postman over streamable HTTP and prov
55
57
The remote server supports the following tool configurations:
56
58
57
59
***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.
60
+
***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.
58
61
***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.
59
62
60
63
### Install in Cursor
@@ -65,15 +68,15 @@ To install the remote Postman MCP Server in Cursor, click the install button.
65
68
66
69
**Note:** Ensure that the Authorization header uses the `Bearer <YOUR_API_KEY>` format.
67
70
68
-
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.
71
+
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`.
69
72
70
73
### Install in Visual Studio Code
71
74
72
75
[](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)
73
76
74
77
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).
75
78
76
-
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.
79
+
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`.
77
80
78
81
#### Manual configuration
79
82
@@ -84,8 +87,7 @@ You can use the Postman MCP Server with MCP-compatible extensions in VS Code, su
84
87
"servers": {
85
88
"postman-api-http-server": {
86
89
"type": "http",
87
-
"url": "https://mcp.postman.com/{minimal OR mcp}",
88
-
// Use "https://mcp.postman.com/mcp" for full or "https://mcp.postman.com/minimal" for minimal mode.
90
+
"url": "https://mcp.postman.com/{minimal OR code OR mcp}",
89
91
// For the EU server, use the "https://mcp.eu.postman.com" URL.
@@ -133,6 +141,7 @@ STDIO is a lightweight solution that's ideal for integration with editors and to
133
141
The local server supports the following tool configurations:
134
142
135
143
***Minimal** — (Default) Only includes essential tools for basic Postman operations.
144
+
***Code** — Includes tools for searching public and internal API definitions and generating client code
136
145
***Full** — Includes all available Postman API tools (100+ tools). Use the `--full` flag to enable this configuration.
137
146
138
147
**Note:** 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.
@@ -144,7 +153,7 @@ The local server supports the following tool configurations:
144
153
145
154
To install the local Postman MCP Server in VS Code, click the install button.
146
155
147
-
By default, the server uses **Full** mode. To access **Minimal** mode, remove the `--full` flag from the `mcp.json` configuration file.
156
+
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`.
148
157
149
158
#### Manual configuration
150
159
@@ -158,7 +167,8 @@ You can manually integrate your MCP server with Cursor or VS Code to use it with
158
167
"command": "npx",
159
168
"args": [
160
169
"@postman/postman-mcp-server",
161
-
"--full"// (optional) Use this flag to enable full mode.
170
+
"--full", // (optional) Use this flag to enable full mode...
171
+
"--code", // (optional) ...OR this flag to enable code mode.
162
172
"--region us"// (optional) Use this flag to specify the Postman API region (us or eu). Defaults to us.
163
173
],
164
174
"env": {
@@ -182,14 +192,15 @@ You can manually integrate your MCP server with Cursor or VS Code to use it with
182
192
183
193
To install the local Postman MCP Server in Cursor, click the install button.
184
194
185
-
By default, the server uses **Full** mode. To access **Minimal** mode, remove the `--full` flag from the `mcp.json` configuration file.
195
+
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`.
186
196
187
197
### Claude integration
188
198
189
199
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.
190
200
191
-
***Minimal** - `postman-api-mcp-minimal.mcpb`
192
-
***Full** - `postman-api-mcp-full.mcpb`
201
+
***Minimal** - `postman-mcp-server-minimal.mcpb`
202
+
***Full** - `postman-mcp-server-full.mcpb`
203
+
***Code** - `postman-mcp-server-code.mcpb`
193
204
194
205
For more information, see the [Claude Desktop Extensions](https://www.anthropic.com/engineering/desktop-extensions) documentation.
195
206
@@ -203,6 +214,12 @@ For **Minimal** mode:
203
214
claude mcp add postman --env POSTMAN_API_KEY=YOUR_KEY -- npx @postman/postman-mcp-server@latest
204
215
```
205
216
217
+
For **Code** mode:
218
+
219
+
```bash
220
+
claude mcp add postman --env POSTMAN_API_KEY=YOUR_KEY -- npx @postman/postman-mcp-server@latest --code
221
+
```
222
+
206
223
For **Full** mode:
207
224
208
225
```bash
@@ -239,7 +256,6 @@ If you're migrating from Postman MCP Server version 1.x to 2.x, be aware of the
239
256
240
257
## Questions and support
241
258
242
-
* See the [Postman Agent Generator](https://postman.com/explore/agent-generator) page for updates and new capabilities.
243
259
* See [Add your MCP requests to your collections](https://learning.postman.com/docs/postman-ai-agent-builder/mcp-requests/overview/) to learn how to use Postman to perform MCP requests.
244
260
* Visit the [Postman Community](https://community.postman.com/) to share what you've built, ask questions, and get help.
245
261
* You can connect to both the remote and local servers and test them using the [Postman MCP Server collection](https://www.postman.com/postman/postman-public-workspace/collection/681dc649440b35935978b8b7).
0 commit comments