From 38f2b0afa2091d0363bdae99efe9f0626b6b801b Mon Sep 17 00:00:00 2001 From: Ruben Date: Tue, 28 Oct 2025 12:44:40 +0100 Subject: [PATCH 01/11] adding changes in package.json and server.json in order to publish to mcp registry --- package.json | 1 + server.json | 137 ++++++++++++++++++++++++++++++++++++++++----------- 2 files changed, 108 insertions(+), 30 deletions(-) diff --git a/package.json b/package.json index afa1818..fb897bd 100644 --- a/package.json +++ b/package.json @@ -2,6 +2,7 @@ "name": "@postman/postman-mcp-server", "version": "2.3.7", "description": "A simple MCP server to operate on the Postman API", + "mcpName":"com.postman/@postman/postman-mcp-server", "main": "dist/src/index.js", "type": "module", "scripts": { diff --git a/server.json b/server.json index 7f34779..4c08873 100644 --- a/server.json +++ b/server.json @@ -1,33 +1,110 @@ { - "server": { - "description": "Postman's MCP server connects AI agents, assistants, and chatbots directly to your APIs on Postman. Use natural language to prompt AI to automate work across your Postman collections, environments, workspaces, and more.", - "name": "com.postman/postman-mcp-server", - "status": "active", - "packages": [ - { - "environment_variables": [ - { - "name": "POSTMAN_API_KEY", - "value": "{api_key}", - "variables": { - "api_key": { - "description": "Your Postman API key", - "is_required": true, - "is_secret": true - } - } - } - ], - "name": "@postman/postman-mcp-server", - "registry_name": "npm", - "runtime_hint": "npx", - "version": "latest" - } - ], - "repository": { - "readme": "# Postman MCP Server\n\nThis project offers the following Model Context Protocol (MCP) server options:\n\n- [**STDIO**](#stdio)\n- [**Streamable HTTP**](#streamable-http)\n\nFor more information about the available transports, see the [MCP specification](https://modelcontextprotocol.io/docs/concepts/transports).\n\n## STDIO\n\nThis is a lightweight solution that's ideal for integration with editors and tools like [VS Code](https://code.visualstudio.com/).\n\n\u003e For Docker set up and installation, see [DOCKER.md](./DOCKER.md).\n\n### VS Code integration\n\n\u003e **Note:**\n\u003e By default, this server provides 37 tools (minimal mode). Use the `--full` flag to access all 106 tools.\n\u003e Use the `--region` flag to specify the Postman API region (`us` or `eu`), or set the `POSTMAN_API_BASE_URL` environment variable directly.\n\nIntegrate your MCP server with Visual Studio Code and use it with VS Code extensions that support MCP. To do this, do the following:\n\n1. Create a *.vscode/mcp.json* file in your project and enter the following:\n\n ```json\n {\n \"servers\": {\n \"postman-api-mcp\": {\n \"type\": \"stdio\",\n \"command\": \"npx\",\n \"args\": [\n \"@postman/postman-mcp-server\",\n \"--full\" // (optional) Use this flag to enable full mode\n ],\n \"env\": {\n \"POSTMAN_API_KEY\": \"${input:postman-api-key}\"\n }\n }\n },\n \"inputs\": [\n {\n \"id\": \"postman-api-key\",\n \"type\": \"promptString\",\n \"description\": \"Enter your Postman API key\"\n }\n ]\n }\n ```\n\n1. Install an MCP-compatible VS Code extension, such as GitHub Copilot, Claude for VS Code, or other AI assistants that support MCP.\n\n#### Configure the extension\n\nConfigure the extension to use the **postman-api-mcp** server, a local STDIO-based server that runs directly from your project files:\n\n1. Clone the **postman-mcp-server** repository.\n1. In the repository's root folder, run the `npm install` command. This installs all the required dependencies.\n1. Replace `${workspaceFolder}` in the *mcp.json* file with the full path to the Postman MCP repository.\n1. When prompted, enter your [Postman API key](https://go.postman.co/settings/me/api-keys).\n\n### Claude integration\n\nTo integrate the MCP server with Claude, check the latest [Postman MCP server release](https://github.com/postmanlabs/postman-mcp-server/releases) and download one of the following `.dxt` files:\n\n- **postman-api-mcp-minimal.dxt** - Contains 37 essential tools for basic Postman operations.\n- **postman-api-mcp-full.dxt** - Contains all 106+ tools for comprehensive Postman functionality.\n\nFor more information, see Anthropic's [Claude Desktop Extensions](https://www.anthropic.com/engineering/desktop-extensions) documentation.\n\n## Streamable HTTP\n\nThe streamable HTTP version is available at `https://mcp.postman.com`. It supports two tool configurations to better serve different use cases:\n\n- **Minimal** — Only includes essential tools for basic Postman operations, available at `https://mcp.postman.com/minimal`. This offers faster performance and simplifies use for those who only need basic Postman operations.\n- **Full** — Includes all available Postman API tools (100+ tools), available at `https://mcp.postman.com/mcp`.\n\n\u003e **Note:** The streamable EU HTTP server is available at `https://mcp.eu.postman.com`.\n\n### Cursor integration\n\nTo integrate the MCP server with Cursor, click the following button:\n\u003e Ensure the Authorization header uses the Bearer \u003cYOUR_API_KEY\u003e format.\n\n[![Install the Postman MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en/install-mcp?name=postman_mcp_server\u0026config=eyJ1cmwiOiJodHRwczovL21jcC5wb3N0bWFuLmNvbS9taW5pbWFsIiwiaGVhZGVycyI6eyJBdXRob3JpemF0aW9uIjoiQmVhcmVyIFlPVVJfQVBJX0tFWSJ9fQ%3D%3D)\n\n### VS Code integration\n\n\u003e By default, the server provides 37 tools. Use **Full** (`https://mcp.postman.com/mcp`) mode to access all 106 tools.\n\nTo install in VS Code, you can use the [Postman VS Code Extension](https://marketplace.visualstudio.com/items?itemName=Postman.postman-for-vscode). Or you can add the following to the *.vscode/mcp.json* file:\n\n```json\n{\n \"servers\": {\n \"postman-api-http-server\": {\n \"type\": \"http\",\n \"url\": \"https://mcp.postman.com/{minimal | mcp}\", // choose \"minimal\" or \"mcp\"\n \"headers\": {\n \"Authorization\": \"Bearer ${input:postman-api-key}\"\n }\n }\n },\n \"inputs\": [\n {\n \"id\": \"postman-api-key\",\n \"type\": \"promptString\",\n \"description\": \"Enter your Postman API key\"\n }\n ]\n}\n```\n\nWhen prompted, enter your Postman API key. Afterwards, the agent performs calls to the Postman cloud MCP server at `https://mcp.postman.com`.\n\n## Migration from v1.x to v2.x\n\n- **Tool naming changes** - All tool names changed from kebab-case to camelCase. For example:\n - `create-collection` → `createCollection`\n - `get-workspaces` → `getWorkspaces`\n - `delete-environment` → `deleteEnvironment`\n- **Tool availability changes**\n - The default (Minimal) behavior provides only 37 essential tools.\n - The `--full` flag provides access to all 106 tools.\n\n## Questions and support\n\n- See the [Postman Agent Generator](https://postman.com/explore/agent-generator) page for updates and new capabilities.\n- 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.\n- Visit the [Postman Community](https://community.postman.com/) to share what you've built, ask questions, and get help.\n- You can connect to both HTTP and STDIO servers and test them using the [Postman MCP Server collection](https://www.postman.com/postman/postman-public-workspace/collection/681dc649440b35935978b8b7).\n", - "source": "github", - "url": "https://github.com/postmanlabs/postman-mcp-server" + "$schema": "https://static.modelcontextprotocol.io/schemas/2025-10-17/server.schema.json", + "name": "com.postman/postman-mcp-server", + "description": "A simple MCP server to operate on the Postman API", + "repository": { + "url": "https://github.com/postmanlabs/postman-mcp-server", + "source": "github" + }, + "version": "2.4.0", + "packages": [ + { + "registryType": "npm", + "identifier": "@postman/postman-mcp-server", + "version": "2.4.0", + "transport": { + "type": "stdio" + }, + "environmentVariables": [ + { + "description": "Your Postman API Key", + "isRequired": true, + "isSecret": true, + "name": "POSTMAN_API_KEY" + } + ] + }, + { + "registryType": "mcpb", + "identifier": "https://github.com/postmanlabs/postman-mcp-server/releases/download/v2.3.7/postman-mcp-server-minimal.mcpb", + "fileSha256": "141d04ea82f35bd140ba8c73fa87b1f746260b9c11ee0623fc04b6012056985f", + "transport": { + "type": "stdio" + }, + "environmentVariables": [ + { + "description": "Your Postman API Key", + "isRequired": true, + "isSecret": true, + "name": "POSTMAN_API_KEY" + } + ] + }, + { + "registryType": "mcpb", + "identifier": "https://github.com/postmanlabs/postman-mcp-server/releases/download/v2.3.7/postman-mcp-server-full.mcpb", + "fileSha256": "8ec132046ecf970a52ae056628a9187bdcabad89dff7b4b6ea3f91769f360aeb", + "transport": { + "type": "stdio" + }, + "environmentVariables": [ + { + "description": "Your Postman API Key", + "isRequired": true, + "isSecret": true, + "name": "POSTMAN_API_KEY" + } + ] } - } + ], + "remotes": [ + { + "type": "streamable-http", + "url": "https://mcp.postman.com/mcp", + "headers": [ + { + "name": "Authorization", + "description": "Bearer + your API key for authentication", + "isRequired": true, + "isSecret": true + } + ] + }, + { + "type": "streamable-http", + "url": "https://mcp.postman.com/minimal", + "headers": [ + { + "name": "Authorization", + "description": "Bearer + your API key for authentication", + "isRequired": true, + "isSecret": true + } + ] + }, + { + "type": "streamable-http", + "url": "https://mcp.eu.postman.com/mcp", + "headers": [ + { + "name": "Authorization", + "description": "Bearer + your API key for authentication", + "isRequired": true, + "isSecret": true + } + ] + }, + { + "type": "streamable-http", + "url": "https://mcp.eu.postman.com/minimal", + "headers": [ + { + "name": "Authorization", + "description": "Bearer + your API key for authentication", + "isRequired": true, + "isSecret": true + } + ] + } + ] } \ No newline at end of file From 3a80d113ed33eafeb9502bde3bf9f4d0bcf87a17 Mon Sep 17 00:00:00 2001 From: Ruben Date: Tue, 28 Oct 2025 12:47:29 +0100 Subject: [PATCH 02/11] adding new line --- server.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/server.json b/server.json index 4c08873..5a69f33 100644 --- a/server.json +++ b/server.json @@ -107,4 +107,4 @@ ] } ] -} \ No newline at end of file +} From 3ad6e75f3a45955836703527392f76950999428c Mon Sep 17 00:00:00 2001 From: Ruben Baraut <116556424+rubenbaraut@users.noreply.github.com> Date: Tue, 28 Oct 2025 12:50:41 +0100 Subject: [PATCH 03/11] Apply suggestion from @akira28 Co-authored-by: Andrea De Pirro --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index fb897bd..0a237a3 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "@postman/postman-mcp-server", "version": "2.3.7", "description": "A simple MCP server to operate on the Postman API", - "mcpName":"com.postman/@postman/postman-mcp-server", + "mcpName": "com.postman/@postman/postman-mcp-server", "main": "dist/src/index.js", "type": "module", "scripts": { From 2bcd6f2f8ff39c134bbdd70f98cb708fa7b8780e Mon Sep 17 00:00:00 2001 From: Ruben Baraut <116556424+rubenbaraut@users.noreply.github.com> Date: Wed, 29 Oct 2025 10:32:17 +0100 Subject: [PATCH 04/11] Update server.json Co-authored-by: Ashley Kinard <113702138+akinard-postman@users.noreply.github.com> --- server.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/server.json b/server.json index 5a69f33..0bca0dc 100644 --- a/server.json +++ b/server.json @@ -1,7 +1,7 @@ { "$schema": "https://static.modelcontextprotocol.io/schemas/2025-10-17/server.schema.json", "name": "com.postman/postman-mcp-server", - "description": "A simple MCP server to operate on the Postman API", + "description": "A basic MCP server to operate on the Postman API.", "repository": { "url": "https://github.com/postmanlabs/postman-mcp-server", "source": "github" From 14b1f47b614d703cea363864b29a4484255abc91 Mon Sep 17 00:00:00 2001 From: Ruben Baraut <116556424+rubenbaraut@users.noreply.github.com> Date: Wed, 29 Oct 2025 10:32:36 +0100 Subject: [PATCH 05/11] Update server.json Co-authored-by: Ashley Kinard <113702138+akinard-postman@users.noreply.github.com> --- server.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/server.json b/server.json index 0bca0dc..ef0408d 100644 --- a/server.json +++ b/server.json @@ -17,7 +17,7 @@ }, "environmentVariables": [ { - "description": "Your Postman API Key", + "description": "A valid Postman API key.", "isRequired": true, "isSecret": true, "name": "POSTMAN_API_KEY" From dac965fc931a26c3df16486917eab150f21b8e9f Mon Sep 17 00:00:00 2001 From: Ruben Baraut <116556424+rubenbaraut@users.noreply.github.com> Date: Wed, 29 Oct 2025 10:32:47 +0100 Subject: [PATCH 06/11] Update server.json Co-authored-by: Ashley Kinard <113702138+akinard-postman@users.noreply.github.com> --- server.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/server.json b/server.json index ef0408d..67e3fc5 100644 --- a/server.json +++ b/server.json @@ -49,7 +49,7 @@ }, "environmentVariables": [ { - "description": "Your Postman API Key", + "description": "A valid Postman API key.", "isRequired": true, "isSecret": true, "name": "POSTMAN_API_KEY" From 360d209dec54e34e92bd67ef8b7a0396866764f8 Mon Sep 17 00:00:00 2001 From: Ruben Baraut <116556424+rubenbaraut@users.noreply.github.com> Date: Wed, 29 Oct 2025 10:32:55 +0100 Subject: [PATCH 07/11] Update server.json Co-authored-by: Ashley Kinard <113702138+akinard-postman@users.noreply.github.com> --- server.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/server.json b/server.json index 67e3fc5..45e651e 100644 --- a/server.json +++ b/server.json @@ -33,7 +33,7 @@ }, "environmentVariables": [ { - "description": "Your Postman API Key", + "description": "A valid Postman API key.", "isRequired": true, "isSecret": true, "name": "POSTMAN_API_KEY" From e7f2dbfe2f8b88b8d557d13b458cec998e8cc4c1 Mon Sep 17 00:00:00 2001 From: Ruben Baraut <116556424+rubenbaraut@users.noreply.github.com> Date: Wed, 29 Oct 2025 10:33:07 +0100 Subject: [PATCH 08/11] Update server.json Co-authored-by: Ashley Kinard <113702138+akinard-postman@users.noreply.github.com> --- server.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/server.json b/server.json index 45e651e..dd9f559 100644 --- a/server.json +++ b/server.json @@ -64,7 +64,7 @@ "headers": [ { "name": "Authorization", - "description": "Bearer + your API key for authentication", + "description": "A Bearer token and a valid Postman API key for authentication.", "isRequired": true, "isSecret": true } From e8047abd9d472e839965c07cdb58b94ef1614d92 Mon Sep 17 00:00:00 2001 From: Ruben Baraut <116556424+rubenbaraut@users.noreply.github.com> Date: Wed, 29 Oct 2025 10:33:15 +0100 Subject: [PATCH 09/11] Update server.json Co-authored-by: Ashley Kinard <113702138+akinard-postman@users.noreply.github.com> --- server.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/server.json b/server.json index dd9f559..793c3b2 100644 --- a/server.json +++ b/server.json @@ -76,7 +76,7 @@ "headers": [ { "name": "Authorization", - "description": "Bearer + your API key for authentication", + "description": "A Bearer token and a valid Postman API key for authentication.", "isRequired": true, "isSecret": true } From 4e70c3f217b976de3d2930491312df3966f528dd Mon Sep 17 00:00:00 2001 From: Ruben Baraut <116556424+rubenbaraut@users.noreply.github.com> Date: Wed, 29 Oct 2025 10:33:23 +0100 Subject: [PATCH 10/11] Update server.json Co-authored-by: Ashley Kinard <113702138+akinard-postman@users.noreply.github.com> --- server.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/server.json b/server.json index 793c3b2..868dd16 100644 --- a/server.json +++ b/server.json @@ -88,7 +88,7 @@ "headers": [ { "name": "Authorization", - "description": "Bearer + your API key for authentication", + "description": "A Bearer token and a valid Postman API key for authentication.", "isRequired": true, "isSecret": true } From a997bab2b3cafb944e1206bd13193a1db17fd860 Mon Sep 17 00:00:00 2001 From: Ruben Baraut <116556424+rubenbaraut@users.noreply.github.com> Date: Wed, 29 Oct 2025 10:33:32 +0100 Subject: [PATCH 11/11] Update server.json Co-authored-by: Ashley Kinard <113702138+akinard-postman@users.noreply.github.com> --- server.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/server.json b/server.json index 868dd16..cc9884f 100644 --- a/server.json +++ b/server.json @@ -100,7 +100,7 @@ "headers": [ { "name": "Authorization", - "description": "Bearer + your API key for authentication", + "description": "A Bearer token and a valid Postman API key for authentication.", "isRequired": true, "isSecret": true }