Apifox MCP Pro

Apifox MCP Pro

English | 中文

---

Português

⚠️ Status do Projeto

Devido à API aberta extremamente limitada do Apifox (apenas 3 endpoints básicos de importação/exportação), este projeto foi simplificado das 33+ ferramentas originalmente planejadas para 9 ferramentas de diagnóstico e consulta de informações. A maioria dos recursos de gerenciamento de API requer o uso da interface web ou do cliente desktop do Apifox.

---

Serviço Apifox MCP aprimorado com capacidades básicas de diagnóstico e informação para Claude Desktop e Cursor.

🆚 Comparação com o MCP Oficial

Recurso	MCP Oficial	Apifox MCP Pro
Número de Ferramentas	3 ferramentas	9 ferramentas (Limitado)
Gerenciamento de Projetos	❌	⚠️ Apenas informações básicas
CRUD de API	❌	❌ Não suportado
Operações em Lote	❌	❌ Não suportado
Suporte ao Cursor	❌	✅ Suporte nativo
Instalação via NPM	❌	✅ Instalação em um clique
Ferramentas CLI	❌	✅ CLI completo

⚠️ Limitações Importantes

Devido à API aberta extremamente limitada do Apifox, a maioria dos recursos avançados não está disponível:

• ❌ Gerenciamento de Interfaces de API - Não é possível listar, criar, atualizar ou excluir APIs
• ❌ Gerenciamento de Pastas - Nenhuma operação de pasta suportada
• ❌ Gerenciamento de Ambientes - Não é possível gerenciar ambientes
• ❌ Gerenciamento de Modelos de Dados - Nenhuma operação de schema
• ❌ Gerenciamento de Casos de Teste - Não é possível gerenciar casos de teste
• ❌ Funcionalidade de Busca - Busca de API não suportada
• ❌ Operações em Lote - Nenhuma operação em massa disponível

O que ESTÁ disponível:

• ✅ Informações Básicas do Projeto - Obter informações do projeto e verificações de acesso
• ✅ Explicações de Limitações - Documentação clara do que não é suportado
• ✅ Validação de Token - Verificar se seu token de acesso funciona
• ✅ Ferramentas de Diagnóstico - Ajuda a entender as limitações da API

Motivo: O Apifox fornece oficialmente apenas 3 endpoints básicos de API de importação/exportação. A maioria das funções de gerenciamento requer o uso da interface web ou do cliente desktop do Apifox.

Recursos

• 🚀 9 Ferramentas MCP - Ferramentas básicas de diagnóstico e informação
• 📋 Informações do Projeto - Obter informações básicas do projeto e status de acesso
• ⚠️ Conscientização de Limitações - Documentação clara das restrições da API
• 🔍 Ferramentas de Diagnóstico - Verificar validade do token e acesso ao projeto
• 💻 Multiplataforma - Funciona com Claude Desktop e Cursor
• 📦 Pacote NPM - Instalação fácil via npm
• 🛠️ Ferramentas CLI - Utilitários de configuração e setup

Nota: Devido à API aberta limitada do Apifox, recursos avançados de gerenciamento não estão disponíveis. Esta ferramenta serve principalmente como um utilitário de diagnóstico e informação.

Início Rápido

Opção 1: Instalação via NPM (Recomendado)

# Install globally
npm install -g apifox-mcp-pro

# Set your Apifox access token
export APIFOX_ACCESS_TOKEN="your_access_token_here"

# Setup for Cursor
apifox-mcp-pro setup --cursor

# Setup for Claude Desktop
apifox-mcp-pro setup --claude

# Setup for both
apifox-mcp-pro setup --both

Opção 2: Desenvolvimento Local

# Clone the repository
git clone https://github.com/guocong-bincai/Apifox_mcp_pro.git
cd Apifox_mcp_pro

# Install dependencies
npm install

# Build the project
npm run build

# Set environment variables
cp .env.example .env
# Edit .env and add your APIFOX_ACCESS_TOKEN

# Setup local configuration
npm run dev setup --both --local

Configuração

Obtendo seu Token de Acesso do Apifox

1. Acesse Site oficial do Apifox
2. Vá para Configurações Pessoais → Token de Acesso à API
3. Crie um novo token de acesso
4. Copie o token gerado (o formato geralmente é APS-xxxxxxxxxx)

⚠️ Aviso de Segurança:

• Guarde seu token de acesso com segurança, não o codifique diretamente no código
• Não envie arquivos de configuração contendo tokens reais para repositórios públicos
• Use variáveis de ambiente ou arquivos de configuração para gerenciar tokens

Variáveis de Ambiente

Crie um arquivo .env ou defina variáveis de ambiente:

# Required - 从Apifox个人设置中获取
APIFOX_ACCESS_TOKEN=your_apifox_access_token_here

# Optional
APIFOX_BASE_URL=https://api.apifox.com  # Default API base URL
LOG_LEVEL=info                          # Log level: debug, info, warn, error

Exemplo de arquivo .env:

# .env 文件示例（请替换为您的真实令牌）
APIFOX_ACCESS_TOKEN=APS-your-actual-token-here
LOG_LEVEL=info

Configuração do Cursor

Após executar apifox-mcp-pro setup --cursor, o servidor MCP será configurado automaticamente. Você também pode adicioná-lo manualmente às configurações do Cursor:

{
  "mcpServers": {
    "apifox-mcp-pro": {
      "command": "npx",
      "args": ["apifox-mcp-pro"],
      "env": {
        "APIFOX_ACCESS_TOKEN": "your_apifox_access_token_here"
      }
    }
  }
}

Configuração do Claude Desktop

Para o Claude Desktop, adicione ao seu claude_desktop_config.json:

{
  "mcpServers": {
    "apifox-mcp-pro": {
      "command": "npx",
      "args": ["apifox-mcp-pro"],
      "env": {
        "APIFOX_ACCESS_TOKEN": "your_apifox_access_token_here"
      }
    }
  }
}

Ferramentas Disponíveis (9 no total)

Informações do Projeto (2 ferramentas)

• apifox_project_info - Obter visão geral das funcionalidades e limitações do MCP
• apifox_check_access - Verificar validade do token e permissões de acesso

Informações da API (2 ferramentas)

• apifox_api_info - Obter explicação das limitações de gerenciamento de API
• apifox_check_project_access - Verificar acesso a um projeto específico

Informações de Limitações de Recursos (5 ferramentas)

• apifox_folder_info - Limitações de gerenciamento de pastas
• apifox_environment_info - Limitações de gerenciamento de ambientes
• apifox_schema_info - Limitações de gerenciamento de modelos de dados
• apifox_test_info - Limitações de gerenciamento de casos de teste
• apifox_import_export_info - Informações sobre funcionalidade de importação/exportação

❌ Ferramentas Removidas (Listadas Anteriormente, mas Não Funcionais)

As seguintes ferramentas foram removidas porque a API aberta do Apifox não as suporta:

Gerenciamento de API (9 removidas)

• apifox_list_apis - Listagem de API não suportada
• apifox_get_api - Detalhes da API não acessíveis
• apifox_create_api - Criação de API não suportada
• apifox_update_api - Atualizações de API não suportadas
• apifox_delete_api - Exclusão de API não suportada
• apifox_search_apis - Funcionalidade de busca indisponível
• apifox_batch_delete_apis - Operações em lote não suportadas
• apifox_batch_update_api_status - Atualizações de status não suportadas
• apifox_batch_move_apis - Movimentação de APIs não suportada

Gerenciamento de Projetos (4 removidas)

• apifox_list_projects - Acesso limitado à API
• apifox_create_project - Criação não suportada
• apifox_update_project - Atualizações não suportadas
• apifox_delete_project - Exclusão não suportada

Todas as Outras Ferramentas de Gerenciamento (14 removidas)

• Todas as ferramentas de gerenciamento de pastas, ambientes, schemas, casos de teste e importação/exportação

Motivo da Remoção: A API aberta do Apifox é extremamente limitada e fornece apenas 3 endpoints básicos de importação/exportação. Todas as operações de gerenciamento requerem o uso da interface web ou do aplicativo desktop do Apifox.

Exemplos de Uso

Obtendo Informações do MCP

// In Claude or Cursor, you can ask:
"What Apifox MCP Pro features are available?"

// This will call:
apifox_project_info()

Verificando Acesso

// Check if your token works:
"Check my Apifox access permissions"

// This will call:
apifox_check_access()

Entendendo as Limitações

// Get information about API management limitations:
"Why can't I list APIs in my Apifox project?"

// This will call:
apifox_api_info()

Soluções Alternativas

Como a maioria dos recursos de gerenciamento não está disponível através da API, considere estas alternativas:

// List all APIs in a project
"Show me all APIs in project 12345"

// Create a new API
"Create a GET API at /users/{id} for getting user details in project 12345"

// Search APIs
"Find all POST APIs in project 12345"

Operações em Lote

// Batch update API status
"Mark APIs with IDs [1, 2, 3] as 'released'"

// Batch move APIs
"Move APIs [4, 5, 6] to folder 'v2-apis'"

Comandos CLI

# Start MCP server (default)
apifox-mcp-pro

# Setup configuration
apifox-mcp-pro setup --cursor          # Setup for Cursor
apifox-mcp-pro setup --claude          # Setup for Claude Desktop
apifox-mcp-pro setup --both            # Setup for both
apifox-mcp-pro setup --local           # Use local node instead of npx
apifox-mcp-pro setup --examples        # Generate config examples only

# Show version
apifox-mcp-pro --version

# Show help
apifox-mcp-pro --help

Desenvolvimento

# Install dependencies
npm install

# Build the project
npm run build

# Run in development mode
npm run dev

# Run tests
npm test

# Lint code
npm run lint

# Format code
npm run format

Arquivos de Configuração

O comando de setup gera vários arquivos de configuração:

• cursor-mcp-config.json - Configuração do MCP para Cursor
• claude-desktop-config.json - Configuração do Claude Desktop
• local-config-example.json - Configuração de desenvolvimento local

Solução de Problemas

Problemas Comuns

1. Problemas com Token de Acesso

   # Make sure your token is set correctly
   echo $APIFOX_ACCESS_TOKEN
   
   # Or check in your IDE configuration
   

2. Problemas de Instalação

   # Clear npm cache and reinstall
   npm cache clean --force
   npm install -g apifox-mcp-pro
   

3. Problemas de Configuração

   # Regenerate configuration files
   apifox-mcp-pro setup --both --examples
   

Obtendo Ajuda

• Consulte o USAGE.md para instruções detalhadas de uso
• Revise os arquivos de configuração gerados
• Verifique as permissões do seu token de acesso do Apifox
• Verifique a configuração do MCP na sua IDE

Contribuindo

1. Faça um fork do repositório
2. Crie um branch de funcionalidade
3. Faça suas alterações
4. Adicione testes, se aplicável
5. Envie um pull request

Licença

Licença MIT - consulte o arquivo LICENSE para detalhes.

Changelog

v1.0.0

• Lançamento inicial com 33 ferramentas MCP
• Suporte a pacote NPM
• Integração com Cursor e Claude Desktop
• Recursos abrangentes de gerenciamento de API
• Ferramentas de setup CLI

---

Nota: Esta é uma versão aprimorada do serviço oficial Apifox MCP, fornecendo significativamente mais funcionalidades do que a implementação oficial básica.

---

中文

⚠️ 项目状态说明

由于Apifox官方开放API功能极其有限（仅提供3个基础导入导出接口），本项目已从最初计划的33+个工具简化为9个诊断和信息查询工具。大部分API管理功能需要使用Apifox Web界面或桌面客户端。

---

为 Claude Desktop 和 Cursor 提供基础诊断和信息功能的 Apifox MCP 服务。

🆚 与官方 MCP 对比

功能	官方 MCP	Apifox MCP Pro
工具数量	3个	9个工具（受限）
项目管理	❌	⚠️ 仅基础信息
API CRUD	❌	❌ 不支持
批量操作	❌	❌ 不支持
Cursor 支持	❌	✅ 原生支持
NPM 安装	❌	✅ 一键安装
CLI 工具	❌	✅ 完整 CLI

⚠️ 重要限制

由于Apifox开放API功能极其有限，大部分高级功能不可用：

• ❌ API接口管理 - 无法列出、创建、更新或删除API
• ❌ 文件夹管理 - 不支持文件夹操作
• ❌ 环境管理 - 无法管理环境
• ❌ 数据模型管理 - 不支持Schema操作
• ❌ 测试用例管理 - 无法管理测试用例
• ❌ 搜索功能 - 不支持API搜索
• ❌ 批量操作 - 不支持批量操作

可用功能：

• ✅ 基础项目信息 - 获取项目信息和访问检查
• ✅ 限制说明 - 清晰的不支持功能文档
• ✅ 令牌验证 - 检查访问令牌是否有效
• ✅ 诊断工具 - 帮助理解API限制

原因： Apifox官方仅提供3个基础导入导出API端点。大部分管理功能需要使用Apifox Web界面或桌面客户端。

功能特性

• 🚀 9个MCP工具 - 基础诊断和信息工具
• 📋 项目信息 - 获取基础项目信息和访问状态
• ⚠️ 限制说明 - 清晰的API限制文档
• 🔍 诊断工具 - 检查令牌有效性和项目访问
• 💻 跨平台 - 支持 Claude Desktop 和 Cursor
• 📦 NPM 包 - 通过 npm 轻松安装
• 🛠️ CLI 工具 - 设置和配置工具

注意： 由于Apifox开放API限制，高级管理功能不可用。此工具主要作为诊断和信息查询工具使用。

快速开始

方式一：NPM 安装（推荐）

# 全局安装
npm install -g apifox-mcp-pro

# 设置 Apifox 访问令牌
export APIFOX_ACCESS_TOKEN="your_access_token_here"

# 配置 Cursor
apifox-mcp-pro setup --cursor

# 配置 Claude Desktop
apifox-mcp-pro setup --claude

# 同时配置两者
apifox-mcp-pro setup --both

方式二：本地开发

# 克隆仓库
git clone https://github.com/guocong-bincai/Apifox_mcp_pro.git
cd Apifox_mcp_pro

# 安装依赖
npm install

# 构建项目
npm run build

# 设置环境变量
cp .env.example .env
# 编辑 .env 文件并添加你的 APIFOX_ACCESS_TOKEN

# 设置本地配置
npm run dev setup --both --local

配置

环境变量

创建 .env 文件或设置环境变量：

# 必需
APIFOX_ACCESS_TOKEN=your_apifox_access_token_here

# 可选
APIFOX_BASE_URL=https://api.apifox.com  # 默认 API 基础 URL
LOG_LEVEL=info                          # 日志级别：debug, info, warn, error

Cursor 配置

运行 apifox-mcp-pro setup --cursor 后，MCP 服务器将自动配置。您也可以手动添加到 Cursor 设置中：

{
  "mcpServers": {
    "apifox-mcp-pro": {
      "command": "npx",
      "args": ["apifox-mcp-pro"],
      "env": {
        "APIFOX_ACCESS_TOKEN": "your_apifox_access_token_here"
      }
    }
  }
}

Claude Desktop 配置

对于 Claude Desktop，添加到您的 claude_desktop_config.json：

{
  "mcpServers": {
    "apifox-mcp-pro": {
      "command": "npx",
      "args": ["apifox-mcp-pro"],
      "env": {
        "APIFOX_ACCESS_TOKEN": "your_apifox_access_token_here"
      }
    }
  }
}

可用工具（共9个）

项目信息（2个工具）

• apifox_project_info - 获取MCP功能概览和限制信息
• apifox_check_access - 检查令牌有效性和访问权限

API信息（2个工具）

• apifox_api_info - 获取API管理限制说明
• apifox_check_project_access - 检查特定项目访问权限

功能限制信息（5个工具）

• apifox_folder_info - 文件夹管理限制说明
• apifox_environment_info - 环境管理限制说明
• apifox_schema_info - 数据模型管理限制说明
• apifox_test_info - 测试用例管理限制说明
• apifox_import_export_info - 导入导出功能信息

❌ 已删除的工具（之前列出但不可用）

由于Apifox开放API不支持，以下工具已被删除：

API管理（9个已删除）

• apifox_list_apis - 不支持API列表查询
• apifox_get_api - 无法访问API详情
• apifox_create_api - 不支持API创建
• apifox_update_api - 不支持API更新
• apifox_delete_api - 不支持API删除
• apifox_search_apis - 搜索功能不可用
• apifox_batch_delete_apis - 不支持批量操作
• apifox_batch_update_api_status - 不支持状态更新
• apifox_batch_move_apis - 不支持移动API

项目管理（4个已删除）

• apifox_list_projects - API访问受限
• apifox_create_project - 不支持创建
• apifox_update_project - 不支持更新
• apifox_delete_project - 不支持删除

其他所有管理工具（14个已删除）

• 所有文件夹、环境、数据模型、测试用例和导入导出管理工具

删除原因： Apifox开放API功能极其有限，仅提供3个基础导入导出端点。所有管理操作需要使用Apifox Web界面或桌面应用程序。

使用示例

获取MCP信息

// 在 Claude 或 Cursor 中，您可以询问：
"Apifox MCP Pro 有哪些可用功能？"

// 这将调用：
apifox_project_info()

检查访问权限

// 检查令牌是否有效：
"检查我的 Apifox 访问权限"

// 这将调用：
apifox_check_access()

了解限制

// 获取API管理限制信息：
"为什么我无法列出 Apifox 项目中的 API？"

// 这将调用：
apifox_api_info()

替代解决方案

由于大部分管理功能通过API不可用，请考虑以下替代方案：

• 使用 Apifox Web界面 进行完整的API管理
• 使用 Apifox 桌面客户端获得最佳体验
• 等待官方完善开放API功能

CLI 命令

# 启动 MCP 服务器（默认）
apifox-mcp-pro

# 设置配置
apifox-mcp-pro setup --cursor          # 设置 Cursor
apifox-mcp-pro setup --claude          # 设置 Claude Desktop
apifox-mcp-pro setup --both            # 设置两者
apifox-mcp-pro setup --local           # 使用本地 node 而不是 npx
apifox-mcp-pro setup --examples        # 仅生成配置示例

# 显示版本
apifox-mcp-pro --version

# 显示帮助
apifox-mcp-pro --help

开发

# 安装依赖
npm install

# 构建项目
npm run build

# 开发模式运行
npm run dev

# 运行测试
npm test

# 代码检查
npm run lint

# 格式化代码
npm run format

配置文件

setup 命令会生成几个配置文件：

• cursor-mcp-config.json - Cursor MCP 配置
• claude-desktop-config.json - Claude Desktop 配置
• local-config-example.json - 本地开发配置

故障排除

常见问题

1. 访问令牌问题

   # 确保您的令牌设置正确
   echo $APIFOX_ACCESS_TOKEN
   
   # 或检查您的 IDE 配置
   

2. 安装问题

   # 清除 npm 缓存并重新安装
   npm cache clean --force
   npm install -g apifox-mcp-pro
   

3. 配置问题

   # 重新生成配置文件
   apifox-mcp-pro setup --both --examples
   

获取帮助

• 查看 USAGE.md 了解详细使用说明
• 查看生成的配置文件
• 检查您的 Apifox 访问令牌权限
• 验证您的 IDE MCP 配置

贡献

1. Fork 仓库
2. 创建功能分支
3. 进行更改
4. 如适用，添加测试
5. 提交 Pull Request

许可证

MIT 许可证 - 详见 LICENSE 文件。

更新日志

v1.0.0

• 首次发布，包含 33 个 MCP 工具
• NPM 包支持
• Cursor 和 Claude Desktop 集成
• 全面的 API 管理功能
• CLI 设置工具

---

注意：这是官方 Apifox MCP 服务的增强版本，提供比基础官方实现更多的功能。