YApi

mcp-server-yapi

mcp-server-yapi é um servidor MCP projetado para YApi. Ele encapsula as funcionalidades comuns do YApi como uma série de ferramentas, permitindo que modelos de linguagem de grande porte (LLM) interajam com sua plataforma YApi por meio de linguagem natural, automatizando o gerenciamento de interfaces.

✨ Funcionalidades principais

Através deste serviço, você pode realizar as seguintes operações usando linguagem natural:

• Gerenciamento de projetos: Obter informações básicas do projeto.
• Gerenciamento de interfaces: Criar, salvar, atualizar e obter informações de interfaces.
• Categorias de interfaces: Criar categorias, obter menu de categorias.
• Importação de dados: Importar dados de interfaces.
• Lista de interfaces: Obter a lista de interfaces de um projeto ou categoria.

⚙️ Configuração do cliente

Requisitos de instalação

• Node.js >= v18.0.0
• Cursor, Windsurf, Claude Desktop ou outros clientes que suportam o protocolo MCP

Exemplo de configuração

TOKEN do projeto YAPI: em "Projeto -> Configurações -> Configuração de token"

{
  "mcpServers": {
    "mcp-server-yapi": {
      "command": "npx",
      "args": ["-y", "mcp-server-yapi"],
      "env": {
        "YAPI_BASE_URL": "YAPI服务地址，例：https://xxx.yyy.com",
        "YAPI_TOKEN": "项目TOKEN",
        "MCP_DEBUG_CONSOLE": "false"
      }
    }
  }
}

🔧 Desenvolvimento e depuração local

Certifique-se de que o Node.js (versão >=18) esteja instalado em seu ambiente de desenvolvimento.

1. Clone e compile

# 克隆仓库
git clone https://github.com/kales0202/mcp-server-yapi.git

# 进入项目目录
cd mcp-server-yapi

# 安装依赖
npm install

# 编译生成dist/index.js
npm run build

2. Integração com Agentes de IA

Você pode integrar este serviço a clientes de Agentes de IA que suportam o protocolo MCP, adicionando a seguinte configuração ao arquivo de configuração do seu cliente

TOKEN do projeto YAPI: em "Projeto -> Configurações -> Configuração de token"

{
  "mcpServers": {
    "mcp-server-yapi": {
      "command": "node",
      "args": ["/absolute/path/to/your/mcp-server-yapi/dist/index.js"],
      "env": {
        "YAPI_BASE_URL": "YAPI服务地址",
        "YAPI_TOKEN": "项目TOKEN",
        "MCP_DEBUG_CONSOLE": "false"
      }
    }
  }
}

🛠️ Lista de ferramentas disponíveis

• get_project: Obter informações básicas do projeto
• add_cat: Adicionar categoria de interface
• get_cat_menu: Obter lista de menus
• list_cat: Obter lista de interfaces de uma categoria
• list_menu: Obter lista de menus de interfaces
• get_interface: Obter dados da interface
• list_interface: Obter dados da lista de interfaces
• save_interface: Adicionar ou atualizar interface
• add_interface: Adicionar interface
• up_interface: Atualizar interface
• import_data: Importação de dados do servidor