基于 MCP 协议和 ApiPost 官方 OpenAPI 实现的 API 管理工具。

功能

• 工作空间管理：查看、切换团队和项目工作空间
• 接口查询列表：根据查询条件查找对应的接口列表
• 查询接口详情：根据接口 ID 查询详细的接口信息
• 接口创建模板：根据接口响应示例生成对应的模板组件

安装

环境要求

在开始安装之前，请确保您的系统已安装以下环境：

环境	版本要求	说明
Node.js	>=18.0.0	JavaScript 运行环境（MCP SDK 官方最低要求）
npm	>=8.0.0	Node.js 包管理器（通常随 Node.js 一起安装）

配置

在 MCP 配置文件中添加：

{
  "mcpServers": {
    "test": {
      "command": "npx",
      "args": ["@lingping/mcp-apipost"],
      "env": {
        "APIPOST_TEAM_ID": "默认团队ID",
        "APIPOST_PROJECT_ID": "默认项目ID",
        "APIPOST_TOKEN": "ApiPost token",
        "APIPOST_HOST": "接口地址"
      }
    }
  }
}

环境变量

变量名	是否必须	说明
APIPOST_TOKEN	是	API 访问令牌
APIPOST_TEAM_ID	否	默认团队 ID
APIPOST_PROJECT_ID	否	默认项目 ID
APIPOST_HOST	否	接口基地址

可用工具

工具	功能	参数
apipost_workspace	工作空间管理	action
apipost_apiList	接口查询列表	search
apipost_apiDetail	查询接口详情	target_id
apipost_createTemp	接口创建模板	responseStr、component

apipost_workspace

统一的工作空间管理工具，支持以下操作：

action	功能	额外参数	说明
current	查看当前工作空间		显示当前工作空间、项目信息
list_teams	查看所有工作空间		显示所有可用团队，标识当前团队
list_projects	查看当前空间所有项目	team_id	显示当前团队的项目列表，或者可以指定团队 ID 下的项目列表
switch	切换工作空间	team_id（必填）、project_id	切换到指定的团队和项目，如果不指定项目 ID 则默认团队下第一个项目

使用示例：

• 查看当前工作空间
• 查看所有工作空间
• 查看当前空间所有项目
• 查看空间 ID：xxxxxxxx 下的所有项目
• 切换到空间 ID：xxxxxxxx
• 切换到空间 ID：xxxxxxxx，并且选择项目 ID：xxxxxxxx

apipost_apiList

支持接口名称、接口 URL、接口方法、接口 ID、接口类别（folder 目录、api 接口）

使用示例：

• 查询接口名称：xxxxxxxx 的接口
• 查询接口 URL：xxxxxxxx 的接口
• 查询接口方法：xxxxxxxx 的接口
• 查询接口 ID：xxxxxxxx 的接口
• 查询接口类别：xxxxxxxx 的接口

apipost_apiDetail

使用示例：

• 查询接口 ID：xxxxxxx 的详细信息

apipost_createTemp

根据接口详情返回的响应示例生成对应的组件

component	说明
elTable	生成 element-ui，el-table 组件

使用示例：

• 查询接口 ID：xxxxxxx 的详细信息，根据响应示例生成 elTable 组件

参考文档

• modelcontextprotocol

• zod