YApi

mcp-server-yapi

mcp-server-yapi es un servidor MCP diseñado para YApi. Envuelve las funciones comunes de YApi como una serie de herramientas, lo que permite que los modelos de lenguaje grandes (LLM) interactúen con tu plataforma YApi mediante lenguaje natural, logrando la automatización de la gestión de interfaces.

✨ Funciones principales

A través de este servicio, puedes realizar las siguientes operaciones usando lenguaje natural:

• Gestión de proyectos: Obtener información básica del proyecto.
• Gestión de interfaces: Crear, guardar, actualizar y obtener información de interfaces.
• Categorías de interfaces: Crear categorías y obtener el menú de categorías.
• Importación de datos: Importar datos de interfaces.
• Lista de interfaces: Obtener la lista de interfaces de un proyecto o categoría.

⚙️ Configuración del cliente

Requisitos de instalación

• Node.js >= v18.0.0
• Cursor, Windsurf, Claude Desktop u otros clientes compatibles con el protocolo MCP

Ejemplo de configuración

TOKEN del proyecto YAPI: en "Proyecto -> Configuración -> Configuración 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"
      }
    }
  }
}

🔧 Desarrollo y depuración local

Asegúrate de tener instalado Node.js en tu entorno de desarrollo (versión >=18).

1. Clona y compila

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

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

# 安装依赖
npm install

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

2. Integración con agentes de IA

Puedes integrar este servicio en clientes de agentes de IA compatibles con el protocolo MCP, añadiendo la siguiente configuración a tu archivo de configuración del cliente

TOKEN del proyecto YAPI: en "Proyecto -> Configuración -> Configuración 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 herramientas disponibles

• get_project: Obtener información básica del proyecto
• add_cat: Añadir una categoría de interfaz
• get_cat_menu: Obtener la lista de menús
• list_cat: Obtener la lista de interfaces de una categoría
• list_menu: Obtener la lista del menú de interfaces
• get_interface: Obtener datos de una interfaz
• list_interface: Obtener datos de la lista de interfaces
• save_interface: Añadir o actualizar una interfaz
• add_interface: Añadir una interfaz
• up_interface: Actualizar una interfaz
• import_data: Importar datos desde el servidor