Postman Agent Generator

Postman Agent Generator

生成されたエージェントへようこそ！🚀

このプロジェクトは、Postman Agent Generatorを使用して作成され、Model Context Provider（MCP）サーバー出力モードに設定されています。次のものが含まれています。

• ✅ MCP 対応サーバー（mcpServer.js）
• ✅ 選択した Postman API リクエストごとに自動生成される JavaScript ツール

セットアップを始めましょう！

🚦 はじめに

⚙️ 前提条件

開始する前に、次のものがあることを確認してください。

• Node.js（v16+ 必須、v20+ 推奨）
• npm（Node に含まれています）

📥 インストールとセットアップ

1. 依存関係をインストールする

プロジェクトのルートディレクトリで次のコマンドを実行します。

npm install

🔐 ツールの環境変数を設定する

.env ファイルには、選択したツールが属するワークスペースごとに、環境変数のプレースホルダーが表示されます。たとえば、Acme と Widgets など、2 つのワークスペースからリクエストを選択した場合、次の 2 つのプレースホルダーが表示されます。

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 でこれが正しいとは限りません。生成ロジックは比較的シンプルです。各ワークスペースに対して、ワークスペースのスラッグと同じ名前の環境変数を作成し、その環境変数を、そのワークスペースに属する各ツールファイルで使用します。選択した API にとってこの動作が適切でない場合も問題ありません。API の認証方式を正確に反映するように、.env ファイルまたはツールファイルを手動で更新できます。

.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）は、Claude Desktop や Postman Desktop Application などの MCP 対応クライアントに、自動化された API ツールを公開します。

A) 🖥️ Postman で実行する

Postman Desktop Application は、MCP サーバーを実行してテストする最も簡単な方法です。

ステップ 1：最新の Postman Desktop Application をhttps://www.postman.com/downloads/からダウンロードします。

ステップ 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>"]
    }
  }
}

環境変数（API キーなど）を .env ファイル内に追加してください。

🌐 Server-Sent Events（SSE）

Server-Sent Events（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"]

➕ 新しいツールの追加

エージェントに簡単にツールを追加できます。

1. Postman Agent Generatorにアクセスします。
2. 新しい API リクエストを選択し、新しいエージェントを生成してダウンロードします。
3. 生成された新しいツールを既存のプロジェクトの tools/ フォルダーにコピーします。
4. tools/paths.js ファイルを更新して、新しいツールへの参照を追加します。

💬 質問とサポート

Postman Agent Generatorのページにアクセスして、更新情報や新機能をご確認ください。

Postman Communityにアクセスして、作成したものを共有したり、質問したり、サポートを受けたりできます。