Skip to main content
Glama
runninghare

REST-to-Postman MCP

by runninghare

REST から Postman MCP へ

鍛冶屋のバッジ

REST APIコード(NestJSコントローラー、FastAPI/Flaskエンドポイントなど)をPostmanのコレクションと環境に変換するモデルコンテキストプロトコル(MCP)サーバー。このツールは、開発者がREST APIエンドポイントと環境設定をPostmanと自動的に同期するのに役立ちます。

特徴

  • REST APIエンドポイントをPostmanコレクションに変換する

  • 環境変数をPostman環境と同期する

  • さまざまな認証方法のサポート(例:ベアラートークン)

  • 新しいエンドポイントと既存のコレクションのインテリジェントなマージ

  • 敏感な環境変数の自動処理

  • stdio と SSE トランスポートモードの両方をサポート

Related MCP server: Codebase Insights MCP Server

前提条件

  • Bun v1.2.2以降

  • Postman APIキー

  • Postman ワークスペース ID

インストールと使用方法

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

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 コード エディターと統合できます。

  • クロードデスクトップ

  • カーソル

  • ウィンドサーフィン

  • ルー・クライン編集者

重要事項:サーバーが機能するにはPostman API認証情報が必要です。サーバーを起動する前に、APIキーとワークスペースIDの両方をご用意ください。

ツールの説明

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

1. RESTからPostman環境へ( rest_to_postman_env

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

入力パラメータ:

  • envName (文字列): Postman環境の名前

  • envVars (オブジェクト): 環境変数のキーと値のペア

入力例:

{
    "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 (オブジェクト): 次の内容を含む 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"
    }]
}

カーソルでこの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 Controller からのすべてのエンドポイントが、Bear トークン設定とともに生成されることに注意してください。

発達

ローカルセットアップ

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

git clone https://github.com/runninghare/rest-to-postman.git
cd rest-to-postman
  1. 依存関係をインストールします:

bun install
  1. .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 ファイルを参照してください。

Available Tools

2 tools
rest_to_postman_collectionA

Creates or updates a Postman collection with the provided collection configuration. This tool helps synchronize your REST API endpoints with Postman. When updating an existing collection, it intelligently merges the new endpoints with existing ones, avoiding duplicates while preserving custom modifications made in Postman. Here's an example:

{ "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"] }
} }, { "name": "Create User", "request": { "method": "POST", "url": { "raw": "{{API_URL}}/users" }, "body": { "mode": "raw", "raw": "{"name":"John Doe","email":"john.doe@example.com"}" } }
} ] }

ParametersJSON Schema
NameRequiredDescriptionDefault
collectionRequestYesThe Postman collection configuration containing info, items, and other collection details

TDQS

A3.7/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It describes key behaviors: it can create or update collections, intelligently merges endpoints to avoid duplicates, and preserves custom modifications. However, it lacks details on permissions, error handling, or rate limits, which are important for a mutation tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with the core purpose but includes a lengthy example that may not be necessary for understanding the tool's function. While the example is helpful, it makes the description less concise, and some details could be moved to documentation.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the complexity (1 parameter with nested objects, no annotations, no output schema), the description is moderately complete. It covers the tool's purpose and behavior but lacks information on return values, error cases, or prerequisites, which are important for a tool that mutates data.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has 100% description coverage, so the baseline is 3. The description adds minimal parameter semantics by mentioning 'collection configuration' and providing an example, but it does not explain parameter constraints or usage beyond what the schema already documents.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose: 'Creates or updates a Postman collection with the provided collection configuration.' It specifies the verb ('creates or updates'), the resource ('Postman collection'), and distinguishes it from sibling tools by mentioning synchronization with REST API endpoints, unlike the sibling 'rest_to_postman_env' which likely handles environments.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides clear context for usage: 'This tool helps synchronize your REST API endpoints with Postman.' It explains when to use it (for creating or updating collections) and hints at the update behavior (intelligent merging). However, it does not explicitly state when not to use it or name specific alternatives beyond the sibling tool.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

rest_to_postman_envA

Creates or updates a Postman environment with the provided environment variables. This tool helps synchronize your REST application's environment configuration with Postman. It supports both creating new environments and updating existing ones in your Postman workspace. Environment variables related to sensitive data (containing 'token' in their names) are automatically marked as secrets. Here's an example:

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

ParametersJSON Schema
NameRequiredDescriptionDefault
envNameYesThe name of the Postman environment to create or update
envVarsYesA record of environment variables to be added to the Postman environment. Format: { [key: string]: string }

TDQS

A3.6/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It reveals important behavioral traits: support for both create and update operations, automatic secret marking for variables containing 'token', and workspace context. However, it doesn't disclose authentication requirements, rate limits, error handling, or whether the operation is idempotent, leaving significant gaps for a mutation tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is appropriately sized and front-loaded with the core functionality in the first sentence. The example is helpful but could be more concise. The text is well-structured with clear sentences, though the example takes up significant space relative to the explanatory content.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a mutation tool with no annotations and no output schema, the description provides adequate basic information about what the tool does and includes a helpful example. However, it lacks important contextual details: no information about return values, error conditions, authentication requirements, or workspace selection logic. The example helps but doesn't compensate for these missing elements.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already fully documents both parameters. The description adds minimal value beyond the schema: it provides an example showing the expected JSON structure and mentions the secret-marking behavior for 'token' variables, but doesn't explain parameter semantics beyond what's in the schema descriptions.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose with specific verbs ('creates or updates') and resource ('Postman environment with environment variables'). It distinguishes from the sibling tool 'rest_to_postman_collection' by focusing on environments rather than collections, providing clear differentiation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage context ('helps synchronize your REST application's environment configuration with Postman') but doesn't explicitly state when to use this tool versus alternatives. No guidance is provided on prerequisites, error conditions, or specific scenarios where this tool is preferred over manual configuration or other tools.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

  1. 2 tool updates
    • First observedrest_to_postman_collection
    • First observedrest_to_postman_env

TDQS

A3.6/5.0

Scored across 2 tools

Disambiguation5/5

The two tools have completely distinct purposes: one handles Postman collections (API endpoint configurations), while the other handles Postman environments (environment variables). There is no overlap in functionality, making it impossible to confuse them.

Naming Consistency5/5

Both tools follow a perfect 'rest_to_postman_' prefix pattern with descriptive suffixes ('collection' and 'env'). The naming is completely consistent in style and structure throughout the set.

Tool Count2/5

With only 2 tools, this server feels severely under-scoped for a REST-to-Postman integration purpose. A complete synchronization system would typically need tools for operations like listing collections/environments, deleting resources, or handling authentication flows, not just create/update operations.

Completeness2/5

The toolset is significantly incomplete for REST-to-Postman synchronization. While create/update operations exist for collections and environments, there are no tools for reading existing resources, deleting them, managing workspaces, or handling more complex Postman features like monitors or mocks. This creates dead ends for agents trying to perform full lifecycle management.

Maintenance

ActivityInactive
ResponsivenessNo issues

Related MCP Connectors

Related MCP Servers

  • F
    license
    Not graded
    quality
    D
    maintenance
    Automatically converts Postman API collections into MCP-compatible tools for AI assistants. Enables users to interact with any API through natural language by generating JavaScript tools from Postman requests.
    -
  • A
    license
    Not graded
    quality
    C
    maintenance
    Analyzes API codebases from GitHub and Bitbucket repositories to generate Postman collections, business reports, and detailed code insights. Supports multiple frameworks including FastAPI, Spring Boot, Flask, Express, and OpenAPI/Swagger specifications.
    MIT
  • A
    license
    A
    quality
    D
    maintenance
    Integrates Postman with Cursor IDE to manage collections and requests through natural language. It features specialized tools for automatically migrating API endpoints and metadata directly from .NET controller code into Postman collections.
    8
    31 npm
    MIT