MCP Postman

🚀 メール投递員 MCP サーバー

このサーバーは、Model Context Protocol (MCP) をベースに構築されており、Newman を使用して Postman コレクションを実行することができます。大規模言語モデル（LLMs）が API テストを実行し、標準化されたインターフェイスを通じて詳細なテスト結果を取得することを可能にします。

✨ 主な機能

• Newman を使用して Postman コレクションを実行
• 環境ファイルをサポート
• グローバル変数をサポート
• 詳細なテスト結果を提供します。具体的には以下の通りです。
  • 全体の成功/失敗ステータス
  • テストの概要（総数、合格数、不合格数）
  • 詳細な失敗情報
  • 実行時間

📦 インストール

Smithery を使用したインストール

Smithery を通じて、Postman Runner for Claude Desktop を自動的にインストールします。

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

手動インストール

# リポジトリをクローン
git clone <repository-url>
cd mcp-postman

# 依存関係をインストール
pnpm install

# プロジェクトをビルド
pnpm build

💻 使用例

サーバーの設定

サーバーをあなたの Claude デスクトップの設定ファイル ~/Library/Application Support/Claude/claude_desktop_config.json に追加します。

{
  "mcpServers": {
    "postman-runner": {
      "command": "node",
      "args": ["/absolute/path/to/mcp-postman/build/index.js"]
    }
  }
}

利用可能なツール

run-collection

Postman コレクションを実行し、テスト結果を返します。

パラメーター：

• collection（必須）：Postman コレクションのパスまたは URL
• environment（オプション）：環境ファイルのパスまたは URL
• globals（オプション）：グローバル変数ファイルのパスまたは URL
• iterationCount（オプション）：反復回数

応答例：

{
  "success": true,
  "summary": {
    "total": 5,
    "failed": 0,
    "passed": 5
  },
  "failures": [],
  "timings": {
    "started": "2024-03-14T10:00:00.000Z",
    "completed": "2024-03-14T10:00:01.000Z",
    "duration": 1000
  }
}

Claude での使用例

Claude で以下のようにして Postman コレクションを実行することができます。 "パス /path/to/collection.json の Postman コレクションを実行し、すべてのテストが合格したかどうかを教えてください"

Claude は以下のことを行います。

1. run-collection ツールを使用する
2. テスト結果を分析する
3. 分かりやすい実行概要を提供する

🔧 技術詳細

プロジェクト構造

• src/: サーバーの主な実装ロジックが含まれています。
• build/: ビルド生成されたファイルが保存されます。
• package.json: プロジェクトの依存関係管理とビルドスクリプトが記載されています。
• README.md: プロジェクトのドキュメントと使用方法が記載されています。

貢献ガイド

1. リポジトリをクローン：まず、このリポジトリをローカル開発環境にクローンします。

   git clone <repository-url>
   cd mcp-postman
   

2. 依存関係をインストール：npm または pnpm を使用して、プロジェクトに必要な依存関係をインストールします。

   pnpm install
   

3. 開発モードで起動：以下のコマンドを使用して、開発サーバーを起動することができます。

   pnpm dev
   

4. プロジェクトをビルド：本番環境では、以下のコマンドを使用してビルドします。

   pnpm build
   

5. テストを実行：テストスイートを実行して、コードの正しさを確認します。

   pnpm test
   

注意事項

• 互換性の問題を避けるために、Node.js と npm または pnpm の最新バージョンをインストールしてください。
• 本番環境では、開発モードのファイルではなく、build/ ディレクトリにあるビルド後のファイルを使用してください。
• コードの一貫性と保守性を確保するために、プロジェクトの貢献規範とコードスタイルガイドに従ってください。

📄 ライセンス

このプロジェクトは MIT License のライセンスの下で提供されています。

上記の手順に従えば、Postman コレクションを開発フローに簡単に統合し、MCP サーバーの強力な機能を利用して API テストを自動化および管理することができます。