Postman MCP Server

🚀 メール投遞員（Postman）プロジェクトドキュメント

本プロジェクトは、メール投遞プロトコル（MCP）用に設計されたポストマン（Postman）ツールセットです。このツールを使用すると、AIモデルを通じてPostman APIと対話し、複雑な操作タスクを実行できます。

🚀 クイックスタート

このプロジェクトを始めるには、以下の手順に従ってください。

✨ 主な機能

• 本プロジェクトはClaudeモデルとCline拡張機能を利用し、OpenAPI仕様をTypeScriptコードに変換し、型安全性と統合性を強化します。
• GitHub上のAPIリファレンス資料ドキュメントには、Postmanプラットフォームをプログラムで使用する方法が詳細に記載されています。

📦 インストール

依存関係のインストール

pnpm install

サーバーのビルド

pnpm run build

開発モード（自動再構築）

pnpm run watch

💻 使用例

基本的な使用法

Claudeの設定

Claudeでは、以下の設定を~/.config/claude/mcp-servers.jsonに追加します。

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

Clineの設定

Clineでは、以下の内容を~/.config/clinetl/mcp-servers.jsonに追加します。

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

Zedの設定

現在、この問題の解決に取り組んでいます。Zedドキュメントによると、拡張機能として使用する必要があります（この問題#21455を参照）。

📚 ドキュメント

プロジェクト概要

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

本プロジェクトでは、ClaudeモデルとCline拡張機能を利用して、OpenAPI仕様をTypeScriptコードに変換し、型安全性と統合性を強化しています。GitHub上のAPIリファレンス資料ドキュメントには、Postmanプラットフォームをプログラムで使用する方法が詳細に記載されています。

主な内容は以下の通りです。

• ローカル開発用のCollection SDK：ローカル環境での手動操作に使用します。
• クラウドプラットフォームのPostman API：オンラインプラットフォームでの操作に使用します。
• 認証メカニズム：Postman APIのさまざまな認証方法を詳しく説明します。
• レート制限：Postman APIの呼び出し頻度制限を説明します。
• 包括的なAPIエンドポイントドキュメント：ワークスペース、コレクション、環境、モックサーバー、モニタリングなどの核心機能をカバーしています。

また、このガイドでは、Postman APIを使用するための前提条件とクイックスタートガイドも提供されています。docs/api/summariesディレクトリには、詳細なMarkdown形式の概要ファイルが含まれており、開発者に全面的な技術サポートを提供します。

🔧 デバッグガイド

MCPサーバーは標準入出力を介して通信するため、デバッグは困難です。MCP Inspectorをおすすめします。これは、開発者がデバッグを支援するグラフィカルなインターフェースを提供します。

以下のコマンドを実行してInspectorを起動します。

pnpm run inspector

http://localhost:9001にアクセスすると、リアルタイムのログとデバッグ情報を確認できます。

📄 ライセンス

本プロジェクトはMITライセンスに準拠しており、詳細な条項はLICENSEファイルを参照してください。