MCP Postman

🚀 Postman MCP サーバー

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

🚀 クイックスタート

Postman MCP サーバーは、Model Context Protocol (MCP) を基に構築されたサーバーで、Newman を使って Postman コレクションを実行します。大規模言語モデル (LLMs) が API テストを行い、詳細な結果を取得できます。

✨ 主な機能

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

📦 インストール

Smithery を通じたインストール

Smithery を通じて Postman ランナーを自動インストールするには：

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 コレクションを実行することができます： "Run the Postman collection located at /path/to/collection.json and tell me if all tests passed"

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

1. MCP プロトコルを使用して run-collection ツールを呼び出す
2. 詳細なテスト結果を受け取る
3. 自然言語でのテストレポートを生成する

🔧 技術詳細

プロジェクト構造

- src/
  - CollectionRunner.ts # Postman コレクションの実行を処理するメインクラス
  - NewmanAdapter.ts     # Newman のアダプターインターフェース
  - types.ts            # MCP プロトコルの型を定義

テストの実行

npm test

# または特定のテストファイルを実行
npm test src/CollectionRunner.spec.ts

プロジェクトのビルド

pnpm build

🤝 貢献ガイド

1. このリポジトリを Fork する
2. 新しい機能ブランチを作成する git checkout -b feature/NewmanAdapter
3. 変更をコミットする git commit -m 'feat: 追加 Newman サポート'
4. リモートにプッシュする git push origin feature/NewmanAdapter
5. Pull Request を作成する

📄 ライセンス

MIT