Postman Agent Generator

Postman Agent 生成器

欢迎使用你生成的 Agent！🚀

此项目由 Postman Agent Generator 创建，并配置为 Model Context Provider (MCP) 服务输出模式。它为你提供：

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

让我们开始设置吧！

🚦 入门

⚙️ 前置条件

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

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

📥 安装与设置

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 的身份验证方式。

在 .env 文件中，为 InsightSentry 工具添加以下环境变量：

INSIGHTSENTRY_API_KEY=your_api_key_here
INSIGHTSENTRY_BASE_URL=https://insightsentry.p.rapidapi.com
INSIGHTSENTRY_WS_URL=wss://stream.insightsentry.com/quote

INSIGHTSENTRY_API_KEY 是你用于访问 InsightSentry API 的 RapidAPI 密钥。 INSIGHTSENTRY_BASE_URL 是 REST API 端点的基础 URL。 INSIGHTSENTRY_WS_URL 是用于实时数据流的 WebSocket URL。

🛠️ 列出可用工具

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

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 服务

MCP 服务（mcpServer.js）会向兼容 MCP 的客户端（例如 Claude Desktop 或 Postman Desktop Application）公开你的自动化 API 工具。

A) 🖥️ 使用 Postman 运行

Postman Desktop Application 是运行和测试 MCP 服务最简单的方式。

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

步骤 2：阅读此处的文档文章，了解后续步骤。

B) 👩‍💻 使用 Claude Desktop 运行

要与 Claude Desktop 集成：

1. 查找 node 路径：

which node

2. 查找 mcpServer.js 路径：

realpath mcpServer.js

3. 打开 Claude Desktop → Settings → Developers → Edit Config，并添加你的服务：

{
  "mcpServers": {
    "<server_name>": {
      "command": "<absolute_path_to_node>",
      "args": ["<absolute_path_to_mcpServer.js>"]
    }
  }
}

重启 Claude Desktop 以启用此更改。

其他选项

🐳 Docker 部署（生产环境）

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

1. 构建 Docker 镜像

docker build -t <your_server_name> .

2. Claude Desktop 集成

将 Docker 服务配置添加到 Claude Desktop（Settings → Developers → Edit Config）：

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

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

🌐 服务器发送事件（SSE）

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

node mcpServer.js --sse

🐳 Dockerfile（已包含）

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

FROM node:22.12-alpine AS builder

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

COPY . .

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

➕ 添加新工具

轻松为你的 Agent 扩展更多工具：

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

💬 问题与支持

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

访问 Postman Community，分享你的作品、提问并获取帮助。