Code2postman Mcp

Code2Postman MCP

Code2Postman MCP - コードディレクトリを Postman コレクションに自動変換する Model Context Protocol（MCP）サーバーの実装です。

概要

Code2Postman MCP は、Model Context Protocol を活用し、開発者がコードベースから Postman コレクションをすばやく生成できるようにするオープンソースのツールです。このツールはコードファイルを分析して API エンドポイントを特定し、テスト、ドキュメント作成、共有に使用できる構造化された Postman コレクションを作成します。コードやローカルリポジトリから Postman コレクションを生成する MCP です。

機能

• コード分析：コードベースを自動でスキャンし、API エンドポイントとそのパラメーターを特定します
• コレクション生成：適切な構造の Postman コレクションを作成します
• フォルダー整理：コード構造に基づいて、エンドポイントを論理的にフォルダー分けします
• 変数のサポート：柔軟性を高めるために、コレクション変数を追加および管理します
• 認証の設定：コードのパターンに基づいて、認証方式を自動で設定します
• イベントスクリプト：該当する場合、リクエスト前スクリプトとテストスクリプトを生成します

サポートされているツール

• create_postman_collection - 新しい Postman コレクションを作成します
• add_postman_collection_item - コレクションにリクエスト項目を追加します
• read_postman_collection - 既存の Postman コレクションを読み込みます
• add_postman_collection_info - コレクションにメタデータを追加します
• add_postman_collection_event - リクエスト前スクリプトまたはテストスクリプトを追加します
• add_postman_collection_variable - コレクションに変数を追加します
• add_postman_collection_auth - コレクションの認証を設定します
• add_postman_collection_protocol_behavior - プロトコルの動作を設定します
• delete_postman_collection_item - コレクションから項目を削除します
• update_postman_collection_variable - 既存の変数を更新します
• add_postman_collection_folder - リクエストを整理するフォルダーを作成します
• add_item_to_folder - 特定のフォルダーに項目を追加します
• get_tree_directory_from_path - ディレクトリのファイルツリー構造を取得します
• read_file - 指定したファイルの内容を読み込みます

インストール

pip install code2postman-mcp

Claude Desktop での使用方法

1. claude_desktop_config.json ファイルに Code2Postman MCP を追加します：

"code2postman-mcp": {
    "command": "uvx",
    "args": ["code2postman-mcp"]
}

2. Claude Desktop を起動し、MCP ツールを使ってコードを分析し、Postman コレクションを生成します。

コマンドラインでの使用方法

Code2Postman MCP は、コマンドラインから直接使用することもできます：

uvx code2postman-mcp

例

ソースコードから Postman コレクションを作成する

1. まず、コードベースを分析して API エンドポイントを特定します。
2. 新しい Postman コレクションを作成します。
3. 特定したエンドポイントを項目としてコレクションに追加します。
4. 必要に応じて認証を設定します。
5. 柔軟性を高めるため、コレクション変数を追加します。
6. Postman にインポートできる JSON ファイルとしてコレクションをエクスポートします。

既存のコレクションに追加する

以下の手順で、既存の Postman コレクションを拡張することもできます：

1. 既存のコレクションを読み込みます。
2. 新しい項目またはフォルダーを追加します。
3. 変数または認証方式を更新します。
4. 更新したコレクションを保存します。

開発

Code2Postman MCP への貢献方法：

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

   git clone https://github.com/yourusername/code2postman-mcp.git
   

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

   cd code2postman-mcp
   uv pip install -e .
   

3. テストを実行します：

   uv run pytest tests/
   

ライセンス

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