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 进行代码设计和开发。