一个提供访问 Postman API 的 MCP 服务器。功能基于 官方 OpenAPI 规范。更多详情,请参阅 Postman API 文档。
该项目是 Anthropic 的 Model Context Protocol (MCP) 计划的一部分。更多信息,请访问 MCP GitHub 仓库 和 Anthropic 博客上的公告。
[!WARNING] 本项目目前处于积极开发中。请谨慎使用并预期会有重大变更。
[!NOTE] 由 AI 生成的代码。我使用了 Cline v2.2.2 和 Claude 3.5 Sonnet (2024-10-22)。有关如何生成此代码的提示和详细信息,请参阅 docs/README.md。
<a href="https://glama.ai/mcp/servers/zoig549xfd"><img width="380" height="200" src="https://gips0.baidu.com/it/u=3256329904,2346945844&fm=3081&app=3101&f=PNG?w=760&h=400" alt="postman-mcp-server MCP 服务器" /></a>
Postman MCP 服务器是一个基于 TypeScript 的 MCP 服务器,它与 Postman API 集成,提供了对 Postman 集合、环境和 API 的全面管理。
要通过 Smithery 自动安装 Postman MCP 服务器到 Claude Desktop:
npx -y @smithery/cli install postman-api-server --client claude
克隆仓库:
git clone https://github.com/delano/postman-api-server.git
cd postman-api-server
安装依赖项:
pnpm install
构建服务器:
pnpm run build
在开发模式下运行并自动重建:
pnpm run watch
生成你的 API 密钥
配置 API 密钥
POSTMAN_API_KEY验证访问
[!NOTE] 如果你直接使用 Postman API 集合,请将你的 API 密钥存储为
postman-api-key集合变量。
要与 Claude Desktop 一起使用,添加服务器配置:
~/Library/Application Support/Claude/claude_desktop_config.json%APPDATA%/Claude/claude_desktop_config.json<img width="480" alt="claude-desktop-settings" src="https://gips1.baidu.com/it/u=2103338397,2972912895&fm=3081&app=3101&f=PNG?w=1642&h=1182" />[!IMPORTANT] 如果你在更新此提供程序时,Claude 必须重新启动以从输入模式中获取 API 更改(即当 MCP 服务器的 ToolDefinition 元素发生变化时)。这是因为 Claude 在启动时缓存了工具定义。
{
"mcpServers": {
"postman": {
"command": "node",
"args": [
"/path/to/postman-api-server/build/index.js"
],
"env": {
"POSTMAN_API_KEY": "CHANGEME"
}
}
}
}
使用相同的示例配置,将服务器配置添加到你的 Cline MCP 服务器配置中:
<img width="480" alt="cline-settings" src="https://gips0.baidu.com/it/u=2225375178,271483663&fm=3081&app=3101&f=PNG?w=972&h=898" />与上面的 Claude 相同。
我仍在尝试使其正常工作。根据 Zed 文档,它需要成为一个扩展(也参见此问题 #21455)。
官方 Postman API 文档 可在 Postman 公共工作区 中找到。
本项目利用 Claude 模型和 Cline 扩展将 OpenAPI 规范转换为 TypeScript 代码,增强类型安全性并在 MCP 服务器中实现集成。
此 GitHub 项目包括 API 参考文档,提供了详细的指导,用于编程方式使用 Postman 平台。它涵盖了本地开发的 Collection SDK 和云平台集成的 Postman API。关键主题包括身份验证机制、速率限制以及所有 API 端点的深入文档,包括工作区、集合、环境、模拟服务器、监控器等。此外,指南还提供了先决条件和快速入门说明,以便无缝地进行 API 交互。
docs/api/summaries 目录包含了 Postman API 的全面 Markdown 总结。这些文档概述了 API 端点、请求/响应格式以及实现细节,对于验证和确保 MCP 服务器的功能至关重要。参阅 API 总结 README 以了解文档结构和实现策略的概述。
参阅 处理程序文档,详细了解实现 MCP 服务器处理程序的具体规范。这包括 URI 格式、提示要求和资源处理模式。这对于正在整合和增强 MCP 服务器中 Postman API 功能的开发者来说至关重要。
Postman 工具的 MCP 包装器主要作为复杂、多步骤操作的 AI 交互层,其中结构和安全性至关重要。然而,对于简单操作,直接使用 CLI 或 API 就足够了。MCP 包装器在以下情况下提供最大价值:
对于以下情况,它提供的价值较小:
安装依赖项:
pnpm install
构建服务器:
pnpm run build
开发模式下自动重建:
pnpm run watch
由于 MCP 服务器通过 stdio 进行通信,调试可能会很困难。我们推荐使用 MCP Inspector,它作为一个包脚本可用:
pnpm run inspector
Inspector 将提供一个 URL 来访问浏览器中的调试工具:http://localhost:5173。你需要在连接之前添加 POSTMAN_API_KEY。导航到“工具”开始。
本项目采用 MIT 许可证。详情请参阅 LICENSE 文件。