Postman MCP Server

Postman MCP Server

バージョン： v0.2.0

Postman API にアクセスする MCP サーバーです。機能は公式 OpenAPI 仕様に基づいています。詳しくは、Postman API ドキュメントをご覧ください。

このプロジェクトは、Anthropic による Model Context Protocol（MCP）イニシアチブの一部です。詳しくは、MCP GitHub リポジトリとAnthropic ブログの発表をご覧ください。

インストール手順へ移動

警告

このプロジェクトは現在、活発に開発されています。慎重にご利用ください。また、互換性を損なう変更が発生する可能性があります。

メモ

AI によって生成されたコードです。Cline v2.2.2 と Claude 3.5 Sonnet (2024-10-22) を使用しました。プロンプトとコードの生成方法の詳細については、docs/README.md をご覧ください。

---

• 概要
• 機能
  • コレクション
  • 環境
  • API
  • 認証と認可
  • その他の機能
• インストール
  • 前提条件
  • 手順
• 使い方
  • API キーの設定
  • Claude Desktop の使用
  • Cline の使用
  • Zed の使用
• ドキュメント
  • プロジェクト概要
• 開発の背景
• 開発
• デバッグ
• その他の MCP サーバー
• ライセンス

概要

Postman MCP Server は、Postman API と連携する TypeScript ベースの MCP サーバーです。Postman のコレクション、環境、API を包括的に管理できます。

機能

コレクション

• CRUD 操作：Postman コレクションの作成、取得、更新、削除を行います。
• フォルダー管理：コレクション内のリクエストをフォルダーに整理します。
• リクエスト管理：コレクション内のリクエストを追加、更新、削除します。
• レスポンス管理：リクエストに関連付けられたレスポンスを管理します。
• バージョン管理：コレクションのフォーク、マージ、変更のプルを行います。
• コメント：コレクションにコメントを追加、管理します。

環境

• 環境の管理：さまざまな設定向けの環境を作成、取得します。
• CRUD 操作：環境の作成、更新、削除をすべてサポートします。

API

• API 管理：API の作成、取得、更新、削除を行います。
• スキーマのサポート：複数ファイルに対応した API スキーマを管理します。
• タグ付け：API のタグを追加、管理します。
• コメント：API にコメントを追加、管理します。

認証と認可

• API キー認証：API キーを使用してアクセスを保護します。
• ロールベースのアクセス制御：ワークスペースとコレクションのレベルで権限を管理します。
• ワークスペースの権限：ワークスペース固有の権限を定義します。

その他の機能

• プライベート API ネットワーク：プライベート API ネットワーク内の要素とフォルダーを管理します。
• Webhook：カスタムペイロードを使ってコレクションを起動する Webhook を作成します。
• エンタープライズ機能：エンタープライズ環境向けの高度なロール制御と SCIM をサポートします。

インストール

Smithery 経由でのインストール

Smithery を使って Claude Desktop 用の Postman MCP Server を自動的にインストールするには：

npx -y @smithery/cli install postman-api-server --client claude

前提条件

• Node.js がインストールされていること。

手順

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

   git clone https://github.com/delano/postman-api-server.git
   cd postman-api-server
   

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

   pnpm install
   

3. サーバーをビルドします：

   pnpm run build
   

4. 自動再ビルドを有効にして開発モードで実行します：

   pnpm run watch
   

使用方法

API キーの設定

1. API キーを生成します

   • Postman Account Settings にアクセスします
   • 「Generate API Key」をクリックします
   • キーは再表示されないため、安全な場所に保存します

2. API キーを設定します

   • POSTMAN_API_KEY として環境変数にキーを追加します
   • Claude Desktop または Cline では、設定ファイルにキーを記載します（以下の設定例を参照）
   • API キーをバージョン管理にコミットしないでください

3. アクセスを確認します

   • API キーを使うと、権限のあるすべての Postman リソースにアクセスできます
   • 簡単なクエリ（例：ワークスペースの一覧表示）を実行して、アクセスをテストします

メモ

Postman API collection を直接使用する場合は、API キーをコレクション変数 postman-api-key として保存してください。

Claude Desktop の使用

Claude Desktop で使用するには、サーバー設定を次のファイルに追加します：

• macOS： ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows： %APPDATA%/Claude/claude_desktop_config.json

重要

このプロバイダーを更新する場合、入力スキーマの API 変更（つまり、MCP サーバーの ToolDefinition 要素に変更があった場合）を反映するには、Claude を再起動する必要があります。これは、Claude が起動時にツール定義をキャッシュするためです。

設定例

{
  "mcpServers": {
    "postman": {
      "command": "node",
      "args": [
        "/path/to/postman-api-server/build/index.js"
      ],
      "env": {
        "POSTMAN_API_KEY": "CHANGEME"
      }
    }
  }
}

Cline の使用

同じ設定例を使用して、Cline の MCP サーバー設定にサーバー設定を追加します：

設定例

上記の Claude の例と同じです。

Zed の使用

まだ動作させる方法を模索中です。Zed のドキュメントを見る限り、拡張機能として追加する必要があるようです（こちらの issue #21455 も参照してください）。

---

ドキュメント

公式の Postman API ドキュメントは、Postman Public Workspace で参照できます。

プロジェクトの概要

Postman API のリファレンスと概要

このプロジェクトでは、Claude モデルと Cline 拡張機能を活用し、OpenAPI 仕様を TypeScript コードに変換して、MCP サーバーの型安全性と統合性を高めています。

この GitHub プロジェクトには、Postman プラットフォームをプログラムから利用するための詳細なガイダンスを提供するAPI リファレンスのドキュメントが含まれています。ローカル開発向けの Collection SDK と、クラウドプラットフォームとの統合向けの Postman API の両方を取り上げています。主なトピックには、認証方式、レート制限、ワークスペース、コレクション、環境、モックサーバー、モニターなど、すべての API エンドポイントに関する詳細なドキュメントが含まれます。また、API を円滑に利用できるよう、前提条件とクイックスタート手順も説明しています。

docs/api/summaries ディレクトリには、Postman API の包括的な Markdown 形式の概要が含まれています。これらのドキュメントでは、API エンドポイント、リクエスト／レスポンス形式、MCP サーバーの機能を検証して確保するうえで不可欠な実装の詳細を説明しています。ドキュメントの構成と実装方針の概要については、API Summaries README を参照してください。

Claude で OpenAPI 仕様を TypeScript コードに変換する

MCP サーバーの構築

MCP サーバーのハンドラーの実装に関する詳細な仕様については、ハンドラーのドキュメントを参照してください。URI 形式、プロンプトの要件、リソースの処理パターンについて説明しています。このガイドは、MCP サーバー内で Postman API の機能を統合・強化する開発者にとって重要です。

---

理由

Postman ツール向けの MCP ラッパーは、構造と安全性が最重要となる複雑な複数ステップの操作において、AI とのやり取りを実現するレイヤーとして特に有用です。一方、CLI や API を直接使用すれば十分な単純な操作には、過剰な設計となる場合があります。MCP ラッパーが特に役立つのは、次のような場合です。

1. 複雑な操作

• 複数のコレクションの管理
• 環境の調整
• 包括的なレポートの生成

2. AI 駆動の自動化

• テストワークフローの自動化
• API ドキュメントの保守
• 環境管理

3. エラーの影響が大きい操作

• 重要な API テスト
• 本番環境へのデプロイ
• コンプライアンスの確認

次のような場合には、あまり役立ちません。

1. 単純な操作

• 基本的なコレクションの実行
• 単一の API 呼び出し
• 簡単な環境チェック

2. CLI の直接使用

• 開発者主導の操作
• ローカルでのテスト
• 素早い反復

開発

依存関係をインストールします。

pnpm install

サーバーをビルドします。

pnpm run build

自動再ビルドを有効にして開発する場合：

pnpm run watch

デバッグ

MCP サーバーは標準入出力を介して通信するため、デバッグが難しい場合があります。パッケージスクリプトとして利用できる MCP Inspector の使用をおすすめします。

pnpm run inspector

ドキュメント

Inspector は、ブラウザーでデバッグツールにアクセスするための URL（http://localhost:5173）を表示します。接続する前に POSTMAN_API_KEY を追加する必要があります。「Tools」に移動して開始してください。

その他の MCP サーバー

• AppCypher による Awesome MCP Servers
• PunkPeye による Awesome MCP Servers

ライセンス

このプロジェクトは MIT ライセンスのもとで公開されています。詳細については、LICENSE ファイルを参照してください。