API工具生成器

Postman Agent Generator是一个基于MCP协议的API工具生成器,可自动生成JavaScript工具并与Postman、Claude Desktop等客户端集成。

  • by jonico
  • JavaScript
  • 本地部署
  • 3 星标
  • 更新于
在 GitHub 查看 jonico/octocat-harry-potter-mcp-server

使用说明

工作坊幻灯片:

https://drive.google.com/drive/folders/1CQaKkrcuD8Vxam559EEdCByX0z2s-Oxc?usp=sharing

邮递员代理生成器

欢迎来到您的生成代理! 🚀

此项目是使用创建的 邮递员代理生成器,配置为 模型上下文提供程序(MCP) 服务器输出模式。它为您提供:

  • ✅ MCP兼容服务器(mcpServer.js)
  • ✅ 为每个选定的Postman API请求自动生成JavaScript工具

让我们把事情安排好!

🚦 入门指南

⚙️ 先决条件

在开始之前,请确保您已经:

📥 安装和设置

1.安装依赖项

从项目的根目录运行:

npm install

🔐 设置工具环境变量(octocat和哈利·波特api不需要)

在 .env 在文件中,您将看到环境变量占位符,每个占位符对应所选工具所在的工作区。例如,如果您从2个工作区(例如Acme和Widgets)中选择请求,您将看到两个占位符:

ACME_API_KEY=
WIDGETS_API_KEY=

使用每个API的实际API键更新值。这些环境变量在生成的工具内部用于为每个请求设置API键。您可以在 tools 查看目录以了解其工作原理。

// environment variables are used inside of each tool file
const apiKey = process.env.ACME_API_KEY;

警告: 这可能不是每个API都正确。生成逻辑相对简单——对于每个工作区,我们创建一个与工作区slug同名的环境变量,然后在属于该工作区的每个工具文件中使用该环境变量。如果这不是您选择的API的正确行为,没问题!您可以手动更新 .env 文件或工具文件,以准确反映API的身份验证方法。

🛠️ 列出可用工具

列出所有生成工具的描述和参数,包括:

node index.js tools

例子:

Available Tools:

Workspace: 6-harry-potter-api-with-magic-visualizations
  Collection: hogwarts-staff.js
    get_hogwarts_staff
      Description: Retrieve all Hogwarts staff characters.
      Parameters:

  Collection: spells.js
    fetch_spells
      Description: Fetch spells from the Harry Potter API.
      Parameters:

  Collection: hogwarts-students.js
    get_hogwarts_students
      Description: Fetch all Hogwarts students from the Harry Potter API.
      Parameters:

  Collection: characters-in-house.js
    get_characters_in_house
      Description: Retrieve characters from a specific Hogwarts house.
      Parameters:
        - house: The name of the Hogwarts house to retrieve characters from.

  Collection: all-characters.js
    get_all_characters
      Description: Retrieve all characters from the Harry Potter API.
      Parameters:


Workspace: 7-git-hub-octodex-postbot
  Collection: build-your-own-octodex-api.js
    fetch_octocats
      Description: Fetch Octocats from the Octodex API.
      Parameters:

🌐 运行MCP服务器

MCP服务器(mcpServer.js)向兼容MCP的客户端(如Claude Desktop或Postman Desktop应用程序)公开您的自动化API工具。

  1. 查找节点路径:
which node
  1. 找到 mcpServer.js 路径:
realpath mcpServer.js

A.🖥️ 与邮差同行

Postman桌面应用程序是运行和测试MCP服务器的最简单方法。

步骤1:从下载最新的Postman桌面应用程序 https://www.postman.com/downloads/ 或者安装最新的Postman Desktop Agent,以便在浏览器中与Postman配合使用。

步骤2:分叉或修改 Octodex-HP-MCP Server 邮差收藏 这里 并调整 Octodex & HP Local Node 指向本地MCP服务器的服务器设置:

B👩‍💻 使用Claude Desktop运行

要与Claude Desktop集成,请执行以下操作:

打开克劳德桌面→ 设置 → 开发者 → 编辑配置 并添加您的服务器:

{
  "mcpServers": {
    "octocat-hp-mcp-server-local": {
      "command": "<absolute_path_to_node>",
      "args": ["<absolute_path_to_mcpServer.js>"]
    }
  }
}

例如

{
  "mcpServers": {
    "octocat-hp-mcp-server-local": {
      "command": "/usr/local/bin/node",
      "args": ["/Users/yourusername/octocat-harry-potter-mcp-server/mcpServer.js"]
    }
  }
}

重新启动Claude Desktop以激活此更改。

C🏃‍♂️ 在VSCode中运行MCP服务器

为了在VSCode中运行本地MCP服务器,您可以调整并启动 octocat hp mcp服务器本地 .vcode文件夹中的服务器。

如果在Co-Pilot Chat中选择代理模式,则工具图标应显示由 octocat-hp-mcp-server-local 服务器。

附加选项

🐳 Docker部署(生产)

对于生产部署,您可以使用Docker:

1.构建Docker镜像

docker build -t octocat-hp-mcp-server .

将环境变量(API键等)添加到 .env 文件。

本地测试:

docker run -i --rm --env-file .env octocat-hp-mcp-server

2.克劳德桌面集成

将Docker服务器配置添加到Claude Desktop(设置→ 开发者→ 编辑配置):

{
  "mcpServers": {
    "octocat-hp-mcp-server-docker": {
      "command": "docker",
      "args": ["run", "-i", "--rm", "--env-file=.env", "octocat-hp-mcp-server"]
    }
  }
}

3.VS代码集成

为了在VSCode中运行Docker MCP服务器,您可以调整并启动 octocat hp-mcp服务器docker .vcode文件夹中的服务器。

如果在Co-Pilot Chat中选择代理模式,则工具图标应显示由 octocat-hp-mcp-server-docker 服务器。

🌐 服务器发送事件(SSE)

要运行支持服务器发送事件(SSE)的服务器,请使用 --sse 标志:

node mcpServer.js --sse

要在Docker中使用SSE运行并在端口9000上公开:

docker run  -i --rm  -p 9000:9000 --env-file .env octocat-hp-mcp-server node mcpServer.js --sse

这将在后台启动服务器,将主机上的端口9000映射到容器中的端口9000,并启用SSE支持。

🐳 Dockerfile(包括在内)

该项目附带了以下最低限度的Docker设置:

FROM node:22.12-alpine AS builder

WORKDIR /app
COPY package.json package-lock.json ./
RUN npm install

COPY . .

ENTRYPOINT ["node", "mcpServer.js"]

➕ 添加新工具

使用更多工具轻松扩展您的代理:

  1. 访问 邮递员代理生成器.
  2. 选择新的API请求,生成新的代理,然后下载。
  3. 将新生成的工具复制到现有项目的 tools/ 文件夹。
  4. 更新您的 tools/paths.js 文件中包含新的工具参考。

示例提示和可视化

prompts.md 有一些示例提示如何测试MCP服务器的功能,这导致 可视化 像这样

💬 问题与支持

访问 邮递员代理生成器 更新和新功能页面。

访问 邮差社区 分享你所构建的内容,提出问题并获得帮助。