postman-mcp-server

Postman MCP サーバー

バージョン: v0.2.0

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

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

インストール手順に進む

[!警告] このプロジェクトは現在開発中です。注意して使用してください。また、互換性を損なう変更が含まれる可能性があります。

[!NOTE] AI生成コード。Claude 3.5 Sonnet（2024年10月22日）を搭載したCline v2.2.2を使用しました。このコードの生成方法に関するプロンプトと詳細については、docs/README.mdをご覧ください。

• 概要
• 特徴
  • コレクション
  • 環境
  • API
  • 認証と承認
  • 追加機能
• インストール
  • 前提条件
  • 手順
• 使用法
  • APIキーの設定
  • Claudeデスクトップの使用
  • Clineの使用
  • Zedの使用
• ドキュメント
  • プロジェクト概要
• 根拠
• 発達
• デバッグ
• その他のMCPサーバー
• ライセンス

概要

Postman MCP サーバーは、Postman API と統合され、Postman コレクション、環境、および API の包括的な管理を提供する TypeScript ベースの MCP サーバーです。

特徴

コレクション

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

環境

• 環境の管理: さまざまなセットアップの環境を作成および取得します。
• CRUD 操作: 環境の作成、更新、削除を完全にサポートします。

API

• API 管理: API を作成、取得、更新、削除します。
• スキーマ サポート: 複数ファイルのサポートを使用して API スキーマを管理します。
• タグ付け: API のタグを追加および管理します。
• コメント: API に関するコメントを追加および管理します。

認証と承認

• API キー認証: API キーを使用して安全にアクセスします。
• ロールベースのアクセス制御: ワークスペースおよびコレクション レベルで権限を管理します。
• ワークスペースの権限: ワークスペース固有の権限を定義します。

追加機能

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

インストール

Smithery経由でインストール

Smithery経由で Claude Desktop 用の Postman MCP Server を自動的にインストールするには:

前提条件

• 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アカウント設定にアクセス
   • 「APIキーを生成」をクリックします
   • キーを安全に保存してください。二度と表示されません。
2. APIキーを設定する
   • キーをPOSTMAN_API_KEYとして環境に追加します
   • Claude Desktop または Cline の場合は、設定ファイルに含めます (以下の設定例を参照)
   • APIキーをバージョン管理にコミットしない
3. アクセスを確認する
   • APIキーは、権限を持つすべてのPostmanリソースへのアクセスを提供します。
   • 簡単なクエリ（ワークスペースの一覧表示など）を実行してアクセスをテストします。

[!NOTE] Postman API コレクションを直接使用している場合は、API キーをpostman-api-keyコレクション変数として保存します。

Claudeデスクトップの使用

Claude Desktop で使用するには、サーバー設定を追加します。

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

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

構成例

Clineの使用

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

構成例

上記のクロードと同様です。

Zedの使用

まだ動作確認中です。Zedのドキュメントによると、拡張機能が必要なようです（この問題も#21455で報告されています）。

ドキュメント

公式のPostman API ドキュメントは、 Postman パブリック ワークスペースで入手できます。

プロジェクト概要

Postman API リファレンスと概要

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

このGitHubプロジェクトには、Postmanプラットフォームをプログラム的に活用するための詳細なガイダンスを提供するAPIリファレンスドキュメントが含まれています。ローカル開発用のCollection SDKとクラウドプラットフォーム統合用のPostman APIの両方を網羅しています。主なトピックには、認証メカニズム、レート制限、そしてワークスペース、コレクション、環境、モックサーバー、モニターなどを含むすべてのAPIエンドポイントの詳細なドキュメントが含まれます。さらに、このガイドでは、シームレスなAPI連携を実現するための前提条件とクイックスタート手順も提供しています。

docs/api/summariesディレクトリには、Postman API の包括的な Markdown 形式のサマリーが含まれています。これらのドキュメントには、MCP サーバーの機能検証と保証に不可欠な API エンドポイント、リクエスト/レスポンス形式、実装の詳細が記載されています。ドキュメント構造と実装戦略の概要については、 API サマリーの 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 の使用

• 開発者主導の運用
• ローカルテスト
• 素早い反復

発達

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

サーバーを構築します。

自動リビルドを使用した開発の場合:

デバッグ

MCPサーバーはstdio経由で通信するため、デバッグが困難になる場合があります。パッケージスクリプトとして利用可能なMCP Inspectorの使用をお勧めします。

ドキュメント

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

その他のMCPサーバー

• AppCypherによる素晴らしいMCPサーバー
• PunkPeyeによる素晴らしいMCPサーバー

ライセンス

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