使用说明
🚀 邮递员MCP服务器
通过无缝Postman集成,将您的人工智能对话转化为强大的API工作流程
停止在AI助手和邮差之间切换! 此模型上下文协议(MCP)服务器将Postman的全部功能直接带入您与Cline、Claude Desktop、Cursor和其他MCP兼容客户端的AI对话中。
🎯 为什么你需要这个
问题
- 上下文切换噩梦:不断在AI聊天和Postman之间切换以管理API
- API手册文档:向你的人工智能助手解释API结构
- 工作流中断:中断流以测试、更新或创建API请求
- 团队协作差距:在人工智能辅助开发和团队工具之间共享API工作流的困难
解决方案
一个命令。无限的可能性。 将您的AI助手直接连接到Postman并解锁:
✨ 即时API管理 -创建、更新和组织API集合,而无需离开您的人工智能对话
🔄 实时同步 -通过人工智能进行的更改可立即在Postman中获得
🎯 情境感知辅助 -您的人工智能了解您的整个API生态系统
🚀 加速发展 -使用AI驱动的工作流,构建和测试API的速度提高了10倍
👥 无缝团队整合 -AI生成的API会自动与团队的Postman工作区同步
🌟 你能做什么
🏢 智能工作空间管理
- “为我们的移动应用项目创建一个新的工作区” -几秒钟内完成
- “列出我的所有团队工作区” -组织的即时概览
- “切换到生产工作区” -无缝环境管理
📚 智能采集楼
- “生成用于用户身份验证的REST API集合” -AI创建整个结构
- “为产品端点添加CRUD操作” -立即生成完整的API集合
- “将我的OpenAPI规范导入新集合” -自动化API文档
🌍 动态环境控制
- “设置开发、暂存和生产环境” -在一个命令中设置多个环境
- “为生产更新API密钥” -安全的凭证管理
- “切换所有请求以使用临时服务器” -批量环境变化
🔧 轻松的请求管理
- “创建带有验证的用户注册POST请求” -使用标头、正文和测试完成请求
- “向此集合中的所有请求添加身份验证” -批量安全实施
- “为用户创建端点生成测试数据” -真实的测试场景
📂 有组织的文件夹结构
- “按功能组织这些请求” -自动逻辑分组
- “为微服务创建文件夹结构” -企业就绪组织
- “将所有身份验证请求移动到单独的文件夹” -即时重组
🎭 人工智能驱动的模拟服务器创建
- “用真实的数据为我的用户API创建一个模拟服务器” -具有智能响应的即时模拟端点
- “生成带有错误场景的模拟响应以供测试” -完整的测试场景,包括400、401、404、500个响应
- “设置具有动态数据和响应延迟的模拟服务器” -用于真实测试的类似生产的模拟行为
🚀 快速入门(掌握API 60秒)
1.全局安装
npm install -g postman-mcp-server
2.获取邮差API密钥
- 访问 邮差API钥匙
- 点击“生成API密钥”
- 复制您的密钥
3.配置您的AI代理
对于 克莱恩 (VSCode扩展)
添加到您的Cline MCP设置中:
{
"mcpServers": {
"postman": {
"command": "postman-mcp-server",
"env": {
"POSTMAN_API_KEY": "your-postman-api-key-here"
}
}
}
}
对于 克劳德桌面
添加到配置文件中:
macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
视窗: %APPDATA%/Claude/claude_desktop_config.json
{
"mcpServers": {
"postman": {
"command": "postman-mcp-server",
"env": {
"POSTMAN_API_KEY": "your-postman-api-key-here"
}
}
}
}
对于 光标
添加到光标MCP配置中:
{
"mcpServers": {
"postman": {
"command": "postman-mcp-server",
"env": {
"POSTMAN_API_KEY": "your-postman-api-key-here"
}
}
}
}
4.开始建设!
重新启动AI代理,并从以下步骤开始:
“向我展示我所有的Postman工作区,并帮助我为我的电子商务项目创建一个新的API集合”
💡 真实世界用例
🎯 API-首次开发
You: "I'm building a social media app. Create a complete API collection with user management, posts, and comments."
AI: *Creates workspace, sets up collections with proper folder structure, adds CRUD operations for users/posts/comments, configures authentication, and sets up test environments*
🔄 快速原型制作
You: "Convert this OpenAPI spec into a Postman collection and add realistic test data."
AI: *Imports spec, creates organized collection, generates sample requests with proper headers and realistic JSON payloads*
🚀 团队登机
You: "Set up a development environment for our new team member with all our microservice endpoints."
AI: *Creates workspace, imports all collections, sets up environment variables, organizes by service, adds documentation*
🔧 API测试自动化
You: "Add comprehensive tests to all endpoints in my user management collection."
AI: *Adds status code checks, response validation, authentication tests, and error handling to every request*
🛠️ 强大的功能
🏢 工作空间管理
- 列表和浏览:立即查看您的所有工作区
- 创建和配置:设置新的团队或个人工作区
- 更新和组织:修改工作区设置和描述
- 智能切换:上下文感知工作区管理
📚 收款操作
- 智能创造:人工智能驱动的采集结构生成
- 批量操作:同时管理多个集合
- 版本控制:跟踪和管理收款变更
- 导入/导出:无缝数据迁移
🌍 环境控制
- 多环境设置:开发、暂存、生产配置
- 变量管理:安全处理API密钥和终结点
- 批量更新:跨集合更改环境
- 环境克隆:新项目的重复设置
🔧 请求工程
- 智能发电:AI创建具有适当结构的完整请求
- 批量修改:同时更新多个请求
- 身份验证集成:跨请求自动设置身份验证
- 测试生成:适用于所有端点的全面测试套件
📂 组织工具
- 文件夹层次结构:创建逻辑API分组
- 自组织:AI建议最佳文件夹结构
- 批量移动:高效地重新组织请求
- 搜索和筛选:查找大型集合中的请求
🔒 安全与最佳实践
🛡️ 供应链安全
- ✅ 零已知漏洞:使用npm审计进行定期安全审计
- 🔍 依赖性监控:通过Socket.dev自动进行漏洞扫描
- 📦 最小依赖性:仅需3个生产依赖项即可减少攻击面
- 🔄 定期更新:自动依赖关系更新和安全补丁
- 🏷️ 已签署的发布:所有发布都经过签名和验证
🔐 API安全
- 🔑 安全的API密钥处理:仅环境变量存储
- 🛡️ 遵守费率限制:内置Postman API速率限制
- ✅ 输入验证:使用Zod模式进行全面的请求验证
- 🔍 错误处理:优雅的故障管理,无数据泄露
- 📝 审计日志:跟踪所有API操作以进行安全监控
🚨 安全报告
发现安全漏洞?请查看我们的 安全策略 负责任的披露指南。
🔧 安全配置
# Recommended: Use environment variables for API keys
export POSTMAN_API_KEY="your-secure-api-key"
# Never commit API keys to version control
echo "POSTMAN_API_KEY=*" >> .gitignore
📊 安全监控
- 自动化安全审计:每日漏洞扫描
- 依赖性健康检查:每周依赖性审查
- Socket.dev集成:实时供应链监控
- GitHub安全公告:自动安全通知
🎨 高级配置
环境变量设置
export POSTMAN_API_KEY="your-postman-api-key-here"
替代配置(如果全局安装不起作用)
{
"mcpServers": {
"postman": {
"command": "node",
"args": ["$(npm root -g)/postman-mcp-server/build/index.js"],
"env": {
"POSTMAN_API_KEY": "your-postman-api-key-here"
}
}
}
}
🧪 验证
测试您的安装:
# Check if the command is available
postman-mcp-server --help
# Verify global installation
npm list -g postman-mcp-server
🚀 可用工具
🏢 Workspace Tools
list_workspaces
立即获取您的所有Postman工作区
{ "name": "list_workspaces", "arguments": {} }
get_workspace
详细的工作空间信息和元数据
{ "name": "get_workspace", "arguments": { "workspaceId": "workspace-id" } }
create_workspace
创建新的团队或个人工作区
{
"name": "create_workspace",
"arguments": {
"name": "My New Workspace",
"type": "team",
"description": "Workspace for our new project"
}
}
update_workspace
修改工作区设置和描述
{
"name": "update_workspace",
"arguments": {
"workspaceId": "workspace-id",
"name": "Updated Name",
"description": "New description"
}
}
delete_workspace
删除工作区(小心使用!)
{ "name": "delete_workspace", "arguments": { "workspaceId": "workspace-id" } }
📚 Collection Tools
list_collections
浏览所有集合或按工作区筛选
{ "name": "list_collections", "arguments": { "workspaceId": "optional-workspace-id" } }
get_collection
完整的收集结构和元数据
{ "name": "get_collection", "arguments": { "collectionId": "collection-id" } }
create_collection
建立新的API集合
{
"name": "create_collection",
"arguments": {
"name": "User Management API",
"description": "Complete user CRUD operations",
"workspaceId": "workspace-id"
}
}
update_collection
修改集合元数据和设置
{
"name": "update_collection",
"arguments": {
"collectionId": "collection-id",
"name": "Updated API Collection",
"description": "Enhanced description"
}
}
delete_collection
永久删除收藏
{ "name": "delete_collection", "arguments": { "collectionId": "collection-id" } }
🌍 Environment Tools
list_environments
查看所有环境或按工作区筛选
{ "name": "list_environments", "arguments": { "workspaceId": "optional-workspace-id" } }
get_environment
包含所有变量的环境详细信息
{ "name": "get_environment", "arguments": { "environmentId": "environment-id" } }
create_environment
使用变量设置新环境
{
"name": "create_environment",
"arguments": {
"name": "Production",
"values": [
{ "key": "baseUrl", "value": "https://api.production.com", "type": "default" },
{ "key": "apiKey", "value": "secret-key", "type": "secret" }
],
"workspaceId": "workspace-id"
}
}
update_environment
修改环境变量和设置
{
"name": "update_environment",
"arguments": {
"environmentId": "environment-id",
"name": "Updated Environment",
"values": [
{ "key": "newVariable", "value": "newValue", "type": "default" }
]
}
}
delete_environment
删除环境
{ "name": "delete_environment", "arguments": { "environmentId": "environment-id" } }
🔧 Request & Folder Management Tools
create_request
创建具有完整配置的新API请求
{
"name": "create_request",
"arguments": {
"collectionId": "collection-id",
"name": "Create User",
"url": "https://api.example.com/users",
"method": "POST",
"description": "Create a new user account",
"headers": [
{ "key": "Content-Type", "value": "application/json" },
{ "key": "Authorization", "value": "Bearer {{token}}" }
],
"body": {
"mode": "raw",
"raw": "{\"name\": \"John Doe\", \"email\": \"john@example.com\"}"
},
"folderId": "optional-folder-id"
}
}
get_request
检索详细的请求信息
{
"name": "get_request",
"arguments": {
"collectionId": "collection-id",
"requestId": "request-id"
}
}
update_request
修改现有请求
{
"name": "update_request",
"arguments": {
"collectionId": "collection-id",
"requestId": "request-id",
"name": "Updated Request Name",
"url": "https://api.example.com/v2/users",
"method": "PUT",
"headers": [
{ "key": "Content-Type", "value": "application/json" }
]
}
}
delete_request
从集合中删除请求
{
"name": "delete_request",
"arguments": {
"collectionId": "collection-id",
"requestId": "request-id"
}
}
create_folder
使用文件夹结构组织请求
{
"name": "create_folder",
"arguments": {
"collectionId": "collection-id",
"name": "User Management",
"description": "All user-related API endpoints",
"parentFolderId": "optional-parent-folder-id"
}
}
update_folder
修改文件夹属性
{
"name": "update_folder",
"arguments": {
"collectionId": "collection-id",
"folderId": "folder-id",
"name": "Updated Folder Name",
"description": "Updated description"
}
}
delete_folder
删除文件夹及其内容
{
"name": "delete_folder",
"arguments": {
"collectionId": "collection-id",
"folderId": "folder-id"
}
}
move_request
重新组织文件夹之间的请求
{
"name": "move_request",
"arguments": {
"collectionId": "collection-id",
"requestId": "request-id",
"targetFolderId": "target-folder-id"
}
}
🎭 Mock Server Tools
list_mock_servers
立即获取所有模拟服务器
{ "name": "list_mock_servers", "arguments": {} }
get_mock_server
详细的模拟服务器信息和配置
{ "name": "get_mock_server", "arguments": { "mockId": "mock-server-id" } }
create_mock_server
从集合中创建新的模拟服务器
{
"name": "create_mock_server",
"arguments": {
"name": "User API Mock",
"collectionId": "collection-id",
"environmentId": "environment-id",
"private": false,
"config": {
"headers": [
{ "key": "Content-Type", "value": "application/json" }
],
"matchBody": true,
"matchQueryParams": true,
"delay": {
"type": "fixed",
"preset": "medium"
}
}
}
}
create_ai_mock_server
创建具有智能数据生成功能的人工智能模拟服务器
{
"name": "create_ai_mock_server",
"arguments": {
"name": "Smart User API Mock",
"collectionId": "collection-id",
"generateRealisticData": true,
"includeErrorResponses": true,
"responseDelay": "medium",
"private": false
}
}
update_mock_server
修改模拟服务器设置和配置
{
"name": "update_mock_server",
"arguments": {
"mockId": "mock-server-id",
"name": "Updated Mock Server",
"private": true,
"config": {
"matchBody": false,
"delay": {
"type": "random",
"preset": "low"
}
}
}
}
delete_mock_server
删除模拟服务器
{ "name": "delete_mock_server", "arguments": { "mockId": "mock-server-id" } }
get_mock_server_call_logs
查看模拟服务器使用情况和呼叫历史记录
{
"name": "get_mock_server_call_logs",
"arguments": {
"mockId": "mock-server-id",
"limit": 50
}
}
🛠️ 发展
设置开发环境
git clone https://github.com/ankit-roy-0602/postman-mcp-server.git
cd postman-mcp-server
npm install
npm run build
可用脚本
npm run build-构建TypeScript代码npm run dev-手表开发模式npm test-运行全面的测试套件npm run lint-代码质量检查npm run format-代码格式
🤝 贡献
我们欢迎捐款!无论是:
- 🐛 错误报告:发现问题?让我们知道!
- ✨ 功能请求:有主意吗?我们很想听听!
- 📖 文档:帮助我们的文档变得更好
- 🔧 代码贡献:提交新功能或修复的PR
查看我们的 贡献指南 了解详情。
📈 路线图
🚀 最近添加
- [x] 请求和文件夹管理:完成请求和文件夹的CRUD操作
- [x] 高级请求创建:基于AI的请求生成,包括标头、正文和身份验证
- [x] 文件夹组织:分层文件夹结构,用于更好的API组织
- [x] 请求移动:在文件夹和集合之间无缝移动请求
- [x] 模拟服务器集成:人工智能驱动的模拟服务器创建,具有逼真的数据生成功能
🚀 即将推出
- [ ] 收款进口/出口:无缝数据迁移工具
- [ ] 高级搜索:在Postman工作区中查找任何内容
🔮 未来愿景
- [ ] 监控管理:自动API监控设置
- [ ] 团队协作:增强团队工作流程集成
- [ ] WebSocket支持:实时更新和通知
- [ ] 批量操作:跨集合的大规模操作
- [ ] AI驱动的测试:智能测试生成和验证
🏆 为什么选择Postman MCP服务器?
⚡ 速度
将数小时的API人工工作转化为数秒的人工智能对话
🎯 精确度
AI了解您确切的API结构和要求
🔄 整合
AI工作流程和团队协作之间的无缝同步
🛡️ 可靠性
企业级错误处理和安全实践
📈 可扩展性
从原型到生产,可根据您的需求进行扩展
📞 支持与社区
- 🐛 问题: GitHub问题
- 💬 讨论: GitHub讨论
- 📧 电子邮件: 支持
- 🐦 推特: @PostmanMCP
📄 许可证
MIT许可证-请参阅 许可证 文件以获取详细信息。
🙏 致谢
- 邮递员团队 -对于令人难以置信的API平台
- 模型上下文协议 -革命性的人工智能集成标准
- 开源社区 -为了持续的灵感和贡献
准备好彻底改变API工作流程了吗?
npm install -g postman-mcp-server
⭐ 如果此仓库能帮助您更快地构建更好的API,请将其标记为星号!
