Code To Apifox MCP

MCP文档知识

提供方 未标注

文档知识 SSE · 服务端推送 Token 社区 / 第三方
查看接入方式

全面解析Code To Apifox MCPMCP Server的核心功能、安装配置和实用案例。作为顶级Model Context Protocol服务器,Code To Apifox MCP能让AI助手访问实时数据、执行操作,为您提供更智能的工作体验和自动化解决方案。

一句话选型结论

按资料字段整理

Code To Apifox MCP 属于文档知识类 MCP 服务器,SSE · 服务端推送,Token,有可直接复制的远程端点配置。接入前先确认权限范围;涉及写入、删除或付款的操作,建议先在测试环境验证。

分类文档知识 传输方式SSE · 服务端推送 鉴权Token 部署方式远程部署
GitHub 星标 未标注 仓库热度,无公开仓库时显示未标注
工具数 未标注 暴露给模型的工具数量
资源 / 提示词 0 / 0 资源与提示词模板数量
维护方 社区 / 第三方 核验等级 仅资料核对

工具与能力

文档知识
数量来自来源目录的标注,具体工具清单以官方文档为准
工具数量未标注暴露给模型可调用的工具个数
资源数量0可读取的资源条目
提示词数量0内置提示词模板数量

能力标签

安装与配置

SSE · 服务端推送 Token
早期远程传输方式,正在被 HTTP 取代
npx code-to-apifox-mcp --stdio

这条命令只是入口,具体启动参数请按官方文档补齐,不要直接照搬到别的服务器。

  1. 1
    准备运行环境

    确认你的客户端支持远程端点,并拿到服务地址。

  2. 2
    安装服务

    复制上面的安装命令执行;命令里带占位符的位置,换成自己的密钥或路径。

  3. 3
    写入客户端配置

    在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,让新配置生效。

  4. 4
    验证是否可用

    连接成功后随便调一个只读工具,确认能返回结果,再接入正式流程。

典型使用场景

3 类
按分类与标签整理的常见用法,具体以官方文档为准
文档检索问答

在你的文档库里按问题找答案。

知识库读写

把新资料写进知识库,随用随取。

内容整理

把零散资料归纳成结构化笔记。

选择建议

选之前先看这几条
按条目字段给出的判断,不替你决定用不用

值得选的地方

  • 有现成的安装命令,不用自己找入口,照着跑就能起服务。

先想清楚的地方

  • 远程端点依赖网络与服务方可用性,注意密钥与调用额度。
  • 使用前要准备好Token对应的凭据,并按最小权限配置。
  • 资料没标注工具数量,实际能力要装好后确认。
  • 版本更新与行为细节以官方仓库为准。

更适合

  • 需要在文档知识场景里让模型直接调用外部能力的人。
  • 想先快速试一下、能接受在本地或自有环境跑服务的人。

不太适合

  • 不方便管理密钥或第三方授权的人。
  • 需要厂商级 SLA 和技术支持的生产环境。

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
MCP 服务器工具数传输方式部署方式安装命令最后核验
Code To Apifox MCP当前 未标注 SSE · 服务端推送 远程部署 有 2026-05-17
dify 未标注 stdio · 本地进程 本地部署 有 2026-04-11
open-webui 未标注 stdio · 本地进程 本地部署 有 2026-04-11
JeecgBoot 未标注 stdio · 本地进程 本地部署 有 2026-04-11
Cherry Studio 未标注 未标注 未标注 无 2026-05-17
mempalace 未标注 stdio · 本地进程 本地部署 有 2026-04-11

服务器档案

文档知识
字段来自项目仓库与公开索引,中文说明由本站标注
提供方未标注上游标注的维护方 未标注
分类文档知识本站按上游分类展示
连接方式SSE · 服务端推送早期远程传输方式,正在被 HTTP 取代
鉴权方式Token远程服务建议用最小权限凭据
维护方社区 / 第三方核验等级 仅资料核对
包名 / 运行时未标注 · Node.js本地安装时用到的包标识与运行时
部署类型远程部署上游给出的部署形态
最近核验2026-05-17上游最后核验时间

详细介绍

6.7 KB
来自项目仓库与上游目录的原文,未做删改

Code-to-ApiFox MCP Server

一个基于Node.js的MCP(Model Context Protocol)服务器,专门用于Swagger文档生成和ApiFox平台集成。

✨ 功能特性

  • 🚀 标准MCP协议支持 - 完全兼容MCP协议规范
  • 📝 Swagger规范生成 - 提供标准的Swagger JSON示例和最佳实践
  • 🔗 ApiFox无缝集成 - 一键上传API文档到ApiFox平台
  • 🔄 双模式运行 - 支持STDIO和HTTP两种连接方式
  • 🌐 云端部署就绪 - 支持本地开发和生产环境部署
  • 🤖 AI助手友好 - 专为AI助手设计的工具集成
  • 🔐 配置文件管理 - 支持通过配置文件管理ApiFox凭据

🚀 快速开始

全局安装(推荐)```bash

全局安装

npm install -g code-to-apifox-mcp

直接使用

code-to-apifox-mcp --stdio # MCP客户端模式
code-to-apifox-mcp # HTTP服务模式


### 临时使用```bash
# 无需安装,直接运行
npx code-to-apifox-mcp --stdio
npx code-to-apifox-mcp

本地开发```bash

克隆项目

git clone https://github.com/xzg0919/code-to-apifox-mcp.git
cd code-to-apifox-mcp

安装依赖

npm install

开发模式运行

npm run dev:stdio # STDIO模式
npm run dev # HTTP模式


## 📖 使用方法

### 1. MCP客户端集成(推荐)

在支持MCP的AI助手(如Claude Desktop)中配置:```json
{
  "mcpServers": {
    "doc-mcp-server": {
      "command": "code-to-apifox-mcp",
      "args": ["--stdio"]
    }
  }
}

配置完成后,你可以直接在AI助手中使用:

获取Swagger规范:```
请帮我获取Swagger规范示例


**使用配置文件上传**:
如果你在项目根目录创建了`code-to-apifox.json`文件:```
请帮我上传API文档到ApiFox
- Swagger JSON: {...}

手动指定参数:```
请帮我上传API文档到ApiFox:
- 项目ID: your-project-id
- 访问令牌: your-access-token
- Swagger JSON: {...}


### 2. HTTP API调用

启动HTTP服务:```bash
code-to-apifox-mcp  # 默认端口3033

获取Swagger规范示例```bash

curl -X POST http://127.0.0.1:3033/tools/getSwaggerSpecification


#### 上传文档到ApiFox```bash
curl -X POST http://127.0.0.1:3033/tools/uploadSwaggerToApiFox \
  -H "Content-Type: application/json" \
  -d '{
    "projectId": "your-project-id",
    "accessToken": "your-access-token",
    "swaggerJson": "your-swagger-json-string"
  }'

健康检查```bash

curl http://127.0.0.1:3033/health


### 3. 编程方式使用

在Node.js项目中直接使用:```javascript
import { SwaggerUploadService } from 'code-to-apifox-mcp';

const config = {
  apifox: {
    api: {
      baseUrl: 'https://api.apifox.com',
      version: '2024-03-28'
    }
  }
};

const service = new SwaggerUploadService(config);

// 获取Swagger规范
const spec = await service.getSwaggerSpecification();
console.log(spec);

// 上传到ApiFox
const result = await service.uploadSwaggerToApiFox(
  'project-id',
  'access-token',
  'swagger-json'
);
console.log(result);

🛠️ 工具说明

getSwaggerSpecification

功能: 获取标准的Swagger JSON规范示例

返回: 包含完整Petstore示例的Swagger规范,以及详细的使用说明和最佳实践建议

新增:包含code-to-apifox.json配置文件的使用说明

适用场景:
- 学习Swagger规范格式
- 作为API文档模板
- 了解最佳实践和注意事项

uploadSwaggerToApiFox

功能: 将Swagger JSON上传到ApiFox平台

参数:
- projectId (必填): ApiFox项目ID
- accessToken (必填): ApiFox访问令牌
- swaggerJson (必填): 完整的Swagger JSON字符串

返回: 上传结果和详细信息

⚙️ 配置说明

默认配置文件(推荐)

在项目根目录创建code-to-apifox.json文件来配置默认的ApiFox项目ID和访问令牌:```json
{
"projectId": "your-project-id",
"accessToken": "your-access-token"
}


**优势**:
- 🔐 避免每次手动输入凭据
- 🚀 提高工作效率
- 📁 支持项目级配置管理

**安全提示**:
- ⚠️ 不要将此文件提交到版本控制系统
- 建议添加到`.gitignore`文件中

### 应用配置文件

配置文件位置: `config/config.json````json
{
  "app": {
    "name": "doc-mcp",
    "port": 3033
  },
  "apifox": {
    "api": {
      "baseUrl": "https://api.apifox.com",
      "version": "2024-03-28"
    }
  },
  "mcp": {
    "server": {
      "name": "doc-mcp-server",
      "version": "1.0.0",
      "instructions": "Swagger文档生成和ApiFox集成工具"
    }
  }
}

🌐 部署指南

本地部署```bash

全局安装

npm install -g code-to-apifox-mcp

启动服务

code-to-apifox-mcp # HTTP模式,端口3033


### 云服务器部署```bash
# 1. 上传到服务器
scp -r . user@your-server.com:/opt/doc-mcp/

# 2. 在服务器上安装和启动
ssh user@your-server.com
cd /opt/doc-mcp
npm install -g code-to-apifox-mcp

# 3. 后台运行
nohup code-to-apifox-mcp > mcp-server.log 2>&1 &

Docker部署```dockerfile

FROM node:18-alpine
RUN npm install -g code-to-apifox-mcp
EXPOSE 3033
CMD ["code-to-apifox-mcp"]
``````bash
docker build -t doc-mcp .
docker run -p 3033:3033 doc-mcp


## 🔗 API端点

当以HTTP模式运行时,提供以下端点:

- `GET /health` - 服务健康检查
- `GET /sse` - MCP客户端SSE连接
- `POST /tools/getSwaggerSpecification` - 获取Swagger规范
- `POST /tools/uploadSwaggerToApiFox` - 上传到ApiFox

## 🧪 测试和验证```bash
# 运行单元测试
npm test

# 测试HTTP服务
curl http://127.0.0.1:3033/health

# 测试工具功能
npx code-to-apifox-mcp --stdio

📋 环境要求

  • Node.js: >= 18.0.0
  • npm: >= 8.0.0
  • 操作系统: Windows, macOS, Linux

❓ 常见问题

Q: 如何使用配置文件管理ApiFox凭据?

A: 在项目根目录创建code-to-apifox.json文件,包含projectId和accessToken字段。这样在使用uploadSwaggerToApiFox工具时就不需要每次都输入凭据。

Q: 配置文件安全吗?

A: 建议将code-to-apifox.json添加到.gitignore文件中,避免意外提交敏感信息到版本控制系统。

Q: 如何获取ApiFox的项目ID和访问令牌?

A: 登录ApiFox,在项目设置 -> 开放API中可以找到项目ID和生成访问令牌。

Q: 支持哪些Swagger版本?

A: 支持Swagger 2.0和OpenAPI 3.0格式。

Q: 如何在AI助手中使用?

A: 配置MCP客户端后,直接用自然语言描述需求即可,如"帮我上传API文档到ApiFox"。

Q: 端口被占用怎么办?

A: 修改config/config.json中的端口号,或设置环境变量PORT=your-port。

🔗 相关链接

  • GitHub仓库
  • npm包
  • ApiFox官网
  • MCP协议文档

如果这个工具对你有帮助,请给个⭐️支持一下!

常见问题

7 问
答案由本站依据条目字段整理,不引用上游原文
Code To Apifox MCP 怎么安装?

在客户端按下面的安装命令接入:npx code-to-apifox-mcp --stdio。装完在客户端配置里引用同一个包或端点。

Code To Apifox MCP 怎么在客户端里配置?

它的传输方式未标注,在客户端 MCP 配置里按官方文档填写启动命令和参数,保存后重启客户端生效。

Code To Apifox MCP 收费吗?

本站不代收费用,也没有标注具体价格。是否收费取决于服务本身和背后的接口额度,正式使用前按官方说明确认。

Code To Apifox MCP 需要 API Key 吗?

资料标注需要Token认证,使用前准备好对应凭据,并按最小权限配置。

Code To Apifox MCP 能提供哪些能力?

资料显示能力标签包括 API文档、JavaScript、Token认证。具体工具清单以官方文档为准。

Code To Apifox MCP 需要什么运行环境?

运行时为 Node.js;属于远程端点,不需要在本地装运行时。

Code To Apifox MCP 是本地还是远程?

它是远程端点,连服务地址即可。传输方式为SSE · 服务端推送。

热门专题

按标签挑服务器
全部专题 →

服务器信息以作者仓库与官方文档为准;分类、传输方式与鉴权方式的中文说明为中文整理,最近核验 2026-05-17。