ApiPost MCP is an API management tool that integrates with ApiPost's OpenAPI to manage documentation, directories, and workspaces through the MCP protocol.
Core Capabilities:
Connection & Workspace
Test connectivity and verify configuration with
apipost_test_connectionView, list, and switch between teams/projects by ID or name using
apipost_workspace
API Documentation Structure
Create hierarchical folder structures with parent-child relationships via
apipost_create_folderOrganize APIs in nested directories for better structure
API Interface Operations
Smart Create (
apipost_smart_create): Generate complete API documentation with HTTP methods, request parameters (headers, query, body, cookies), response examples with field definitions, authentication configurations, and automatic URL prefix handlingUpdate (
apipost_update): Incremental field-level updates—keep unchanged fields, delete by supplying empty values, replace with new valuesView (
apipost_detail): Retrieve complete API configuration and specificationsDelete (
apipost_delete): Batch deletion of single or multiple API interfaces
Advanced Search & Navigation (apipost_list)
Multi-dimensional search by name, URL, method, ID, or description
Hierarchical filtering by type (API, folder, or all)
Recursive search within subdirectories with depth control
Display options: tree view, list view, or grouped by folder with path navigation
Flexible result limits (default 50, max 200, or show all)
Security & Permissions
Three security modes:
readonly(view-only),limited(read/write, no deletion),full(complete access)Token-based authentication for secure API access
Special Features
URL prefix management: Automatically prepend defined prefixes to API paths
Field-level control with support for nested objects and arrays
Optional inline comment generation in response examples
Supports project installation via Git clone commands.
Requires Node.js 16+ as runtime environment for the MCP server.
Used for dependency management and build processes with commands like 'npm install' and 'npm run build'.
Implemented using TypeScript for type safety and improved development experience.
ApiPost MCP
基于 MCP 协议和 ApiPost 官方 OpenAPI 实现的 API 管理工具。
功能
连接测试 - 一键验证MCP服务器状态和配置
工作空间管理 - 查看、切换团队和项目工作空间
目录管理 - 创建API文档目录,支持层级结构
API接口管理 - 创建、查看、修改、删除接口文档
增量更新 - 支持字段级别的精确更新和删除
层级搜索 - 强化的目录层级搜索和父子关系定位
递归浏览 - 递归搜索子目录,支持深度限制
多维筛选 - 多维度搜索和批量操作
结构化显示 - 树形结构和分组显示
路径导航 - 完整路径显示,快速定位
权限管理 - 多种安全模式,灵活的操作权限控制
Related MCP server: Appwrite MCP Server
安装
环境要求
在开始安装之前,请确保您的系统已安装以下环境:
环境 | 版本要求 | 说明 |
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
验证安装:
开始安装
配置
在 MCP 配置文件中添加:
环境变量
变量名 | 是否必需 | 说明 |
| 是 | API访问令牌 |
| 否 | 安全模式:
,
,
|
| 否 | 默认团队名称 |
| 否 | 默认项目名称 |
| 否 | 接口URL前缀,自动拼接到所有新建/修改的接口路径,如
|
安全模式说明
模式 | 权限 | 说明 |
| 只读 | 仅允许查看接口列表和详情,禁止创建、修改、删除 |
| 读写 | 允许查看、创建、修改接口,禁止删除操作 |
| 完全访问 | 允许所有操作,包括查看、创建、修改、删除 |
可用工具
工具 | 功能 | 主要参数 |
| 连接测试 |
|
| 工作空间管理 |
(必需) |
| 创建目录 |
,
|
| 创建接口 |
,
,
|
| 强化列表搜索 |
,
,
,
,
,
|
| 查看详情 |
|
| 修改接口 |
, 其他可选 |
| 删除接口 |
|
apipost_test_connection 说明
快速诊断工具,适合首次使用或故障排查:
✅ 验证MCP服务器连接状态
🔧 检查环境变量配置
🏢 显示当前工作空间信息
🛠️ 检查操作权限和安全模式
📊 提供系统环境详情
apipost_workspace 说明
统一的工作空间管理工具,支持以下操作:
Action | 功能 | 主要参数 | 说明 |
| 查看当前工作空间 |
| 显示当前团队、项目信息,可选显示所有可用选项 |
| 列出团队 |
| 显示所有可用团队,标识当前团队 |
| 列出项目 |
,
| 显示指定团队的项目列表 |
| 切换工作空间 |
,
或
,
| 切换到指定的团队和项目 |
使用示例:
apipost_create_folder 说明
API文档目录创建工具,支持在指定父目录下创建新的文件夹:
参数 | 类型 | 必需 | 说明 |
| string | 是 | 目录名称 |
| string | 否 | 父目录ID,使用"0"表示根目录,默认为"0" |
| string | 否 | 目录描述(可选) |
使用示例:
apipost_list 参数说明
参数 | 类型 | 说明 |
| string | 搜索关键词(接口名称、URL、方法、ID、描述) |
| string | 父目录ID,精确查找子项目。"0"为根目录 |
| string | 类型筛选:
(仅接口)、
(仅目录)、
(全部) |
| boolean | 显示树形结构,默认false为列表模式 |
| boolean | 显示完整路径,默认false |
| boolean | 递归搜索子目录,默认false |
| number | 深度限制(配合recursive),默认无限制 |
| boolean | 按目录分组显示,默认false |
| number | 显示数量限制(默认50,最大200) |
| 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
示例(嵌套):
获取 Token
用户api_token。获取方式:Apipost客户端>工作台>项目设置>对外能力>open API
📝 更新日志
查看 CHANGELOG.md 了解版本更新信息。
💡 提示:这是一个专注于API接口管理的MCP工具,简化了接口创建和管理流程,提高团队协作效率。
联系方式
📧 邮箱: jlcodes@163.com
🐛 问题反馈: GitHub Issues
🌟 项目主页: GitHub Repository
相关链接
⭐ 如果这个项目对你有帮助,请给我们一个星标!