Postman Agent Generator

ワークショップのスライド：

https://drive.google.com/drive/folders/1CQaKkrcuD8Vxam559EEdCByX0z2s-Oxc?usp=sharing

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

🔐 ツールの環境変数を設定する（octocat と harry potter api では不要です）

.env ファイルには環境変数のプレースホルダーがあり、選択したツールの取得元となるワークスペースごとに 1 つずつ用意されています。たとえば、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 ファイルやツールファイルを手動で更新できます。

🛠️ 利用可能なツールを一覧表示する

生成されたすべてのツールの説明とパラメーターを一覧表示するには、次を実行します。

node index.js tools

例：

Available Tools:

Workspace: 6-harry-potter-api-with-magic-visualizations
  Collection: hogwarts-staff.js
    get_hogwarts_staff
      Description: Retrieve all Hogwarts staff characters.
      Parameters:

  Collection: spells.js
    fetch_spells
      Description: Fetch spells from the Harry Potter API.
      Parameters:

  Collection: hogwarts-students.js
    get_hogwarts_students
      Description: Fetch all Hogwarts students from the Harry Potter API.
      Parameters:

  Collection: characters-in-house.js
    get_characters_in_house
      Description: Retrieve characters from a specific Hogwarts house.
      Parameters:
        - house: The name of the Hogwarts house to retrieve characters from.

  Collection: all-characters.js
    get_all_characters
      Description: Retrieve all characters from the Harry Potter API.
      Parameters:


Workspace: 7-git-hub-octodex-postbot
  Collection: build-your-own-octodex-api.js
    fetch_octocats
      Description: Fetch Octocats from the Octodex API.
      Parameters:

🌐 MCP サーバーを実行する

MCP サーバー（mcpServer.js）は、自動化された API ツールを、Claude Desktop や Postman Desktop Application などの MCP 互換クライアントに公開します。

1. Node のパスを確認します。

which node

2. mcpServer.js のパスを確認します。

realpath mcpServer.js

A) 🖥️ Postman で実行する

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

ステップ 1：最新の Postman Desktop Application を https://www.postman.com/downloads/ からダウンロードするか、最新の Postman Desktop Agent をインストールして、ブラウザーで Postman を使用します。

ステップ 2：こちらから Octodex-HP-MCP Server Postman Collection をフォークまたは変更し、Octodex & HP Local Node サーバーの設定がローカルの MCP サーバーを指すように調整します。

B) 👩‍💻 Claude Desktop で実行する

Claude Desktop と統合するには、次の手順を行います。

Claude Desktop を開き、Settings → Developers → Edit Config の順に選択して、サーバーを追加します。

{
  "mcpServers": {
    "octocat-hp-mcp-server-local": {
      "command": "<absolute_path_to_node>",
      "args": ["<absolute_path_to_mcpServer.js>"]
    }
  }
}

例：

{
  "mcpServers": {
    "octocat-hp-mcp-server-local": {
      "command": "/usr/local/bin/node",
      "args": ["/Users/yourusername/octocat-harry-potter-mcp-server/mcpServer.js"]
    }
  }
}

Claude Desktop を再起動して、この変更を有効にします。

C) 🏃‍♂️ VSCode で MCP サーバーを実行する

VSCode でローカル MCP サーバーを実行するには、.vscode フォルダー内にある octocat-hp-mcp-server-local サーバーを調整して起動します。

その後、Co-Pilot Chat で Agent モードを選択すると、ツールアイコンに octocat-hp-mcp-server-local サーバーが公開する API エンドポイント（ツール）が表示されます。

その他のオプション

🐳 Docker によるデプロイ（本番環境）

本番環境にデプロイする場合は、Docker を使用できます。

1. Docker イメージをビルドする

docker build -t octocat-hp-mcp-server .

.env ファイルに環境変数（API キーなど）を追加します。

ローカルでテストします。

docker run -i --rm --env-file .env octocat-hp-mcp-server

2. Claude Desktop との連携

Claude Desktop に Docker サーバーの設定を追加します（Settings → Developers → Edit Config）。

{
  "mcpServers": {
    "octocat-hp-mcp-server-docker": {
      "command": "docker",
      "args": ["run", "-i", "--rm", "--env-file=.env", "octocat-hp-mcp-server"]
    }
  }
}

3. VS Code との連携

VSCode で Docker MCP サーバーを実行するには、.vscode フォルダーにある octocat-hp-mcp-server-docker サーバーを適宜変更して起動します。

その後、Co-Pilot Chat で Agent モードを選択すると、ツールアイコンに octocat-hp-mcp-server-docker サーバーが公開している API エンドポイント（ツール）が表示されます。

🌐 Server-Sent Events（SSE）

Server-Sent Events（SSE）をサポートしてサーバーを実行するには、--sse フラグを使用します。

node mcpServer.js --sse

Docker で SSE を有効にし、ポート 9000 で公開して実行する場合：

docker run  -i --rm  -p 9000:9000 --env-file .env octocat-hp-mcp-server node mcpServer.js --sse

これにより、サーバーがバックグラウンドで起動し、ホストのポート 9000 がコンテナーのポート 9000 にマッピングされ、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 ファイルを更新し、新しいツールの参照を追加します。

プロンプトとビジュアライゼーションの例

prompts.md には、MCP サーバーの機能をテストするためのプロンプト例が掲載されています。これらのプロンプトを使うと、次のようなビジュアライゼーションが生成されます。

💬 質問とサポート

最新情報や新機能については、Postman Agent Generator のページをご覧ください。

作成したものの共有、質問、サポートの依頼は、Postman Community をご利用ください。