Postman MCP Generator

Postman MCP Generator

欢迎使用生成的 MCP 服务！🚀 此项目由 Postman MCP Generator 创建，配置为 Model Context Provider (MCP) 服务输出模式。它为你提供：

• ✅ 一个兼容 MCP 的服务（mcpServer.js）
• ✅ 为每个选定的 Postman API 请求自动生成的 JavaScript 工具

开始设置吧！

🚦 入门指南

⚙️ 前置条件

开始之前，请确保已安装：

• Node.js（需要 v18+，推荐 v20+）
• npm（随 Node 一起安装）

警告：如果使用较低版本的 Node 运行，fetch 将不可用。工具使用 fetch 发起 HTTP 调用。要解决此问题，可以修改工具，改用 node-fetch。请确保已将 node-fetch 安装为依赖项，然后在每个工具文件中将其作为 fetch 导入。

📥 安装与设置

1. 安装依赖项

在项目根目录中运行：

npm install

🔐 设置工具环境变量

在 .env 文件中，你会看到环境变量占位符，每个占位符对应所选工具所属的一个工作区。例如，如果你选择了来自 2 个工作区（如 Acme 和 Widgets）的请求，你会看到两个占位符：

ACME_API_KEY=
WIDGETS_API_KEY=

将值更新为各 API 的实际 API 密钥。这些环境变量会在生成的工具中使用，为每个请求设置 API 密钥。你可以查看 tools 目录中的文件，了解其工作方式。

// environment variables are used inside of each tool file
const apiKey = process.env.ACME_API_KEY;

注意： 这可能不适用于所有 API。生成逻辑相对简单：对于每个工作区，我们都会创建一个与工作区 slug 同名的环境变量，然后在属于该工作区的每个工具文件中使用该环境变量。如果这不符合所选 API 的要求，也没关系！你可以手动更新 .env 文件或工具文件中的任何内容，使其准确反映 API 的身份验证方式。

🌐 使用 Postman 测试 MCP 服务

MCP 服务（mcpServer.js）会向兼容 MCP 的客户端（如 Claude Desktop 或 Postman Desktop Application）提供自动化 API 工具。我们建议先使用 Postman 测试服务，然后再尝试将其与大模型搭配使用。

Postman Desktop Application 是运行和测试 MCP 服务最简单的方式。先测试下载的服务是可选步骤，但建议执行。

步骤 1：从 https://www.postman.com/downloads/ 下载最新的 Postman Desktop Application。

步骤 2：阅读此处的文档文章，了解如何在 Postman 应用中创建 MCP 请求。

步骤 3：将 MCP 请求的类型设为 STDIO，并将命令设为 node </absolute/path/to/mcpServer.js>。如果仅使用 node 时遇到问题（例如，使用了较旧版本），请改为提供 Node v18+ 版本的绝对路径。运行以下命令即可获取 node 的完整路径：

which node

要检查 node 版本，请运行：

node --version

要获取 mcpServer.js 的绝对路径，请运行：

realpath mcpServer.js

在新建的 Postman MCP Request 中，将 node 命令与 mcpServer.js 的完整路径一起用作命令。然后点击 Connect 按钮。你应该会看到生成服务之前所选工具的列表。在将 MCP 服务连接到大模型之前，可以先在此测试每个工具是否正常工作。

👩‍💻 将 MCP 服务连接到 Claude

你可以将 MCP 服务连接到任意 MCP 客户端。这里介绍如何将其连接到 Claude Desktop。

步骤 1：记下上一步中 node 和 mcpServer.js 的完整路径。

步骤 2：打开 Claude Desktop → 设置 → 开发者 → 编辑配置，并添加新的 MCP 服务：

{
  "mcpServers": {
    "<server_name>": {
      "command": "<absolute/path/to/node>",
      "args": ["<absolute/path/to/mcpServer.js>"]
    }
  }
}

重启 Claude Desktop 以启用此更改。确保新的 MCP 已开启，并且旁边显示绿色圆点。如果是这样，你就可以开始聊天，并使用已连接的工具。

警告：如果你没有提供绝对路径，并且该路径指向的 node 版本低于 v18，Claude（及其他 MCP 客户端）可能会改用系统上较早版本的 node。此时将无法使用 fetch API，工具调用也无法正常工作。如果发生这种情况，你可以：a）安装较新版本的 node，并在命令中指定其路径；或 b）在每个工具中将 node-fetch 导入为 fetch，并确保将 node-fetch 依赖项添加到 package.json。

其他选项

🐳 Docker 部署（生产环境）

对于生产环境部署，你可以使用 Docker：

1. 构建 Docker 镜像

docker build -t <your_server_name> .

2. 集成 Claude Desktop

将 Docker 服务配置添加到 Claude Desktop（设置 → 开发者 → 编辑配置）：

{
  "mcpServers": {
    "<your_server_name>": {
      "command": "docker",
      "args": ["run", "-i", "--rm", "--env-file=.env", "<your_server_name>"]
    }
  }
}

在 .env 文件中添加环境变量（API 密钥等）。

项目附带以下最精简的 Docker 配置：

FROM node:22.12-alpine AS builder

WORKDIR /app
COPY package.json package-lock.json ./
RUN npm install

COPY . .

ENTRYPOINT ["node", "mcpServer.js"]

🌐 服务器发送事件（SSE）

若要通过服务器发送事件（SSE）支持运行服务，请使用 --sse 标志：

node mcpServer.js --sse

🛠️ 其他 CLI 命令

列出工具

使用以下命令列出所有生成工具的描述和参数：

node index.js tools

示例：

Available Tools:

Workspace: acme-workspace
  Collection: useful-api
    list_all_customers
      Description: Retrieve a list of useful things.
      Parameters:
        - magic: The required magic power
        - limit: Number of results returned
        [...additional parameters...]

➕ 添加新工具

轻松为 MCP 服务添加更多工具：

1. 访问 Postman MCP Generator。
2. 选择新的 API 请求，生成新的 MCP 服务并下载。
3. 将新生成的工具复制到现有项目的 tools/ 文件夹中。
4. 更新 tools/paths.js 文件，以包含新工具的引用。

💬 问题与支持

访问 Postman MCP Generator 页面，了解更新和新功能。

加入 Postman Discord 中的 #mcp-lab 频道，分享你的作品并获取帮助。