🚀 邮件投递员（Postman）项目文档
本项目是一个为邮件投递协议（MCP）设计的邮差（Postman）工具集。借助该工具，可通过AI模型与Postman API进行交互，执行复杂的操作任务。
🚀 快速开始
若你想快速上手本项目，可按以下步骤操作：
安装依赖
pnpm install
构建服务器
pnpm run build
开发模式（自动重建）
pnpm run watch
✨ 主要特性
- 利用Claude模型和Cline扩展，将OpenAPI规范转换为TypeScript代码，增强类型安全性和集成性。
- 提供本地开发的Collection SDK，支持本地环境的手动操作。
- 支持云平台的Postman API，可进行在线平台的操作。
- 详细讲解Postman API的各种认证方法及调用频率限制。
- 提供全面的API端点文档，涵盖工作区、集合、环境、模拟服务器、监控等核心功能。
📦 安装指南
安装依赖
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文件。