Postman MCP Server Aio

🚀 郵政人 MCP 服務器

郵政人 MCP 服務器是一個 Cloudflare Worker，藉助 Claude AI 的 MCP（模型控制平面）接口，為 Postman 集合和環境提供 API 訪問能力，助力 API 測試、文檔編寫和管理等任務。

🚀 快速開始

克隆倉庫

首先，克隆此倉庫到本地：

git clone <倉庫地址>

安裝依賴

進入項目目錄，安裝所需依賴：

npm install

配置環境變量

複製 .env.example 文件為 .env，並添加您的 Postman API 密鑰：

cp .env.example .env

部署到 Cloudflare 工作者

完成上述步驟後，將項目部署到 Cloudflare 工作者：

wrangler deploy

✨ 主要特性

此服務器允許 Claude AI 與您的 Postman 集合和環境交互，實現以下功能：

• 獲取所有集合
• 獲取特定集合的詳細信息
• 創建新的集合
• 向集合中添加請求
• 運行集合並獲取測試結果

📦 安裝指南

本地開發環境搭建

若要在本地運行服務器進行開發，可執行以下命令：

npm run dev

此命令將使用 wrangler 在本地啟動服務器。

部署到 Cloudflare 工作者

要將項目部署到 Cloudflare 工作者，執行以下命令：

npm run deploy

請確保您的 wrangler.toml 文件已正確配置。

💻 使用示例

基本工具方法

// 返回帶有提供的名稱的問候語
mcp__sayHello('John');

// 反轉字符串中的字符順序
mcp__reverseString('hello');

集合方法

// 獲取您 Postman 賬戶中的所有集合
mcp__get_collections();

// 獲取特定集合的詳細信息
mcp__get_collection('collectionId');

// 創建新集合
mcp__create_collection('New Collection', 'This is a new collection');

// 向集合中添加請求
mcp__add_request('collectionId', 'New Request', 'GET', 'https://example.com');

環境方法

// 獲取您 Postman 賬戶中的所有環境
mcp__get_environments();

// 獲取特定環境的詳細信息
mcp__get_environment('environmentId');

// 創建包含變量的新環境
mcp__create_environment('New Environment', { key: 'value' });

測試執行

// 使用可選環境運行集合
mcp__run_collection('collectionId', 'environmentId');

更多詳細示例請參閱 examples/postman-examples.md 文件。

📚 詳細文檔

項目結構

• /src - 源代碼
  • /interfaces - TypeScript 接口
  • /services - 服務類
  • index.ts - 主工人程序入口點
• /test - 單元測試
• /examples - 示例用法
• /docs - 額外文檔

🔧 技術細節

此服務器基於 Cloudflare Worker 構建，使用 Claude AI 的 MCP 接口與 Postman 集合和環境進行交互。通過調用 Postman 的 API，實現了對集合和環境的各種操作，包括獲取信息、創建、添加請求和運行測試等。

📄 許可證

文檔中未提及許可證相關信息。

⚠️ 重要提示

此服務器需要一個 Postman API 密鑰才能運行。請確保將密鑰安全地存儲在 Cloudflare 工人環境變量中，並且不要將其提交到版本控制中。

💡 使用建議

在開發和使用過程中，請遵循 DEVELOPMENT_GUIDELINES.md 和 SOLID_PRINCIPLES.md 進行代碼設計和開發。