ApiPost MCP

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

功能

连接测试 - 一键验证MCP服务器状态和配置
工作空间管理 - 查看、切换团队和项目工作空间
目录管理 - 创建API文档目录，支持层级结构
API接口管理 - 创建、查看、修改、删除接口文档
增量更新 - 支持字段级别的精确更新和删除
层级搜索 - 强化的目录层级搜索和父子关系定位
递归浏览 - 递归搜索子目录，支持深度限制
多维筛选 - 多维度搜索和批量操作
结构化显示 - 树形结构和分组显示
路径导航 - 完整路径显示，快速定位
权限管理 - 多种安全模式，灵活的操作权限控制

安装

环境要求

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

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

环境安装指南

Node.js 安装：

访问 Node.js 官网下载 LTS 版本

或使用包管理器：

# macOS (使用 Homebrew)
sudo brew install node

# Ubuntu/Debian
sudo apt update && sudo apt install nodejs npm

# CentOS/RHEL
sudo yum install nodejs npm

验证安装：

node --version   # 应显示 v18.0.0 或更高版本
npm --version    # 应显示 8.0.0 或更高版本

开始安装

git clone https://github.com/jlcodes99/apipost-mcp.git
cd apipost-mcp
npm install && npm run build

配置

在 MCP 配置文件中添加：

{
  "mcpServers": {
    "apipost": {
      "command": "node",
      "args": ["/absolute/path/to/apipost-mcp/dist/index.js"],
      "env": {
        "APIPOST_TOKEN": "your_access_token_here",
        "APIPOST_HOST": "https://open.apipost.net",
        "APIPOST_SECURITY_MODE": "limited",
        "APIPOST_DEFAULT_TEAM_NAME": "你的团队名称",
        "APIPOST_DEFAULT_PROJECT_NAME": "你的项目名称",
        "APIPOST_URL_PREFIX": "接口前缀可定义常量比如{{host}}"
      }
    }
  }
}

环境变量

变量名	是否必需	说明
`APIPOST_TOKEN`	是	API访问令牌
`APIPOST_SECURITY_MODE`	否	安全模式：`readonly`, `limited`, `full`
`APIPOST_DEFAULT_TEAM_NAME`	否	默认团队名称
`APIPOST_DEFAULT_PROJECT_NAME`	否	默认项目名称
`APIPOST_URL_PREFIX`	否	接口URL前缀，自动拼接到所有新建/修改的接口路径，如 `{{host}}`

安全模式说明

模式	权限	说明
`readonly`	只读	仅允许查看接口列表和详情，禁止创建、修改、删除
`limited`	读写	允许查看、创建、修改接口，禁止删除操作
`full`	完全访问	允许所有操作，包括查看、创建、修改、删除

可用工具

工具	功能	主要参数
`apipost_test_connection`	连接测试	`random_string`
`apipost_workspace`	工作空间管理	`action` (必需)
`apipost_create_folder`	创建目录	`name`, `parent_id`
`apipost_smart_create`	创建接口	`method`, `url`, `name`
`apipost_list`	强化列表搜索	`search`, `parent_id`, `target_type`, `show_structure`, `recursive`, `group_by_folder`
`apipost_detail`	查看详情	`target_id`
`apipost_update`	修改接口	`target_id`, 其他可选
`apipost_delete`	删除接口	`api_ids`

apipost_test_connection 说明

快速诊断工具，适合首次使用或故障排查：

✅ 验证MCP服务器连接状态
🔧 检查环境变量配置
🏢 显示当前工作空间信息
🛠️ 检查操作权限和安全模式
📊 提供系统环境详情

apipost_workspace 说明

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

Action	功能	主要参数	说明
`current`	查看当前工作空间	`show_all`	显示当前团队、项目信息，可选显示所有可用选项
`list_teams`	列出团队	`show_details`	显示所有可用团队，标识当前团队
`list_projects`	列出项目	`team_id`, `show_details`	显示指定团队的项目列表
`switch`	切换工作空间	`team_id`, `project_id` 或 `team_name`, `project_name`	切换到指定的团队和项目

使用示例：

# 查看当前工作空间
apipost_workspace action: "current"

# 列出所有团队
apipost_workspace action: "list_teams" show_details: true

# 列出项目
apipost_workspace action: "list_projects" team_id: "your_team_id"

# 切换工作空间（支持按名称或ID）
apipost_workspace action: "switch" team_name: "团队名" project_name: "项目名"

apipost_create_folder 说明

API文档目录创建工具，支持在指定父目录下创建新的文件夹：

参数	类型	必需	说明
`name`	string	是	目录名称
`parent_id`	string	否	父目录ID，使用"0"表示根目录，默认为"0"
`description`	string	否	目录描述（可选）

使用示例：

# 在根目录创建目录
apipost_create_folder name: "用户管理" description: "用户相关接口"

# 在指定目录下创建子目录
apipost_create_folder name: "认证接口" parent_id: "folder_123" description: "用户认证相关接口"

apipost_list 参数说明

参数	类型	说明
`search`	string	搜索关键词（接口名称、URL、方法、ID、描述）
`parent_id`	string	父目录ID，精确查找子项目。"0"为根目录
`target_type`	string	类型筛选：`api`(仅接口)、`folder`(仅目录)、`all`(全部)
`show_structure`	boolean	显示树形结构，默认false为列表模式
`show_path`	boolean	显示完整路径，默认false
`recursive`	boolean	递归搜索子目录，默认false
`depth`	number	深度限制（配合recursive），默认无限制
`group_by_folder`	boolean	按目录分组显示，默认false
`limit`	number	显示数量限制（默认50，最大200）
`show_all`	boolean	显示全部（忽略limit限制）

apipost_smart_create 说明（字段列表驱动）

规则（强制）：

responses 只传 fields，不要传 data；所有字段（含父级）必须带 desc。
headers/query/body/cookies 用字段列表字符串，嵌套用 .，数组用 []（如 meta.flags.debug、items[].id），example 填真实值，不要放 JSON 字符串。
父级需显式声明并写 desc，示例：{"key":"data","type":"object","desc":"返回体"},{"key":"data.user","type":"object","desc":"用户"},{"key":"data.user.id","type":"integer","example":1,"desc":"用户ID"}。
可选 APIPOST_INLINE_COMMENTS=true 时，raw 会按 desc 生成行内注释（mock 始终为纯 JSON）。
可选 APIPOST_URL_PREFIX={{ajllxa}} 时，创建或更新接口时会将前缀自动拼接到 URL（避免手动重复填写路由常量）。

必填：method、url、name。其他字段（均为字符串化 JSON 数组/对象）：

headers/query/body/cookies：[{"key":"X-Request-ID","type":"string","required":true,"example":"req-1","desc":"说明"}]
responses：[{"name":"成功","status":200,"fields":[{"key":"code","type":"integer","example":0,"desc":"状态码"},{"key":"data.items[].id","type":"string","example":"1","desc":"商品ID"}]}]
auth：{"type":"bearer","bearer":{"key":"your_token"}}

字段类型：string/integer/number/boolean/object/array/null

示例（嵌套）：

"body": "[{\"key\":\"user.id\",\"type\":\"integer\",\"required\":true,\"example\":9001,\"desc\":\"用户ID\"},{\"key\":\"user.profile.tags[]\",\"type\":\"string\",\"example\":\"vip\",\"desc\":\"标签\"}]",
"responses": "[{\"name\":\"成功\",\"status\":200,\"fields\":[{\"key\":\"code\",\"type\":\"integer\",\"example\":0,\"desc\":\"状态码\"},{\"key\":\"data.user.profile.tags[]\",\"type\":\"string\",\"example\":\"vip\",\"desc\":\"标签\"}]}]"

获取 Token

ApiPost OpenApi官方文档查看
用户api_token。获取方式：Apipost客户端>工作台>项目设置>对外能力>open API

📝 更新日志

查看 CHANGELOG.md 了解版本更新信息。

💡 提示：这是一个专注于API接口管理的MCP工具，简化了接口创建和管理流程，提高团队协作效率。

联系方式

📧 邮箱: jlcodes@163.com
🐛 问题反馈: GitHub Issues
🌟 项目主页: GitHub Repository

ApiPost MCP

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

功能

连接测试 - 一键验证MCP服务器状态和配置
工作空间管理 - 查看、切换团队和项目工作空间
目录管理 - 创建API文档目录，支持层级结构
API接口管理 - 创建、查看、修改、删除接口文档
增量更新 - 支持字段级别的精确更新和删除
层级搜索 - 强化的目录层级搜索和父子关系定位
递归浏览 - 递归搜索子目录，支持深度限制
多维筛选 - 多维度搜索和批量操作
结构化显示 - 树形结构和分组显示
路径导航 - 完整路径显示，快速定位
权限管理 - 多种安全模式，灵活的操作权限控制

安装

环境要求

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

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

环境安装指南

Node.js 安装：

访问 Node.js 官网下载 LTS 版本

或使用包管理器：

# macOS (使用 Homebrew)
sudo brew install node

# Ubuntu/Debian
sudo apt update && sudo apt install nodejs npm

# CentOS/RHEL
sudo yum install nodejs npm

验证安装：

node --version   # 应显示 v18.0.0 或更高版本
npm --version    # 应显示 8.0.0 或更高版本

开始安装

git clone https://github.com/jlcodes99/apipost-mcp.git
cd apipost-mcp
npm install && npm run build

配置

在 MCP 配置文件中添加：

{
  "mcpServers": {
    "apipost": {
      "command": "node",
      "args": ["/absolute/path/to/apipost-mcp/dist/index.js"],
      "env": {
        "APIPOST_TOKEN": "your_access_token_here",
        "APIPOST_HOST": "https://open.apipost.net",
        "APIPOST_SECURITY_MODE": "limited",
        "APIPOST_DEFAULT_TEAM_NAME": "你的团队名称",
        "APIPOST_DEFAULT_PROJECT_NAME": "你的项目名称",
        "APIPOST_URL_PREFIX": "接口前缀可定义常量比如{{host}}"
      }
    }
  }
}

环境变量

变量名	是否必需	说明
`APIPOST_TOKEN`	是	API访问令牌
`APIPOST_SECURITY_MODE`	否	安全模式：`readonly`, `limited`, `full`
`APIPOST_DEFAULT_TEAM_NAME`	否	默认团队名称
`APIPOST_DEFAULT_PROJECT_NAME`	否	默认项目名称
`APIPOST_URL_PREFIX`	否	接口URL前缀，自动拼接到所有新建/修改的接口路径，如 `{{host}}`

安全模式说明

模式	权限	说明
`readonly`	只读	仅允许查看接口列表和详情，禁止创建、修改、删除
`limited`	读写	允许查看、创建、修改接口，禁止删除操作
`full`	完全访问	允许所有操作，包括查看、创建、修改、删除

可用工具

工具	功能	主要参数
`apipost_test_connection`	连接测试	`random_string`
`apipost_workspace`	工作空间管理	`action` (必需)
`apipost_create_folder`	创建目录	`name`, `parent_id`
`apipost_smart_create`	创建接口	`method`, `url`, `name`
`apipost_list`	强化列表搜索	`search`, `parent_id`, `target_type`, `show_structure`, `recursive`, `group_by_folder`
`apipost_detail`	查看详情	`target_id`
`apipost_update`	修改接口	`target_id`, 其他可选
`apipost_delete`	删除接口	`api_ids`

apipost_test_connection 说明

快速诊断工具，适合首次使用或故障排查：

✅ 验证MCP服务器连接状态
🔧 检查环境变量配置
🏢 显示当前工作空间信息
🛠️ 检查操作权限和安全模式
📊 提供系统环境详情

apipost_workspace 说明

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

Action	功能	主要参数	说明
`current`	查看当前工作空间	`show_all`	显示当前团队、项目信息，可选显示所有可用选项
`list_teams`	列出团队	`show_details`	显示所有可用团队，标识当前团队
`list_projects`	列出项目	`team_id`, `show_details`	显示指定团队的项目列表
`switch`	切换工作空间	`team_id`, `project_id` 或 `team_name`, `project_name`	切换到指定的团队和项目

使用示例：

# 查看当前工作空间
apipost_workspace action: "current"

# 列出所有团队
apipost_workspace action: "list_teams" show_details: true

# 列出项目
apipost_workspace action: "list_projects" team_id: "your_team_id"

# 切换工作空间（支持按名称或ID）
apipost_workspace action: "switch" team_name: "团队名" project_name: "项目名"

apipost_create_folder 说明

API文档目录创建工具，支持在指定父目录下创建新的文件夹：

参数	类型	必需	说明
`name`	string	是	目录名称
`parent_id`	string	否	父目录ID，使用"0"表示根目录，默认为"0"
`description`	string	否	目录描述（可选）

使用示例：

# 在根目录创建目录
apipost_create_folder name: "用户管理" description: "用户相关接口"

# 在指定目录下创建子目录
apipost_create_folder name: "认证接口" parent_id: "folder_123" description: "用户认证相关接口"

apipost_list 参数说明

参数	类型	说明
`search`	string	搜索关键词（接口名称、URL、方法、ID、描述）
`parent_id`	string	父目录ID，精确查找子项目。"0"为根目录
`target_type`	string	类型筛选：`api`(仅接口)、`folder`(仅目录)、`all`(全部)
`show_structure`	boolean	显示树形结构，默认false为列表模式
`show_path`	boolean	显示完整路径，默认false
`recursive`	boolean	递归搜索子目录，默认false
`depth`	number	深度限制（配合recursive），默认无限制
`group_by_folder`	boolean	按目录分组显示，默认false
`limit`	number	显示数量限制（默认50，最大200）
`show_all`	boolean	显示全部（忽略limit限制）

apipost_smart_create 说明（字段列表驱动）

规则（强制）：

responses 只传 fields，不要传 data；所有字段（含父级）必须带 desc。
headers/query/body/cookies 用字段列表字符串，嵌套用 .，数组用 []（如 meta.flags.debug、items[].id），example 填真实值，不要放 JSON 字符串。
父级需显式声明并写 desc，示例：{"key":"data","type":"object","desc":"返回体"},{"key":"data.user","type":"object","desc":"用户"},{"key":"data.user.id","type":"integer","example":1,"desc":"用户ID"}。
可选 APIPOST_INLINE_COMMENTS=true 时，raw 会按 desc 生成行内注释（mock 始终为纯 JSON）。
可选 APIPOST_URL_PREFIX={{ajllxa}} 时，创建或更新接口时会将前缀自动拼接到 URL（避免手动重复填写路由常量）。

必填：method、url、name。其他字段（均为字符串化 JSON 数组/对象）：

headers/query/body/cookies：[{"key":"X-Request-ID","type":"string","required":true,"example":"req-1","desc":"说明"}]
responses：[{"name":"成功","status":200,"fields":[{"key":"code","type":"integer","example":0,"desc":"状态码"},{"key":"data.items[].id","type":"string","example":"1","desc":"商品ID"}]}]
auth：{"type":"bearer","bearer":{"key":"your_token"}}

字段类型：string/integer/number/boolean/object/array/null

示例（嵌套）：

"body": "[{\"key\":\"user.id\",\"type\":\"integer\",\"required\":true,\"example\":9001,\"desc\":\"用户ID\"},{\"key\":\"user.profile.tags[]\",\"type\":\"string\",\"example\":\"vip\",\"desc\":\"标签\"}]",
"responses": "[{\"name\":\"成功\",\"status\":200,\"fields\":[{\"key\":\"code\",\"type\":\"integer\",\"example\":0,\"desc\":\"状态码\"},{\"key\":\"data.user.profile.tags[]\",\"type\":\"string\",\"example\":\"vip\",\"desc\":\"标签\"}]}]"

获取 Token

ApiPost OpenApi官方文档查看
用户api_token。获取方式：Apipost客户端>工作台>项目设置>对外能力>open API

📝 更新日志

查看 CHANGELOG.md 了解版本更新信息。

💡 提示：这是一个专注于API接口管理的MCP工具，简化了接口创建和管理流程，提高团队协作效率。

联系方式

📧 邮箱: jlcodes@163.com
🐛 问题反馈: GitHub Issues
🌟 项目主页: GitHub Repository

ApiPost MCP

ApiPost MCP

功能

安装

环境要求

环境安装指南

开始安装

配置

环境变量

安全模式说明

可用工具

apipost_test_connection 说明

apipost_workspace 说明

apipost_create_folder 说明

apipost_list 参数说明

apipost_smart_create 说明（字段列表驱动）

获取 Token

📝 更新日志

联系方式

相关链接

ApiPost MCP

功能

安装

环境要求

环境安装指南

开始安装

配置

环境变量

安全模式说明

可用工具

apipost_test_connection 说明

apipost_workspace 说明

apipost_create_folder 说明

apipost_list 参数说明

apipost_smart_create 说明（字段列表驱动）

获取 Token

📝 更新日志

联系方式

相关链接