apifox-import-mcp
v1.0.1
Published
MCP server for importing OpenAPI data to Apifox
Maintainers
Readme
MCP Apifox Import Server
一个基于 MCP (Model Context Protocol) 的服务器,用于将 OpenAPI 3/Swagger 2 格式数据导入到 Apifox 平台。
快速开始
Claude Desktop 配置
在 mcp.json 中添加:
{
"servers": {
"apifox-import": {
"command": "npx",
"args": ["-y", "apifox-import-mcp", "--project-id", "<your-project-id>"],
"env": {
"APIFOX_ACCESS_TOKEN": "<your-access-token>"
}
}
}
}功能特性
- 支持 OpenAPI 3 和 Swagger 2 格式数据导入
- 提供丰富的导入选项(目录、覆盖行为、分支等)
- 基于 stdio 的 MCP 传输方式
获取 Apifox 访问令牌
- 登录 Apifox
- 进入「开放平台」
- 创建系统级访问令牌
- 将令牌复制到
mcp配置文件中
获取 Apifox 项目 ID
项目 ID 可以从 Apifox 项目 URL 中获取:
- 在 Apifox 中打开您的项目
- 浏览器地址栏的 URL 格式为:
https://app.apifox.com/project/{projectId}/... {projectId}部分即为项目 ID
开发
# 构建
npm run build
# 运行
npm start
# 开发模式(构建后运行)
npm run dev
# 监听模式
npm run watchMCP 工具
import-openapi
将 OpenAPI 3/Swagger 2 数据导入到 Apifox 项目。项目 ID 需要在 MCP 配置中设置。
参数
input(必填): OpenAPI 数据,支持以下格式:string: JSON/YAML 格式的 OpenAPI 数据字符串
options(可选): 导入配置选项targetEndpointFolderId: 目标接口目录 IDtargetSchemaFolderId: 目标数据模型目录 IDendpointOverwriteBehavior: 接口覆盖行为schemaOverwriteBehavior: 数据模型覆盖行为updateFolderOfChangedEndpoint: 是否更新接口目录prependBasePath: 是否添加基础路径targetBranchId: 目标分支 IDmoduleId: 目标模块 ID
示例
{
"input": "{\"openapi\":\"3.0.1\",\"info\":{\"title\":\"API\"},\"paths\":{}}",
"options": {
"targetEndpointFolderId": 0,
"endpointOverwriteBehavior": "OVERWRITE_EXISTING"
}
}许可证
MIT
