项目简介

Postman Tool Generation Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务,它利用 Postman API 将您在 Postman 中定义的 API 集合和请求转换为 AI Agent 可以调用的工具代码。通过这个 MCP 服务器,您可以让 LLM 客户端(如 Claude 或 Cline)通过自然语言指令,直接操作您的 Postman 账户和 API 资源,例如创建、读取、更新 Postman 中的数据或执行 API 请求。

主要功能点

  • Postman API 工具生成: 将 Postman Collection 和 Request 转换为 AI 工具,使得 LLM 能够理解和调用您的 API。
  • 多框架支持: 生成的代码支持多种主流 AI 框架,包括 OpenAI, Mistral, Gemini, Anthropic, LangChain 和 AutoGen。
  • 类型安全的代码: 生成的工具代码是类型安全的 (TypeScript 或 JavaScript),易于集成和维护。
  • 简化 API 集成: 无需手动编写复杂的 API 调用代码,即可让 LLM 应用轻松集成 Postman API 功能。

安装步骤

  1. 安装 Node.js 和 npm: 确保您的系统已安装 Node.js 和 npm (Node Package Manager)。
  2. 下载仓库代码: 从 GitHub 仓库 https://github.com/giovannicocco/mcp-server-postman-tool-generation 下载代码到本地。
  3. 安装依赖: 在项目根目录下打开终端,运行命令 'npm install' 安装项目依赖。
  4. 构建服务器: 运行命令 'npm run build' 构建服务器代码。
  5. 设置 Postman API 密钥: 您需要一个 Postman API 密钥才能使用此服务器。请访问 Postman API 获取您的密钥,并将密钥设置为环境变量 'POSTMAN_API_KEY'。

服务器配置

要将此 MCP 服务器添加到 MCP 客户端(例如 Claude 或 Cline),您需要在客户端的 MCP 设置文件中添加以下配置信息。通常,这个文件可能是 'cline_mcp_settings.json' 或 Claude 的设置文件。

{
  "mcpServers": {
    "postman-ai-tools": {  // 服务器名称,可以自定义
      "command": "node",  // 启动服务器的命令,这里使用 Node.js 运行 JavaScript 文件
      "args": [
        "/path/to/postman-tool-generation-server/build/index.js" //  'index.js' 文件的绝对路径,请替换为实际路径
      ],
      "env": {
        "POSTMAN_API_KEY": "YOUR_POSTMAN_API_KEY" // 您的 Postman API 密钥,请替换为实际密钥,或者确保已在系统环境变量中设置
      },
      "disabled": false, // 设置为 false 启用该服务器
      "autoApprove": []  // 自动批准的工具列表,默认为空
    }
  }
}

请注意:

  • 请将 '/path/to/postman-tool-generation-server/build/index.js' 替换为服务器 'index.js' 文件在您本地文件系统中的绝对路径
  • 请将 'YOUR_POSTMAN_API_KEY' 替换为您的实际 Postman API 密钥。或者,您也可以选择在运行 MCP 客户端的环境中设置名为 'POSTMAN_API_KEY' 的环境变量。

基本使用方法

配置完成后,在 MCP 客户端中,您可以使用 'generate_ai_tool' 工具来生成 AI 工具代码。

工具名称: 'generate_ai_tool'

工具参数:

{
  collectionId: string;    // Postman Public API Network Collection 的 ID
  requestId: string;       // Postman Public Request 的 ID
  language: "javascript" | "typescript";  // 生成代码的编程语言,可选 "javascript" 或 "typescript"
  agentFramework: "openai" | "mistral" | "gemini" | "anthropic" | "langchain" | "autogen";  // 目标 AI Agent 框架,例如 "openai", "langchain" 等
}

使用示例 (假设在 Claude 或 Cline 中):

// 使用 MCP 工具生成 OpenAI 框架的 TypeScript 代码
const result = await use_mcp_tool({
  server_name: "postman-ai-tools", //  您在配置中设置的服务器名称
  tool_name: "generate_ai_tool",
  arguments: {
    collectionId: "your-collection-id", // 替换为您的 Postman Collection ID
    requestId: "your-request-id",    // 替换为您的 Postman Request ID
    language: "typescript",
    agentFramework: "openai"
  }
});

// 'result' 将包含生成的工具代码,通常为 JSON 字符串
console.log(result);

请根据您的 Postman Collection 和 Request ID,以及期望的编程语言和 AI 框架,调用 'generate_ai_tool' 工具。生成的代码可以集成到您的 AI Agent 应用中,从而实现通过 LLM 自然语言控制 Postman API 的功能。

信息

分类

开发者工具