REST-to-Postman MCP

REST-to-Postman MCP

REST API コード（NestJS コントローラー、FastAPI／Flask エンドポイントなど）を Postman コレクションと環境に変換する Model Context Protocol（MCP）サーバーです。このツールを使うと、REST API エンドポイントと環境設定を Postman と自動的に同期できます。

機能

• REST API エンドポイントを Postman コレクションに変換
• 環境変数を Postman 環境と同期
• さまざまな認証方式（Bearer トークンなど）に対応
• 新しいエンドポイントを既存のコレクションにインテリジェントにマージ
• 機密性の高い環境変数を自動的に処理
• stdio と SSE の両方のトランスポートモードに対応

前提条件

• Bun v1.2.2 以降
• Postman API キー
• Postman ワークスペース ID

インストールと使用方法

この Model Context Protocol（MCP）stdio サーバーは、コレクションと環境を作成・更新するために、Postman ワークスペースへのアクセスが必要です。

Smithery 経由でインストールする

Smithery 経由で Claude Desktop に REST-to-Postman MCP を自動的にインストールするには：

npx -y @smithery/cli install @runninghare/rest-to-postman-mcp --client claude

npx で MCP サーバーを実行する

npx で MCP サーバーを使用するには：

npx -y rest-to-postman@latest --postman-api-key your_api_key --postman-workspace-id your_workspace_id

または、環境変数を使用します：

export POSTMAN_API_KEY=your_api_key
export POSTMAN_ACTIVE_WORKSPACE_ID=your_workspace_id
npx -y rest-to-postman@latest 

このコマンドは、MCP に対応したさまざまな AI コードエディターと連携できます。

• Claude Desktop
• Cursor
• Windsurf
• Roo Cline Editor

重要な注意事項：サーバーを動作させるには Postman API の認証情報が必要です。サーバーを起動する前に、API キーとワークスペース ID の両方を用意してください。

ツールの説明

サーバーは 2 つの主要なツールを提供します。

1. REST から Postman 環境へ（rest_to_postman_env）

アプリケーションの環境変数を含む Postman 環境を作成または更新します。

入力パラメーター：

• envName（string）：Postman 環境の名前
• envVars（object）：環境変数のキーと値のペア

入力例：

{
    "envName": "REST Environment",
    "envVars": {
        "API_URL": "https://api.example.com",
        "API_TOKEN": "secret-token-1"
    }
}

2. REST から Postman コレクションへ（rest_to_postman_collection）

REST API エンドポイントを含む Postman コレクションを作成または更新します。

入力パラメーター：

• collectionRequest（object）：以下を含む Postman コレクションの設定：
  • info：コレクションのメタデータ
  • auth：認証設定
  • item：API エンドポイントの配列

入力例：

{
    "info": {
        "name": "REST Collection",
        "description": "REST Collection", 
        "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
    },
    "auth": {
        "type": "bearer",
        "bearer": [
            {   
                "key": "Authorization",
                "value": "Bearer {{API_TOKEN}}",
                "type": "string"
            }
        ]
    },  
    "item": [
        {
            "name": "Get Users",
            "request": {
                "method": "GET",    
                "url": {
                    "raw": "{{API_URL}}/users",
                    "protocol": "https",
                    "host": ["api", "example", "com"],
                    "path": ["users"]
                }   
            }
        }
    ]
}

応答形式

どちらのツールも、Postman リソースの作成または更新が完了したことを示す成功メッセージを返します。

{
    "content": [{
        "type": "text",
        "text": "Successfully created/updated Postman environment: REST Environment"
    }]
}

Cursor でこの MCP を使用する

この MCP サーバーは Cursor で使用できます。以下は、Nest.js の Typescript コントローラーをもとに Postman コレクションを生成する例です。

プロンプト：

Create a postman collection named "Campaign Endpoints" based on this next.js controller. The baseUrl is `http://localhost:7022`. The collection should have a Bear token which applies to all the endpoints

自動生成された Postman コレクションは次のとおりです。

Campaign コントローラーのすべてのエンドポイントが生成され、Bearer トークンの設定も含まれていることを確認してください。

開発

ローカル環境のセットアップ

1. リポジトリをクローンします：

git clone https://github.com/runninghare/rest-to-postman.git
cd rest-to-postman

2. 依存関係をインストールします：

bun install

3. .env ファイルを作成します：

POSTMAN_API_KEY=your_api_key_here
POSTMAN_ACTIVE_WORKSPACE_ID=your_workspace_id_here

開発モードでの実行

開発時は、Bun を使ってサーバーを直接実行できます。

# Start in stdio mode (default)
bun run src/mcp.ts

# Start in SSE mode
bun run src/mcp.ts --sse

ビルド

プロジェクトをビルドするには：

bun run build

これにより、dist ディレクトリにバンドル済みの出力が作成されます。

スクリプト

• bun run build - プロジェクトをビルド
• bun run dev - サーバーを開発モードで実行
• bun run startSSE - サーバーを SSE モードで起動

貢献

貢献を歓迎します！お気軽にプルリクエストを送信してください。

ライセンス

このプロジェクトは MIT ライセンスの下でライセンスされています。詳細については LICENSE ファイルをご覧ください。